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 .xml suffix or ?format=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.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>