Reason

get

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Query parameters

codesstringOptional

typestring · enumOptionalPossible values:

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

get

/reason

HTTPcURLJavaScriptPython

GET /api/reason HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "isSuccess": true,
  "results": [
    {
      "code": "text",
      "description": "text",
      "parentReasonCode": null,
      "type": [
        "downtime"
      ]
    }
  ]
}

post

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Body

application/json

codestring · min: 1 · max: 50Required

descriptionstring · min: 1 · max: 50Required

parentReasonCodestring | null · min: 1 · max: 50Optional

Responses

200

200 OK

application/json

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

post

/reason

HTTPcURLJavaScriptPython

POST /api/reason HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "code": "text",
  "description": "text",
  "parentReasonCode": null,
  "type": [
    "downtime"
  ]
}

{
  "isSuccess": true,
  "result": {
    "accountId": "text",
    "code": "text",
    "description": "text",
    "parentReasonCode": null,
    "type": [
      "downtime"
    ],
    "createdAt": "text",
    "updatedAt": "text"
  }
}

delete

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Path parameters

codestring · min: 1 · max: 50Required

Responses

204

204 No Content

400

Bad Request - The server could not process the request due to invalid input, missing required parameters, or malformed syntax.

application/json

401

Unauthorized - Authentication is missing or invalid. Ensure you provide a valid token or credentials to access this resource.

application/json

403

Forbidden - You are authenticated but do not have permission to perform this action. Contact the administrator if you believe this is an error.

application/json

409

Conflict - The request could not be completed due to a conflict with the current state of the resource, such as a duplicate record or a versioning issue.

application/json

500

Internal Server Error - An unexpected error occurred on the server. Please try again later or contact support if the issue persists.

application/json

delete

/reason/{code}

HTTPcURLJavaScriptPython

DELETE /api/reason/{code} HTTP/1.1
Host: demo.busroot.com
X-API-KEY: YOUR_API_KEY
Accept: */*

No content