Retrieve the details of a specific Alert Template

GET /seiapi/v3/AlertTemplates/${TemplateID} 

Retrieve a list of all Alert Templates

GET /seiapi/v3/AlertTemplates

Insert or Update the details of a specific Alert Template

PUT /seiapi/v3/AlertTemplates/${TemplateID}

Bulk Insert or Update the details of specific Alert Templates

PUT /seiapi/v3/AlertTemplates

Delete a specific Alert Template

DELETE /seiapi/v3/AlertTemplates/${TemplateID}

Retrieve the details of a specific Alert Template

This REST API will return an Alert Template with the specified ID. The Alert Template with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response Body

On success, an HTTP response code of 200 will be returned, and the response body will contain an Alert Template Object.

{
	"Accept": {
		"DisplayNotes": false,
		"RequireResponseNotes": false
	},
	"Decline": {
		"DisplayNotes": false,
		"RequireResponseNotes": false
	},
	"Deleted": false,
	"Message": "",
	"TemplateID": "",
	"RefID": "",
	"URL": ""
}

Otherwise, on error, the API returns the standard response object.

Retrieve a list of all Alert Templates

This REST API will return a list of all Alert Templates that exist in the system.

URL

HTTP Request Body

This request does not require a request body. 

HTTP Response

On success, an HTTP status of 200 will be returned, and the response body will contain a collection of Alert Template Objects. 

 It is possible for the returned collection to be empty if the system does not have any Alert Templates. 

{
	"AlertTemplates" : [
		// A collection of zero or more Alert Template Objects.
	]
}

Otherwise, on error, the API returns the standard response object.

Insert or Update the details of a specific Alert Template

This REST API will insert a new Alert Template with the specified ID into the system, if an Alert Template with the specified ID does not already exist in the system.

If, however, the Alert Template with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Alert Template with the specified ID with the details of the Alert Template supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must contain a valid Alert Template Object.

Bulk Insert or Update the details of specific Alert Templates

This REST API will insert new Alert Templates with the specified IDs into the system, if the Alert Templates with the specified IDs do not already exist in the system.

If, however, the Alert Templates with the specified IDs do already exist in the system, then this REST API will update (i.e. replace) the already existing Alert Templates with the specified IDs with the details of the Alert Templates supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must be a JSON array of one or more Alert Template Object definitions.

[
	{
		// Alert Template Object
	},
	{
		// Alert Template Object
	},
	{
		// etc., as required
	}
]

Delete a specific Alert Template

This REST API will delete an Alert Template with the specified ID from the system. The Alert Template with the specified ID must already exist in the system.

URL

HTTP Request Body

This request does not require a request body.