Darren.atherton: /* Example response */

2014-06-23T14:55:39Z

‎Example response

Darren.atherton: /* Summary */

2014-02-06T11:04:27Z

‎Summary

Darren.atherton: Created page with "== Summary == {| border="1" class="wikitable" ! Jobs ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/jobs/today?api_key=YOUR_KEY |- ! Type | co..."

2014-02-06T11:03:57Z

Created page with "== Summary == {| border="1" class="wikitable" ! Jobs ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/jobs/today?api_key=YOUR_KEY |- ! Type | co..."

New page

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

! Jobs
! colspan="2" |
|-
! URL
| colspan="2" | http://:base_url/:api_path/:version/jobs/today?api_key=YOUR_KEY
|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
! Response
| colspan="2" | JSON
|}

The jobs for today method returns all jobs listed for exactly today's' date. If no such jobs exist, an empty list is returned.

== Example response ==

<source lang="java">
{
"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
},
"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":[

]
}
</source>

== Example curl request ==

http://live.mymobileworkers.com:8080/api/1/jobs/today?api_key=YOUR_KEY

← Older revision		Revision as of 11:04, 6 February 2014
Line 19:		Line 19:


−	The jobs for today method returns all jobs listed for ~~exactly~~ today's' date. If no such jobs exist, an empty list is returned.	+	The jobs for today method returns all jobs listed for today's' date. If no such jobs exist, an empty list is returned.

	== Example response ==		== Example response ==

@@ Line 47: / Line 47: @@
        "color":"AE3B94",
        "engineer_registration_number":null
     },
     "timeslot":null,

Get Jobs For Today - Revision history

Darren.atherton: /* Example response */

Darren.atherton: /* Summary */

Darren.atherton: Created page with "== Summary == {| border="1" class="wikitable" ! Jobs ! colspan="2" | |- ! URL | colspan="2" | http://:base_url/:api_path/:version/jobs/today?api_key=YOUR_KEY |- ! Type | co..."