Delete

Delete a job record

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areajobs.json
GeneralYesParameters described in overviewuser=user&password=user&version=3.7v3.7 Overview
ActionYesThe action to performaction=delete
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
IdentifierYesJob ID or UUID"jobNumber":"1/00008772"

Delete will fail if job is used on one or more activity records.

Example request:

http://<SERVER>/jsonAPI/jobs.json?user=user&password=user&version=3.7&action=delete&input={
  "data": [
    {
      "jobNumber": "1/00008772"
    }
  ]
}

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "data": [
    {
      "jobNumber": "1/00008772",
      "jobUuid": "19C1C231B8DE43B5BD2BC80F8A23E699",
    }
  ]
}

Note:

To discover which fields are editable make a call to the "Job details" endpoint and specify '&style=modelstructure' see Meta-data

example of fields that can be updated using this endpoint:

Note: this is subject to the business rules set up on the system. For instance you can not alter the due date of a job if the system is set up to be phase dates driven.

  jobExchangeRate
  jobClientCode
  jobComments
  jobCurQuotedPrice
  jobDateIn
  jobDateDue
  jobDescription
  jobStatus
  jobOrderNumber
  jobQuotedPrice
  jobReferenceJob
  jobTaxCode
  jobOppCurrentStatus
  jobOppLeadRating
  jobOppSource
  jobOppWeighting
  jobStageNotes
  jobHandlerUserID
  jobHandlerTeam
  jobCampaignNo
  jobContactInternalRef
  jobCurrencyCode
  jobJobtypeCode
  jobProjectCode
  jobStagePriority
  jobWorkflowCode