POST API/Document/Download

Request Information

URI Parameters

None.

Body Parameters

DownloadRequest
NameDescriptionTypeAdditional information
document_id

globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "document_id": "d597357e-791d-4ae4-9ce9-879533bed252"
}

application/xml, text/xml

Sample:
<DownloadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CarPark.Models.Interaction">
  <document_id>d597357e-791d-4ae4-9ce9-879533bed252</document_id>
</DownloadRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ByteResponse
NameDescriptionTypeAdditional information
success

boolean

None.

message

string

None.

result

Collection of byte

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "result": "QEA="
}

application/xml, text/xml

Sample:
<ByteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CarPark.Models.Interaction">
  <message>sample string 2</message>
  <result>QEA=</result>
  <success>true</success>
</ByteResponse>