Documents

Download documents from the site.

post/sites/{site-identifier}/documents/download

Request

  • Base URL: https://api-dev.superconcepts.com.au/api/v1
  • URL: https://api-dev.superconcepts.com.au/api/v1/sites/{site-identifier}/documents/download
  • Auth: OAuth 2 (authorization code, authorization URL https://api.supermate.com.au/oauth/v1/authorize, token URL https://api.supermate.com.au/oauth/v1/token, scopes: default, documents_write)

Path parameters

site-identifierstring required

The GUID that identifies a site

Request body

FundGUIDstring guid required
Documents'All' | 'Auditor'
DocumentTypestring
FinancialYearinteger required

Example request

{
  "FundGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8",
  "DocumentType": "DOC-TYPE-1",
  "FinancialYear": 2020
}

Response

Accepted

JobGUIDstring guid

Example response

{
  "JobGUID": "df7f1068-e0c3-709d-8a14-ac2af4b632f8"
}

Changes

No recorded changes to this operation across all 1 revision of this API.