DanielleH: /* Summary */

2023-09-22T11:50:05Z

‎Summary

DanielleH: /* Summary */

2023-09-22T11:49:52Z

‎Summary

Danielle: /* Example curl request */

2020-11-23T11:09:05Z

‎Example curl request

Ian: /* Example response */

2020-04-05T13:38:09Z

‎Example response

Ian: Created page with "== Summary == {| border="1" class="wikitable" ! Forms ! colspan="2" | |- ! URL | colspan="2" | https://:base_url/:api_path/:version/vehicleChecks/status?api_key=YOUR_KEY&st..."

2020-04-05T13:37:43Z

Created page with "== Summary == {| border="1" class="wikitable" ! Forms ! colspan="2" | |- ! URL | colspan="2" | https://:base_url/:api_path/:version/vehicleChecks/status?api_key=YOUR_KEY&st..."

New page

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

! Forms
! colspan="2" |
|-
! URL
| colspan="2" | https://:base_url/:api_path/:version/vehicleChecks/status?api_key=YOUR_KEY&status=VEHICLE_STATUS&start_date=DATETIME&end_date=DATETIME
|-
! Type
| colspan="2" | GET
|-
! Params:
| api_key || required
|-
!
| status || required
|-
|-
!
| start_date ||
|-
!
| end_date ||
|-
! Response
| colspan="2" | JSON
|}

The Get Vehicle Checks by Status method returns all vehicle checks for a vehicle with a status matching the 'status' parameter.
A start_date and end_date can be specified if required.

== Example response ==

<source lang="java">
{
"vehicle_checks" : [
{
"signature": "",
"registration": {
"registration": "TEST",
"model": "",
"deleted": false,
"make": "",
"vehicleStatus": {
"branchId": null,
"vehicleAvailable": true,
"statusName": "TestStatus",
"additionalInfo": "true",
"helpText": "Vehicle is OK for mobile users to use"
},
"currentMileage": 0,
"motExpiry": null,
"taxExpiry": null,
"lastServiceDate": null,
"lastInspectionDate": null,
"nextServiceDate": null,
"nextInspectionDate": null
},
"createdAt": "2020-02-06T11:17:17+00:00",
"mobile_user": {
"username": "Test User",
"external_id": null,
"color": "A42E5A",
"uat": false,
"engineer_registration_number": null,
"email": "",
"contact_number": "",
"panicked": false,
"lastInternetConnection": null
},
"startMileage": 0,
"defectNotes": null,
"endMileage": null,
"signee": null,
"updatedAt": "2020-02-06T11:17:17+00:00",
"formId": {
"created_at": "2020-02-06T11:17:07+00:00",
"name": "Test",
"id": 2951,
"notes": null,
"mobile_user": {
"username": "Test User",
"external_id": null,
"color": "A42E5A",
"uat": false,
"engineer_registration_number": null,
"email": "",
"contact_number": "",
"panicked": false,
"lastInternetConnection": null
},
"vehicle": {
"registration": "TEST",
"model": "",
"deleted": false,
"make": "",
"vehicleStatus": {
"branchId": null,
"vehicleAvailable": true,
"statusName": "TestStatus",
"additionalInfo": "true",
"helpText": "Vehicle is OK for mobile users to use"
},
"currentMileage": 0,
"motExpiry": null,
"taxExpiry": null,
"lastServiceDate": null,
"lastInspectionDate": null,
"nextServiceDate": null,
"nextInspectionDate": null
},
"updated_at": "2020-02-06T11:17:18+00:00",
"checklist": [
{
"created_at": "2020-02-06T11:17:14+00:00",
"name": "Test1",
"linked_uuid": "52fcadf6-bf20-4285-aecd-b077ad02cba8",
"checklist_questions": [
{
"notes": null,
"question": "Question1",
"answer": "ANSWER1"
},
{
"notes": null,
"question": "Question2",
"answer": null
}
]
},
{
"created_at": "2020-02-06T11:17:16+00:00",
"name": "Test2",
"linked_uuid": null,
"checklist_questions": [
{
"notes": null,
"question": "Question3",
"answer": null
},
{
"notes": null,
"question": "Question4",
"answer": null
}
]
}
]
},
"startFuelLevel": "Test",
"endFuelLevel": null,
"decodedSignature": null,
"customisation_results": []
}
]
}
</source>

== Example curl request ==

curl "https://api.mymobileworkers.com:8181/api/1/vehicleChecks/status?api_key=YOUR_KEY&registration=TEST_STATUS&start_date=2015-05-07%2012:50:44&end_date=2015-06-08%2012:50:44"

← Older revision		Revision as of 11:09, 23 November 2020
Line 160:		Line 160:
	== Example curl request ==		== Example curl request ==

−	curl "https://api.mymobileworkers.com:8181/api/1/vehicleChecks/status?api_key=YOUR_KEY&~~registration~~=TEST_STATUS&start_date=2015-05-07%2012:50:44&end_date=2015-06-08%2012:50:44"	+	curl "https://api.mymobileworkers.com:8181/api/1/vehicleChecks/status?api_key=YOUR_KEY&status=TEST_STATUS&start_date=2015-05-07%2012:50:44&end_date=2015-06-08%2012:50:44"

@@ Line 29: / Line 29: @@
 The Get Vehicle Checks by Status method returns all vehicle checks for a vehicle with a status matching the 'status' parameter.
-A start_date and end_date can be specified if required.
+A start_date and end_date can be specified.
 == Example response ==

@@ Line 19: / Line 19: @@
 |-
+!
-| start_date ||
+| start_date || required
 |-
+!
-| end_date ||
+| end_date || required
 |-
 ! Response

@@ Line 38: / Line 38: @@
+	{
                  "signature": "",
-                 "registration": {
+                 "vehicle": {
                      "registration": "TEST",
                      "model": "",

Get Vehicle Checks By Status - Revision history

DanielleH: /* Summary */

DanielleH: /* Summary */

Danielle: /* Example curl request */

Ian: /* Example response */

Ian: Created page with "== Summary == {| border="1" class="wikitable" ! Forms ! colspan="2" | |- ! URL | colspan="2" | https://:base_url/:api_path/:version/vehicleChecks/status?api_key=YOUR_KEY&st..."