Document toolboxDocument toolbox

[Depreciated]Activity REST API

Owned by Andrew Hill (Deactivated)
Last updated: Oct 01, 2024 by Jason Andrew
2 min read

3.0.0

The Activity REST API is used to create, get, update or delete an activity object.

An activity is a scheduled event that may or may not be associated with an actual address. Activities appear within the mobile application's schedule views along side scheduled work orders.

Any time the mobile user performs an action that causes the activity object to change, it will automatically be uploaded to the server. For example, when the activity is started, the activity object will be uploaded to the server with the updated Started field populated.

On this page:

Related pages:

Resource URL Summary

Retrieve the details of a specific Activity

GET /seiapi/v3/trans/Activity/${ActivityID}

Insert or Update the details of a specific Activity

PUT /seiapi/v3/trans/Activity/${ActivityID}

Delete a specific Activity

DELETE /seiapi/v3/trans/Activity/${ActivityID}

API Specific Parameters

ParameterDescription

${ActivityID}

Identifies the Activity Object.

Activity IDs are globally unique.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Retrieve the details of a specific Activity

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

URL

GET /seiapi/v3/trans/Activity/${ActivityID}

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 Activity Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

JSON Format 
{
    "ActivityID": "", 
    "Started": "", 
    "Ended": "", 
    "Address": {
        "City": "", 
        "Country": "", 
        "Line1": "", 
        "Line2": "", 
        "Name": "", 
        "State": "", 
        "Zip": ""
    }, 
    "Desc": "", 
    "Dur": "", 
    "Extensions": {
        "key1": "value1", 
        "key2": "value2"
    },  
    "FlexForms": [
        "${FlexFormID}"
    ],
    "FlexView": [
        {
            "Title": "GroupName",
            "Items": [
                {
                    "Label": "labeltext",
                    "Value": "valuetext"
                }
            ]
        }
    ],
    "Paused": false, 
    "Priority": "", 
    "Remarks": "",
    "SchedDur": "", 
    "SchedEnd": "", 
    "SchedStart": "", 
    "Status": "", 
    "SysActCode": "", 
    "Title": "", 
    "UserName": ""
}

Insert or Update the details of a specific Activity

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

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

URL

PUT /seiapi/v3/trans/Activity/${ActivityID}

HTTP Request Body

The HTTP request body must contain a valid Activity Object.

HTTP Response

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

Delete a specific Activity

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

URL

DELETE /seiapi/v3/trans/Activity/${ActivityID}

HTTP Request Body

This request does not require a request body.

HTTP Response

On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent Activity Object.