Difference between revisions of "Get Job Updates Between"
From MyMobileWorkers API
(→Example response) |
(→Summary) |
||
| (3 intermediate revisions by one user not shown) | |||
| Line 6: | Line 6: | ||
|- | |- | ||
! URL | ! URL | ||
| − | | colspan="2" | https://:base_url/:api_path/:version/jobs/updated_between?api_key=YOUR_KEY&start_date=DATETIME&end_date=DATETIME&status=JOB_STATUS | + | | colspan="2" | https://:base_url/:api_path/:version/jobs/updated_between?api_key=YOUR_KEY&start_date=DATETIME&end_date=DATETIME&status=JOB_STATUS&branch=BRANCH_NAME |
|- | |- | ||
! Type | ! Type | ||
| Line 20: | Line 20: | ||
| end_date || required | | end_date || required | ||
|- | |- | ||
| − | ! | + | ! |
| − | | status || | + | | branch || optional |
| + | |- | ||
| + | ! | ||
| + | | status || required | ||
|- | |- | ||
! Response | ! Response | ||
| Line 28: | Line 31: | ||
| − | The jobs/updated method returns all jobs that have been updated between the specified start date and end date, optionally you can filter by status to only download complete or failed jobs etc. | + | The jobs/updated method returns all jobs that have been updated between the specified start date and end date, optionally you can filter by status to only download complete or failed jobs etc or which branch the jobs come from. |
| − | + | ||
== Example response == | == Example response == | ||
| Line 374: | Line 376: | ||
curl "https://api.mymobileworkers.com:8181/api/1/jobs/updated_between?start_date=2015-05-07%2012:50:44&end_date=2015-06-08 12:50:44&api_key=APIKEY" | curl "https://api.mymobileworkers.com:8181/api/1/jobs/updated_between?start_date=2015-05-07%2012:50:44&end_date=2015-06-08 12:50:44&api_key=APIKEY" | ||
| − | curl "https://api.mymobileworkers.com:8181/api/1/jobs/updated_between?start_date=2015-05-07%2012:50:44&end_date=2015-06-08 12:50:44&status=JOB_COMPLETED&api_key=APIKEY" | + | curl "https://api.mymobileworkers.com:8181/api/1/jobs/updated_between?start_date=2015-05-07%2012:50:44&end_date=2015-06-08 12:50:44&status=JOB_COMPLETED&api_key=APIKEY&branch=BRANCH_NAME" |
Latest revision as of 13:36, 9 March 2018
[edit] Summary
| Jobs Update Between | ||
|---|---|---|
| URL | https://:base_url/:api_path/:version/jobs/updated_between?api_key=YOUR_KEY&start_date=DATETIME&end_date=DATETIME&status=JOB_STATUS&branch=BRANCH_NAME | |
| Type | GET | |
| Params: | api_key | required |
| start_date | required | |
| end_date | required | |
| branch | optional | |
| status | required | |
| Response | JSON | |
The jobs/updated method returns all jobs that have been updated between the specified start date and end date, optionally you can filter by status to only download complete or failed jobs etc or which branch the jobs come from.
[edit] Example response
{ "secondary_users": [], "type": "repair", "signatures": [], "date": "2017-03-28", "time": null, "status": "NEW", "task": null, "duration": 0, "product": null, "weight": 100.15, "branch": { "name": "BranchA", "number": null, "external_id": null, "contact_name": "Joe Bloggs", "address_1": "", "address_2": "", "address_3": "", "address_4": "", "postcode": "", "created_at": 1473425398000, "contact_number": "06575346575", "contact_email": "branch@example.com" }, "route": { "external_id": null, "route_name": "Liverpool-AM", "route_code": "LIV-001", "route_limit": 180 }, "customer": null, "customer_sites": { "external_id": null, "contact_name": "Joe", "address_1": "29 bath road", "address_2": "", "address_3": "", "address_4": "", "postcode": "la1 3cd", "created_at": 1465210944000, "updated_at": 1465210944000, "contact_number": "06709253543", "contact_email": "joe@example.com", "sic_code": null, "customer_site_emails": [ { "customer_email": "joe@example.com" } ] }, "created_at": "2017-03-28T10:54:41+01:00", "updated_at": "2017-03-28T10:54:41+01:00", "actualStart": null, "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": [], "job_invoices": [], "pre_job_details": [ { "invoice_number": null, "po_no": "TestPo" } ] }
[edit] Example curl request
curl "https://api.mymobileworkers.com:8181/api/1/jobs/updated_between?start_date=2015-05-07%2012:50:44&end_date=2015-06-08 12:50:44&api_key=APIKEY"
curl "https://api.mymobileworkers.com:8181/api/1/jobs/updated_between?start_date=2015-05-07%2012:50:44&end_date=2015-06-08 12:50:44&status=JOB_COMPLETED&api_key=APIKEY&branch=BRANCH_NAME"
