POST api/SecureArchive/GetDocument

Get document from SecureArchive corresponding to the provided documentId

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserId	The UserId making the request. Value is a SouthData client number	string	None.
AuthToken	The AuthToken required to validate the request. Must be unique for each and every request. See documentation on how to generate an auth token	string	None.
DocumentId	DocumentId of the document to retrieve	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "UserId": "sample string 1",
  "AuthToken": "sample string 2",
  "DocumentId": 1
}

application/xml, text/xml

Sample:

<GetDocumentRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AuthToken>sample string 2</AuthToken>
  <DocumentId>1</DocumentId>
  <UserId>sample string 1</UserId>
</GetDocumentRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

multipart/form-data

Sample:

Sample not available.

application/octet-stream

Sample:

Sample not available.

Response Information

Resource Description

Response model containing pdf bytes for the SecureArchive document corresponding to the provided documentId

GetDocumentResponseModel

Name	Description	Type	Additional information
Pdf	Document bytes. Can be AES encrypted if desired	Collection of byte	None.

Response Formats

application/json, text/json

Sample:

{
  "Pdf": "QEA="
}

application/xml, text/xml

Sample:

<GetDocumentResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <Pdf>QEA=</Pdf>
</GetDocumentResponseModel>