Status

colour	Green
title	3.0.0

The System Category REST API is used to create, update or delete system category definitions. A system category, depending on how it designed to be used by the system, may have child activity definitions, sub categories or both. Please refer to the REST System Categories related page for more details.

For any system category that has not been configured, the global default values will be used. Please refer to the specific system category definition for its specific default values.

Pushing System Category Updates to Mobile Devices

By default, calling the System Category API will not cause any updates to be used to the mobile devices. This is by design and is intended to allow for multiple updates (API calls) to be made before pushing out any changes. Updates will be pushed to the mobile device only when a GET request is made with the RefreshMobile URL parameter set to 1 as shown below.

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

On this page:

Table of Contents

maxLevel	2

Related pages:

Resource URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

Retrieve the details of a specific System Category

GET /seiapi/v3/trans/SystemCategory/default/${Code}

Insert or Update a specific System Category

PUT /seiapi/v3/trans/SystemCategory/default/${Code}

Push System Category changes to mobile device

GET /seiapi/v3/trans/SystemCategory/default/${Code}?RefreshMobile=1

Delete a specific System Category

DELETE/seiapi/v3/trans/SystemCategory/default/${Code}

API Specific Parameters

Parameter	Description
`${Code}`	The unique System Category code.
`RefreshMobile=1`	Add this parameter with a value of 1 to push updates to mobile devices.

Include Page

	_Default HTTP Headers
	_Default HTTP Headers

API Specifics

Panel

Retrieve the details of a specific System Category

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

GET /seiapi/v3/trans/SystemCategory/default/${Code}

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 a REST Object Definitions Configuration Related Objects System Category Object. Otherwise, on error, the response body will contain a descriptive reason for the error.

Include Page

	_System Category Object Formats
	_System Category Object Formats

Panel

Insert or Update a specific System Category

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

PUT /seiapi/v3/trans/SystemCategory/default/${Code}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Configuration Related Objects System Category Object.

HTTP Response

On success the API will return a response code of 200.

Panel

Push System Category changes to mobile device

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

GET /seiapi/v3/trans/SystemCategory/default/${Code}?RefreshMobile=1

HTTP Request Body

This request does not require a request body.

HTTP Response

On success the API will return a response code of 200.

Panel

Delete a specific System Category

URL

Panel

borderColor	grey
bgColor	whitesmoke
borderStyle	solid

DELETE/seiapi/v3/trans/SystemCategory/default/${Code}

HTTP Request Body

This request does not require a request body.

HTTP Response

On success the API will return a response code of 200.

Versions Compared

Old Version 15

New Version 16

Key

Pushing System Category Updates to Mobile Devices

Resource URL

API Specific Parameters

API Specifics

Retrieve the details of a specific System Category

URL

HTTP Request Body

HTTP Response Body

Insert or Update a specific System Category

URL

HTTP Request Body

HTTP Response

Push System Category changes to mobile device

URL

HTTP Request Body

HTTP Response

Delete a specific System Category

URL

HTTP Request Body

HTTP Response

Page Comparison

Versions Compared

Old Version 15

New Version 16

Key

Pushing System Category Updates to Mobile Devices

Resource URL

API Specific Parameters

API Specifics

Retrieve the details of a specific System Category

URL

HTTP Request Body

HTTP Response Body

Insert or Update a specific System Category

URL

HTTP Request Body

HTTP Response

Push System Category changes to mobile device

URL

HTTP Request Body

HTTP Response

Delete a specific System Category

URL

HTTP Request Body

HTTP Response