Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.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.

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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 REST Object Definitions Work Order Activity Related Objects Activity Object.

Activity IDs are globally unique.

Include Page
_URI Default HTTP Headers
_URI Default HTTP Headers

 


API Specifics

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Include Page
_Activity Object Formats
_Activity Object Formats

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Activity Object.

HTTP Response

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

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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 REST Object Definitions Work Order Activity Related Objects Activity Object.