Trendsic Platform Service

<back to all web services

ContainersRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/warehouse/containers
"use strict";
export class ContainerItemDto {
    /** @param {{Id?:string,Name?:string,Flag?:string,Warn?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Flag;
    /** @type {boolean} */
    Warn;
}
export class RecordContainerDto {
    /** @param {{ContainerId?:number,Barcode?:string,Kind?:string,Icon?:string,Name?:string,ZoneKey?:string,Slot?:string,Status?:string,CheckoutJson?:string,Items?:ContainerItemDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContainerId;
    /** @type {string} */
    Barcode;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Icon;
    /** @type {string} */
    Name;
    /** @type {string} */
    ZoneKey;
    /** @type {string} */
    Slot;
    /** @type {string} */
    Status;
    /** @type {string} */
    CheckoutJson;
    /** @type {ContainerItemDto[]} */
    Items = [];
}
export class ContainersResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Containers?:RecordContainerDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {RecordContainerDto[]} */
    Containers = [];
}
export class ContainersRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript ContainersRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/records/warehouse/containers HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContainersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Containers>
    <RecordContainerDto>
      <Barcode>String</Barcode>
      <CheckoutJson>String</CheckoutJson>
      <ContainerId>0</ContainerId>
      <Icon>String</Icon>
      <Items>
        <ContainerItemDto>
          <Flag>String</Flag>
          <Id>String</Id>
          <Name>String</Name>
          <Warn>false</Warn>
        </ContainerItemDto>
      </Items>
      <Kind>String</Kind>
      <Name>String</Name>
      <Slot>String</Slot>
      <Status>String</Status>
      <ZoneKey>String</ZoneKey>
    </RecordContainerDto>
  </Containers>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ContainersResponse>