ProReport - Get report categories

API Url

Used for grouping together reports.

GET
http://localhost:16010/ProMarkREST/rest/ProReport/categories

Permissions: user

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    categoriesObject[]

List of report categories.

      descString

Category description.

      idString

Category identifier.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"categories": [
{
"id": "1",
"desc": "Absence"
},
{
"id": "2",
"desc": "Balance"
}
],
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.