1 Scope
This document specifies a communication scheme for providing mobile machine status data from a telematics provider's server to a third party client application over a network. Data is collected from the mobile machine using a telematics data recording device and stored on the telematics provider's server. This document describes the communication log used to request data from the server and the server response containing specific data elements used to analyse the performance and operational status of the machine.
This document applies to mobile earth-moving machines as defined in ISO 6165 and mobile road construction machines equipped with positioning and time instrumentation as defined in ISO 22242.
This document does not apply to on-board data collection, on-board communication protocols (e.g. CAN bus) or the wireless transmission of mobile machinery data to a telematics provider server after the data has been collected by a logger (see Figure 1).
2 Normative references
The contents of the following documents constitute essential provisions of this document by means of normative references in the text. Where a reference is dated, only the version corresponding to that date applies to this document; where a reference is not dated, the latest version (including all change orders) applies to this document.
3 Terms and definitions and abbreviations
3.1 Terms and definitions
The following terms and definitions apply to this document.
4 Data management and access control
4.1 Minimum response cycle
The minimum response time from the telematics vendor's server to the third party application should be 15 min.
The server provides the final known data to the application and is not dependent on the machine to server update rate. The actual call-in time to the machine may vary depending on cell coverage, telematics settings, etc., so the final known data can be stored for a long time and the data transfer between the application's servers can remain constant.
Data providers can cache telematics data or rate limit responses to provide the highest quality of service possible. 4.2 Editing data element updates
The data identified in this document will be modified at any time in a controlled manner as specified in ISO 15143-1;2010, A.2, and the updated .XSD file will be available at http;// www.jcmanet.or.jp/english2017/ISO/15143/-3/上发布. The procedures specified in Appendix E shall be followed.
Each request will contain an Acceptable Header to negotiate the definition of the data required in the response. The Acceptable Header will be associated with the version of the ISO file. The version will be the date string (YYYYMMDD) when the ISO file was published. See Table 2 for a list of versions and an example date string.
5 Response format
This document recommends and describes the application of one of two representation formats, XML version 1.0 or JSON.
For the examples in this document, XML version 1.0 is used. The recommended encoding is UTF-8. XML files are stand-alone documents. Each endpoint provides its own XML schema, including the common schema located at http;// www. jcmanet. or. jp/english2017/ISO/15143/-3/20190501/common.xsd. A file or stream containing an XML document consists of one or more records. Each record consists of several fields, details of which are given below. The XML document is sent without encapsulation (e.g. SOAP). The Internet media type is text/ xml. XML is the preferred representation format.
JSON should conform to the ECMA-404 standard representation and the JSON naming convention should adhere to the XML protocol. If schema validation is required, then the XML representation format is preferred.
6 XML declaration of the link definition segment
7 Paging
All endpoints that return more than one list of device or telematics data should be paginated. Navigation is controlled by the page number parameter displayed on the endpoint URL. Each endpoint that provides paging should also include links for easy navigation to the current page (self), previous page (prev), next page (next) and last page (last). By default, up to 100 records are returned per page.
8 Discoverability
8.1 General rules
Integrators who use this document are encouraged to discover the data provided. Therefore, the endpoints presented in this document contain sets of links that allow traversal of data pages and links to other endpoints in the standard. This allows programs to traverse these links and query the data supported by each implementation. There are two classifications of endpoints: snapshot (see 8.2) and time series (see 8.3). Snapshot endpoints return data from a data queue (see 8.2.2) or from a single device (see 8.23).
8.2 Snapshot endpoints
8.2.1 Overview
The set of snapshot endpoints listed in 8.2.2 and 8.2.3 provide a snapshot view of a queue or a separate device using a generic schema. Snapshots are individual points in time. Time series data, such as fault codes and switchover status, are not included in the snapshot view.
8.2.2 Snapshot queues
The snapshot queue endpoint is defined as URL:/Fleet/{pagedNumber}. The snapshot queue endpoint uses the generic schema (see Appendix A). This endpoint provides a snapshot view of the queue. This endpoint is paged, with a default of 100 records per page (see Appendix C).
The detailed specification of each data element is listed in Chapter 11.
9 Date and time formatting
The format of all date and time stamps in EI documents is "date and time" as specified in ISO 8601 (all parts), including year, month, day, hour, minute and second; it does not include decimal seconds. If the information available to the server does not include minutes and seconds, then the minutes and seconds are set to zero. The UTC indicator ("Z") is used to indicate Universal Coordinated Time (UTC).
Data and time are expressed as YYYY-MM-DDThh: mm:ssZ. Note: Minutes and seconds are optional as specified in ISO 8601 (all parts).
10 Data field summary
The data elements identified in this document are summarised in Table 3 in the order in which they are presented in the .XML response to the request. The parameters in brackets in Table 3 are the names of the data elements and attributes in the .XSD file.
Appendix A contains a cross-reference table for the harmonisation of data element names and value domains as defined in ISO 15143-2.
11 Description of data fields
11.1 General requirements
The endpoint (request) shall be sent from the third party application to the telematics provider server. 11.2 to 11.21 contain example URLs describing the endpoint. Two optional illustrative examples are listed below.
12 Data schema
12.1 Generic mode
This schema is shared between all endpoints and is used to construct queue elements and associated complex types, see Appendix C.12.2 Time Series Schema
This schema is shared among the time series overview endpoints and is used to construct queue elements and associated hyperlinks and data elements, see Appendix D.
13 Syntax errors
The Supplier shall follow the standard HTTP protocol as specified in IETFRFC 7231, which uses the echoes shown in Table 5. Specifically, the responses given in Table 5 are used in that protocol.
Appendix A (informative) Data relationship of this document to ISO 15143-2
Appendix B (informative) Data support and collection
Appendix C (Informative): Generic model
Appendix D (informative) Time series models
Appendix E (normative) Process for adding new data elements to this document
Bibliography
1 Scope
2 Normative references
3 Terms and definitions and abbreviations
4 Data management and access control
5 Response format
6 XML declaration of the link definition segment
7 Paging
8 Discoverability
9 Date and time formatting
10 Data field summary
11 Description of data fields
12 Data schema
13 Syntax errors
Appendix A (informative) Data relationship of this document to ISO 15143-2
Appendix B (informative) Data support and collection
Appendix C (Informative): Generic model
Appendix D (informative) Time series models
Appendix E (normative) Process for adding new data elements to this document
Bibliography
Standard
GB/T 35484.3-2021 Earth-moving machinery and mobile road construction machinery—Worksite data exchange—Part 3:Telematics data (English Version)
Standard No.
GB/T 35484.3-2021
Status
valid
Language
English
File Format
PDF
Word Count
31000 words
Price(USD)
930.0
Implemented on
2022-7-1
Delivery
via email in 1~5 business day
Detail of GB/T 35484.3-2021
Standard No.
GB/T 35484.3-2021
English Name
Earth-moving machinery and mobile road construction machinery—Worksite data exchange—Part 3:Telematics data
1 Scope
This document specifies a communication scheme for providing mobile machine status data from a telematics provider's server to a third party client application over a network. Data is collected from the mobile machine using a telematics data recording device and stored on the telematics provider's server. This document describes the communication log used to request data from the server and the server response containing specific data elements used to analyse the performance and operational status of the machine.
This document applies to mobile earth-moving machines as defined in ISO 6165 and mobile road construction machines equipped with positioning and time instrumentation as defined in ISO 22242.
This document does not apply to on-board data collection, on-board communication protocols (e.g. CAN bus) or the wireless transmission of mobile machinery data to a telematics provider server after the data has been collected by a logger (see Figure 1).
2 Normative references
The contents of the following documents constitute essential provisions of this document by means of normative references in the text. Where a reference is dated, only the version corresponding to that date applies to this document; where a reference is not dated, the latest version (including all change orders) applies to this document.
3 Terms and definitions and abbreviations
3.1 Terms and definitions
The following terms and definitions apply to this document.
4 Data management and access control
4.1 Minimum response cycle
The minimum response time from the telematics vendor's server to the third party application should be 15 min.
The server provides the final known data to the application and is not dependent on the machine to server update rate. The actual call-in time to the machine may vary depending on cell coverage, telematics settings, etc., so the final known data can be stored for a long time and the data transfer between the application's servers can remain constant.
Data providers can cache telematics data or rate limit responses to provide the highest quality of service possible. 4.2 Editing data element updates
The data identified in this document will be modified at any time in a controlled manner as specified in ISO 15143-1;2010, A.2, and the updated .XSD file will be available at http;// www.jcmanet.or.jp/english2017/ISO/15143/-3/上发布. The procedures specified in Appendix E shall be followed.
Each request will contain an Acceptable Header to negotiate the definition of the data required in the response. The Acceptable Header will be associated with the version of the ISO file. The version will be the date string (YYYYMMDD) when the ISO file was published. See Table 2 for a list of versions and an example date string.
5 Response format
This document recommends and describes the application of one of two representation formats, XML version 1.0 or JSON.
For the examples in this document, XML version 1.0 is used. The recommended encoding is UTF-8. XML files are stand-alone documents. Each endpoint provides its own XML schema, including the common schema located at http;// www. jcmanet. or. jp/english2017/ISO/15143/-3/20190501/common.xsd. A file or stream containing an XML document consists of one or more records. Each record consists of several fields, details of which are given below. The XML document is sent without encapsulation (e.g. SOAP). The Internet media type is text/ xml. XML is the preferred representation format.
JSON should conform to the ECMA-404 standard representation and the JSON naming convention should adhere to the XML protocol. If schema validation is required, then the XML representation format is preferred.
6 XML declaration of the link definition segment
7 Paging
All endpoints that return more than one list of device or telematics data should be paginated. Navigation is controlled by the page number parameter displayed on the endpoint URL. Each endpoint that provides paging should also include links for easy navigation to the current page (self), previous page (prev), next page (next) and last page (last). By default, up to 100 records are returned per page.
8 Discoverability
8.1 General rules
Integrators who use this document are encouraged to discover the data provided. Therefore, the endpoints presented in this document contain sets of links that allow traversal of data pages and links to other endpoints in the standard. This allows programs to traverse these links and query the data supported by each implementation. There are two classifications of endpoints: snapshot (see 8.2) and time series (see 8.3). Snapshot endpoints return data from a data queue (see 8.2.2) or from a single device (see 8.23).
8.2 Snapshot endpoints
8.2.1 Overview
The set of snapshot endpoints listed in 8.2.2 and 8.2.3 provide a snapshot view of a queue or a separate device using a generic schema. Snapshots are individual points in time. Time series data, such as fault codes and switchover status, are not included in the snapshot view.
8.2.2 Snapshot queues
The snapshot queue endpoint is defined as URL:/Fleet/{pagedNumber}. The snapshot queue endpoint uses the generic schema (see Appendix A). This endpoint provides a snapshot view of the queue. This endpoint is paged, with a default of 100 records per page (see Appendix C).
The detailed specification of each data element is listed in Chapter 11.
9 Date and time formatting
The format of all date and time stamps in EI documents is "date and time" as specified in ISO 8601 (all parts), including year, month, day, hour, minute and second; it does not include decimal seconds. If the information available to the server does not include minutes and seconds, then the minutes and seconds are set to zero. The UTC indicator ("Z") is used to indicate Universal Coordinated Time (UTC).
Data and time are expressed as YYYY-MM-DDThh: mm:ssZ. Note: Minutes and seconds are optional as specified in ISO 8601 (all parts).
10 Data field summary
The data elements identified in this document are summarised in Table 3 in the order in which they are presented in the .XML response to the request. The parameters in brackets in Table 3 are the names of the data elements and attributes in the .XSD file.
Appendix A contains a cross-reference table for the harmonisation of data element names and value domains as defined in ISO 15143-2.
11 Description of data fields
11.1 General requirements
The endpoint (request) shall be sent from the third party application to the telematics provider server. 11.2 to 11.21 contain example URLs describing the endpoint. Two optional illustrative examples are listed below.
12 Data schema
12.1 Generic mode
This schema is shared between all endpoints and is used to construct queue elements and associated complex types, see Appendix C.12.2 Time Series Schema
This schema is shared among the time series overview endpoints and is used to construct queue elements and associated hyperlinks and data elements, see Appendix D.
13 Syntax errors
The Supplier shall follow the standard HTTP protocol as specified in IETFRFC 7231, which uses the echoes shown in Table 5. Specifically, the responses given in Table 5 are used in that protocol.
Appendix A (informative) Data relationship of this document to ISO 15143-2
Appendix B (informative) Data support and collection
Appendix C (Informative): Generic model
Appendix D (informative) Time series models
Appendix E (normative) Process for adding new data elements to this document
Bibliography
Contents of GB/T 35484.3-2021
1 Scope
2 Normative references
3 Terms and definitions and abbreviations
4 Data management and access control
5 Response format
6 XML declaration of the link definition segment
7 Paging
8 Discoverability
9 Date and time formatting
10 Data field summary
11 Description of data fields
12 Data schema
13 Syntax errors
Appendix A (informative) Data relationship of this document to ISO 15143-2
Appendix B (informative) Data support and collection
Appendix C (Informative): Generic model
Appendix D (informative) Time series models
Appendix E (normative) Process for adding new data elements to this document
Bibliography
