SensusRF gateway user manual
| 29/10/2019
17 APPENDIX A: GATEWAY REST API SPECIFICATION
17.1 Introduction
This section describes the CAS GATEWAY REST API interface, which allows other systems to inquire for
gateway sensors status and meter readings.
17.1.1 Glossary
• HTTP => Acronym for Hypertext Transfer Protocol. This is the communication protocol used as
the basis for the World Wide Web in browsers;
• JSON => Acronym for JavaScript Object Notation. This is a format for data exchange between
applications being easy to read and write for humans. Further details of the format can be found
at http://www.json.org;
• POST => The HTTP protocol defines eight methods (GET, HEAD, POST, PUT, DELETE, TRACE,
OPTIONS and CONNECT) indicating the action to be performed on specified resource. The
method determines what the server should do with the URL provided at the request of a specific
resource;
• URL => A URL is an abbreviation that refers to the network address where a computational
resource is located, for example, a computer file, a peripheral device (printer) or a website;
• REST => Representational State Transfer (REST) is a software architectural style that defines a set
of constraints to be used for creating Web services;
• JWT => JSON Web Token is an Internet standard for creating JSON-based access tokens that
assert some number of claims. https://jwt.io;
• OMS => Opening Metering System.