POST api/Order/GetProof

Gets Proof PDF bytes for a given orderId.

Request Information

URI Parameters

None.

Body Parameters

GetProofRequestModel
NameDescriptionTypeAdditional information
UserId

integer

None.

AuthToken

string

None.

ClientId

integer

Required

Range: inclusive between 0 and 2147483647

OrderId

The SouthData orderId that will be used to retrieve the PDF. OrderId is required and must be a positive number.

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "UserId": 1,
  "AuthToken": "sample string 2",
  "ClientId": 3,
  "OrderId": 4
}

application/xml, text/xml

Sample:
<GetProofRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SouthDataAPI.Models">
  <AuthToken>sample string 2</AuthToken>
  <ClientId>3</ClientId>
  <OrderId>4</OrderId>
  <UserId>1</UserId>
</GetProofRequestModel>

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 proof pdf bytes

GetProofResponseModel
NameDescriptionTypeAdditional information
FileBytes

Collection of byte

None.

Response Formats

application/json, text/json

Sample:
{
  "FileBytes": "QEA="
}

application/xml, text/xml

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