The Zonar Open Maintenance Interface (OMI)

Version 1.1.8
This Manual describes Production Protocol version 2.10 / 1.15

Recent Changes

1.0 Introduction

• 1.1 General Information
• 1.2 Account Code
• 1.3 Identification and Authentication
• 1.3A Sessions
• 1.4 Action Information
• 1.5 Additional Information
• 1.6 Security Considerations
• 1.7 User-Agent Header Requirements

2.0 Add an Asset

• 2.1 Request Data
• 2.2 Data Returned

3.0 Get an Asset

• 3.1 Request Data
• 3.2 Data Returned

4.0 Get (new) Inspections

• 4.1 Request Data
• 4.2 Data Returned

5.0 Get Inspection details

• 5.1 Request Data
• 5.2 Data Returned

6.0 Add Repair

• 6.1 Request Data
• 6.2 Data Returned

7.0 Get Aux Item(s)

• 7.1 Request Data
• 7.2 Data Returned

8.0 Get Mechanics

• 8.1 Request Data
• 8.2 Data Returned

9. Get Locations

• 9.1 Request Data
• 9.2 Data Returned

10. Get Assets

• 10.1 Request Data
• 10.1A Specifying a Particular Asset (Asset Target)
• 10.2 Data Returned

11. Mileage Reporting

• 11.1 Request Data
• 11.2 Data Returned

12. Expired Operators Report

• 12.1 Request Data
• 12.2 Data Returned

13. Expired Assets Report

• 13.1 Request Data
• 13.2 Data Returned

14. Expired Aux Items Report

• 14.1 Request Data
• 14.2 Data Returned

15. Get Expiry Types

• 15.1 Request Data
• 15.2 Data Returned

16. Get Operators

• 16.1 Request Data
• 16.2 Data Returned

17. Get Inspection Configs

• 17.1 Request Data
• 17.2 Data Returned

18. Get Defect Information

• 18.1 Request Data
• 18.2 Data Returned

19. Get Yard Events

• 19.1 Request Data
• 19.2 Data Returned

20. Asset Types

• 20.1 Request Data
• 20.2 Data Returned

21. Inspection Statistics

• 21.1 Request Data
• 21.2 Data Returned

22. Edit an Asset

• 22.1 Request Data
• 22.2 Data Returned

23. GPS Mileage Report

• 23.1 Request Data
• 23.2 Data Returned

24. GPS Idle/Stop Report

• 24.1 Request Data
• 24.2 Data Returned

25. Export a Path

• 25.1 Request Data
• 25.2 Data Returned
• 25.2A KML Return Data
• 25.2B Binary Return Data
• 25.2C XML Return Data
• 25.2D CSV Return Data

26. Current Location

• 26.1 Request Data
• 26.2 Data Returned
• 26.2A KML Return Data
• 26.2B Binary Return Data

27. Speed Report

• 27.1 Request Data
• 27.2 Data Returned

28. Inspection Data

• 28.1 Request Data
• 28.2 Data Returned

29. Asset Activity

• 29.1 Request Data
• 29.2 Data Returned

30. Routes

• 30.1 Request Data
• 30.2 Data Returned

31. Add a Location of Interest (LOI)* / GPS Zone

• 31.1 Request Data
• 31.2 Data Returned

32. Edit a Location of Interest (LOI)* / GPS Zone

• 32.1 Request Data
• 32.2 Data Returned

33. Delete a Location of Interest (LOI)* / GPS Zone

• 33.1 Request Data
• 33.2 Data Returned

34. List Locations of Interest (LOIs)* / GPS Zones

• 34.1 Request Data
• 34.2 Data Returned

35. Add an Operator

• 35.1 Request Data
• 35.2 Data Returned

36. Edit an Existing Operator

• 36.1 Request Data
• 36.2 Data Returned

37. GPS Schedule Report

• 37.1 Request Data
• 37.2 Data Returned

38. Find Nearest Address (reverse geocode)

• 38.1 Request Data
• 38.2 Data Returned

39. Edit Operator Status

• 39.1 Request Data
• 39.2 Data Returned

40. Delete Operator

• 40.1 Request Data
• 40.2 Data Returned

41. Manage LOI Categories*

• 41.1 Add
• 41.2 Delete
• 41.3 Edit
• 41.4 List

42. Export Audit Report

• 42.1 Request Data
• 42.2 Data Returned

43. List Personnel Events

• Request Data
• Data Returned

44. Generic Data

• Request Data
• Data Returned
• Data Labels

45. Edit Asset Status

• Request Data
• Data Returned

46. Edit Asset GPS Units

• Request Data
• Data Returned

47. Get GPS Units

• Request Data
• Data Returned

52. Get GPS Phone Home

• Request Data
• Data Returned

53. Get Resource Attributes

• Request Data
• Data Returned

54. Add Resource Attributes

• Request Data
• Data Returned

55. Edit Resource Attributes

• Request Data
• Data Returned

56. Delete Resource Attributes

• Request Data
• Data Returned

57. Admin List Resource Attributes Assignments

• Request Data
• Data Returned

58. Admin Add Resource Attributes Assignments

• Request Data
• Data Returned

59. Admin Delete Resource Attributes Assignments

• Request Data
• Data Returned

60. Get Attributes Filters

• Request Data
• Data Returned

61. Add Attributes Filters

• Request Data
• Data Returned

62. Edit Attributes Filters

• Request Data
• Data Returned

63. Delete Attributes Filters

• Request Data
• Data Returned

64. Path Summary

• Request Data
• Data Returned

65. Add Location

• Request Data
• Data Returned

66. Edit Location

• Request Data
• Data Returned

67. Find Nearest Point (Forward Geocode)

• Request Data
• Data Returned

68. Jbus Trip Report

• Request Data
• Data Returned

69. Inspection Timecard

• Request Data
• Data Returned

72. Add User

• Request Data
• Data Returned

73. Edit User

• Request Data
• Data Returned

74. Delete User

• Request Data
• Data Returned

75. List Users

• Request Data
• Data Returned

76. Get User Roles

• Request Data
• Data Returned

Appendices

Appendix a. Error messages

Appendix b. Success messages

Appendix c. Error Codes

Appendix d. Versioning

• Current versions.

Appendix e. Special Functions