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
request
RegisterForTrackingRequestName | Description | Type | Additional 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. For MSC BOOKING USE: BK-MSCU |
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. |
hbl |
Optional House Bill 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. |
callbackkey |
Callback Key [Custom callback key] |
string |
None. |
callback |
[New Beta] Replaces legacy parameters for callback options |
RegisterCallback |
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/xml
<RegisterForTrackingRequest> <apikey>8881BA2F-5FE2-4CF1-D99E-5963J9192806</apikey> <ctoken>46f675da-2747-4fac-b870-71bd5bac6fda</ctoken> <password>dpassword</password> <username>demoapi</username> <callback /> <callbackauthkey /> <callbackkey /> <callbackurl>http://abc.com/aescallback/</callbackurl> <cbl>EGLV0833300168439</cbl> <cnt /> <customattributes> <kvps> <KeyValueOfstringstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <Key>uid</Key> <Value>ABC00001</Value> </KeyValueOfstringstring> <KeyValueOfstringstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <Key>groupcbid</Key> <Value>GROUP-CBL-001</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> <hbl /> <load /> <refs> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">ABC00001</string> </refs> <scac /> </RegisterForTrackingRequest>
application/json, text/json
{ "cbl": "EGLV0833300168439", "scac": null, "cnt": null, "hbl": null, "load": null, "enablecallback": true, "callbackauthkey": null, "callbackurl": "http://abc.com/aescallback/", "callbackkey": null, "callback": null, "refs": [ "ABC00001" ], "customattributes": { "subclients": [ { "key": "CCODE1", "name": "CUSTOMER NAME 1" }, { "key": "CCODE2", "name": "CUSTOMER NAME 2" } ], "kvps": { "uid": "ABC00001", "groupcbid": "GROUP-CBL-001" } }, "apikey": "8881BA2F-5FE2-4CF1-D99E-5963J9192806", "username": "demoapi", "password": "dpassword", "ctoken": "46f675da-2747-4fac-b870-71bd5bac6fda" }
application/x-www-form-urlencoded
apikey=8881BA2F-5FE2-4CF1-D99E-5963J9192806&callbackurl=http%3A%2F%2Fabc.com%2Faescallback%2F&cbl=EGLV0833300168439&ctoken=46f675da-2747-4fac-b870-71bd5bac6fda&customattributes=kvps=uid=ABC00001&groupcbid=GROUP-CBL-001&subclients=key=CCODE1&name=CUSTOMER%20NAME%201&subclients=key=CCODE2&name=CUSTOMER%20NAME%202&enablecallback=True&password=dpassword&refs=ABC00001&username=demoapi
text/xml
<RegisterForTrackingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models"> <apikey>sample string 9</apikey> <ctoken>sample string 12</ctoken> <password>sample string 11</password> <username>sample string 10</username> <callback> <authentication> <key>sample string 1</key> </authentication> <key>sample string 2</key> <url>sample string 3</url> </callback> <callbackauthkey>sample string 6</callbackauthkey> <callbackkey>sample string 8</callbackkey> <callbackurl>sample string 7</callbackurl> <cbl>sample string 1</cbl> <cnt>sample string 3</cnt> <customattributes> <kvps xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </kvps> <subclients i:nil="true" /> </customattributes> <enablecallback>true</enablecallback> <hbl>sample string 4</hbl> <load>sample string 5</load> <refs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </refs> <scac>sample string 2</scac> </RegisterForTrackingRequest>
Response Information
Resource Description
response
RegisterForTrackingResponseName | Description | Type | Additional 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. |
hbl |
Optional House Bill Number |
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. |
callback |
[New Beta] Replaces legacy parameters for callback options |
RegisterCallback |
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/xml
<RegisterForTrackingResponse> <ack>1</ack> <ctoken>46f675da-2747-4fac-b870-71bd5bac6fda</ctoken> <exceptions /> <callback /> <callbackauthkey /> <callbackurl>http://abc.com/aescallback/</callbackurl> <cbl>EGLV0833300168439</cbl> <cnt /> <customattributes> <kvps> <KeyValueOfstringstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <Key>uid</Key> <Value>ABC00001</Value> </KeyValueOfstringstring> <KeyValueOfstringstring xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <Key>groupcbid</Key> <Value>GROUP-CBL-001</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> <hbl /> <load /> <refs> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">ABC00001</string> </refs> <scac /> <updated_cbl /> </RegisterForTrackingResponse>
application/json, text/json
{ "cbl": "EGLV0833300168439", "load": null, "updated_cbl": null, "cnt": null, "hbl": null, "scac": null, "enablecallback": true, "callbackauthkey": null, "callbackurl": "http://abc.com/aescallback/", "callback": null, "refs": [ "ABC00001" ], "customattributes": { "subclients": [ { "key": "CCODE1", "name": "CUSTOMER NAME 1" }, { "key": "CCODE2", "name": "CUSTOMER NAME 2" } ], "kvps": { "uid": "ABC00001", "groupcbid": "GROUP-CBL-001" } }, "ack": 1, "exceptions": null, "ctoken": "46f675da-2747-4fac-b870-71bd5bac6fda" }
text/xml
<RegisterForTrackingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models"> <ack>0</ack> <ctoken>sample string 9</ctoken> <exceptions> <ResponseExceptionDto> <errorcode>sample string 1</errorcode> <msg>sample string 2</msg> <suggestion>sample string 4</suggestion> <validationcodes>sample string 3</validationcodes> <validationdetails i:nil="true" /> </ResponseExceptionDto> <ResponseExceptionDto> <errorcode>sample string 1</errorcode> <msg>sample string 2</msg> <suggestion>sample string 4</suggestion> <validationcodes>sample string 3</validationcodes> <validationdetails i:nil="true" /> </ResponseExceptionDto> </exceptions> <callback> <authentication> <key>sample string 1</key> </authentication> <key>sample string 2</key> <url>sample string 3</url> </callback> <callbackauthkey>sample string 7</callbackauthkey> <callbackurl>sample string 8</callbackurl> <cbl>sample string 1</cbl> <cnt>sample string 4</cnt> <customattributes> <kvps xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </kvps> <subclients i:nil="true" /> </customattributes> <enablecallback>true</enablecallback> <hbl>sample string 5</hbl> <load>sample string 2</load> <refs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </refs> <scac>sample string 6</scac> <updated_cbl>sample string 3</updated_cbl> </RegisterForTrackingResponse>