GET api/GetContainersForUnLoad?AuthToken={AuthToken}

Get a list of Containers For Collection

Request Information

URI Parameters

NameDescriptionTypeAdditional information
AuthToken

Users AuthToken provided from Authenticate method

string

Required

Body Parameters

None.

Response Information

Resource Description

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

Collection of ContainerForUnload
NameDescriptionTypeAdditional information
ContainerNo

The Container Number

string

None.

ImageUploaded

at least 1 image has been uploaded

boolean

None.

SealNo

The Seal Number provided (If any)

string

None.

ShippingLineRef

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ContainerNo": "sample string 1",
    "ImageUploaded": true,
    "SealNo": "sample string 3",
    "ShippingLineRef": "sample string 4"
  },
  {
    "ContainerNo": "sample string 1",
    "ImageUploaded": true,
    "SealNo": "sample string 3",
    "ShippingLineRef": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfContainerForUnload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JAMAPI.Models">
  <ContainerForUnload>
    <ContainerNo>sample string 1</ContainerNo>
    <ImageUploaded>true</ImageUploaded>
    <SealNo>sample string 3</SealNo>
    <ShippingLineRef>sample string 4</ShippingLineRef>
  </ContainerForUnload>
  <ContainerForUnload>
    <ContainerNo>sample string 1</ContainerNo>
    <ImageUploaded>true</ImageUploaded>
    <SealNo>sample string 3</SealNo>
    <ShippingLineRef>sample string 4</ShippingLineRef>
  </ContainerForUnload>
</ArrayOfContainerForUnload>