Secured Signing API

<back to all web services

UploadAttachmentRequest

Attachment
The following routes are available for this service:
POST/Attachment/UploadByUrlUploads a file by urlUploads a file using a url
UploadAttachmentRequest Parameters:
NameParameterData TypeRequiredDescription
FilemodelobjectYesThe file infomation
AttachmentFileInfo Parameters:
NameParameterData TypeRequiredDescription
NumberformstringNoAttachment Number, can only be digitals
CategoryformstringNoAttachment Category
FileInfoBase Parameters:
NameParameterData TypeRequiredDescription
NamemodelstringYesFile Name
FileTypemodelstringYesFile type of file

Allowable Values

  • pdf
  • doc
  • docx
  • rtf
FileUrlmodelstringYesUrl to download retrieve file data
AttachmentResponse Parameters:
NameParameterData TypeRequiredDescription
ReferenceformstringYesAttachment reference

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 /Attachment/UploadByUrl HTTP/1.1 
Host: api.dsx.co.nz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UploadAttachmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Requests">
  <File xmlns:d2p1="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
    <d2p1:FileType>String</d2p1:FileType>
    <d2p1:FileUrl>String</d2p1:FileUrl>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Category>String</d2p1:Category>
    <d2p1:Number>String</d2p1:Number>
  </File>
</UploadAttachmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AttachmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecuredSigning.Api.Rest.Models">
  <FileType>String</FileType>
  <FileUrl>String</FileUrl>
  <Name>String</Name>
  <Category>String</Category>
  <Number>String</Number>
  <Reference>String</Reference>
</AttachmentResponse>