Job Details

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areajobs.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.7v3.7 Overview
Model StructureYesName of model requiredmodelstructure=jobdetailsUsing data models
ViewNoStored filter appliedUsing views
SortNoChange the view's default sort ordersort=CLIENTSorting
FiltersNoFilter by a key fieldFilters
CompanyYesThe company numbercompany=1
IdentifierYesJob ID or UUIDjob=1/00000510

Example request:

http://<SERVER>/jsonapi/jobs.json?user=user&password=user&company=1&modelstructure=jobdetails&job=1/00000510&version=3.7

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