Difference between revisions of "Get Jobs By Status"

From MyMobileWorkers API
Jump to: navigation, search
(→‎Example response)
(→‎Example response)
Line 32: Line 32:
  
 
== Example response ==
 
== Example response ==
−
<textarea rows="2" cols="20" wrap="hard">
 
  
 
<source lang="java">
 
<source lang="java">
−
{"jobs":[{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:27:57+00:00","job_number":"RB45603_45789","repair_description":"x1 operative to clear basic 3-way Traffic light se","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"ANDREWSMITH","email":"asdfds@asdfsdfasdf.com","color":"FA556A","engineer_registration_number":null},"address_1":"Broadmeadow LaneBishopsteignton Road","address_2":"Teignmouth","address_3":null,"address_4":null,"postcode":"TQ14 9AE","contact_name":"Leigh Newton - Mcnicholas Plc","contact_number_1":"07557921078","contact_number_2":"02082366323","special_instructions":"x1 operative to clear basic 3-way Traffic light set up. ","timeslot":"2013-05-20T18:00:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:29:48+00:00","job_number":"RM45752_45938","repair_description":"2 Way Lights + Setup 30mph ASAP","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"JAMESSHAW","email":"sdfd@asdasd.com","color":"135902","engineer_registration_number":null},"address_1":"98a Kings Road","address_2":"Birkhamsted","address_3":null,"address_4":null,"postcode":"HP4 3BD","contact_name":"David Amos - Balfour Beatty Utility Solutions","contact_number_1":"01142329727","contact_number_2":"","special_instructions":"2 Way Lights + Setup 30mph ASAP","timeslot":"2013-05-20T12:25:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:56:33+00:00","job_number":"SE45655_45940","repair_description":"Setup & install temporary 4 way lights whilst UKPN","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"PHILIPWESSELS","email":"asdsasd@asdasds.com","color":"F830A0","engineer_registration_number":null},"address_1":"Notting Hill Gate","address_2":"London ","address_3":null,"address_4":null,"postcode":"W11 3HX","contact_name":"Paula Carvalho - Westminster Transerv","contact_number_1":"07766902707","contact_number_2":"","special_instructions":"Setup & install temporary 4 way lights whilst UKPN disconnect existing lights and install new meter. Job will only last 1-2 hours. NO TM PLAN","timeslot":"2013-05-21T10:30:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:57:54+00:00","job_number":"JD45527_45942","repair_description":"4 way lights + setup 30mph. MAN ON SITE","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"RAJINDERSINGH","email":"fdassddssd@asdasgfds.com","color":"3BA646","engineer_registration_number":null},"address_1":"Magpie Hall Road Junc High Road and The Comm","address_2":"Bushey Heath Bushey","address_3":null,"address_4":null,"postcode":"WD23 1NU","contact_name":"Mick Owen - Balfour Beatty Utility Solutions ","contact_number_1":"00000000000","contact_number_2":"","special_instructions":"Full address:Magpie Hall Road Junc High Road and The Common4 way lights + setup 30mph. MAN ON SITE","timeslot":"2013-05-21T08:00:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]}]}
+
{"jobs":[{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:27:57+00:00","job_number":"RB45603_45789","repair_description":"x1
 +
operative to clear basic 3-way Traffic light
 +
se","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"ANDREWSMITH","email":"asdfds@asdfsdfasdf.com","color":"FA556A","engineer_registration_number":null},"address_1":"Broadmeadow
 +
LaneBishopsteignton
 +
Road","address_2":"Teignmouth","address_3":null,"address_4":null,"postcode":"TQ14
 +
9AE","contact_name":"Leigh Newton - Mcnicholas
 +
Plc","contact_number_1":"07557921078","contact_number_2":"02082366323","special_instructions":"x1
 +
operative to clear basic 3-way Traffic light set up.
 +
","timeslot":"2013-05-20T18:00:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:29:48+00:00","job_number":"RM45752_45938","repair_description":"2
 +
Way Lights + Setup 30mph
 +
ASAP","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"JAMESSHAW","email":"sdfd@asdasd.com","color":"135902","engineer_registration_number":null},"address_1":"98a
 +
Kings
 +
Road","address_2":"Birkhamsted","address_3":null,"address_4":null,"postcode":"HP4
 +
3BD","contact_name":"David Amos - Balfour Beatty Utility
 +
Solutions","contact_number_1":"01142329727","contact_number_2":"","special_instructions":"2
 +
Way Lights + Setup 30mph
 +
ASAP","timeslot":"2013-05-20T12:25:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:56:33+00:00","job_number":"SE45655_45940","repair_description":"Setup
 +
& install temporary 4 way lights whilst
 +
UKPN","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"PHILIPWESSELS","email":"asdsasd@asdasds.com","color":"F830A0","engineer_registration_number":null},"address_1":"Notting
 +
Hill Gate","address_2":"London
 +
","address_3":null,"address_4":null,"postcode":"W11
 +
3HX","contact_name":"Paula Carvalho - Westminster
 +
Transerv","contact_number_1":"07766902707","contact_number_2":"","special_instructions":"Setup
 +
& install temporary 4 way lights whilst UKPN disconnect existing lights
 +
and install new meter. Job will only last 1-2 hours. NO TM
 +
PLAN","timeslot":"2013-05-21T10:30:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:57:54+00:00","job_number":"JD45527_45942","repair_description":"4
 +
way lights + setup 30mph. MAN ON
 +
SITE","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"RAJINDERSINGH","email":"fdassddssd@asdasgfds.com","color":"3BA646","engineer_registration_number":null},"address_1":"Magpie
 +
Hall Road Junc High Road and The Comm","address_2":"Bushey Heath
 +
Bushey","address_3":null,"address_4":null,"postcode":"WD23
 +
1NU","contact_name":"Mick Owen - Balfour Beatty Utility Solutions
 +
","contact_number_1":"00000000000","contact_number_2":"","special_instructions":"Full
 +
address:Magpie Hall Road Junc High Road and The Common4 way lights +
 +
setup 30mph. MAN ON
 +
SITE","timeslot":"2013-05-21T08:00:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]}]}
 
</source>
 
</source>
−
</textarea>
 
  
 
== Example curl request ==
 
== Example curl request ==
  
 
http://10.1.0.75:8080/api/1/jobs/status?api_key=YOURKEY&status=NEW&start_date=2013-01-10%2012:12:12&end_date=2013-05-25%2012:12:12
 
http://10.1.0.75:8080/api/1/jobs/status?api_key=YOURKEY&status=NEW&start_date=2013-01-10%2012:12:12&end_date=2013-05-25%2012:12:12

Revision as of 13:17, 20 May 2013

Summary

Jobs
URL http://:base_url/:api_path/:version/jobs/status?api_key=<your key>&status=<a valid status>&start_date=<timestamp>&end_date=<timestamp>
Type GET
Params: api_key required
status required
start_date required
end_date required
Response JSON


The jobs/status method returns all jobs listed between the specified date range, currently in the specified status


Example response 

{"jobs":[{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:27:57+00:00","job_number":"RB45603_45789","repair_description":"x1
operative to clear basic 3-way Traffic light
se","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"ANDREWSMITH","email":"asdfds@asdfsdfasdf.com","color":"FA556A","engineer_registration_number":null},"address_1":"Broadmeadow
LaneBishopsteignton
Road","address_2":"Teignmouth","address_3":null,"address_4":null,"postcode":"TQ14
9AE","contact_name":"Leigh Newton - Mcnicholas
Plc","contact_number_1":"07557921078","contact_number_2":"02082366323","special_instructions":"x1
operative to clear basic 3-way Traffic light set up.
","timeslot":"2013-05-20T18:00:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:29:48+00:00","job_number":"RM45752_45938","repair_description":"2
Way Lights + Setup 30mph
ASAP","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"JAMESSHAW","email":"sdfd@asdasd.com","color":"135902","engineer_registration_number":null},"address_1":"98a
Kings
Road","address_2":"Birkhamsted","address_3":null,"address_4":null,"postcode":"HP4
3BD","contact_name":"David Amos - Balfour Beatty Utility
Solutions","contact_number_1":"01142329727","contact_number_2":"","special_instructions":"2
Way Lights + Setup 30mph
ASAP","timeslot":"2013-05-20T12:25:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:56:33+00:00","job_number":"SE45655_45940","repair_description":"Setup
& install temporary 4 way lights whilst
UKPN","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"PHILIPWESSELS","email":"asdsasd@asdasds.com","color":"F830A0","engineer_registration_number":null},"address_1":"Notting
Hill Gate","address_2":"London
","address_3":null,"address_4":null,"postcode":"W11
3HX","contact_name":"Paula Carvalho - Westminster
Transerv","contact_number_1":"07766902707","contact_number_2":"","special_instructions":"Setup
& install temporary 4 way lights whilst UKPN disconnect existing lights
and install new meter. Job will only last 1-2 hours. NO TM
PLAN","timeslot":"2013-05-21T10:30:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]},{"type":"repair","status":"NEW","duration":0,"product":null,"created_at":"2013-05-20T11:57:54+00:00","job_number":"JD45527_45942","repair_description":"4
way lights + setup 30mph. MAN ON
SITE","repair_code":null,"notes":null,"gas_safe_inspection":[],"satisfaction":null,"fault":null,"failure_type":null,"mobile_user":{"username":"RAJINDERSINGH","email":"fdassddssd@asdasgfds.com","color":"3BA646","engineer_registration_number":null},"address_1":"Magpie
Hall Road Junc High Road and The Comm","address_2":"Bushey Heath
Bushey","address_3":null,"address_4":null,"postcode":"WD23
1NU","contact_name":"Mick Owen - Balfour Beatty Utility Solutions
","contact_number_1":"00000000000","contact_number_2":"","special_instructions":"Full
address:Magpie Hall Road Junc High Road and The Common4 way lights +
setup 30mph. MAN ON
SITE","timeslot":"2013-05-21T08:00:00+00:00","activities":[],"items":[],"signee":null,"attachments":[],"parts":[],"post_job_checks":[],"pre_job_checks":[],"photos":[],"invoices":[]}]}

Example curl request

http://10.1.0.75:8080/api/1/jobs/status?api_key=YOURKEY&status=NEW&start_date=2013-01-10%2012:12:12&end_date=2013-05-25%2012:12:12

Retrieved from ‘https://docs.mymobileworkers.com/index.php?title=Get_Jobs_By_Status&oldid=85’
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox