(GET) Generate Hoses Report PDF

URL

Description  

This URL will allow a customer to generate a pdf of the Hoses Report for Asset Management.

Only api_key, and businessName are mandatory.
If no value is entered for groupName, departmentName, and areaName then the value will be set by default to all groups, departments, and areas. If no value is entered for language, the default is en-AU.

Type

GET

URL Parameters  
(1)

(key)     api_key
(value)   Provided separately to this document

(key)      businessName
(value)   The name of the business you wish to generate the report for

(key)      groupName {Optional}
(value)   The name of the group you wish to generate the report for. Defaults to All if not provided.

(key)      departmentName {Optional}
(value)   The name of the department you wish to generate the report for. Defaults to All if not provided.

(key)      areaNames {Optional}
(value)   The name of the area/s you wish to generate the report for, delimited by underscores (e.g CV101_CV102). Defaults to All if not provided.

(key)      installed {Optional}
(value)   True/False. Defaults to True.

(key)      language {Optional}
(value)   Sets the DateTime format to be used in the report. Defaults to en-AU if not provided (e.g. DD/MM/YYYY hh:mm:ss)

Response Data

HTTP Response OK (200)

HTTP Response Bad Request (400)

-          Missing api_key, or businessName parameter
-          Incorrect businessName, groupName, departmentName,             or areaName value
-          Invalid/Incorrect installed value
-          Invalid/Incorrect language value

HTTP Response Forbidden (403)

-          Invalid/Incorrect API Key
-          Non “API User” role