Difference between revisions of "Get Jobs By Status"
From MyMobileWorkers API
(→Summary) |
(→Example curl request) |
||
| Line 346: | Line 346: | ||
== Example curl request == | == Example curl request == | ||
| − | https:// | + | <source lang="php"> |
| + | https://api.mymobileworkers.com:8181/api/1/jobs/status?api_key=YOUR_KEY&status=NEW&start_date=2013-01-10%2012:12:12&end_date=2013-05-25%2012:12:12 | ||
| + | </source> | ||
Revision as of 12:26, 8 November 2016
Summary
| Jobs | ||
|---|---|---|
| URL | https://:base_url/:api_path/:version/jobs/status?api_key=YOUR_KEY&status=A_STATUS&start_date=DATETIME&end_date=DATETIME | |
| Type | GET | |
| Params: | api_key | required |
| status | required | |
| start_date | required | |
| end_date | required | |
| Response | JSON | |
The jobs/status method returns all jobs that have been created between the specified start_date and end_date which are currently in the specified status.
This API call will not respond with jobs that have been updated between the specified start_date and end_date and are currently in the specified status. Please see Get_Job_Updates_Between if this is your requirment.
Example response
{ "type":"repair", "status":"NEW", "duration":0, "product":null, "weight":100.15, "route":{ "external_id":null, "route_name":"Liverpool-AM", "route_code":"LIV-001", "route_limit":180.0 } "customer":null, "created_at":"2013-08-05T00:00:00+01:00", "job_number":"123", "gas_safe_inspection":[ ], "mobile_user":{ "username":"Darren_test32", "email":"darren.atherton19@yahoo.com", "color":"AE3B94", "engineer_registration_number":null }, "priorityDetails":{ "colour":"00731D", "name":"Very Low" }, "timeslot":null, "asset_histories":[ { "location":"aPlace2", "status":{ "external_id":null, "name":"test" }, "description":"describingwords", "item":{ "external_id":null, "category":"test2", "name":"Woo" }, "serial_number":"serialNo456", "external_id":"sss32", "last_scanned_by":null, "last_updated_by":null, "created_at":"2013-10-08 14:19:17", "job":{ "job_ number":"123" }, "asset":{ "external_id":"sss32", "serial_number":"serialNo456" }, "custom_fields":{ "testFieldName3":"testFieldValue3", "testFieldName2":"testFieldValue2", "testFieldName1":"testFieldValue1" }, "customer":{ "name":"john" }, "branch":{ "name":"DarrenDevTest" }, "photos":[ ] }, { "location":"aPlace2", "status":{ "external_id":null, "name":"test" }, "description":"describingwords", "item":{ "external_id":null, "category":"test2", "name":"Woo" }, "serial_number":"serialNo456", "external_id":"sss32", "last_scanned_by":null, "last_updated_by":null, "created_at":"2013-10-08 14:19:17", "job":{ "job_ number":"123" }, "asset":{ "external_id":"sss32", "serial_number":"serialNo456" }, "custom_fields":{ "testFieldName3":"testFieldValue3", "testFieldName2":"testFieldValue2", "testFieldName1":"testFieldValue1" }, "customer":{ "name":"john" }, "branch":{ "name":"DarrenDevTest" }, "photos":[ ] }, { "location":"aPlace2", "status":{ "external_id":null, "name":"test" }, "description":"describingwords", "item":{ "external_id":null, "category":"test2", "name":"Woo" }, "serial_number":"serialNo456", "external_id":"sss32", "last_scanned_by":null, "last_updated_by":null, "created_at":"2013-10-08 14:19:17", "job":{ "job_ number":"123" }, "asset":{ "external_id":"sss32", "serial_number":"serialNo456" }, "custom_fields":{ "testFieldName3":"testFieldValue3", "testFieldName2":"testFieldValue2", "testFieldName1":"testFieldValue1" }, "customer":{ "name":"john" }, "branch":{ "name":"DarrenDevTest" }, "photos":[ ] }, { "location":"aPlace2", "status":{ "external_id":null, "name":"test" }, "description":"describingwords", "item":{ "external_id":null, "category":"test2", "name":"Woo" }, "serial_number":"serialNo789", "external_id":"sss34", "last_scanned_by":null, "last_updated_by":null, "created_at":"2013-10-08 14:19:17", "job":{ "job_ number":"123" }, "asset":{ "external_id":"sss34", "serial_number":"serialNo789" }, "custom_fields":{ "testFieldName3":"testFieldValue3", "testFieldName2":"testFieldValue2", "testFieldName1":"testFieldValue1" }, "customer":{ "name":"john" }, "branch":{ "name":"DarrenDevTest" }, "photos":[ { "file_name":"www.testFileName.com/test" }, { "file_name":"www.testFileName.com/test" } ] } ], "contact_name":"qwerty", "address_1":"qwerty", "address_2":null, "postcode":"qqwerty", "notes":null, "address_3":null, "address_4":null, "contact_number_1":"0", "contact_number_2":null, "special_instructions":null, "fault":null, "repair_code":null, "repair_description":null, "signee":null, "satisfaction":null, "failure_type":null, "attachments":[ ], "items":[ { "name":"Bob", "type":"C", "status":"COMPLETED", "notes":"exampleNotes", "expected_quantity":4, "other":"test", "actual_quantity":null }, { "name":"Bob", "type":"C", "status":"COMPLETED", "notes":"exampleNotes", "expected_quantity":4, "other":"test", "actual_quantity":null }, { "name":"darrenItem", "type":"C", "status":"COMPLETED", "notes":"exampleNotes", "expected_quantity":4, "other":"test", "actual_quantity":null }, { "name":"darrenItem245", "type":"C", "status":"COMPLETED", "notes":"exampleNotes", "expected_quantity":4, "other":"test", "actual_quantity":null }, { "name":"darrenItem245", "type":"C", "status":"COMPLETED", "notes":"exampleNotes", "expected_quantity":4, "other":"test", "actual_quantity":null }, { "name":"darrenItem245", "type":"C", "status":"COMPLETED", "notes":"exampleNotes", "expected_quantity":4, "other":"test", "actual_quantity":null }, { "name":"darrenItem", "type":"C", "status":"COMPLETED", "notes":"exampleNotes", "expected_quantity":4, "other":"test", "actual_quantity":null } ], "activities":[ { "type":"JOB_VIEWED", "created_at":"2014-01-13T10:15:00+00:00" }, { "type":"JOB_VIEWED", "created_at":"2014-01-13T10:15:00+00:00" }, { "type":"JOB_STARTED", "created_at":"2014-01-13T10:16:00+00:00" }, { "type":"JOB_ARRIVED", "created_at":"2014-01-13T10:21:00+00:00" } ], "post_job_checks":[ ], "pre_job_checks":[ ], "photos":[ ], "invoices":[ ] }
Example curl request
https://api.mymobileworkers.com:8181/api/1/jobs/status?api_key=YOUR_KEY&status=NEW&start_date=2013-01-10%2012:12:12&end_date=2013-05-25%2012:12:12
