EUROTECH Everyware Cloud API: edcPayload

EdcPayload defines the recommended payload structure for the messages sent to the Everyware Cloud platform. Eurotech designed the format as an open format that is flexible from the aspect of data modeling yet is efficient when it comes to bandwidth conservation. The same payload model is used by the REST API - in which case it is serialized into XML or JSON as requested by the client - or uses the efficient Google ProtoBuf when sent over an MQTT connection when the bandwidth is very important. The EdcPayload contains the following fields: sentOn timestamp, an optional set of metrics represented as name-value pairs, an optional position field to capture a GPS position, and an optional binary body.

sentOn: it is the timestamp when the data was captured and sent to the Everyware Cloud platform.
metrics: a metric is a data structure composed of the name, a value, and the type of the value. When used with the REST API valid metric types are: string, double, int, float, long, boolean, base64Binary. Data exposed into the payload metrics can be processed through the real-time rules offered by the Everyware Cloud platform or used as query criteria when searching for messages through the messages/searchByMetric API. Each payload can have zero or more metrics.
position: it is an optional field used to capture a geo position associated to this payload.
body: it is an optional part of the payload that allows additional information to be transmitted in any format determined by the user. This field will be stored into the platform database, but the Everyware Cloud cannot apply any statistical analysis on it.

Namespace: http://eurotech.com/edc/2.0
Schema: edc.xsd
Subtypes: edcResponsePayload

Properties
name	data type	type	namespace	min/max occurs	description
body	base64Binary	element	edc	0/1	It is an optional part of the payload that allows additional information to be transmitted in any format determined by the user. This field will be stored into the platform database but the Everyware Cloud cannot apply any statistical analysis on it.
metrics	edcMetricsMapType	element	edc	0/1	A metric is a data structure composed of the name, a value, and the type of the value. When used with the REST API valid metric types are: string, double, int, float, long, boolean, base64Binary. Data exposed into the payload metrics can be processed through the real-time rules offered by the Everyware Cloud platform or used a query criteria when searching for messages through the messages/searchByMetric API. Each payload can have zero or more metrics.
position	edcPosition	element	edc	0/1	It is an optional field used to capture a geo position associated to this payload.
sentOn	dateTime	element	edc	0/1	Timestamp when the data was captured and sent to the Everyware Cloud platform.

Example

<payload xmlns="http://eurotech.com/edc/2.0">
  <sentOn>...</sentOn>
  <position>
    <longitude>...</longitude>
    <latitude>...</latitude>
    <altitude>...</altitude>
    <precision>...</precision>
    <heading>...</heading>
    <speed>...</speed>
    <timestamp>...</timestamp>
    <satellites>...</satellites>
    <status>...</status>
  </position>
  <metrics>
    <metric>
      <name>...</name>
      <type>...</type>
      <value>...</value>
    </metric>
  </metrics>
  <body>...</body>
</payload>

edcPayload Data Type