POST api/TransactionalData/BolDetail/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

DataCollectionResultOfBillOfLadingDetailEntityModel

Name	Description	Type	Additional information
TotalRecords		integer	None.
Data			None.

Response Formats

application/json, text/json

Sample:

{
  "TotalRecords": 1,
  "Data": [
    {
      "BillOfLading": {
        "BillOfLadingId": 1,
        "BOLNumber": "sample string 2",
        "DocumentListId": 1,
        "IsActive": true,
        "MethodOfTransportationCodeValue": {
          "CodeValueId": 1,
          "Display": "sample string 2"
        }
      },
      "BillOfLadingDetailId": 1,
      "BoldateTime": "2025-12-10T08:26:14.0847623-06:00",
      "CarrierCounterParty": {
        "Abbreviation": "sample string 1",
        "CounterPartyId": 2,
        "Name": "sample string 3"
      },
      "DestinationLocation": {
        "Abbreviation": "sample string 1",
        "LocationId": 2,
        "Name": "sample string 3"
      },
      "IsActive": true,
      "LiftingNumber": "sample string 4",
      "Location": {
        "Abbreviation": "sample string 1",
        "LocationId": 2,
        "Name": "sample string 3"
      },
      "OriginLocation": {
        "Abbreviation": "sample string 1",
        "LocationId": 2,
        "Name": "sample string 3"
      },
      "PoNumber": "sample string 5",
      "Product": {
        "Abbreviation": "sample string 1",
        "IsActive": true,
        "Name": "sample string 3",
        "ProductId": 4
      },
      "Quantity": 6.0,
      "QuantityAmbientTemp": 1.0,
      "QuantityStandardTemp": 1.0,
      "SpecificGravity": 1.0,
      "TradeDetail": {
        "Trade": {
          "ExternalContractNumber": "sample string 1",
          "ExternalCounterPartyId": 2,
          "InternalContractNumber": "sample string 3",
          "TradeId": 4
        },
        "TradeDetailId": 1
      },
      "VehicleInitial": "sample string 7",
      "VehicleNumber": "sample string 8",
      "Extras": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "BillOfLading": {
        "BillOfLadingId": 1,
        "BOLNumber": "sample string 2",
        "DocumentListId": 1,
        "IsActive": true,
        "MethodOfTransportationCodeValue": {
          "CodeValueId": 1,
          "Display": "sample string 2"
        }
      },
      "BillOfLadingDetailId": 1,
      "BoldateTime": "2025-12-10T08:26:14.0847623-06:00",
      "CarrierCounterParty": {
        "Abbreviation": "sample string 1",
        "CounterPartyId": 2,
        "Name": "sample string 3"
      },
      "DestinationLocation": {
        "Abbreviation": "sample string 1",
        "LocationId": 2,
        "Name": "sample string 3"
      },
      "IsActive": true,
      "LiftingNumber": "sample string 4",
      "Location": {
        "Abbreviation": "sample string 1",
        "LocationId": 2,
        "Name": "sample string 3"
      },
      "OriginLocation": {
        "Abbreviation": "sample string 1",
        "LocationId": 2,
        "Name": "sample string 3"
      },
      "PoNumber": "sample string 5",
      "Product": {
        "Abbreviation": "sample string 1",
        "IsActive": true,
        "Name": "sample string 3",
        "ProductId": 4
      },
      "Quantity": 6.0,
      "QuantityAmbientTemp": 1.0,
      "QuantityStandardTemp": 1.0,
      "SpecificGravity": 1.0,
      "TradeDetail": {
        "Trade": {
          "ExternalContractNumber": "sample string 1",
          "ExternalCounterPartyId": 2,
          "InternalContractNumber": "sample string 3",
          "TradeId": 4
        },
        "TradeDetailId": 1
      },
      "VehicleInitial": "sample string 7",
      "VehicleNumber": "sample string 8",
      "Extras": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ],
  "Query": {},
  "Validations": null
}

text/html

Sample:

{"TotalRecords":1,"Data":[{"BillOfLading":{"BillOfLadingId":1,"BOLNumber":"sample string 2","DocumentListId":1,"IsActive":true,"MethodOfTransportationCodeValue":{"CodeValueId":1,"Display":"sample string 2"}},"BillOfLadingDetailId":1,"BoldateTime":"2025-12-10T08:26:14.0847623-06:00","CarrierCounterParty":{"Abbreviation":"sample string 1","CounterPartyId":2,"Name":"sample string 3"},"DestinationLocation":{"Abbreviation":"sample string 1","LocationId":2,"Name":"sample string 3"},"IsActive":true,"LiftingNumber":"sample string 4","Location":{"Abbreviation":"sample string 1","LocationId":2,"Name":"sample string 3"},"OriginLocation":{"Abbreviation":"sample string 1","LocationId":2,"Name":"sample string 3"},"PoNumber":"sample string 5","Product":{"Abbreviation":"sample string 1","IsActive":true,"Name":"sample string 3","ProductId":4},"Quantity":6.0,"QuantityAmbientTemp":1.0,"QuantityStandardTemp":1.0,"SpecificGravity":1.0,"TradeDetail":{"Trade":{"ExternalContractNumber":"sample string 1","ExternalCounterPartyId":2,"InternalContractNumber":"sample string 3","TradeId":4},"TradeDetailId":1},"VehicleInitial":"sample string 7","VehicleNumber":"sample string 8","Extras":{"sample string 1":{},"sample string 3":{}}},{"BillOfLading":{"BillOfLadingId":1,"BOLNumber":"sample string 2","DocumentListId":1,"IsActive":true,"MethodOfTransportationCodeValue":{"CodeValueId":1,"Display":"sample string 2"}},"BillOfLadingDetailId":1,"BoldateTime":"2025-12-10T08:26:14.0847623-06:00","CarrierCounterParty":{"Abbreviation":"sample string 1","CounterPartyId":2,"Name":"sample string 3"},"DestinationLocation":{"Abbreviation":"sample string 1","LocationId":2,"Name":"sample string 3"},"IsActive":true,"LiftingNumber":"sample string 4","Location":{"Abbreviation":"sample string 1","LocationId":2,"Name":"sample string 3"},"OriginLocation":{"Abbreviation":"sample string 1","LocationId":2,"Name":"sample string 3"},"PoNumber":"sample string 5","Product":{"Abbreviation":"sample string 1","IsActive":true,"Name":"sample string 3","ProductId":4},"Quantity":6.0,"QuantityAmbientTemp":1.0,"QuantityStandardTemp":1.0,"SpecificGravity":1.0,"TradeDetail":{"Trade":{"ExternalContractNumber":"sample string 1","ExternalCounterPartyId":2,"InternalContractNumber":"sample string 3","TradeId":4},"TradeDetailId":1},"VehicleInitial":"sample string 7","VehicleNumber":"sample string 8","Extras":{"sample string 1":{},"sample string 3":{}}}],"Query":{},"Validations":null}

application/xml, text/xml

Sample:

<DataCollectionResultOfBillOfLadingDetailEntityModelwD3tWLDN 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:BillOfLadingDetailEntityModel>
      <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:BillOfLading xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:BOLNumber>sample string 2</d4p1:BOLNumber>
        <d4p1:BillOfLadingId>1</d4p1:BillOfLadingId>
        <d4p1:DocumentListId>1</d4p1:DocumentListId>
        <d4p1:IsActive>true</d4p1:IsActive>
        <d4p1:MethodOfTransportationCodeValue xmlns:d5p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes.BillOfLadingEntityModelTypes">
          <d5p1:CodeValueId>1</d5p1:CodeValueId>
          <d5p1:Display>sample string 2</d5p1:Display>
        </d4p1:MethodOfTransportationCodeValue>
      </d2p1:BillOfLading>
      <d2p1:BillOfLadingDetailId>1</d2p1:BillOfLadingDetailId>
      <d2p1:BoldateTime>2025-12-10T08:26:14.0847623-06:00</d2p1:BoldateTime>
      <d2p1:CarrierCounterParty xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:CounterPartyId>2</d4p1:CounterPartyId>
        <d4p1:Name>sample string 3</d4p1:Name>
      </d2p1:CarrierCounterParty>
      <d2p1:DestinationLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:LocationId>2</d4p1:LocationId>
        <d4p1:Name>sample string 3</d4p1:Name>
      </d2p1:DestinationLocation>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:LiftingNumber>sample string 4</d2p1:LiftingNumber>
      <d2p1:Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:LocationId>2</d4p1:LocationId>
        <d4p1:Name>sample string 3</d4p1:Name>
      </d2p1:Location>
      <d2p1:OriginLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:LocationId>2</d4p1:LocationId>
        <d4p1:Name>sample string 3</d4p1:Name>
      </d2p1:OriginLocation>
      <d2p1:PoNumber>sample string 5</d2p1:PoNumber>
      <d2p1:Product xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:IsActive>true</d4p1:IsActive>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:ProductId>4</d4p1:ProductId>
      </d2p1:Product>
      <d2p1:Quantity>6</d2p1:Quantity>
      <d2p1:QuantityAmbientTemp>1</d2p1:QuantityAmbientTemp>
      <d2p1:QuantityStandardTemp>1</d2p1:QuantityStandardTemp>
      <d2p1:SpecificGravity>1</d2p1:SpecificGravity>
      <d2p1:TradeDetail xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Trade xmlns:d5p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes.TradeDetailEntityModelTypes">
          <d5p1:ExternalContractNumber>sample string 1</d5p1:ExternalContractNumber>
          <d5p1:ExternalCounterPartyId>2</d5p1:ExternalCounterPartyId>
          <d5p1:InternalContractNumber>sample string 3</d5p1:InternalContractNumber>
          <d5p1:TradeId>4</d5p1:TradeId>
        </d4p1:Trade>
        <d4p1:TradeDetailId>1</d4p1:TradeDetailId>
      </d2p1:TradeDetail>
      <d2p1:VehicleInitial>sample string 7</d2p1:VehicleInitial>
      <d2p1:VehicleNumber>sample string 8</d2p1:VehicleNumber>
    </d2p1:BillOfLadingDetailEntityModel>
    <d2p1:BillOfLadingDetailEntityModel>
      <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:BillOfLading xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:BOLNumber>sample string 2</d4p1:BOLNumber>
        <d4p1:BillOfLadingId>1</d4p1:BillOfLadingId>
        <d4p1:DocumentListId>1</d4p1:DocumentListId>
        <d4p1:IsActive>true</d4p1:IsActive>
        <d4p1:MethodOfTransportationCodeValue xmlns:d5p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes.BillOfLadingEntityModelTypes">
          <d5p1:CodeValueId>1</d5p1:CodeValueId>
          <d5p1:Display>sample string 2</d5p1:Display>
        </d4p1:MethodOfTransportationCodeValue>
      </d2p1:BillOfLading>
      <d2p1:BillOfLadingDetailId>1</d2p1:BillOfLadingDetailId>
      <d2p1:BoldateTime>2025-12-10T08:26:14.0847623-06:00</d2p1:BoldateTime>
      <d2p1:CarrierCounterParty xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:CounterPartyId>2</d4p1:CounterPartyId>
        <d4p1:Name>sample string 3</d4p1:Name>
      </d2p1:CarrierCounterParty>
      <d2p1:DestinationLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:LocationId>2</d4p1:LocationId>
        <d4p1:Name>sample string 3</d4p1:Name>
      </d2p1:DestinationLocation>
      <d2p1:IsActive>true</d2p1:IsActive>
      <d2p1:LiftingNumber>sample string 4</d2p1:LiftingNumber>
      <d2p1:Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:LocationId>2</d4p1:LocationId>
        <d4p1:Name>sample string 3</d4p1:Name>
      </d2p1:Location>
      <d2p1:OriginLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:LocationId>2</d4p1:LocationId>
        <d4p1:Name>sample string 3</d4p1:Name>
      </d2p1:OriginLocation>
      <d2p1:PoNumber>sample string 5</d2p1:PoNumber>
      <d2p1:Product xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Abbreviation>sample string 1</d4p1:Abbreviation>
        <d4p1:IsActive>true</d4p1:IsActive>
        <d4p1:Name>sample string 3</d4p1:Name>
        <d4p1:ProductId>4</d4p1:ProductId>
      </d2p1:Product>
      <d2p1:Quantity>6</d2p1:Quantity>
      <d2p1:QuantityAmbientTemp>1</d2p1:QuantityAmbientTemp>
      <d2p1:QuantityStandardTemp>1</d2p1:QuantityStandardTemp>
      <d2p1:SpecificGravity>1</d2p1:SpecificGravity>
      <d2p1:TradeDetail xmlns:d4p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes">
        <d4p1:Trade xmlns:d5p1="http://schemas.datacontract.org/2004/07/Gravitate.Domain.CoreModel.DtoClasses.BillOfLadingDetailEntityModelTypes.TradeDetailEntityModelTypes">
          <d5p1:ExternalContractNumber>sample string 1</d5p1:ExternalContractNumber>
          <d5p1:ExternalCounterPartyId>2</d5p1:ExternalCounterPartyId>
          <d5p1:InternalContractNumber>sample string 3</d5p1:InternalContractNumber>
          <d5p1:TradeId>4</d5p1:TradeId>
        </d4p1:Trade>
        <d4p1:TradeDetailId>1</d4p1:TradeDetailId>
      </d2p1:TradeDetail>
      <d2p1:VehicleInitial>sample string 7</d2p1:VehicleInitial>
      <d2p1:VehicleNumber>sample string 8</d2p1:VehicleNumber>
    </d2p1:BillOfLadingDetailEntityModel>
  </Data>
  <TotalRecords>1</TotalRecords>
</DataCollectionResultOfBillOfLadingDetailEntityModelwD3tWLDN>