POST api/registerbatch

This method is used for registering a list of Ocean Carrier Bill of Lading numbers (CBLs). This method is required to be called for the GetTracking method to return tracking feeds.

Request Information

URI Parameters

None.

Body Parameters

request

RegisterBatchRequest
NameDescriptionTypeAdditional information
items

List of Register Item Requests

 Collection of RegisterItemRequest

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

Sample: 
<RegisterBatchRequest>
  <apikey>8881BA2F-5FE2-4CF1-D99E-5963J9192806</apikey>
  <ctoken>d029d95b-f461-4db4-ae8f-8aa6840df3ed</ctoken>
  <password>dpassword</password>
  <username>demoapi</username>
  <items>
    <RegisterItemRequest>
      <alternateShipmentReference />
      <callback />
      <callbackauthkey />
      <callbackurl>http://abc.com/aescallback/</callbackurl>
      <cbl>EGLV0833300168439</cbl>
      <cnt />
      <customattributes />
      <enablecallback>true</enablecallback>
      <hbl />
      <load />
      <refs>
        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">PO00001</string>
        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">PO00002</string>
      </refs>
      <scac />
    </RegisterItemRequest>
    <RegisterItemRequest>
      <alternateShipmentReference />
      <callback />
      <callbackauthkey />
      <callbackurl>http://abc.com/aescallback/</callbackurl>
      <cbl>ZBMURUI743564</cbl>
      <cnt />
      <customattributes />
      <enablecallback>true</enablecallback>
      <hbl />
      <load />
      <refs>
        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">PO00003</string>
        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">PO00004</string>
      </refs>
      <scac />
    </RegisterItemRequest>
  </items>
</RegisterBatchRequest>

application/json, text/json

Sample: 
{
  "items": [
    {
      "cbl": "EGLV0833300168439",
      "alternateShipmentReference": null,
      "scac": null,
      "cnt": null,
      "hbl": null,
      "load": null,
      "refs": [
        "PO00001",
        "PO00002"
      ],
      "enablecallback": true,
      "callbackauthkey": null,
      "callbackurl": "http://abc.com/aescallback/",
      "callback": null,
      "customattributes": null
    },
    {
      "cbl": "ZBMURUI743564",
      "alternateShipmentReference": null,
      "scac": null,
      "cnt": null,
      "hbl": null,
      "load": null,
      "refs": [
        "PO00003",
        "PO00004"
      ],
      "enablecallback": true,
      "callbackauthkey": null,
      "callbackurl": "http://abc.com/aescallback/",
      "callback": null,
      "customattributes": null
    }
  ],
  "apikey": "8881BA2F-5FE2-4CF1-D99E-5963J9192806",
  "username": "demoapi",
  "password": "dpassword",
  "ctoken": "d029d95b-f461-4db4-ae8f-8aa6840df3ed"
}

application/x-www-form-urlencoded

Sample: 
apikey=8881BA2F-5FE2-4CF1-D99E-5963J9192806&ctoken=d029d95b-f461-4db4-ae8f-8aa6840df3ed&items=&callbackurl=http%3A%2F%2Fabc.com%2Faescallback%2F&cbl=EGLV0833300168439&enablecallback=True&refs=PO00001&refs=PO00002&items=&callbackurl=http%3A%2F%2Fabc.com%2Faescallback%2F&cbl=ZBMURUI743564&enablecallback=True&refs=PO00003&refs=PO00004&password=dpassword&username=demoapi

text/xml

Sample: 
<RegisterBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <apikey>sample string 1</apikey>
  <ctoken>sample string 4</ctoken>
  <password>sample string 3</password>
  <username>sample string 2</username>
  <items>
    <RegisterItemRequest>
      <alternateShipmentReference>
        <enabled>true</enabled>
        <referenceNumber>sample string 3</referenceNumber>
        <scac>sample string 2</scac>
      </alternateShipmentReference>
      <callback>
        <authentication>
          <key>sample string 1</key>
        </authentication>
        <key>sample string 2</key>
        <url>sample string 3</url>
      </callback>
      <callbackauthkey>sample string 6</callbackauthkey>
      <callbackurl>sample string 7</callbackurl>
      <cbl>sample string 1</cbl>
      <cnt>sample string 3</cnt>
      <customattributes>
        <kvps xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </kvps>
        <subclients i:nil="true" />
      </customattributes>
      <enablecallback>true</enablecallback>
      <hbl>sample string 4</hbl>
      <load>sample string 5</load>
      <refs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </refs>
      <scac>sample string 2</scac>
    </RegisterItemRequest>
    <RegisterItemRequest>
      <alternateShipmentReference>
        <enabled>true</enabled>
        <referenceNumber>sample string 3</referenceNumber>
        <scac>sample string 2</scac>
      </alternateShipmentReference>
      <callback>
        <authentication>
          <key>sample string 1</key>
        </authentication>
        <key>sample string 2</key>
        <url>sample string 3</url>
      </callback>
      <callbackauthkey>sample string 6</callbackauthkey>
      <callbackurl>sample string 7</callbackurl>
      <cbl>sample string 1</cbl>
      <cnt>sample string 3</cnt>
      <customattributes>
        <kvps xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 1</d5p1:Key>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>sample string 3</d5p1:Key>
            <d5p1:Value>sample string 4</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </kvps>
        <subclients i:nil="true" />
      </customattributes>
      <enablecallback>true</enablecallback>
      <hbl>sample string 4</hbl>
      <load>sample string 5</load>
      <refs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </refs>
      <scac>sample string 2</scac>
    </RegisterItemRequest>
  </items>
</RegisterBatchRequest>

Response Information

Resource Description

response

RegisterBatchResponse
NameDescriptionTypeAdditional information
items

List of responses to request items

 Collection of RegisterItemResponse

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

Sample: 
<RegisterBatchResponse>
  <ack>1</ack>
  <ctoken>d029d95b-f461-4db4-ae8f-8aa6840df3ed</ctoken>
  <exceptions />
  <items>
    <RegisterItemResponse>
      <alternateShipmentReference />
      <callback />
      <callbackauthkey />
      <callbackurl>http://abc.com/aescallback/</callbackurl>
      <cbl>EGLV0833300168439</cbl>
      <cnt />
      <customattributes />
      <enablecallback>true</enablecallback>
      <hbl />
      <load />
      <refs>
        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">PO00001</string>
        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">PO00002</string>
      </refs>
      <scac />
      <ack>Valid</ack>
      <exceptions />
      <updatedAlternateShipmentReferenceNumber />
      <updated_cbl />
    </RegisterItemResponse>
    <RegisterItemResponse>
      <alternateShipmentReference />
      <callback />
      <callbackauthkey />
      <callbackurl>http://abc.com/aescallback/</callbackurl>
      <cbl>ZBMURUI743564</cbl>
      <cnt />
      <customattributes />
      <enablecallback>true</enablecallback>
      <hbl />
      <load />
      <refs>
        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">PO00003</string>
        <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">PO00004</string>
      </refs>
      <scac />
      <ack>Invalid</ack>
      <exceptions>
        <ItemExceptionDto>
          <errorcode>ER106</errorcode>
          <msg>INVALID BOL</msg>
          <suggestion />
          <validationcodes />
          <validationdetails />
        </ItemExceptionDto>
      </exceptions>
      <updatedAlternateShipmentReferenceNumber />
      <updated_cbl />
    </RegisterItemResponse>
  </items>
</RegisterBatchResponse>

application/json, text/json

Sample: 
{
  "items": [
    {
      "ack": 1,
      "updated_cbl": null,
      "updatedAlternateShipmentReferenceNumber": null,
      "exceptions": null,
      "cbl": "EGLV0833300168439",
      "alternateShipmentReference": null,
      "scac": null,
      "cnt": null,
      "hbl": null,
      "load": null,
      "refs": [
        "PO00001",
        "PO00002"
      ],
      "enablecallback": true,
      "callbackauthkey": null,
      "callbackurl": "http://abc.com/aescallback/",
      "callback": null,
      "customattributes": null
    },
    {
      "ack": 0,
      "updated_cbl": null,
      "updatedAlternateShipmentReferenceNumber": null,
      "exceptions": [
        {
          "errorcode": "ER106",
          "msg": "INVALID BOL",
          "validationcodes": null,
          "validationdetails": null,
          "suggestion": null
        }
      ],
      "cbl": "ZBMURUI743564",
      "alternateShipmentReference": null,
      "scac": null,
      "cnt": null,
      "hbl": null,
      "load": null,
      "refs": [
        "PO00003",
        "PO00004"
      ],
      "enablecallback": true,
      "callbackauthkey": null,
      "callbackurl": "http://abc.com/aescallback/",
      "callback": null,
      "customattributes": null
    }
  ],
  "ack": 1,
  "exceptions": null,
  "ctoken": "d029d95b-f461-4db4-ae8f-8aa6840df3ed"
}

text/xml

Sample: 
<RegisterBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalRestService.Models">
  <ack>0</ack>
  <ctoken>sample string 1</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>
  <items i:nil="true" />
</RegisterBatchResponse>