NOTE: These API is going to change in near future. Not meant for extenal purpose for now

Gets SLA Reminders

URL : v3/api/admin/sla-reminders/slaId

Method : GET

Response :

{
	"id": 58,
	"reminders": {
		"approach": [{
			"id": 1,
			"reminder_delta": 10,
			"reminder_receivers": {
				"agents": [{
					"id": 1,
					"name": "demo admin"
				}],
				"agent_types": [{
					"id": 1,
					"name": "Department Manager"
				}]
			},
			"type": "response"
		}, {
			"id": 2,
			"reminder_delta": 10,
			"reminder_receivers": {
				"agents": [{
					"id": 1,
					"name": "demo admin"
				}],
				"agent_types": [{
					"id": 1,
					"name": "Department Manager"
				}]
			},
			"type": "resolution"
		}],
		"violated": [{
			"id": 1,
			"reminder_delta": 10,
			"reminder_receivers": {
				"agents": [{
					"id": 1,
					"name": "demo admin"
				}],
				"agent_types": [{
					"id": 1,
					"name": "Department Manager"
				}]
			},
			"type": "response"
		}, {
			"id": 2,
			"reminder_delta": 10,
			"reminder_receivers": {
				"agents": [{
					"id": 1,
					"name": "demo admin"
				}],
				"agent_types": [{
					"id": 1,
					"name": "Department Manager"
				}]
			},
			"type": "resolution"
		}]
	}
}

Post SLA Reminders

URL : api/admin/sla-reminders/slaId

Method : POST

Request Body :

{		
    "approach": [{
			"id": null,
			"reminder_delta": 10, // number of minutes
			"reminder_receivers": {
				"agents": [1], // id of the agent
				"agent_types": [1] // id of agent-types in api `/api/dependency/agent-types` 
			},
			"type": "response" // either for response or resolution
		}, {
			"id": null,
			"reminder_delta": 10,
			"reminder_receivers": {
				"agents": [1],
				"agent_types": [1]
			},
			"type": "resolution"
		}],
   
   "violated": [{
			"id": null,
			"reminder_delta": 10,
			"reminder_receivers": {
				"agents": [1],
				"agent_types": [1]
			},
			"type": "response"
		}, {
			"id": null,
			"reminder_delta": 10,
			"reminder_receivers": {
				"agents": [1],
				"agent_types": [1]
			},
			"type": "resolution"
		}]
}

Response:

  {
	"success": true,
	"message":"Saved Successfully"
}

 

Delete SLA Reminder

URL : api/admin/sla-reminder

Method : DELETE

Parameters:

Name Data Type Required / Optional Description
id Integer Required Id of the reminder that has to be deleted
type String Required Which type of reminder is getting deleted. Possible values are `violated` and `resolution`

Response:

  {
	"success": true,
	"message":"Deleted Successfully"
}

 

Tagged: