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 .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.

POST /documents/containerItems HTTP/1.1 
Host: initiation-pen.sirva.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContainerItemsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <ExternalId>String</ExternalId>
</ContainerItemsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContainerItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <IsSuccess>false</IsSuccess>
  <Message>String</Message>
  <ContainerItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ContainerItems>
</ContainerItemsResponse>