POST api/ReferenceData/CounterParty/GetByDataRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
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:

{
  "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:

{"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:

<DataRequest 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>
</DataRequest>

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 'DataRequest'.

Response Information

Resource Description

DataCollectionResultOfCounterPartyEntityModel

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

Response Formats

application/json, text/json

Sample:

{
  "TotalRecords": 1,
  "Data": [
    {
      "SourceString": "sample string 1",
      "Abbreviation": "sample string 2",
      "CategoryCvId": 1,
      "CounterPartyId": 3,
      "Domain": "sample string 4",
      "HasCustomerPortal": true,
      "HasCustomerPortalModifiedDateTime": "2025-12-10T08:24:12.2359259-06:00",
      "HasTradeRelationship": true,
      "IsActive": true,
      "Name": "sample string 8",
      "NeedsFullSync": true,
      "ParentCounterPartyId": 1,
      "PrimaryColleagueId": 1,
      "PrimaryInternalCounterpartyId": 1,
      "PropertyListId": 1,
      "SourceExtractedDateTime": "2025-12-10T08:24:12.2359259-06:00",
      "SourceId": 1,
      "SourceId2": 1,
      "SourceId3": 1,
      "SourceSystemId": 1,
      "SourceVerb": "sample string 10",
      "Extras": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "SourceString": "sample string 1",
      "Abbreviation": "sample string 2",
      "CategoryCvId": 1,
      "CounterPartyId": 3,
      "Domain": "sample string 4",
      "HasCustomerPortal": true,
      "HasCustomerPortalModifiedDateTime": "2025-12-10T08:24:12.2359259-06:00",
      "HasTradeRelationship": true,
      "IsActive": true,
      "Name": "sample string 8",
      "NeedsFullSync": true,
      "ParentCounterPartyId": 1,
      "PrimaryColleagueId": 1,
      "PrimaryInternalCounterpartyId": 1,
      "PropertyListId": 1,
      "SourceExtractedDateTime": "2025-12-10T08:24:12.2359259-06:00",
      "SourceId": 1,
      "SourceId2": 1,
      "SourceId3": 1,
      "SourceSystemId": 1,
      "SourceVerb": "sample string 10",
      "Extras": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ],
  "Query": {},
  "Validations": null
}

text/html

Sample:

{"TotalRecords":1,"Data":[{"SourceString":"sample string 1","Abbreviation":"sample string 2","CategoryCvId":1,"CounterPartyId":3,"Domain":"sample string 4","HasCustomerPortal":true,"HasCustomerPortalModifiedDateTime":"2025-12-10T08:24:12.2359259-06:00","HasTradeRelationship":true,"IsActive":true,"Name":"sample string 8","NeedsFullSync":true,"ParentCounterPartyId":1,"PrimaryColleagueId":1,"PrimaryInternalCounterpartyId":1,"PropertyListId":1,"SourceExtractedDateTime":"2025-12-10T08:24:12.2359259-06:00","SourceId":1,"SourceId2":1,"SourceId3":1,"SourceSystemId":1,"SourceVerb":"sample string 10","Extras":{"sample string 1":{},"sample string 3":{}}},{"SourceString":"sample string 1","Abbreviation":"sample string 2","CategoryCvId":1,"CounterPartyId":3,"Domain":"sample string 4","HasCustomerPortal":true,"HasCustomerPortalModifiedDateTime":"2025-12-10T08:24:12.2359259-06:00","HasTradeRelationship":true,"IsActive":true,"Name":"sample string 8","NeedsFullSync":true,"ParentCounterPartyId":1,"PrimaryColleagueId":1,"PrimaryInternalCounterpartyId":1,"PropertyListId":1,"SourceExtractedDateTime":"2025-12-10T08:24:12.2359259-06:00","SourceId":1,"SourceId2":1,"SourceId3":1,"SourceSystemId":1,"SourceVerb":"sample string 10","Extras":{"sample string 1":{},"sample string 3":{}}}],"Query":{},"Validations":null}

application/xml, text/xml

Sample:

<DataCollectionResultOfCounterPartyEntityModelwD3tWLDN 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:CounterPartyEntityModel>
      <Extras xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.Extensibility">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Extras>
      <d2p1:Abbreviation>sample string 2</d2p1:Abbreviation>
      <d2p1:CategoryCvId>1</d2p1:CategoryCvId>
      <d2p1:CounterPartyId>3</d2p1:CounterPartyId>
      <d2p1:Domain>sample string 4</d2p1:Domain>
      <d2p1:HasCustomerPortal>true</d2p1:HasCustomerPortal>
      <d2p1:HasCustomerPortalModifiedDateTime>2025-12-10T08:24:12.2359259-06:00</d2p1:HasCustomerPortalModifiedDateTime>
      <d2p1:HasTradeRelationship>true</d2p1:HasTradeRelationship>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:Name>sample string 8</d2p1:Name>
      <d2p1:NeedsFullSync>true</d2p1:NeedsFullSync>
      <d2p1:ParentCounterPartyId>1</d2p1:ParentCounterPartyId>
      <d2p1:PrimaryColleagueId>1</d2p1:PrimaryColleagueId>
      <d2p1:PrimaryInternalCounterpartyId>1</d2p1:PrimaryInternalCounterpartyId>
      <d2p1:PropertyListId>1</d2p1:PropertyListId>
      <d2p1:SourceExtractedDateTime>2025-12-10T08:24:12.2359259-06:00</d2p1:SourceExtractedDateTime>
      <d2p1:SourceId>1</d2p1:SourceId>
      <d2p1:SourceId2>1</d2p1:SourceId2>
      <d2p1:SourceId3>1</d2p1:SourceId3>
      <d2p1:SourceString>sample string 1</d2p1:SourceString>
      <d2p1:SourceSystemId>1</d2p1:SourceSystemId>
      <d2p1:SourceVerb>sample string 10</d2p1:SourceVerb>
    </d2p1:CounterPartyEntityModel>
    <d2p1:CounterPartyEntityModel>
      <Extras xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.Extensibility">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Extras>
      <d2p1:Abbreviation>sample string 2</d2p1:Abbreviation>
      <d2p1:CategoryCvId>1</d2p1:CategoryCvId>
      <d2p1:CounterPartyId>3</d2p1:CounterPartyId>
      <d2p1:Domain>sample string 4</d2p1:Domain>
      <d2p1:HasCustomerPortal>true</d2p1:HasCustomerPortal>
      <d2p1:HasCustomerPortalModifiedDateTime>2025-12-10T08:24:12.2359259-06:00</d2p1:HasCustomerPortalModifiedDateTime>
      <d2p1:HasTradeRelationship>true</d2p1:HasTradeRelationship>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:Name>sample string 8</d2p1:Name>
      <d2p1:NeedsFullSync>true</d2p1:NeedsFullSync>
      <d2p1:ParentCounterPartyId>1</d2p1:ParentCounterPartyId>
      <d2p1:PrimaryColleagueId>1</d2p1:PrimaryColleagueId>
      <d2p1:PrimaryInternalCounterpartyId>1</d2p1:PrimaryInternalCounterpartyId>
      <d2p1:PropertyListId>1</d2p1:PropertyListId>
      <d2p1:SourceExtractedDateTime>2025-12-10T08:24:12.2359259-06:00</d2p1:SourceExtractedDateTime>
      <d2p1:SourceId>1</d2p1:SourceId>
      <d2p1:SourceId2>1</d2p1:SourceId2>
      <d2p1:SourceId3>1</d2p1:SourceId3>
      <d2p1:SourceString>sample string 1</d2p1:SourceString>
      <d2p1:SourceSystemId>1</d2p1:SourceSystemId>
      <d2p1:SourceVerb>sample string 10</d2p1:SourceVerb>
    </d2p1:CounterPartyEntityModel>
  </Data>
  <TotalRecords>1</TotalRecords>
</DataCollectionResultOfCounterPartyEntityModelwD3tWLDN>