Client_Initiations

<back to all web services

DocumentUploadRequest

Requires Authentication
The following routes are available for this service:
POST/documents
DocumentUploadRequest Parameters:
NameParameterData TypeRequiredDescription
FileNamepathstringYesFileName
ExternalIdpathstringYesExternalID
RequestStreambodystringNoRequestStream needs to be base64 file content
DocumentUploadResponse Parameters:
NameParameterData TypeRequiredDescription
FileNameformstringNo
DownloadLinkformstringNo
ListLinkformstringNo
DaysToLiveformintNo
MessageformstringNo
IsSuccessformboolNo
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /documents HTTP/1.1 
Host: initiation-pen.sirva.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"FileName":"String","ExternalId":"String","RequestStream":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"FileName":"String","DownloadLink":"String","ListLink":"String","DaysToLive":0,"Message":"String","IsSuccess":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}