IzzitUp allows REST API calls. This allows other applications to automatically update IzzitUp data.
At this point, an API for setting a Service’s status is available. More options may follow.
Services API
URI
…/api/services
If no request body is submitted, IzzitUp will list the available Services. No login is required to get this result.
JSON
In order to perform an action on a Service, a JSON formatted request body has to be submitted.
{ "action": "setstatus", "service": 2, "status" : 6, "user" : "mmouse", "pwd" : "password" }
Key | Value |
---|---|
action | Currently supported: “setstatus” |
service | The ID of the Service to change. Call the API URI without a request body to get a list of Services and their IDs. |
status | The ID of the Status to change the Service to. Allowed are: 5 (Operational), 6 (Impaired) and 7 (Outage). |
user | The username of the IzzitUp account to perform this action with |
pwd | The password of the IzzitUp account to perform this action with |
Response
The API will produce a JSON formatted response. In case of success it will look similar to this:
{ "uri": "/lewe/izzitup/app/public/api/services", "request": { "action": "setstatus", "service": 2, "status": 6, "user": "mmouse", "pwd": "password" }, "result": "Success", "message": "Status of Service Service Desk was set to Impaired", "data": { "id": "2", "name": "Service Desk", "key": "SDSK", "description": "Online Service Desk", "url": "https://support.lewe.com/submit-ticket/", "curl": "https://support.lewe.com/submit-ticket/", "status": "6", "hidden": "0", "created": "2020-03-26 21:01:27", "updated": "2020-04-13 12:01:27" } }
An error response will look similar to this:
{ "uri": "/lewe/izzitup/app/public/api/services", "request": { "action": "setstatus", "service": 12, "status": 6, "user": "mmouse", "pwd": "password" }, "result": "Warning", "message": "Service not found", "data": "" }
Result | Message | Description |
---|---|---|
Warning | Service not found | A Service with the given ID does not exist. |
Warning | Status not found | A Status with the given ID does not exist. |
Warning | Status not allowed. Must be 5 (Operational), 6 (Impaired) or 7 (Outage). | Only the status applicable to a Service are allowed. |
Error | Incomplete request | One or more kye/value pairs are missing in the JSON request. |
Error | Unknown action | The vlaue for “action” is not supported. |
Error | Sign in failed | A sign in with the given credentials was not successful. |
Error | Not allowed | A siogn in with the given credentials was successful but the user’s role is not permitted to perform the action. |