POST api/ConveyShipmentEvents

Request Information

URI Parameters

None.

Body Parameters

GetConveyShipmentEventsDataModel

NameDescriptionTypeAdditional Information
SiteCode

Site Code

string

None.

VerificationKey

Verification Key

string

None.

TimestampUTC

Current Time in UTC format

string

None.

ConveyApiKey

string

None.

ConveyApiUrl

string

None.

APIUsername

string

None.

Request Formats

application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GenericResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:
<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">
  <CorrelationId>sample string 2</CorrelationId>
  <Message>sample string 1</Message>
  <ResponseCode>Success</ResponseCode>
</GenericResponse>