Returns one or more activity records.
Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | activities.json | |
General | Yes | Parameters described in overview | See overview | Structure of an API call |
Model Structure | Yes | Name of model required | modelstructure=activitylist | Using data models |
View | No | Stored filter applied | Using views | |
Sort | No | Change the view's default sort order | sort=CLIENT | Sorting |
Filters | No | Filter by a key field | Filters | |
Company | Yes | The company number | company=1 |
Example request:
http://<SERVER>/jsonapi/activities.json?company=1&version=3.9&user=user&password=user&modelstructure=activitylist
Markdown example
Colour
- Changes the colour of the booking in both 'My calendar' and 'Calendar bookings'
Tentative
- Tentative bookings indicate a decree if uncertainty
- Bookings marked as 'Tentative' have a dotted border
- Duck Duck Go
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 164,
"totalpages": 82,
"responsemessage": "",
"pagerows": 2,
"pagenumber": 1,
"success": true,
"data": [
{
"activityuuid": "76F4FA3D460555449D7372B9B32E7AB9",
"activityTimeStampModified": 1560322015,
"activityRecordVersionNumber": 725,
"activityAttachmentCount": "1",
"activityCreated": "Created by Helen Whitley on 24/10/2016 at 3:01pm",
"activityDetails1stLine": "Add further detail here about the meeting",
"activityRegardingDescription": "",
"activityRegardingDescription2": "",
"activityRegardingWhat": "Job: 1/120670",
"activityCustomField435": true,
"activityCustomField436": "",
"activityCustomField437": "www.bbc.co.uk",
"activityCustomField438": -0.1,
"activityCustomField439": "2019-05-09",
"activityCustomField441": false,
"activityCustomField442": "",
"activityCustomField443": "",
"activityCustomField444": 0,
"activityCustomField445": "0000-00-00",
"activityPriorityDescription": "Med",
"activityOwnerID": 263,
"activityOwnerName": "Matthew Tanner",
"activityClientCode": "1/C4093",
"activityClientName": "Roxborough",
"activityCompleted": false,
"activityViewDate": "2016-10-24",
"activityViewTime": "08:00:00",
"activityViewTimezone": "UTCA",
"activityJobNumber": "1/120670",
"activityJobNumberSimple": "120670",
"activityJobAndPhase": "",
"activityJobAndPhaseSimple": "",
"activitySubject": "Launch meeting 1B",
"activityActivitytype": "Requisition RQ (Prof)",
"activityID": 7080,
"activityCreationDate": "2016-10-24"
},
etc. etc.