Client_Initiations

<back to all web services

ContainerItemsRequest

Requires Authentication
The following routes are available for this service:
POST, PUT/documents/containerItems

export class DocumentRequestBase
{
    /** @description ExternalID */
    // @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    public ExternalId: string;

    public constructor(init?: Partial<DocumentRequestBase>) { (Object as any).assign(this, init); }
}

export class ContainerItemsRequest extends DocumentRequestBase
{

    public constructor(init?: Partial<ContainerItemsRequest>) { super(init); (Object as any).assign(this, init); }
}

export class ResponseBase
{
    public Message: string;
    public IsSuccess: boolean;

    public constructor(init?: Partial<ResponseBase>) { (Object as any).assign(this, init); }
}

export class ContainerItemsResponse extends ResponseBase
{
    public ContainerItems: string[];

    public constructor(init?: Partial<ContainerItemsResponse>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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-pen.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
}