POST api/RegisterV2

This method is used for registering a Container. This method is required to be called for the GetTrackingV2 method to return tracking feeds.

Request Information

URI Parameters

None.

Body Parameters

RegisterForTrackingV2Request

Name	Description	Type	Additional information
cnt	Required Container Number If the value is null, the response will return all Containers manifested under the MVOCC Carrier Bill of Lading Number.	string	None.
queryrange	Required. The start and end date (UTC) range of container event information to be returned for a container.	ContainerQueryRange	None.
carrier	Optional but preferred Carrier Code e.g.: MSC	string	None.
blref	Optional but preferred Carrier Bill's Manifest Reference or Booking Number without SCAC prefix. This must be accompanied with a Carrier Code.	string	None.
refs	Conditional Additional List of References At least 1 unique reference is required.	Collection of string	None.
enablecallback	Enable or disable callback	boolean	None.
callbackauthkey	Only applies if callbacks have special authentication requirements Pre-specified Key	string	None.
callbackurl	Callback URL	string	None.
apikey	Unique Value assigned by an administrator during account setup.	string	None.
username	Username Assigned by an administrator during account setup	string	None.
password	Password Assigned by an administrator during account setup	string	None.
ctoken	Optional Client Token	string	None.

Request Formats

application/json, text/json

Sample:

{
  "cnt": "MOFU0602878",
  "queryrange": null,
  "carrier": "ONE",
  "blref": "HPHV07147800",
  "refs": null,
  "enablecallback": true,
  "callbackauthkey": null,
  "callbackurl": "http://abc.com/aescallback/",
  "apikey": "8881BA2F-5FE2-4CF1-D99E-5963J9192806",
  "username": "demoapi",
  "password": "dpassword",
  "ctoken": null
}

text/xml, application/xml

Sample:

<RegisterForTrackingV2Request>
  <apikey>8881BA2F-5FE2-4CF1-D99E-5963J9192806</apikey>
  <ctoken />
  <password>dpassword</password>
  <username>demoapi</username>
  <blref>HPHV07147800</blref>
  <callbackauthkey />
  <callbackurl>http://abc.com/aescallback/</callbackurl>
  <carrier>ONE</carrier>
  <cnt>MOFU0602878</cnt>
  <enablecallback>true</enablecallback>
  <queryrange />
  <refs />
</RegisterForTrackingV2Request>

application/x-www-form-urlencoded

Sample:

CNT=MOFU0602878&CARRIER=ONE&BLReference=HPHV07147800&EnableCallback=True&CallbackUrl=http%3A%2F%2Fabc.com%2Faescallback%2F&ApiKey=8881BA2F-5FE2-4CF1-D99E-5963J9192806&Username=demoapi&Password=dpassword

Response Information

Resource Description

RegisterForTrackingV2Response

Name	Description	Type	Additional information
cnt	Required Container Number If the value is null, the response will return all Containers manifested under the MVOCC Carrier Bill of Lading Number.	string	None.
queryrange	Required. The start and end date (UTC) range of container event information to be returned for a container.	ContainerQueryRange	None.
carrier	Optional but preferred Carrier Code e.g.: MSC	string	None.
blref	Optional but preferred Carrier Bill's Manifest Reference or Booking Number without SCAC prefix. This must be accompanied with a Carrier Code.	string	None.
ack	A flag indicating success or failure of the web service response back to the client. Default is success.	AcknowledgeType	None.
exceptions	Message back to client. Mostly used when a web service failure occurs.	Collection of ResponseExceptionDto	None.
ctoken	Optional Client Token	string	None.

Response Formats

application/json, text/json

Sample:

{
  "cnt": "MOFU0602878",
  "queryrange": null,
  "carrier": "ONE",
  "blref": "HPHV07147800",
  "ack": 1,
  "exceptions": null,
  "ctoken": null
}

text/xml, application/xml

Sample:

<RegisterForTrackingV2Response>
  <ack>Success</ack>
  <ctoken />
  <exceptions />
  <blref>HPHV07147800</blref>
  <carrier>ONE</carrier>
  <cnt>MOFU0602878</cnt>
  <queryrange />
</RegisterForTrackingV2Response>