POST Api/TransporterExternal/RetrieveTransporterExternalInfo?Email={Email}&Token={Token}&DeviceID={DeviceID}

Request Information

URI Parameters

Name	Type	Additional information
Email	string	Required
Token	string	Required
DeviceID	string	None.

Body Parameters

APIParameters

Name	Description	Type	Additional information
Parameters		Collection of Pair of string [key] and string [value]	Required

Request Formats

application/json, text/json

Sample:

{
  "Parameters": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<APIParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Clara.Objects">
  <Parameters xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
    <d2p1:KeyValuePairOfstringstring>
      <d2p1:key>sample string 1</d2p1:key>
      <d2p1:value>sample string 2</d2p1:value>
    </d2p1:KeyValuePairOfstringstring>
  </Parameters>
</APIParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseResponse

Name	Type	Additional information
Acknowledge	Acknowledge	None.
ResponseCode	ResponseCode	None.
ResponseMessage	string	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Acknowledge": 0,
  "ResponseCode": 0,
  "ResponseMessage": "sample string 1",
  "Data": {}
}

application/xml, text/xml

Sample:

<BaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClaraServiceApi.Responses">
  <Acknowledge xmlns="http://schemas.datacontract.org/2004/07/Clara.Objects">NACK</Acknowledge>
  <Data xmlns="http://schemas.datacontract.org/2004/07/Clara.Objects" />
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/Clara.Objects">FAIL</ResponseCode>
  <ResponseMessage xmlns="http://schemas.datacontract.org/2004/07/Clara.Objects">sample string 1</ResponseMessage>
</BaseResponse>