Client_Initiations

<back to all web services

ClientDownloadRequest

Requires Authentication
The following routes are available for this service:
POST, PUT/documents/download
ClientDownloadRequest Parameters:
NameParameterData TypeRequiredDescription
FileNamebodystringNo
MonthpathintYesMonth
DaypathintYesDay
DocumentRequestBase Parameters:
NameParameterData TypeRequiredDescription
ExternalIdpathstringYesExternalID
ClientDownloadResponse Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
StreamformStreamNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
IsSuccessformboolNo

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>