Resources

A restful API to external methods of Ethersource. Returned data is encoded as json objects. The default endpoint to use is https://ethersource.gavagai.se/ethersource/rest/v2/. So to use getValue you should use https://ethersource.gavagai.se/ethersource/rest/v2/getValue For most of these externalApi methods, you need to have a list of your customerObserverViews. To get these, use the method listAllCustomerObserverViews

The API requires HTTP Basic Authentication, thus you need a username and a password to access the API. You will get this from a Gavagai operator.

Most API methods also require you to pass in an API key. You will get this as well from a Gavagai operator.

v8 added several TopicTracker Methods to the api, only applicable to a TopicTrackerUser.

v7 added getValues(to get the Polarization Values for a CustomerObserver over a given Range), getMostRecentValues(to get the recent Polarization Values), getComparisonValues(to get the most recent values for a set of customerObserverViews, to compare them) to the api.

v6 added findAssociations to the api

v5 added findDocumentURIs to the api

v4 getTriggerMarker changed its matching algorithm slightly: now it matches a triggermarker within the given day or hour (or whatever resolution is set) regardless of the values of the smaller time fields, and not, as previously, the closest triggerMarker.

v3 trigger marker methods now reference a sensorSubscriptionId instead of a sensorId

v2 changed path in example call

v1 first version of api with getValue

Changes to Ethersource Api:

We have upgraded our api from Version 1 to Version 2. These are the changes that go along with this upgrade:

End Point: https://ethersource.gavagai.se/ethersource/rest/v2/
Documentation: https://ethersource.gavagai.se/ethersource/v2/apis/

1) For all the method calls, the outer wrapper that was returned with the JSON has been removed
2) The names of the fields as returned by the json have been modified
3) Values that were null, before were not output. They will now be output, with a NULL value
4) Arrays that had only one element, before we output as a single object. If the array was empty, the field was skipped. Now, irrespective of whether the array is empty/single object/multiple objects, the arrays are output as arrays
5) Before, Float values without a decimal value were output as Ints, they will now be output as floats with a ‘.0’
6)The order of the fields within the JSON have been changed
7) Method getValuesMultiple now takes a minimum of 2 customerObserverViewIds as a parameter. If 1 customerObserverViewId only is passed, an error is thrown