Create

Job create

Create a new job.

Example request:

  <th>
    Description
  </th>

  <th>
    Examples
  </th>
</tr>

  <td>
    create a new record in the jobs table
  </td>

  <td>
    action=create
  </td>
</tr>

<tr>
  <td>
    <General />
  </td>

  <td>
    Parameters described in overview
  </td>

  <td>
    user=user&password=user&version=3.1
  </td>
</tr>

<tr>
  <td>
    Company
  </td>

  <td>
    Company number
  </td>

  <td>
    company=8
  </td>
</tr>

<tr>
  <td>
    input
  </td>

  <td>
    JSON string
  </td>

  <td>
    input="data": ...
  </td>
</tr>

<tr>
  <td>
    <input mandatory>varJobTemplate</input>
  </td>

  <td>
    Specify the template to use
  </td>

  <td>
    "varJobTemplate": "8/00800001"
  </td>
</tr>

<tr>
  <td>
    <input mandatory>jobClientCode</input>
  </td>

  <td>
    Client code - see clients API
  </td>

  <td>
    "jobClientCode": "8/1244"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobDateIn</input>
  </td>

  <td>
    Date in
  </td>

  <td>
    "jobDateIn": "2017/04/01"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobDateDue</input>
  </td>

  <td>
    Date due
  </td>

  <td>
    "jobDateDue": "2017/04/30"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobNumber</input>
  </td>

  <td>
    Job number
  </td>

  <td>
    "jobNumber": "8/00JON6"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobDescription</input>
  </td>

  <td>
    Job description
  </td>

  <td>
    "jobDescription": "My new job description"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobComments</input>
  </td>

  <td>
    Job comments
  </td>

  <td>
    "jobComments": "My new job comments"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobJobtypeCode</input>
  </td>

  <td>
    Job type code - see job types API
  </td>

  <td>
    "jobJobtypeCode": "8/10"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobHandleruserid</input>
  </td>

  <td>
    Handler ID - see users API
  </td>

  <td>
    "jobHandleruserid": "3"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobHandlerTeam</input>
  </td>

  <td>
    Job team  - see teams API
  </td>

  <td>
    "jobHandlerTeam": "8/DQS"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobStatus</input>
  </td>

  <td>
    1=Quote 2=Live 3=In house 4=On hold 5=Special
  </td>

  <td>
    "jobStatus": "2"
  </td>
</tr>

<tr>
  <td>
    <input optional>jobReferenceJob</input>
  </td>

  <td>
    Reference Job field - if not passed the reference job <br>will be set to the job number of the template job used.
  </td>

  <td>
    "jobReferenceJob": "ABC1000"
  </td>
</tr>

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.

due date:

In a system where dates are driven by phase/stages (see date controls in company settings), the due date is ignored since all due dates are calculated by the durations set in the phases/stage in the template being used. 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

Request to create a job

http:///jsonAPI/jobs.json?user=user&password=user&action=create&company=8&version=3.1&input={
"data":[
{
"varJobTemplate": "8/00800001",
"jobHandleruserid": "3",
"jobClientCode": "8/1244",
"jobJobtypeCode": "8/10",
"jobNumber": "8/00MIKE12",
"jobDescription": "My new job description",
"jobDateIn": "2017/12/06",
"jobDateDue": "2017/12/07",
"jobHandlerTeam":"8/DQS",
"jobStatus":"2"
}
],
"additionalData":[
{
"varJobTemplate": "8/00800001",
"jobHandleruserid": "3",
"jobClientCode": "8/1244",
"jobJobtypeCode": "8/10",
"jobNumber": "8/00MIKE12",
"jobDescription": "My new job description",
"jobDateIn": "2017/12/06",
"jobDateDue": "2017/12/07",
"jobHandlerTeam":"8/DQS",
"jobStatus":"2"
}
]
}

Example response:

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