POST api/RegisterBatchV2

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

Request Information


URI Parameters

None.

Body Parameters

RegisterBatchV2Request
NameDescriptionTypeAdditional information
items

List of Register Item Requests

Collection of RegisterItemV2Request

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:
{
  "items": [
    {
      "cnt": "sample string 1",
      "queryrange": {
        "start": "2022-05-18T06:19:54.5964413+00:00",
        "end": "2022-05-18T06:19:54.5964413+00:00"
      },
      "carrier": "sample string 2",
      "blref": "sample string 3",
      "refs": [
        "sample string 1",
        "sample string 2"
      ],
      "enablecallback": true,
      "callbackauthkey": "sample string 4",
      "callbackurl": "sample string 5"
    },
    {
      "cnt": "sample string 1",
      "queryrange": {
        "start": "2022-05-18T06:19:54.5964413+00:00",
        "end": "2022-05-18T06:19:54.5964413+00:00"
      },
      "carrier": "sample string 2",
      "blref": "sample string 3",
      "refs": [
        "sample string 1",
        "sample string 2"
      ],
      "enablecallback": true,
      "callbackauthkey": "sample string 4",
      "callbackurl": "sample string 5"
    }
  ],
  "apikey": "sample string 1",
  "username": "sample string 2",
  "password": "sample string 3",
  "ctoken": "sample string 4"
}

application/xml, text/xml

Sample:
<RegisterBatchV2Request 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>
    <RegisterItemV2Request>
      <blref>sample string 3</blref>
      <callbackauthkey>sample string 4</callbackauthkey>
      <callbackurl>sample string 5</callbackurl>
      <carrier>sample string 2</carrier>
      <cnt>sample string 1</cnt>
      <enablecallback>true</enablecallback>
      <queryrange>
        <end>2022-05-18T06:19:54.5964413+00:00</end>
        <start>2022-05-18T06:19:54.5964413+00:00</start>
      </queryrange>
      <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>
    </RegisterItemV2Request>
    <RegisterItemV2Request>
      <blref>sample string 3</blref>
      <callbackauthkey>sample string 4</callbackauthkey>
      <callbackurl>sample string 5</callbackurl>
      <carrier>sample string 2</carrier>
      <cnt>sample string 1</cnt>
      <enablecallback>true</enablecallback>
      <queryrange>
        <end>2022-05-18T06:19:54.5964413+00:00</end>
        <start>2022-05-18T06:19:54.5964413+00:00</start>
      </queryrange>
      <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>
    </RegisterItemV2Request>
  </items>
</RegisterBatchV2Request>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information


Resource Description

RegisterBatchV2Response
NameDescriptionTypeAdditional information
items

List of responses to request items

Collection of RegisterItemV2Response

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, application/xml, text/xml

Sample:

Sample not available.