| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | phases.json | |
| General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=phaseslist | 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/phases.json?user=user&password=user&company=1&modelstructure=phaseslist&view=-1307&page=1&rows=2&version=3.9
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 45,
"totalpages": 23,
"responsemessage": "",
"pagerows": 2,
"pagenumber": 1,
"success": true,
"data": [
{
"phaseuuid": "366650887E8C5F4BA822E0F4870A3AED",
"phaseTimeStampModified": 1597853984,
"phaseRecordVersionNumber": 4,
"phasePhaseDescription1stLine": "Phase 1",
"phaseCustomField186": "",
"phaseCustomField203": "0000-00-00",
"phaseCustomField213": "",
"phaseCustomField219": 0,
"phaseCustomField220": false,
"phaseCustomField280": "0000-00-00",
"phaseCustomField287": "",
"phaseCustomField297": "",
"phaseThermProgress": "",
"phaseThermValue": 0,
"phaseThermWhitePoint": 110,
"phaseJobDescription1stLine": "205 - No BP",
"phaseJobNumber": "1/00000205",
"phaseJobAndPhase": "1/00000205.001",
"phasePhase": "001",
"phaseHandlerFullName": "User - Andy",
"phaseOwnerFullName": "",
"phaseDatein": "2020-08-12",
"phaseDateDue": "0000-00-00",
"phaseOrderNumber": "",
"phaseCompleted": false,
"phaseClientCode": "1/11223222",
"phaseClientName": "Meadowside",
"phaseJobNumberSimple": "205",
"phaseJobPhaseNumberSimple": "205.001",
"phaseContactFullName": "",
"phaseStatusDescription": "Live",
"phasePriorityDescription": ""
},