| POST | /documents |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FileName | path | string | Yes | FileName |
| ExternalId | path | string | Yes | ExternalID |
| RequestStream | body | string | No | RequestStream needs to be base64 file content |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FileName | form | string | No | |
| DownloadLink | form | string | No | |
| ListLink | form | string | No | |
| DaysToLive | form | int | No | |
| Message | form | string | No | |
| IsSuccess | form | bool | No | |
| ResponseStatus | form | ResponseStatus | No |
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
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.sirva.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"FileName":"String","ExternalId":"String","RequestStream":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}