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.

scac

Isolated SCAC. This value is not consumed unless the account is enabled for a separate requests.

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.

load

Optional Load Type. FCL| Full Container Load | LCL: Less than Container Load | BCO: Beneficial Cargo Owner

string

None.

enablecallback

Enable or disable callback

boolean

None.

callbackauthkey

Only applies if callbacks have special authentication requirements Pre-specified Key e.g.: BASIC | OAUTH2

string

None.

callbackurl

Callback URL

string

None.

refs

Conditional List of References (At least 1 unique reference is required) Illegal Chars ',' '|' '\' '/' ';'

Collection of string

None.

customattributes

Conditional Custom Attributes: Must be mutually agreed upon with AES Admin

RegisterAttributes

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",
  "scac": null,
  "cnt": null,
  "load": null,
  "enablecallback": true,
  "callbackauthkey": null,
  "callbackurl": "http://abc.com/aescallback/",
  "refs": [
    "ABC00001"
  ],
  "customattributes": {
    "subclients": [
      {
        "key": "CCODE1",
        "name": "CUSTOMER NAME 1"
      },
      {
        "key": "CCODE2",
        "name": "CUSTOMER NAME 2"
      }
    ],
    "kvps": {
      "uid": "ABC00001"
    }
  },
  "apikey": "8881BA2F-5FE2-4CF1-D99E-5963J9192806",
  "username": "demoapi",
  "password": "dpassword",
  "ctoken": null
}

text/xml, application/xml

Sample:
<RegisterForTrackingRequest>
  <apikey>8881BA2F-5FE2-4CF1-D99E-5963J9192806</apikey>
  <ctoken />
  <password>dpassword</password>
  <username>demoapi</username>
  <callbackauthkey />
  <callbackurl>http://abc.com/aescallback/</callbackurl>
  <cbl>ONEYHPHV07147800</cbl>
  <cnt />
  <customattributes>
    <kvps>
      <KeyValueOfstringstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <Key>uid</Key>
        <Value>ABC00001</Value>
      </KeyValueOfstringstring>
    </kvps>
    <subclients>
      <RegisterAttributes.SubClient>
        <key>CCODE1</key>
        <name>CUSTOMER NAME 1</name>
      </RegisterAttributes.SubClient>
      <RegisterAttributes.SubClient>
        <key>CCODE2</key>
        <name>CUSTOMER NAME 2</name>
      </RegisterAttributes.SubClient>
    </subclients>
  </customattributes>
  <enablecallback>true</enablecallback>
  <load />
  <refs>
    <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">ABC00001</string>
  </refs>
  <scac />
</RegisterForTrackingRequest>

application/x-www-form-urlencoded

Sample:
CBL=ONEYHPHV07147800&EnableCallback=True&CallbackUrl=http%3A%2F%2Fabc.com%2Faescallback%2F&References=ABC00001&Attributes=ExternalRestService.Models.RegisterAttributes&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.

load

Optional Load Type. FCL| Full Container Load | LCL: Less than Container Load | BCO: Beneficial Cargo Owner

string

None.

updated_cbl

Autocorrected CBL. This value is null unless the account is enabled for autocorrection.

string

None.

cnt

Container Number from the RegisterForTracking request method.

string

None.

scac

Isolated SCAC. This value is not consumed unless the account is enabled for a separate requests.

string

None.

enablecallback

Enable or disable callback

boolean

None.

callbackauthkey

Only applies if callbacks have special authentication requirements Pre-specified Key e.g.: BASIC | OAUTH2

string

None.

callbackurl

Callback URL

string

None.

refs

Conditional List of References (At least 1 unique reference is required) Illegal Chars ',' '|' '\' '/' ';'

Collection of string

None.

customattributes

Conditional Custom Attributes: Must be mutually agreed upon with AES Admin

RegisterAttributes

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:
{
  "cbl": "ONEYHPHV07147800",
  "load": null,
  "updated_cbl": null,
  "cnt": null,
  "scac": null,
  "enablecallback": false,
  "callbackauthkey": null,
  "callbackurl": null,
  "refs": null,
  "customattributes": null,
  "ack": 1,
  "exceptions": null,
  "ctoken": null
}

text/xml, application/xml

Sample:
<RegisterForTrackingResponse>
  <ack>Success</ack>
  <ctoken />
  <exceptions />
  <callbackauthkey />
  <callbackurl />
  <cbl>ONEYHPHV07147800</cbl>
  <cnt />
  <customattributes />
  <enablecallback>false</enablecallback>
  <load />
  <refs />
  <scac />
  <updated_cbl />
</RegisterForTrackingResponse>