POST | /Document/Uploader | Uploads a file by mulitpart form | Uploads a file using multipart form type. Allowed FileTypes: .pdf, .doc, .docx, .odt, .rtf .xls, .xlsx, .ods, .txt, .gif, .jpeg, .jpg, .png, .bmp, .dcm, .svg, .tif, .tiff. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
AnyThing | model | object | Yes | |
ClientReference | model | string | No | Client reference |
Folder | model | string | No | Upload the file and put in a folder; Only 'InBox' supported; if put in inbox, the document will be charged and visible in web portal; by default, the document is in an invisible temporary folder and can only be used via API.Allowable Values
|
MatterNumber | model | string | No | Matter/Ref Number |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Reference | form | string | Yes | Document reference, used for document access |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Document/Uploader HTTP/1.1
Host: api.securedsigning.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UploaderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
<AnyThing />
<ClientReference>String</ClientReference>
<Folder>String</Folder>
<MatterNumber>String</MatterNumber>
</UploaderRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <DocumentReferenceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models"> <Reference>String</Reference> </DocumentReferenceResponse>