| 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=phasedetails | 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=phasedetails&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,
"phaseCustomField186": "",
"phaseCustomField203": "0000-00-00",
"phaseCustomField213": "",
"phaseCustomField219": 0,
"phaseCustomField220": false,
"phaseCustomField280": "0000-00-00",
"phaseCustomField287": "",
"phaseCustomField297": "",
"phaseSalesCodeDescription": "1 (20%)",
"phaseJobNumber": "1/00000205",
"phaseJobAndPhase": "1/00000205.001",
"phaseJobDescription": "205 - No BP",
"phaseClientName": "Meadowside",
"phaseDescription": "Phase 1",
"phaseOrderNumber": "",
"phaseProjectCode": 0,
"phaseProjectName": "",
"phaseCampaignNo": 0,
"phaseCampaignName": "",
"phaseStatus": 2,
"phaseStatusDescription": "Live",
"phaseWorkflowCode": "",
"phaseStageDesc": "",
"phasePhasetypeCode": "",
"phasePhasetypeDescription": "",
"phaseContactInternalRef": 0,
"phaseContactFullName": "",
"phaseHandlerId": 54,
"phaseHandlerFullName": "User - Andy",
"phaseOwner": "",
"phasePhaseOwner": "",
"phaseTaxCode": 1,
"phaseSalesTaxRate": 20,
"phaseCurrency": "",
"phaseCurrencyCode": "",
"phaseExchangeRate": 1,
"phaseDatein": "2020-08-12",
"phaseTimeIn": "07:52:00",
"phaseDateDue": "0000-00-00",
"phaseTimeDue": "00:00:00",
"phaseStagePriority": 10,
"phasePriorityDescription": "",
"phaseDisplayOrder": ""
},