Phase List

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	phases.json
General	Yes	Parameters described in overview	`Authorization: Bearer <access_token>` header — see Synergist API Authentication	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 (OAuth 2.0):

Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/phases.json?&company=1&modelstructure=phaseslist&view=-1307&page=1&rows=2&version=6

Example request (legacy username/password):

http://<SERVER>/jsonapi/phases.json?&company=1&modelstructure=phaseslist&view=-1307&page=1&rows=2&version=6&user=<username>&password=<password>

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": ""
    }
  ]
}

CSV_request:

This call will return the same data as above but as a simple downloaded CSV file

If "modelstructure=view", and a view number also specified, the CSV will contain the columns associated with the view - rather than a standard model

Authorization: Bearer <access_token>
http://<SERVER>/csvapi/phases.csv?company=1&version=6&&company=1&modelstructure=phaseslist&view=-1307&rows=2&page=1

Example request (legacy username/password):

http://<SERVER>/csvapi/phases.csv?company=1&version=6&&company=1&modelstructure=phaseslist&view=-1307&rows=2&page=1&user=<username>&password=<password>