Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

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.

On this page:

Related pages:

Resource URL

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

ParameterDescription

${Code}

The unique System Category code.
RefreshMobile=1Add this parameter with a value of 1 to push updates to mobile devices.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Retrieve the details of a specific System Category

URL

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. 

JSON Format 
 {
    "SysCatID": "1",
    "Desc" : {
        "en" : "English description",
        "es" : "Spanish description"
    },
    "FlexForms" : [
        "${FlexFormID}",
        "${FlexFormID}"
    ],
    "SysActs" : [
        {
            "SysActID" : "",
            "IsActive" : true,
            "Desc" : {
                "en" : "English description",
                "es" : "Spanish description"
            },
            "FlexForms" : [
                "${FlexFormID}",
                "${FlexFormID}"
            ]
        }
    ],
    "SubCats" : []
}

Insert or Update a specific System Category

URL

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.

Push System Category changes to mobile device

URL

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.

Delete a specific System Category

URL

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.

  • No labels