Difference between revisions of "Create Jobs"
From MyMobileWorkers API
(→Summary) |
|||
| Line 5: | Line 5: | ||
! | ! | ||
|- | |- | ||
| − | ! URL | + | ! URL |
| − | | http://base_url/api_path/version/mobile_users | + | | colspan="2" | http://base_url/api_path/version/mobile_users |
|- | |- | ||
! Type | ! Type | ||
Revision as of 10:29, 15 May 2013
Contents |
Summary
| Create Job | ||
|---|---|---|
| URL | http://base_url/api_path/version/mobile_users | |
| Type | POST | |
| Params: | api_key | required |
| file | required | |
| update_existing | optional (default = false) | |
| Response | JSON | |
The create job method accepts an array of jobs to be added to the system. If the update_existing param is set then any existing jobs will be updated in the system, if set to false or not provided then any job where the job number is not unique will be rejected.
JSON Parameters
| Standard Fields | ||
|---|---|---|
| Field | Expected Data | Required |
| job_number | varchar(45) * must be unique |
✓ |
| address_1 | varchar(45) | ✓ |
| address_2 | varchar(45) | |
| address_3 | varchar(45) | |
| address_4 | varchar(45) | |
| postcode | varchar(45) | ✓ |
| contact_name | varchar(45) | ✓ |
| contact_number_1 | varchar(45) | ✓ |
| contact_number_2 | varchar(45) | |
| timeslot | datetime | ✓ |
| special_instructions | text | |
| type (type of job) |
"repair","podc","gassafe" | ✓ |
| mobile_user | "{"username":"<username>"} *nested JSON object |
✓ |
| customer *must be a valid customer in MMW |
varchar(45) | |
| Repair Only Fields | ||
| product | varchar(255) | |
| fault | varchar(255) | |
| Gas Safe Only Fields | ||
| owner_title | varchar(45) | |
| owner_name | varchar(45) | ✓ |
| owner_address_1 | varchar(45) | ✓ |
| owner_address_2 | varchar(45) | |
| owner_address_3 | varchar(45) | |
| owner_address_4 | varchar(45) | |
| owner_postcode | varchar(45) | ✓ |
| owner_contact_number | varchar(45) | |
| owner_email | varchar(255) | |
| customer_email | varchar(255) | |
Example JSON
{"jobs":[{ "job_number":"SEJOB9", "address_1":"Rover Lane", "address_2":"Glasgow", "contact_name":"Joe Bloggs", "contact_number_1":"0770999999", "contact_number_2":"", "mobile_user":{"username":"MOB_01"}, "postcode":"G71 8TS","type":"repair", "timeslot":"2013-04-09 17:54:39", "special_instructions":"Door bell is faulty so knock on the door", "repair_description":"Replace U Bend" }]}
