api/v1/docs

Path: api/v1/docs

This API is JSON:API compliant.

This endpoint supports the following methods:
GET

The resource type for this endpoint is Document
The identifier is docid

Filters:

objreftype	The type of object being referenced, can be Job,Stock
objrefid	The object reference. For a job, the job number, for stock the stock code.

The Document resource type attributes are as follows:

{

"code":string (read-only)

"docName":string (read-only)

}

Example GET

Path: api/v1/docs?filter[objreftype]=Stock?filter[objrefid]=DEPL

Response:

{
  "data": [
    {
      "id": "232",
      "type": "Document",
      "attributes": {
        "code": "232",
        "docName": "default-image_100.png"
      }
    },
    {
      "id": "233",
      "type": "Document",
      "attributes": {
        "code": "233",
        "docName": "default-image.gif"
      }
    },
    {
      "id": "234",
      "type": "Document",
      "attributes": {
        "code": "234",
        "docName": "Report.pdf"
      }
    }
  ]
}