Synergist API call
This URL would get system information.
GET /jsonapi/system.json?user=user&password=user&action=version&version=3.1
Called using a browser
http:///jsonapi/system.json?user=user&password=user&action=version&version=3.1
Returns
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "",
"warningmessage": "",
"success": true,
"data": [
{
"uuid": "E646889F48DD423CA1300491A31E8C50",
"systemparameters_versionno": 12.2,
"systemparameters_versionrevision": "d",
"variable_apiversion": "3.1"
}
]
}
General parameters for all requests:
| parameter | description |
|---|---|
| user | Synergist login ID |
| password | Synergist password |
| page (optional) | Data page to return, page numbering starts at 0 |
| rows (optional) | Number of records/rows to return. 0 = return all rows |
| version | Version of the API – currently 3.1 |
The API supports SHA512 encryption of passwords. Replace 'password' with 'sha512password' and pass the hashed password instead.
e.g.
http:///jsonAPI/diary.json?user=user&sha512password=05d929ccb4693507ab5c1c25f6a582da1f27ac225882af5295e392ae89033c356b4ddf201f78dda3c16a4d6d198998
JSON Response
When a response is sent which contains multiple records, the root of the JSON string will have the following attributes:
| attribute | description |
|---|---|
| totalrows | this will be the total number of records/rows in the selection, regardless of page requested |
| totalpages | this will be the total number of pages available, based on the rows parameter supplied |
| pagenumber | the current page returned in the set |
| pagerows | number of rows requested |
A successful response will contain the following attributes at root level:
| attribute | description |
|---|---|
| Success | true |
| Responsemessage | a context response message |
| Responsecode | response code indicator |
| Errormessage | empty string |
| Errorcode | 0 |
| Data | the root json element containing the data result rows |
A response error will contain the following attributes at root level:-
| attribute | description |
|---|---|
| Success | false |
| Errormessage | any error context message |
| Errorcode | response code indicator |
In case of any error, the Synergist server will return an HTTP 404 error together with an XML structure containing the error details:
<Responses>
<Error ErrorID="404500">
<ErrorText>invalid action companylist</ErrorText>
</Error>
</Responses>