Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | thermos.json | |
General | Yes | Parameters described in overview | see overview | Structure of an API call |
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 | |
type | Yes | Job or Phase | type=job |
Example request:
http://<SERVER>/jsonapi/thermos.json?user=user&password=user&version=3.9&company=1&type=job
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 0,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"lookupJobPhaseThermGroup": "KeyThermos",
"lookupJobPhaseThermName": "Key thermos",
"lookupJobPhaseThermNumber": -1,
"lookupJobPhaseThermWhitePoint": 0
},
{
"lookupJobPhaseThermGroup": "KeyThermos",
"lookupJobPhaseThermName": "Actual to estimated cost",
"lookupJobPhaseThermNumber": 1,
"lookupJobPhaseThermWhitePoint": 110
}
]
}
Note: Feature from API 2.2