Phase list

List phases

  <th>
    Description
  </th>

  <th>
    Examples
  </th>

  <th>
    More info
  </th>
</tr>

  <td>
    The API area
  </td>

  <td>
    jobs.json
  </td>
</tr>

<tr>
  <td>
    Action
  </td>

  <td>
    Not required
  </td>
</tr>

<tr>
  <td>
    <General>
  </td>

  <td>
    Parameters described in overview
  </td>

  <td>
    user=user\&password=user
  </td>

  <td>
    [Overview](ref:overview-2)
  </td>
</tr>

<tr>
  <td>
    Modelstructure
  </td>

  <td>
    Name of model required
  </td>

  <td>
    Modelstructure=phaseslist
  </td>

  <td>
    [Using data models](ref:using-models)
  </td>
</tr>

<tr>
  <td>
    Company
  </td>

  <td>
    Company number
  </td>

  <td>
    company=1
  </td>
</tr>

<tr>
  <td>
    Views
  </td>

  <td>
    Stored filter applied
  </td>

  <td>
    view=-1307
  </td>

  <td>
    [Using views](ref:models)
  </td>
</tr>

<tr>
  <td>
    Sort
  </td>

  <td>
    Change the view's default sort order
  </td>

  <td>
    sort=CLIENT
  </td>

  <td>
    [Sorting](ref:sorting)
  </td>
</tr>

<tr>
  <td>
    <Filters>
  </td>

  <td>
    Filter by a key field
  </td>

  <td>

  </td>

  <td>
    [Filters](ref:filters)
  </td>
</tr>

<tr>
  <td>
    Response
  </td>

  <td>
    Returned data
  </td>

  <td>
    A JSON string containing the data
  </td>
</tr>

Parameter
API

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