POST api/Register

This method is used for registering an Ocean Carrier Bill of Lading number (CBL). This method is required to be called for the GetTracking method to return tracking feeds.

Request Information


URI Parameters

None.

Body Parameters

RegisterForTrackingRequest
NameDescriptionTypeAdditional information
cbl

MVOCC Carrier Bill of Lading Number

string

None.

cnt

Optional Container Number If the value is null, the response will return all Containers manifested under the MVOCC Carrier Bill of Lading Number.

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:
{
  "cbl": "ONEYHPHV07147800",
  "cnt": null,
  "apikey": "8881BA2F-5FE2-4CF1-D99E-5963J9192806",
  "username": "demoapi",
  "password": "dpassword",
  "ctoken": null
}

text/xml, application/xml

Sample:
<RegisterForTrackingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OceanExternalRestService.Tracking.Models">
  <apikey>8881BA2F-5FE2-4CF1-D99E-5963J9192806</apikey>
  <ctoken i:nil="true" />
  <password>dpassword</password>
  <username>demoapi</username>
  <cbl>ONEYHPHV07147800</cbl>
  <cnt i:nil="true" />
</RegisterForTrackingRequest>

application/x-www-form-urlencoded

Sample:
CBL=ONEYHPHV07147800&ApiKey=8881BA2F-5FE2-4CF1-D99E-5963J9192806&Username=demoapi&Password=dpassword

Response Information


Resource Description

RegisterForTrackingResponse
NameDescriptionTypeAdditional information
cbl

MVOCC Carrier Bill of Lading Number from the RegisterForTracking request method.

string

None.

cnt

Container Number from the RegisterForTracking request method.

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.

Response Formats

application/json, text/json

Sample:
{
  "cbl": "ONEYHPHV07147800",
  "cnt": null,
  "ack": 1,
  "exceptions": null
}

text/xml, application/xml

Sample:
<RegisterForTrackingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OceanExternalRestService.Tracking.Models">
  <ack>Success</ack>
  <exceptions i:nil="true" />
  <cbl>ONEYHPHV07147800</cbl>
  <cnt i:nil="true" />
</RegisterForTrackingResponse>