Selecting a client for an activity record. This action can take place prior to creating an activity. It would normal be used if creating an activity on a client, where the activity is not related to a job.
| 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 |
| Model Structure | Yes | Name of model required | modelstructure=clientslist | 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 | |
| Action | Yes | The action to perform | action=clientslist |
Example request:
http://<SERVER>/jsonapi/activities.json?style=modeldata&modelstructure=clientslist&action=clientslist&company=1&view=SELECTVIEW44486&version=3.9&user=user&password=user
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 480,
"totalpages": 48,
"responsemessage": "",
"pagerows": 10,
"pagenumber": 1,
"success": true,
"data": [
{
"clientUuid": "C28D517EC2F14921B347C4E1744E0CBC",
"clientTimeStampModified": 1496750532,
"clientRecordVersionNumber": 730,
"clientCode": "1/GRA",
"clientName": "Granada",
"clientCategoryName": "Client",
"clientPhone": "0171 698 9800",
"clientCategory": 3,
"clientHandlerUserID": 239,
"clientWebURL": "www.onedayx.com",
"clientEmail": "[email protected]",
"clientInactive": false,
"clientType": "Arts 1",
"clientOpStatus": "Bronze",
"clientMarketSector": "Arts, Sport, Entertainment1",
"clientOnHold": true,
"clientHandlerFullName": "Aaron Cronshaw"
},
{
"clientUuid": "ADA9CBAD7BA43447A94DF6E39A5D03AA",
"clientTimeStampModified": 1496750447,
"clientRecordVersionNumber": 99,
"clientCode": "1/C4036",
"clientName": "999 Inc",
"clientCategoryName": "Client",
"clientPhone": "",
"clientCategory": 3,
"clientHandlerUserID": 239,
"clientWebURL": "",
"clientEmail": "",
"clientInactive": false,
"clientType": "B2B2",
"clientOpStatus": "",
"clientMarketSector": "Tourism",
"clientOnHold": false,
"clientHandlerFullName": "Aaron Cronshaw"
},
etc., etc.,
}