GET api/GetContainersForRestitution?AuthToken={AuthToken}

Get a list of Containers that require restitution

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 ContainerForRestitution
NameDescriptionTypeAdditional information
ContainerNo

The Container Number

string

None.

RestitutionDest

string

None.

RestitutionDate

Restitution Date - required for PUT only

date

None.

ContainerSize_Type

string

None.

ShippingLineRef

string

None.

ShippingLineName

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ContainerNo": "sample string 1",
    "RestitutionDest": "sample string 2",
    "RestitutionDate": "2025-12-12T21:17:22.182792+00:00",
    "ContainerSize_Type": "sample string 3",
    "ShippingLineRef": "sample string 4",
    "ShippingLineName": "sample string 5"
  },
  {
    "ContainerNo": "sample string 1",
    "RestitutionDest": "sample string 2",
    "RestitutionDate": "2025-12-12T21:17:22.182792+00:00",
    "ContainerSize_Type": "sample string 3",
    "ShippingLineRef": "sample string 4",
    "ShippingLineName": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfContainerForRestitution xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JAMAPI.Models">
  <ContainerForRestitution>
    <ContainerNo>sample string 1</ContainerNo>
    <ContainerSize_Type>sample string 3</ContainerSize_Type>
    <RestitutionDate>2025-12-12T21:17:22.182792+00:00</RestitutionDate>
    <RestitutionDest>sample string 2</RestitutionDest>
    <ShippingLineName>sample string 5</ShippingLineName>
    <ShippingLineRef>sample string 4</ShippingLineRef>
  </ContainerForRestitution>
  <ContainerForRestitution>
    <ContainerNo>sample string 1</ContainerNo>
    <ContainerSize_Type>sample string 3</ContainerSize_Type>
    <RestitutionDate>2025-12-12T21:17:22.182792+00:00</RestitutionDate>
    <RestitutionDest>sample string 2</RestitutionDest>
    <ShippingLineName>sample string 5</ShippingLineName>
    <ShippingLineRef>sample string 4</ShippingLineRef>
  </ContainerForRestitution>
</ArrayOfContainerForRestitution>