Create

Job create

Create a new job.

Parameter	Description	Examples	More info
API	The API area	jobs.json
Action	Create a new record in the jobs table	action=create
	Parameters described in overview	user=user&password=user	Overview
Company	Company number	company=8
Input	JSON string	input="data": ...
varJobTemplate	Specify the template to use	"varJobTemplate": "8/00800001"
jobClientCode	Client code - see clients API	"jobClientCode": "8/1244"
jobDateIn	Date in	"jobDateIn": "2017/04/01"
jobDateDue	Date due	"jobDateDue": "2017/04/30"
jobNumber	Job number	"jobNumber": "8/00JON6"
jobDescription	Job description	"jobDescription": "My new job description"
jobComments	Job comments	"jobComments": "My new job comments"
jobJobtypeCode	Job type code - see job types API	"jobJobtypeCode": "8/10"
jobHandleruserid	Handler ID - see users API	"jobHandleruserid": "3"
jobHandlerTeam	Job team - see teams API	"jobHandlerTeam": "8/DQS"
jobStatus	1=Quote 2=Live 3=In house 4=On hold 5=Special	"jobStatus": "2"
jobPrefixOnly	Pass this param if you need to add a prefix to an automatic job number	"jobPrefixOnly": "JN"
jobReferenceJob	Reference Job field - if not passed the reference job will be set to the job number of the template job used.	"jobReferenceJob": "ABC1000"
jobContactInternalRef	Client contact ID Job client contact	"jobContactInternalRef": 8600
jobProjectCode	Project code	"jobProjectCode": 388
jobCampaignNo	Campaign code	"jobCampaignNo": 268

Job prefixes:

If no job number is being passed in the API call and the system is set to use automatic job numbers, any automatic job prefixes will be added to the generated job number. If you wish to pass a manual prefix you can (see above) but this will only be accepted if the company settings allow for manual prefixes.

due date:

In a system where dates are driven by phase/stages (see date controls in company settings), the due date should not be passed - all due dates are then calculated by the durations set in the phases/stage in the template being used. If a due date is passed this overrides the due dates set in the template and all phases and stages are given the same due date (the date passed)

If a due date is passed that is earlier than the start date no error is returned but the due date in the request is ignored

Example request:
Request to create a job

http://<SERVER>/jsonAPI/jobs.json?user=user&password=user&action=create&company=8&version=3.3&input={
  "data": [
    {
      "varJobTemplate": "8/00800001",
      "jobHandleruserid": "3",
      "jobClientCode": "8/1244",
      "jobJobtypeCode": "8/10",
      "jobNumber": "8/00MJP20",
      "jobDescription": "My new job description",
      "jobDateIn": "2017/12/06",
      "jobDateDue": "2017/12/07",
      "jobHandlerTeam": "8/DQS",
      "jobStatus": "2",
      "jobContactInternalRef": 8600,
      "jobProjectCode": 388,
      "jobCampaignNo": 268
    }
  ]
}

Example response:

{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "data processed successfully.",
"warningmessage": "",
"success": true,
"data": [
{
"jobNumber": "8/00MJP20",
"jobUuid": "E5569957F40EF943A3C32BCAAD542633",
"jobTimeStampModified": 1523625197,
"jobRecommendedVersionNumber": 7
}
]
}