Client_Initiations

ClientDownloadRequest

The following routes are available for this service:
POST, PUT	/documents/download


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 ClientDownloadRequest extends DocumentRequestBase
{
    public FileName: string;
    /** @description Month */
    // @ApiMember(Description="Month", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    public Month: number;

    /** @description Day */
    // @ApiMember(Description="Day", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    public Day: number;

    public constructor(init?: Partial<ClientDownloadRequest>) { 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 ClientDownloadResponse extends ResponseBase
{
    public FileName: string;
    public Stream: string;

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

TypeScript ClientDownloadRequest 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/download HTTP/1.1 
Host: initiation.sirva.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ClientDownloadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Client_Initiations.ServiceModel.ClientUpload">
  <ExternalId>String</ExternalId>
  <Day>0</Day>
  <FileName>String</FileName>
  <Month>0</Month>
</ClientDownloadRequest>

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

<ClientDownloadResponse 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>
  <FileName>String</FileName>
  <Stream xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.IO" i:nil="true" />
</ClientDownloadResponse>