POST api/ReferenceData/PriceInstrument/GetGroupedDataByDataRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Groupings	Collection of string	None.
Predicate	string	None.
Identifiers	Collection of integer	None.
OrderingFields	Collection of OrderingField	None.
Count	integer	None.
Offset	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Groupings": [
    "sample string 1",
    "sample string 2"
  ],
  "Predicate": "sample string 1",
  "Identifiers": [
    1,
    2
  ],
  "OrderingFields": [
    {
      "FieldName": "sample string 1",
      "SortDirection": "Ascending"
    },
    {
      "FieldName": "sample string 1",
      "SortDirection": "Ascending"
    }
  ],
  "Count": 1,
  "Offset": 1
}

text/html

Sample:

{"Groupings":["sample string 1","sample string 2"],"Predicate":"sample string 1","Identifiers":[1,2],"OrderingFields":[{"FieldName":"sample string 1","SortDirection":"Ascending"},{"FieldName":"sample string 1","SortDirection":"Ascending"}],"Count":1,"Offset":1}

application/xml, text/xml

Sample:

<GroupedDataRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Services.Base.DataRequests">
  <Count>1</Count>
  <Offset>1</Offset>
  <OrderingFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gravitate.Library.DynamicLinq">
    <d2p1:OrderingField>
      <d2p1:FieldName>sample string 1</d2p1:FieldName>
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
    </d2p1:OrderingField>
    <d2p1:OrderingField>
      <d2p1:FieldName>sample string 1</d2p1:FieldName>
      <d2p1:SortDirection>Ascending</d2p1:SortDirection>
    </d2p1:OrderingField>
  </OrderingFields>
  <Identifiers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Identifiers>
  <Predicate>sample string 1</Predicate>
  <Groupings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Groupings>
</GroupedDataRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GroupedDataRequest'.

Response Information

Resource Description

GroupedDataResultOfPriceInstrumentEntityModel

Name	Type	Additional information
TotalRecords	integer	None.
Data	Collection of Collection of PriceInstrumentEntityModel	None.
TotalGroups	integer	None.
Query	Object	None.
Validations	Collection of Object	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalRecords": 1,
  "Data": [
    [
      {
        "Abbreviation": "sample string 1",
        "BookId": 1,
        "CounterPartyId": 1,
        "CurrencyId": 1,
        "ExchangeSymbol": "sample string 2",
        "ExternalReferenceNumber": "sample string 3",
        "ExtractPrices": true,
        "IndexPriceInstrumentId": 1,
        "IndexPriceTypeCvid": 1,
        "IsActive": true,
        "LocationId": 1,
        "Name": "sample string 6",
        "PriceInstrumentId": 7,
        "PricePublisherId": 8,
        "ProductId": 1,
        "PropertyListId": 1,
        "SourceExtractedDateTime": "2025-12-10T08:24:11.0152376-06:00",
        "SourceId": 1,
        "SourceVerb": "sample string 9",
        "ToCurrencyId": 1,
        "UnitofMeasureId": 1,
        "Extras": {
          "sample string 1": {},
          "sample string 3": {}
        }
      },
      {
        "Abbreviation": "sample string 1",
        "BookId": 1,
        "CounterPartyId": 1,
        "CurrencyId": 1,
        "ExchangeSymbol": "sample string 2",
        "ExternalReferenceNumber": "sample string 3",
        "ExtractPrices": true,
        "IndexPriceInstrumentId": 1,
        "IndexPriceTypeCvid": 1,
        "IsActive": true,
        "LocationId": 1,
        "Name": "sample string 6",
        "PriceInstrumentId": 7,
        "PricePublisherId": 8,
        "ProductId": 1,
        "PropertyListId": 1,
        "SourceExtractedDateTime": "2025-12-10T08:24:11.0152376-06:00",
        "SourceId": 1,
        "SourceVerb": "sample string 9",
        "ToCurrencyId": 1,
        "UnitofMeasureId": 1,
        "Extras": {
          "sample string 1": {},
          "sample string 3": {}
        }
      }
    ],
    [
      {
        "Abbreviation": "sample string 1",
        "BookId": 1,
        "CounterPartyId": 1,
        "CurrencyId": 1,
        "ExchangeSymbol": "sample string 2",
        "ExternalReferenceNumber": "sample string 3",
        "ExtractPrices": true,
        "IndexPriceInstrumentId": 1,
        "IndexPriceTypeCvid": 1,
        "IsActive": true,
        "LocationId": 1,
        "Name": "sample string 6",
        "PriceInstrumentId": 7,
        "PricePublisherId": 8,
        "ProductId": 1,
        "PropertyListId": 1,
        "SourceExtractedDateTime": "2025-12-10T08:24:11.0152376-06:00",
        "SourceId": 1,
        "SourceVerb": "sample string 9",
        "ToCurrencyId": 1,
        "UnitofMeasureId": 1,
        "Extras": {
          "sample string 1": {},
          "sample string 3": {}
        }
      },
      {
        "Abbreviation": "sample string 1",
        "BookId": 1,
        "CounterPartyId": 1,
        "CurrencyId": 1,
        "ExchangeSymbol": "sample string 2",
        "ExternalReferenceNumber": "sample string 3",
        "ExtractPrices": true,
        "IndexPriceInstrumentId": 1,
        "IndexPriceTypeCvid": 1,
        "IsActive": true,
        "LocationId": 1,
        "Name": "sample string 6",
        "PriceInstrumentId": 7,
        "PricePublisherId": 8,
        "ProductId": 1,
        "PropertyListId": 1,
        "SourceExtractedDateTime": "2025-12-10T08:24:11.0152376-06:00",
        "SourceId": 1,
        "SourceVerb": "sample string 9",
        "ToCurrencyId": 1,
        "UnitofMeasureId": 1,
        "Extras": {
          "sample string 1": {},
          "sample string 3": {}
        }
      }
    ]
  ],
  "TotalGroups": 2,
  "Query": {},
  "Validations": null
}

text/html

Sample:

{"TotalRecords":1,"Data":[[{"Abbreviation":"sample string 1","BookId":1,"CounterPartyId":1,"CurrencyId":1,"ExchangeSymbol":"sample string 2","ExternalReferenceNumber":"sample string 3","ExtractPrices":true,"IndexPriceInstrumentId":1,"IndexPriceTypeCvid":1,"IsActive":true,"LocationId":1,"Name":"sample string 6","PriceInstrumentId":7,"PricePublisherId":8,"ProductId":1,"PropertyListId":1,"SourceExtractedDateTime":"2025-12-10T08:24:11.0152376-06:00","SourceId":1,"SourceVerb":"sample string 9","ToCurrencyId":1,"UnitofMeasureId":1,"Extras":{"sample string 1":{},"sample string 3":{}}},{"Abbreviation":"sample string 1","BookId":1,"CounterPartyId":1,"CurrencyId":1,"ExchangeSymbol":"sample string 2","ExternalReferenceNumber":"sample string 3","ExtractPrices":true,"IndexPriceInstrumentId":1,"IndexPriceTypeCvid":1,"IsActive":true,"LocationId":1,"Name":"sample string 6","PriceInstrumentId":7,"PricePublisherId":8,"ProductId":1,"PropertyListId":1,"SourceExtractedDateTime":"2025-12-10T08:24:11.0152376-06:00","SourceId":1,"SourceVerb":"sample string 9","ToCurrencyId":1,"UnitofMeasureId":1,"Extras":{"sample string 1":{},"sample string 3":{}}}],[{"Abbreviation":"sample string 1","BookId":1,"CounterPartyId":1,"CurrencyId":1,"ExchangeSymbol":"sample string 2","ExternalReferenceNumber":"sample string 3","ExtractPrices":true,"IndexPriceInstrumentId":1,"IndexPriceTypeCvid":1,"IsActive":true,"LocationId":1,"Name":"sample string 6","PriceInstrumentId":7,"PricePublisherId":8,"ProductId":1,"PropertyListId":1,"SourceExtractedDateTime":"2025-12-10T08:24:11.0152376-06:00","SourceId":1,"SourceVerb":"sample string 9","ToCurrencyId":1,"UnitofMeasureId":1,"Extras":{"sample string 1":{},"sample string 3":{}}},{"Abbreviation":"sample string 1","BookId":1,"CounterPartyId":1,"CurrencyId":1,"ExchangeSymbol":"sample string 2","ExternalReferenceNumber":"sample string 3","ExtractPrices":true,"IndexPriceInstrumentId":1,"IndexPriceTypeCvid":1,"IsActive":true,"LocationId":1,"Name":"sample string 6","PriceInstrumentId":7,"PricePublisherId":8,"ProductId":1,"PropertyListId":1,"SourceExtractedDateTime":"2025-12-10T08:24:11.0152376-06:00","SourceId":1,"SourceVerb":"sample string 9","ToCurrencyId":1,"UnitofMeasureId":1,"Extras":{"sample string 1":{},"sample string 3":{}}}]],"TotalGroups":2,"Query":{},"Validations":null}

application/xml, text/xml

Sample:

<GroupedDataResultOfPriceInstrumentEntityModelwD3tWLDN xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Services.Base.DataRequests">
  <Query />
  <Validations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gravitate.Library.Validation" i:nil="true" />
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses">
    <d2p1:ArrayOfPriceInstrumentEntityModel>
      <d2p1:PriceInstrumentEntityModel>
        <Extras xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.Extensibility">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </Extras>
        <d2p1:Abbreviation>sample string 1</d2p1:Abbreviation>
        <d2p1:BookId>1</d2p1:BookId>
        <d2p1:CounterPartyId>1</d2p1:CounterPartyId>
        <d2p1:CurrencyId>1</d2p1:CurrencyId>
        <d2p1:ExchangeSymbol>sample string 2</d2p1:ExchangeSymbol>
        <d2p1:ExternalReferenceNumber>sample string 3</d2p1:ExternalReferenceNumber>
        <d2p1:ExtractPrices>true</d2p1:ExtractPrices>
        <d2p1:IndexPriceInstrumentId>1</d2p1:IndexPriceInstrumentId>
        <d2p1:IndexPriceTypeCvid>1</d2p1:IndexPriceTypeCvid>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:LocationId>1</d2p1:LocationId>
        <d2p1:Name>sample string 6</d2p1:Name>
        <d2p1:PriceInstrumentId>7</d2p1:PriceInstrumentId>
        <d2p1:PricePublisherId>8</d2p1:PricePublisherId>
        <d2p1:ProductId>1</d2p1:ProductId>
        <d2p1:PropertyListId>1</d2p1:PropertyListId>
        <d2p1:SourceExtractedDateTime>2025-12-10T08:24:11.0152376-06:00</d2p1:SourceExtractedDateTime>
        <d2p1:SourceId>1</d2p1:SourceId>
        <d2p1:SourceVerb>sample string 9</d2p1:SourceVerb>
        <d2p1:ToCurrencyId>1</d2p1:ToCurrencyId>
        <d2p1:UnitofMeasureId>1</d2p1:UnitofMeasureId>
      </d2p1:PriceInstrumentEntityModel>
      <d2p1:PriceInstrumentEntityModel>
        <Extras xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.Extensibility">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </Extras>
        <d2p1:Abbreviation>sample string 1</d2p1:Abbreviation>
        <d2p1:BookId>1</d2p1:BookId>
        <d2p1:CounterPartyId>1</d2p1:CounterPartyId>
        <d2p1:CurrencyId>1</d2p1:CurrencyId>
        <d2p1:ExchangeSymbol>sample string 2</d2p1:ExchangeSymbol>
        <d2p1:ExternalReferenceNumber>sample string 3</d2p1:ExternalReferenceNumber>
        <d2p1:ExtractPrices>true</d2p1:ExtractPrices>
        <d2p1:IndexPriceInstrumentId>1</d2p1:IndexPriceInstrumentId>
        <d2p1:IndexPriceTypeCvid>1</d2p1:IndexPriceTypeCvid>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:LocationId>1</d2p1:LocationId>
        <d2p1:Name>sample string 6</d2p1:Name>
        <d2p1:PriceInstrumentId>7</d2p1:PriceInstrumentId>
        <d2p1:PricePublisherId>8</d2p1:PricePublisherId>
        <d2p1:ProductId>1</d2p1:ProductId>
        <d2p1:PropertyListId>1</d2p1:PropertyListId>
        <d2p1:SourceExtractedDateTime>2025-12-10T08:24:11.0152376-06:00</d2p1:SourceExtractedDateTime>
        <d2p1:SourceId>1</d2p1:SourceId>
        <d2p1:SourceVerb>sample string 9</d2p1:SourceVerb>
        <d2p1:ToCurrencyId>1</d2p1:ToCurrencyId>
        <d2p1:UnitofMeasureId>1</d2p1:UnitofMeasureId>
      </d2p1:PriceInstrumentEntityModel>
    </d2p1:ArrayOfPriceInstrumentEntityModel>
    <d2p1:ArrayOfPriceInstrumentEntityModel>
      <d2p1:PriceInstrumentEntityModel>
        <Extras xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.Extensibility">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </Extras>
        <d2p1:Abbreviation>sample string 1</d2p1:Abbreviation>
        <d2p1:BookId>1</d2p1:BookId>
        <d2p1:CounterPartyId>1</d2p1:CounterPartyId>
        <d2p1:CurrencyId>1</d2p1:CurrencyId>
        <d2p1:ExchangeSymbol>sample string 2</d2p1:ExchangeSymbol>
        <d2p1:ExternalReferenceNumber>sample string 3</d2p1:ExternalReferenceNumber>
        <d2p1:ExtractPrices>true</d2p1:ExtractPrices>
        <d2p1:IndexPriceInstrumentId>1</d2p1:IndexPriceInstrumentId>
        <d2p1:IndexPriceTypeCvid>1</d2p1:IndexPriceTypeCvid>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:LocationId>1</d2p1:LocationId>
        <d2p1:Name>sample string 6</d2p1:Name>
        <d2p1:PriceInstrumentId>7</d2p1:PriceInstrumentId>
        <d2p1:PricePublisherId>8</d2p1:PricePublisherId>
        <d2p1:ProductId>1</d2p1:ProductId>
        <d2p1:PropertyListId>1</d2p1:PropertyListId>
        <d2p1:SourceExtractedDateTime>2025-12-10T08:24:11.0152376-06:00</d2p1:SourceExtractedDateTime>
        <d2p1:SourceId>1</d2p1:SourceId>
        <d2p1:SourceVerb>sample string 9</d2p1:SourceVerb>
        <d2p1:ToCurrencyId>1</d2p1:ToCurrencyId>
        <d2p1:UnitofMeasureId>1</d2p1:UnitofMeasureId>
      </d2p1:PriceInstrumentEntityModel>
      <d2p1:PriceInstrumentEntityModel>
        <Extras xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.Extensibility">
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
          <d5p1:KeyValueOfstringanyType>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value />
          </d5p1:KeyValueOfstringanyType>
        </Extras>
        <d2p1:Abbreviation>sample string 1</d2p1:Abbreviation>
        <d2p1:BookId>1</d2p1:BookId>
        <d2p1:CounterPartyId>1</d2p1:CounterPartyId>
        <d2p1:CurrencyId>1</d2p1:CurrencyId>
        <d2p1:ExchangeSymbol>sample string 2</d2p1:ExchangeSymbol>
        <d2p1:ExternalReferenceNumber>sample string 3</d2p1:ExternalReferenceNumber>
        <d2p1:ExtractPrices>true</d2p1:ExtractPrices>
        <d2p1:IndexPriceInstrumentId>1</d2p1:IndexPriceInstrumentId>
        <d2p1:IndexPriceTypeCvid>1</d2p1:IndexPriceTypeCvid>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:LocationId>1</d2p1:LocationId>
        <d2p1:Name>sample string 6</d2p1:Name>
        <d2p1:PriceInstrumentId>7</d2p1:PriceInstrumentId>
        <d2p1:PricePublisherId>8</d2p1:PricePublisherId>
        <d2p1:ProductId>1</d2p1:ProductId>
        <d2p1:PropertyListId>1</d2p1:PropertyListId>
        <d2p1:SourceExtractedDateTime>2025-12-10T08:24:11.0152376-06:00</d2p1:SourceExtractedDateTime>
        <d2p1:SourceId>1</d2p1:SourceId>
        <d2p1:SourceVerb>sample string 9</d2p1:SourceVerb>
        <d2p1:ToCurrencyId>1</d2p1:ToCurrencyId>
        <d2p1:UnitofMeasureId>1</d2p1:UnitofMeasureId>
      </d2p1:PriceInstrumentEntityModel>
    </d2p1:ArrayOfPriceInstrumentEntityModel>
  </Data>
  <TotalGroups>2</TotalGroups>
  <TotalRecords>1</TotalRecords>
</GroupedDataResultOfPriceInstrumentEntityModelwD3tWLDN>