Request list

This page provides a reference of requests and responses.

Basics concepts

Before you start you need to understand a couple of basic concepts:

  • The Zeus API use JSON as a data exchange format. In the GET requests, when the body of the message is decrypted, we get a JSON with all the data received. Likewise, in the POST requests, the data that we want to send (previously to its encryption) must be in JSON format.
  • The URL can contain filters that indicate certain conditions of the request (details). These filters are key-value pairs separated by the '&' character.
    There are three special filters:
    • AcceptEncoding=gzip: request the server to return the compressed data in GZIP format.
    • ContentEncoding=gzip: tells the server that the payload is compressed using GZIP
    • The date type whit the following format:
  • The requests are case sensitive.

Requests can be made on the following data sets or collections:

  • Accounts: You can get your authtoken to authenticate each of the requests you make to ZeusServer through your authaccount, authpass and your user password. You can obtain your authaccount and authpass once logged on ZeusWeb, going to URL: api_credentials.html. Learn more about the authentication process (details).
  • Stations: This collection contains information about the station objects. With this collection you can consult online stations, their properties or select the latest known values.
  • Historicals: This collection contains information about historical objects. With this collection you can receive or send the historical data of a specific station.
  • Alarms: This collection contains information about alarms objects. With this collection you can receive or send the alarm data of a specific station.
  • Messages: This collection contains information about messages objects. With this collection you can receive or send messages from/to a station.

Stations


  • Gets the list of stations of this user

    Request

    Response: list of string containing the names of stations this user can access (details).


  • Gets the list of stations currently online (connected to server) of this user

    Request

    Response: list of string containing the names of stations currently online (connected to server) from the list of stations this user can access (details).


  • Gets the list of pending messages enqueued for stations of this user

    Request

    Response: list of key-value pair where keys are Stations IDs and Values are message texts (details).


  • Gets properties of a station

    Request

    Response: object type Station Properties (details).


  • Gets extended properties of a station

    Request

    Response: object type Dictionary (String, value) (details).


  • Gets extended properties of all stations

    Request

    Response: object type Dictionary of (String, Dictionary(String, value)) (details).


  • Gets properties of all stations

    Request

    Response: object type Dictionary of (String, StationsProperties) (details).


  • Gets the last known values of a station

    Request

    Response: object type Last Known Values (details).


  • Gets the last known values of all stations

    Request

    Response: object type Dictionary of (String, LastKnownValues) (details).


  • Sets the last known values of a station

    Request

    Payload: object type Last Known Values (details)


  • Gets the programmable relay period of a station

    Request

    Response: list of Programmable Relay Period (details).

Historicals


  • Gets historical values of the specified station

    Request

    Response: list of Historical (details).


  • Uploads a list of historical values of the specified station

    Request

    Payload: list of Historical (details)

Alarms


  • Gets alarms values of the specified station and date interval

    Request

    Response: list of Alarms (details).


  • Uploads a list of alarms values of the specified station

    Request

    Payload: list of Alarms (details)

Messages


  • Sends a message to the specified station or phone number

    Request

    Payload: object type Key-Value (details) where "Key" is the ID (ZeusID) of the station (or the phone number, only if sendBySMS parameter is TRUE) and "Value" is the text of the message to be sent.