Phase list

List phases

Parameters follow General parameters

Parameter

Description

Examples

More info

API

The API area

jobs.json

Action

Not required

<General>

Parameters described in overview

user=user&password=user

Overview

Modelstructure

Name of model required

Modelstructure=phaseslist

Using data models

Company

Company number

company=1

Views

Stored filter applied

view=-1307

Using views

Sort

Change the view's default sort order

sort=CLIENT

Sorting

<Filters>

Filter by a key field

Filters

Response

Returned data

A JSON string containing the data

Example request:

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

Using this request, the response will list 2 jobs (rows=2&page=1), use the View -1300 and a also uses Models.

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 1,
  "totalpages": 1,
  "responsemessage": "",
  "pagerows": 2,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "phaseuuid": "A1D4A4DA86612140AA806146DC95E161",
      "phaseTimeStampModified": 1489080105,
      "phaseRecordVersionNumber": 11,
      "phasePhaseDescription1stLine": "Test Copy Actuals",
      "phaseCustomField186": "",
      "phaseCustomField203": "0000-00-00",
      "phaseCustomField213": "",
      "phaseCustomField219": 0,
      "phaseCustomField220": false,
      "phaseCustomField280": "0000-00-00",
      "phaseCustomField287": "",
      "phaseCustomField297": "",
      "phaseThermProgress": "2%",
      "phaseThermValue": 10,
      "phaseThermWhitePoint": 110,
      "phaseJobDescription1stLine": "Test Copy Actuals",
      "phaseJobNumber": "1/00075539",
      "phaseJobAndPhase": "1/00075539.001",
      "phasePhase": "001",
      "phaseHandlerFullName": "User",
      "phaseOwnerFullName": "",
      "phaseDatein": "2015-05-07",
      "phaseDateDue": "2015-10-23",
      "phaseOrderNumber": "",
      "phaseCompleted": false,
      "phaseClientCode": "1/TEST2",
      "phaseClientName": "AAK Foods",
      "phaseJobNumberSimple": "75539",
      "phaseJobPhaseNumberSimple": "75539.001",
      "phaseContactFullName": "",
      "phaseStatusDescription": "Live",
      "phasePriorityDescription": ""
    }
  ]
}