Difference between revisions of "Create Job Parts"

Latest revision as of 12:35, 14 November 2016

[edit] Summary

Job parts can be created for any workflow type however for the data to be displayed on the device the correct screen needs to be enabled.

A job part can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

A job part may be created either by supplying freeform text for the 'name' field, or by supplying the name or external id of an existing part, which will then be linked from the items catalog to the new part.

This method is transactional. If one part fails validation, then no parts will be created.

Returns a list of valid job parts and a list of failed job parts. Even if parts are valid, they will not be created unless there are no failed parts.

[edit] Multi Part Form Data

[edit] JSON As Body

[edit] JSON Contents

[edit] Example Input

[edit] Multi Part Form Data

{"parts":[{
"quantity":"4",
"external_id":"testingThis",
"description":"testDescription",
"code":"helloCode"
}]}

[edit] JSON As Body

{
   "key":"darrenwebapi",
   "job_number":"123",
   "parts":[
      {
         "quantity":"4",
         "external_id":"testingThis",
         "description":"testDescription",
         "code":"helloCode"
      }
   ]
}

[edit] Example Curl Requests

[edit] Multi Part Form Data

curl -F validate_only=false -F update_existing=true -F api_key=darrenwebapi -F job_number=123 -F file=@/Users/darrenatherton/Desktop/webAPICurling/create_job_part_stage.txt https://api.mymobileworkers.com:8181/api/1/jobs/job/parts

[edit] JSON As Body

curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi","job_number":"123","parts":[{"quantity":"4","external_id":"testingThis","description":"testDescription","code":"helloCode"}]}' https://api.mymobileworkers.com:8181/api/1/jobs/job/parts

[edit] Responses

[edit] Example JSON

{
   "result":"failed",
   "failed":[
      {
         "part":{
            "name":"part2",
            "code":null,
            "description":null,
            "quantity":0.0
         },
         "errors":[
            {
               "error_code":"WAJ037",
               "error_message":"code invalid empty string"
            },
            {
               "error_code":"WAJ034",
               "error_message":"description invalid empty string"
            }
         ]
      }
   ],
   "valid":[
      {
         "name":"part1",
         "code":"CODE1",
         "description":"description",
         "quantity":1.0
      }
   ]
}