POST Cargo/Reference

Request Information

URI Parameters

None.

Body Parameters

CargoReferenceRequest
NameDescriptionTypeAdditional information
supplierName

string

None.

userID

user API

string

None.

accessToken

access code getting from login

string

None.

Request Formats

application/json, text/json

Sample:
{
  "supplierName": "sample string 1",
  "userID": "sample string 2",
  "accessToken": "sample string 3"
}

application/xml, text/xml

Sample:
<CargoReferenceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 3</accessToken>
  <userID>sample string 2</userID>
  <supplierName>sample string 1</supplierName>
</CargoReferenceRequest>

Response Information

Resource Description

CargoReferenceResponse
NameDescriptionTypeAdditional information
references

Collection of CargoReferenceModel

None.

respTime

describe time in sending response

date

None.

userID

user ID to access API

string

None.

accessToken

access token that needed to access API

string

None.

status

SUCCESS or FAILED

string

None.

respMessage

detail message of response status

string

None.

Response Formats

application/json, text/json

Sample:
{
  "references": [
    {
      "referenceID": "sample string 1",
      "referenceName": "sample string 2"
    },
    {
      "referenceID": "sample string 1",
      "referenceName": "sample string 2"
    }
  ],
  "respTime": "2021-11-27T12:57:55.8944873+07:00",
  "userID": "sample string 2",
  "accessToken": "sample string 3",
  "status": "sample string 4",
  "respMessage": "sample string 5"
}

application/xml, text/xml

Sample:
<CargoReferenceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cebes.DI.H2H.Api.Models">
  <accessToken>sample string 3</accessToken>
  <respMessage>sample string 5</respMessage>
  <respTime>2021-11-27T12:57:55.8944873+07:00</respTime>
  <status>sample string 4</status>
  <userID>sample string 2</userID>
  <references>
    <CargoReferenceModel>
      <referenceID>sample string 1</referenceID>
      <referenceName>sample string 2</referenceName>
    </CargoReferenceModel>
    <CargoReferenceModel>
      <referenceID>sample string 1</referenceID>
      <referenceName>sample string 2</referenceName>
    </CargoReferenceModel>
  </references>
</CargoReferenceResponse>