Activity type is mandatory when creating an activity. This API provides a lookup list of valid activity types.
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | activities.json | |
| General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | Overview |
| Company | Yes | The company number | company=1 | |
| Action | Yes | The action to perform | action= | |
| Job | No | Job number | job=1/00088972 | |
| Jobphase | No | Job and phase number | jobphase=1/00088972.001 | |
| Activitytype | No | Activity type | activitytype=MEET |
If you are supporting requisition type activities, you need to pass either the job or jobphase parameter.
Example request:
http://<SERVER>/jsonapi/activities.json?user=user&password=user&company=1&action=activitytypes&version=3.9
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 26,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"activitytypeActive": true,
"activitytypeNoteCategory": 2,
"activitytypeCode": "1/ARTWORK",
"activitytypeCompletionAlertByDefault": false,
"activitytypeDescription": "Artwork 1",
"activitytypeDisplayOrder": "",
"activitytypeImmediateAlertOnByDefault": false,
"variable_selected": false
},
{
"activitytypeActive": true,
"activitytypeNoteCategory": 2,
"activitytypeCode": "1/CBA",
"activitytypeCompletionAlertByDefault": false,
"activitytypeDescription": "Calendar Booking Activity",
"activitytypeDisplayOrder": "",
"activitytypeImmediateAlertOnByDefault": false,
"variable_selected": false
},