Client_Initiations

<back to all web services

ContainerItemsRequest

Requires Authentication
The following routes are available for this service:
POST, PUT/documents/containerItems
"use strict";
export class DocumentRequestBase {
    /** @param {{ExternalId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description ExternalID */
    ExternalId;
}
export class ContainerItemsRequest extends DocumentRequestBase {
    /** @param {{ExternalId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ResponseBase {
    /** @param {{Message?:string,IsSuccess?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Message;
    /** @type {boolean} */
    IsSuccess;
}
export class ContainerItemsResponse extends ResponseBase {
    /** @param {{ContainerItems?:string[],Message?:string,IsSuccess?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string[]} */
    ContainerItems;
}

JavaScript ContainerItemsRequest DTOs

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

HTTP + JSV

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

POST /documents/containerItems HTTP/1.1 
Host: initiation.sirva.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ExternalId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ContainerItems: 
	[
		String
	],
	Message: String,
	IsSuccess: False
}