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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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-test.sirva.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FileName":"String","Month":0,"Day":0,"ExternalId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"FileName":"String","Message":"String","IsSuccess":false}