GET api/GetContainersForCollection?AuthToken={AuthToken}&JobType={JobType}

Get a list of Containers For Collection

Request Information

URI Parameters

Name	Description	Type	Additional information
AuthToken	Users AuthToken provided from Authenticate method	string	Required
JobType	Import or Export	string	Required

Body Parameters

None.

Response Information

Resource Description

List of Container records in the system for the user to collect

Collection of ContainerForCollection

Name	Description	Type	Additional information
ContainerNo	This will be set to the username collecting the container for the Get Method and should be set to the real container number for Put	string	None.
ShippingLineRef		string	None.
ShippingLineName		string	None.
CollectionPoint		string	None.
ContainerSize_Type		string	None.
JobType	Required for PutContainer calls, Please specify "Import" or "Export"	string	None.
SealNo		string	None.
PairingCode		string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ContainerNo": "sample string 1",
    "ShippingLineRef": "sample string 2",
    "ShippingLineName": "sample string 3",
    "CollectionPoint": "sample string 4",
    "ContainerSize_Type": "sample string 5",
    "JobType": "sample string 6",
    "SealNo": "sample string 7",
    "PairingCode": "sample string 8"
  },
  {
    "ContainerNo": "sample string 1",
    "ShippingLineRef": "sample string 2",
    "ShippingLineName": "sample string 3",
    "CollectionPoint": "sample string 4",
    "ContainerSize_Type": "sample string 5",
    "JobType": "sample string 6",
    "SealNo": "sample string 7",
    "PairingCode": "sample string 8"
  }
]

application/xml, text/xml

Sample:

<ArrayOfContainerForCollection xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JAMAPI.Models">
  <ContainerForCollection>
    <CollectionPoint>sample string 4</CollectionPoint>
    <ContainerNo>sample string 1</ContainerNo>
    <ContainerSize_Type>sample string 5</ContainerSize_Type>
    <JobType>sample string 6</JobType>
    <PairingCode>sample string 8</PairingCode>
    <SealNo>sample string 7</SealNo>
    <ShippingLineName>sample string 3</ShippingLineName>
    <ShippingLineRef>sample string 2</ShippingLineRef>
  </ContainerForCollection>
  <ContainerForCollection>
    <CollectionPoint>sample string 4</CollectionPoint>
    <ContainerNo>sample string 1</ContainerNo>
    <ContainerSize_Type>sample string 5</ContainerSize_Type>
    <JobType>sample string 6</JobType>
    <PairingCode>sample string 8</PairingCode>
    <SealNo>sample string 7</SealNo>
    <ShippingLineName>sample string 3</ShippingLineName>
    <ShippingLineRef>sample string 2</ShippingLineRef>
  </ContainerForCollection>
</ArrayOfContainerForCollection>