Secondary owners

An activity can have one or more secondary owners (called 'others' in the web ui). These endpoints are for listing all the possible owners - and showing the selected ones, and also an API for updating the activity with selected secondary owners

Secondary Owner lookup (also called 'others')

ParameterDescriptionExamplesMore info
APIThe API areaactivities.json
ActionDefines the API callaction=secondaryowners
GeneralParameters described in overviewuser=user&password=userv3.3 Overview
User ID(s)Selected secondary owners

userid=

[242,192]

CompanySpecify the company (data-set)company=1

Example request:

http://<SERVER>/jsonapi/activities.json?user=user&password=user&company=1&action=secondaryowners&userid=[242,192]&version=3.3

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 172,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 0,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "userFullName": "Jim Smith",
      "userUserId": 344,
      "variable_selected": false
    },
    {
      "userFullName": "Aaron Cronshaw",
      "userUserId": 242,
      "variable_selected": true
    }
  ]
}

Secondary Owner update

Example request:

ParameterDescriptionExamples
ActionDefines the the API callaction=update
InputJSON array{"data": [{"activityID":7476,"activitySecondaryOwnersUserID":[242,192]}]}
GeneralParameters described in overview
http://<SERVER>/jsonapi/notes.json?&user=user&password=user&version=3.3&action=update&input={"data": [{"activityID":7476,"activitySecondaryOwnersUserID":[242,192] }]}.

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "activityID": 7476,
      "activityuuid": "34912CA9753A494F8EB70BF0CD385CB7",
      "activitySecondaryOwnersDescription": "Adele Graham, Alan Greenwoodx",
      "activitySecondaryOwnersUserID": [
        242,
        192
      ],
      "activityTimeStampModified": 1497456978,
      "activityRecordVersionNumber": 112
    }
  ]
}