Activity type lookup

Activity type is mandatory when creating an activity. This API provides a lookup list of valid activity types

Activity type lookup

Example request:

Parameter

Description

Examples

Action

Defines the the API call

action=activitytypes

General

Parameters described in overview

job (optional)

Specify the job for this activity

job=1/00088972

jobphase (optional)

Specify the job phase for this activity

jobphase=1/00088972.001

Activitytype (optional)

Specify the current activity type

activitytype=MEET

Company

Specify the company (data-set)

company=1

http://<SERVER>/jsonapi/activities.json?user=user&password=user&company=1&action=activitytypes&version=3.1

Requisions

if you are supporting requisition type activities you need to pass the job/jobphase parameter

Example response

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 19,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "activitytypeNoteCategory": 2,
      "activitytypeCode": "COMM",
      "activitytypeCompany": 1,
      "activitytypeDescription": "Communication",
      "activitytypeDisplayOrder": "",
      "activitytypeActive": true,
      "activitytypeImmediateAlertOnByDefault": true,
      "activitytypeCompletionAlertByDefault": true,
      "variable_selected": false
    },
    {
      "activitytypeNoteCategory": 5,
      "activitytypeCode": "MEET",
      "activitytypeCompany": 1,
      "activitytypeDescription": "Meeting notes",
      "activitytypeDisplayOrder": "",
      "activitytypeActive": true,
      "activitytypeImmediateAlertOnByDefault": false,
      "activitytypeCompletionAlertByDefault": false,
      "variable_selected": true
    },
    {
      "activitytypeNoteCategory": 2,
      "activitytypeCode": "MER",
      "activitytypeCompany": 1,
      "activitytypeDescription": "Merge",
      "activitytypeDisplayOrder": "",
      "activitytypeActive": true,
      "activitytypeImmediateAlertOnByDefault": false,
      "activitytypeCompletionAlertByDefault": false,
      "variable_selected": false
    },
    {
      "activitytypeNoteCategory": 2,
      "activitytypeCode": "QUOT",
      "activitytypeCompany": 1,
      "activitytypeDescription": "Quotation",
      "activitytypeDisplayOrder": "",
      "activitytypeActive": true,
      "activitytypeImmediateAlertOnByDefault": true,
      "activitytypeCompletionAlertByDefault": true,
      "variable_selected": false
    },
    {
      "activitytypeNoteCategory": 2,
      "activitytypeCode": "TODO",
      "activitytypeCompany": 1,
      "activitytypeDescription": "Task",
      "activitytypeDisplayOrder": "",
      "activitytypeActive": true,
      "activitytypeImmediateAlertOnByDefault": true,
      "activitytypeCompletionAlertByDefault": true,
      "variable_selected": false
    }
  ]
}