Difference between revisions of "Get Job Updates Since"

From MyMobileWorkers API
Jump to: navigation, search
m (Reverted edits by Ryanmt (talk) to last revision by Darren.atherton)
Line 2: Line 2:
 
{| border="1" class="wikitable"
 
{| border="1" class="wikitable"
  
−
! Jobs Update Between
+
! Jobs Update Since
 
! colspan="2" |  
 
! colspan="2" |  
 
|-
 
|-
 
! URL
 
! URL
−
| colspan="2" |  http://:base_url/:api_path/:version/jobs/updated_between?api_key=YOUR_KEY&start_date=DATETIME&end_date=DATETIME&status=JOB_STATUS
+
| colspan="2" |  http://:base_url/:api_path/:version/jobs/updated?api_key=YOUR_KEY&since=DATETIME
 
|-
 
|-
 
! Type
 
! Type
Line 15: Line 15:
 
|-
 
|-
 
!  
 
!  
−
| start_date || required
+
| since || required
−
|-
+
−
!
+
−
| end_date || required
+
−
|-
+
−
!
+
−
| status ||
+
 
|-
 
|-
 +
 
! Response
 
! Response
 
| colspan="2" | JSON
 
| colspan="2" | JSON
Line 28: Line 23:
  
  
−
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 since the specified "since" parameter
  
  
Line 344: Line 339:
  
 
== Example curl request ==
 
== Example curl request ==
−
curl "http://live.mymobileworkers.com:8080/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 "http://live.mymobileworkers.com:8080/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 "http://live.mymobileworkers.com:8080/api/1/jobs/updated?api_key=YOUR_KEY&since=2013-05-20%2012:12:12"

Revision as of 08:36, 7 July 2015

Summary

Jobs Update Since
URL http://:base_url/:api_path/:version/jobs/updated?api_key=YOUR_KEY&since=DATETIME
Type GET
Params: api_key required
since required
Response JSON


The jobs/updated method returns all jobs that have been updated since the specified "since" parameter


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

curl "http://live.mymobileworkers.com:8080/api/1/jobs/updated?api_key=YOUR_KEY&since=2013-05-20%2012:12:12"

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

Variants
Actions
Navigation
Toolbox