| 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=3.9
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"jobUuid": "57F47F438D6A49489FD50D25BFC4509E",
"jobTimeStampModified": 1520003029,
"jobRecommendedVersionNumber": 133,
"jobDescription1stLine": "Letterhead - re-design",
"jobWonBy": "",
"jobCustomField290": "0000-00-00",
"jobCurrencySymbol": "KW",
"jobCurrency": "Kuwaiti dinar",
"jobExchangeRate": 0.45,
"jobClientCode": "1/WARD",
"jobClientName": "Ward Homes",
"jobComments": "",
"jobCurQuotedPrice": 0,
"jobDateIn": "2001-09-11",
"jobDateDue": "2001-10-11",
"jobCompletedDate": "0000-00-00",
"jobDescription": "Letterhead - re-design",
"jobNumber": "1/00000510",
"jobStatus": 1,
"jobStatusDescription": "Quote",
"jobLeadClosedDate": "2016-11-17",
"jobOrderNumber": "",
"jobQuotedPrice": 0,
"jobReferenceJob": "",
"jobTaxCode": 3,
"jobOppCurrentStatus": "",
"jobOppLeadRating": "",
"jobOppSource": "",
"jobOppWeighting": 75,
"jobStageNotes": "",
"jobHandlerUserID": 0,
"jobHandlerFullName": "",
"jobHandlerTeam": "",
"jobTeamDescription": "",
"jobCampaignNo": 0,
"jobCampaignDescription": "",
"jobContactInternalRef": 26,
"jobContactFullName": "Russell Tomes a",
"jobCurrencyCode": "1/KWD",
"jobJobtypeCode": "1/WEB",
"jobJobtypeDescription": "Website Design",
"jobProjectCode": 68,
"jobProjectDescription": "Manchester Site",
"jobStagePriority": 10,
"jobPriorityDescription": "",
"jobWorkflowCode": "",
"jobCurrentStageDescription": ""
}
]
}