Skip to main content

Get Plant or Vehicle details (with Sites)

Support avatar
Written by Support
Updated over 5 months ago

GET [ plant/{id} ]

Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/acu/plant/{id}
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/acu/plant/{id}

Overview

This endpoint returns the detail of a single Plant or Vehicle attached to the current Organisation.

Authentication instructions

Refer to the Authentication method for Authentication Methods (for Login and Logout).

Permissions Required

The user will required the permissions below:

  • API User

  • User is Staff

  • Users have View Contractor Permission

  • Selected Plant belongs to the User’s Organization

Please also refer to the Permissions Overview guide.

Query parameters

FIELD

TYPE

DESCRIPTION

Example

REQUIRED

DEFAULT

PATTERN

id

integer

Plant ID

70

YES

\d+

Request Example

curl --location 'http://test.complyflow.com.au/app/public/index.php/api/acu/plant/70' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'

Response Example

The API Request returns detail of single Plant or Vehicle attached to the current Organisation.

{
"token": "",
"data": {
"id": 70,
"contractor_id": 1554,
"company_name": "asda123123123123123",
"make": "YES",
"model": "YES-123x",
"type": "BMW",
"year_of_manufacture": 2023,
"serial_number": "14236666",
"sticker_id": "",
"owned_by": "wr er",
"plant_categories": [
{
"id": 12,
"name": "PlantA",
"status": "Pending"
}
],
"documents": [
{
"id": 166,
"name": "DocA2"
}
],
"sites": [
{
"id": 41,
"name": "projecta"
}
]
}
}

Did this answer your question?