GET api/GetDocument?AuthToken={AuthToken}&JobIDorLoadRef={JobIDorLoadRef}&DocumentType={DocumentType}

PDF document for a specified job id

Request Information

URI Parameters

Name	Description	Type	Additional information
AuthToken	Users AuthToken provided from Authenticate method	string	Required
JobIDorLoadRef	Job ID of LoadRef for documents - Job ID is required for CondtionReport and Additional Requirements, Load Ref is requried for the Collection/Delivery	string	Required
DocumentType	Document type name, ConditionReport, Collection, Delivery, AdditionalRequirementsRequest, AdditionalRequirementsProcessed	string	Required

Body Parameters

None.

Response Information

Resource Description

DocumentInfo Record

Collection of DocumentItem

Name	Description	Type	Additional information
FileName	The Image FileName	string	None.
FileSize	The Image Size	integer	None.
DocumentData	The Document Data	Collection of byte	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "FileName": "sample string 1",
    "FileSize": 2,
    "DocumentData": "QEA="
  },
  {
    "FileName": "sample string 1",
    "FileSize": 2,
    "DocumentData": "QEA="
  }
]

application/xml, text/xml

Sample:

<ArrayOfDocumentItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JAMAPI.Models">
  <DocumentItem>
    <DocumentData>QEA=</DocumentData>
    <FileName>sample string 1</FileName>
    <FileSize>2</FileSize>
  </DocumentItem>
  <DocumentItem>
    <DocumentData>QEA=</DocumentData>
    <FileName>sample string 1</FileName>
    <FileSize>2</FileSize>
  </DocumentItem>
</ArrayOfDocumentItem>