POST api/v1/APACEventGET

Retrieve event data for eventid and shipment id

Request Information

URI Parameters

None.

Body Parameters

APACEventGETParams
NameDescriptionTypeAdditional information
apiKey

Please contact Caliq support to get your key

 string

Required
EventID

integer

Required
ShipmentID

integer

Required

Request Formats

application/json, text/json

Sample: 
{
  "apiKey": "sample string 1",
  "EventID": 2,
  "ShipmentID": 3
}

application/xml, text/xml

Sample: 
<APACEventGETParams xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <apiKey>sample string 1</apiKey>
  <EventID>2</EventID>
  <ShipmentID>3</ShipmentID>
</APACEventGETParams>

Response Information

Resource Description

Returns:
200 OK Returns event email and phone
400 Bad Request - parameters supplied cannot be properly interpreted
401 Not Authorised if supplied api key is not valid
204 No Content if the requested product code or product id don't exist
503 Service Unavailable

APACEventData
NameDescriptionTypeAdditional information
contact_number

string

Max length: 100
email

string

Max length: 255

Response Formats

application/json, text/json

Sample: 
{
  "contact_number": "sample string 1",
  "email": "sample string 2"
}

application/xml, text/xml

Sample: 
<APACEventData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <contact_number>sample string 1</contact_number>
  <email>sample string 2</email>
</APACEventData>