Jobs list

List jobs

If you wish to access multiple job records you would normally use the jobslist model

For more details about using models see Using data models

For jobs two models are available:

jobslist
jobdetails

If a list of records is required a ‘view’ parameter should be passed. If no ‘view’ parameter is passed all records for the synergist company are returned.

Parameter	Description	Example	More info
API	The API area	jobs.json
Action	Not required
General	Parameters described in overview	user=user&password=user	Overview
Company	Company number	company=1
Modelstructure	Name of model required	Modelstructure=jobslist	Using data models
View	Stored filter applied	view=-1303	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:
Request for data (list of records using specified model)

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

or with a timestamp filter ...

This will return any job records created/modified in the past 15 mins.

http://<SERVER>/jsonapi/jobs.json?company=1&version=3.3&user=user&password=user&company=1&style=modeldata&modelstructure=jobslist&timestampoffsetfrom=-900

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "totalrows": 405,
  "totalpages": 203,
  "responsemessage": "",
  "pagerows": 2,
  "pagenumber": 1,
  "success": true,
  "data": [
    {
      "jobUuid": "504EB2C781EA457D8D54B65E26CF739F",
      "jobTimeStampModified": 1519131664,
      "jobRecommendedVersionNumber": 236,
      "jobDescription1stLine": "Web site",
      "jobCustomField185": "",
      "jobCustomField290": "0000-00-00",
      "jobThermProgress": "",
      "jobThermValue": 0,
      "jobThermWhitePoint": 110,
      "jobOrderNumber": "1",
      "jobContactFullName": "",
      "jobHandlerFullName": "",
      "jobClientCode": "1/MULTI",
      "jobClientName": "Multi Store",
      "jobCompleted": false,
      "jobDateIn": "2004-03-02",
      "jobDateDue": "2004-03-02",
      "jobNumber": "1/00SCP974",
      "jobNumberSimple": "SCP974",
      "jobStatus": 2,
      "jobStatusDescription": "Live",
      "jobJobtypeDescription": "",
      "jobPriorityDescription": "",
      "jobCurrencyCode": "1/DOL",
      "jobExchangeRate": 1.5
    },
    etc. etc.
  ]
}