Get jobs assigned to route - Revision history

Ian: /* Example curl request */

2016-11-14T12:49:58Z

‎Example curl request

Darren.atherton: /* Example curl request */

2013-12-05T10:22:26Z

‎Example curl request

Darren.atherton at 15:58, 14 November 2013

2013-11-14T15:58:48Z

Darren.atherton at 15:49, 14 November 2013

2013-11-14T15:49:24Z

Darren.atherton at 16:07, 11 November 2013

2013-11-11T16:07:42Z

Darren.atherton: Created page with "== Summary == {| border="1" class="wikitable" ! Jobs jobs assigned to route ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/routes/route/jobs?a..."

2013-11-11T16:05:54Z

Created page with "== Summary == {| border="1" class="wikitable" ! Jobs jobs assigned to route ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/routes/route/jobs?a..."

New page

== Summary ==
{| border="1" class="wikitable"

! Jobs jobs assigned to route
! colspan="2" |
|-
! URL
| colspan="2" | http://:base_url/:api_path/:version/routes/route/jobs?api_key=YOUR_KEY&route_code=CODE&route_date=DATE
|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
!
| route_code || required
|-
!
| route_date || required
|-
! Response
| colspan="2" | JSON
|}

The jobs by route method returns all jobs that have been assigned to the route specified by the route code in the 'route_code' parameter, and which have the date specified in the 'route_date' parameter.

== Example response ==

<source lang="java">
{
"jobs":[
{
"type":"repair",
"date":"2013-12-05",
"time":"10:00:00",
"status":"NEW",
"duration":0,
"product":"Internet",
"created_at":"2013-11-07T15:09:49+00:00",
"job_number":"JOB-0103",
"repair_description":null,
"repair_code":null,
"notes":null,
"gas_safe_inspection":[

],
"satisfaction":null,
"fault":"Doesn't work",
"failure_type":null,
"mobile_user":{
"username":"darren_mobile",
"email":"darren.atherton@momote.com",
"color":"FA909B",
"engineer_registration_number":null
},
"address_1":"567 Lord Street",
"address_2":"Liverpool",
"address_3":"Merseyside",
"address_4":"",
"postcode":"L236YU",
"contact_name":"Fred Jones",
"contact_number_1":"1234567890",
"contact_number_2":"1234567890",
"special_instructions":"Ask for Fred at the gate",
"timeslot":"2013-12-05T10:00:00+00:00",
"customer":{
"name":"test",
"created_at":1382956809000,
"address_1":"1 the street",
"address_2":null,
"address_3":null,
"address_4":null,
"postcode":"WA12 0JQ",
"contact_name":"testName",
"external_id":"hello",
"updated_at":1382956809000,
"contact_number":"01942295900"
},
"external_id":null,
"signee":null,
"attachments":[

],
"items":[

],
"activities":[

],
"parts":[

],
"post_job_checks":[

],
"pre_job_checks":[

],
"photos":[

],
"invoices":[

],
"asset_histories":[

],
"route":{
"external_id":null,
"route_name":"Liverpool-AM",
"route_code":"LIV-001",
"route_limit":180.0
}
},
{
"type":"repair",
"date":"2013-12-05",
"time":"11:00:00",
"status":"NEW",
"duration":0,
"product":"",
"created_at":"2013-11-07T15:10:54+00:00",
"job_number":"JOB-0104",
"repair_description":null,
"repair_code":null,
"notes":null,
"gas_safe_inspection":[

],
"satisfaction":null,
"fault":"",
"failure_type":null,
"mobile_user":{
"username":"darren_mobile",
"email":"darren.atherton@momote.com",
"color":"FA909B",
"engineer_registration_number":null
},
"address_1":"89 Sale Road",
"address_2":"Warrington",
"address_3":"",
"address_4":"",
"postcode":"L456YT",
"contact_name":"Elaine Griffiths",
"contact_number_1":"1234567890",
"contact_number_2":"",
"special_instructions":"",
"timeslot":"2013-12-05T11:00:00+00:00",
"customer":{
"name":"test",
"created_at":1382956809000,
"address_1":"1 the street",
"address_2":null,
"address_3":null,
"address_4":null,
"postcode":"WA12 0JQ",
"contact_name":"testName",
"external_id":"hello",
"updated_at":1382956809000,
"contact_number":"01942295900"
},
"external_id":null,
"signee":null,
"attachments":[

],
"items":[

],
"activities":[

],
"parts":[

],
"post_job_checks":[

],
"pre_job_checks":[

],
"photos":[

],
"invoices":[

],
"asset_histories":[

],
"weight":100.15,
"route":{
"external_id":null,
"route_name":"Liverpool-AM",
"route_code":"LIV-001",
"route_limit":180.0
}
}
]
}
</source>

== Example curl request ==

http://live.mymobileworkers.com/api/1/routes/route/jobs?api_key=TEST_KEY&route_code=ROUTE-001&route_date=2013-12-05"

← Older revision		Revision as of 12:49, 14 November 2016
Line 204:		Line 204:
	== Example curl request ==		== Example curl request ==

−	curl "http://~~live~~.mymobileworkers.com:8080/api/1/routes/route/jobs?api_key=TEST_KEY&route_code=ROUTE-001&route_date=2013-12-05"	+	curl "http://api.mymobileworkers.com:8080/api/1/routes/route/jobs?api_key=TEST_KEY&route_code=ROUTE-001&route_date=2013-12-05"

← Older revision		Revision as of 10:22, 5 December 2013
Line 204:		Line 204:
	== Example curl request ==		== Example curl request ==

−	curl "http://live.mymobileworkers.com/api/1/routes/route/jobs?api_key=TEST_KEY&route_code=ROUTE-001&route_date=2013-12-05"	+	curl "http://live.mymobileworkers.com:8080/api/1/routes/route/jobs?api_key=TEST_KEY&route_code=ROUTE-001&route_date=2013-12-05"

← Older revision		Revision as of 15:58, 14 November 2013
Line 204:		Line 204:
	== Example curl request ==		== Example curl request ==

−	http://live.mymobileworkers.com/api/1/routes/route/jobs?api_key=TEST_KEY&route_code=ROUTE-001&route_date=2013-12-05"	+	curl "http://live.mymobileworkers.com/api/1/routes/route/jobs?api_key=TEST_KEY&route_code=ROUTE-001&route_date=2013-12-05"

@@ Line 2: / Line 2: @@
 {| border="1" class="wikitable"
-! Jobs jobs assigned to route
+! Jobs assigned to route
 ! colspan="2" |
 |-

@@ Line 23: / Line 23: @@
 | colspan="2" | JSON
 |}
 The jobs by route method returns all jobs that have been assigned to the route specified by the route code in the 'route_code' parameter, and which have the date specified in the 'route_date' parameter.
 == Example response ==
@@ Line 52: / Line 50: @@
           "failure_type":null,
           "mobile_user":{
-             "username":"darren_mobile",
+             "username":"test_username",
-             "email":"darren.atherton@momote.com",
+             "email":"testing@momote.com",
              "color":"FA909B",
              "engineer_registration_number":null
@@ Line 135: / Line 133: @@
           "failure_type":null,
           "mobile_user":{
-             "username":"darren_mobile",
+             "username":"test_username",
-             "email":"darren.atherton@momote.com",
+             "email":"tester@momote.com",
              "color":"FA909B",
              "engineer_registration_number":null