Example call - all possible standard parameters
This example is from the activities API. However, similar parameters can be used in most API calls.
| Parameter | Description | Examples | Explanation | Links |
|---|---|---|---|---|
| Action | Defines the API call. | action=update | If not specified records for the API area are returned, or its structure | |
| Parameters described in overview | user=user&password=user&version=3.9 | Username, password and API version | v3.9 Overview | |
| Company | The company context | company=1 | Synergist company | |
| Style | Which kind of data is required | style=modelstructure / style=modeldata | Request either meta-data (structure) or actual data | Using models |
| Modelstructure | Name of model required | Modelstructure=activitylist / Modelstructure=activitydetails | Defines the fields returned. There are two available models | Using models |
| Activityid | ID of a specific record | activityid=4833 | Used to identify a specific record or filter the output using a key field | Filters |
| View | ID for a pre-existing query (called a “view”) | view=-1700 | Use the “views.json” call to obtain these values | Table of views |
| Collection | Data collection support | collection=new / collection= | Optional - used to improve API performance (advanced option) | |
| Type | The data area | type=activity | Specifies the area this API all relates to | Which API to use |
| Input | JSON array | {"data":[{"activityDetails":"Meeting at BoundryMill","activityID":6958,"activityRecordVersionNumber":1}]} | Passing data array to an API request | |
| Page | Data page to return | page=1 | Page numbering starts at 0 | |
| Rows | Number of records/rows to return. | rows=2 | 0 = return all rows | |
| Response | Returned data | See below | A JSON string containing the data available for this area, for the specified company/user |