| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | jobs.json | |
| General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
| Model Structure | Yes | Name of model required | modelstructure=jobdetails | 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 | |
| Identifier | Yes | Job ID or UUID | job=1/00000510 |
Example request:
http://<SERVER>/jsonapi/jobs.json?user=user&password=user&company=1&modelstructure=jobdetails&job=1/00000510&version=4
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"synversion": "13.010.0095",
"synapiversion": 4.01,
"data": [
{
"jobUuid": "57F47F438D6A49489FD50D25BFC4509E",
"jobTimeStampModified": 1722441274,
"jobRecommendedVersionNumber": 349,
"jobDescription1stLine": "Letterhead re-design",
"jobSalesStatus": "Promoted",
"jobWonBy": "Won SYN_Jon on 23/05/2018 at 4:00pm",
"jobCustomField788": 0,
"jobCustomField789": 0,
"jobCustomField814": false,
"jobCustomField815": "",
"jobCustomField816": "",
"jobCustomField817": 0,
"jobCustomField818": "0000-00-00",
"jobCustomField819": "00:00:00",
"jobCustomField820": "",
"jobCustomField821": "",
"jobCustomField822": "",
"jobCustomField898": false,
"jobCustomField899": "",
"jobCustomField900": "",
"jobCustomField901": 0,
"jobCustomField902": "0000-00-00",
"jobCustomField904": "00:00:00",
"jobCustomField905": "",
"jobCustomField906": 0,
"jobCustomField907": 0,
"jobCustomField908": "",
"jobCustomField909": "",
"jobCustomField910": "",
"jobCustomField917": "",
"jobCustomField923": "",
"jobCustomField924": "",
"jobCustomField925": "0000-00-00",
"jobCustomField936": "",
"jobCustomField937": "",
"jobCustomField943": "",
"jobCurrencySymbol": "KW",
"jobCurrency": "Kuwaiti dinar",
"jobExchangeRate": 0.45,
"jobClientCode": "",
"jobClientName": "",
"jobComments": "Letterhead design",
"jobCurQuotedPrice": 0,
"jobDateIn": "2001-09-11",
"jobDateDue": "2001-10-11",
"jobCompletedDate": "0000-00-00",
"jobDescription": "Letterhead re-design",
"jobNumber": "1/00000510",
"jobStatus": 2,
"jobStatusDescription": "Live",
"jobLeadClosedDate": "2016-11-17",
"jobOrderNumber": "",
"jobQuotedPrice": 0,
"jobReferenceJob": "",
"jobTaxCode": 3,
"jobOppCurrentStatus": "",
"jobOppLeadRating": "",
"jobOppSource": "",
"jobOppWeighting": 100,
"jobStageNotes": "28/07/2017 3:36pm: Stage changed from 'dqs' to '(blank)' by SYN_Mike\r\n27/03/2019 10:25am: Stage changed from 'Supplied by Client' to '(blank)' by SYN_Miguel\r\n08/05/2019 3:02pm: Stage changed from 'Supplied by Client' to '(blank)' by User",
"jobHandlerUserID": 242,
"jobHandlerFullName": "Hermione Crumpleton",
"jobHandlerTeam": "1/MAR",
"jobTeamDescription": "Marketing",
"jobCampaignNo": 180,
"jobCampaignDescription": "Campaign2015",
"jobContactInternalRef": 26,
"jobContactFullName": "Russell Tomes a",
"jobCurrencyCode": "1/KWD",
"jobJobtypeCode": "1/WEB",
"jobJobtypeDescription": "Website",
"jobProjectCode": 68,
"jobProjectDescription": "Manchester Site",
"jobStageNo": 0,
"workflowtype_workflowname__jobheader_stageno": "test web add",
"jobStagePriority": 10,
"jobPriorityDescription": "",
"jobWorkflowCode": "",
"jobCurrentStageDescription": ""
}
]
}