This document is a reference for the services provided by the Data Aggregator module by I+. For the data model associated to the services, please refer to the model.xsd file provided with the documentation.
returns: An Hypermedia
containing links to the main service entry points.
available response representations:
User in the system, also creating
an associated authorization token that is then returned as an Authorized-by
header. The token will expire after some time, defined in an
associated expires header returned along with the
token.
returns: The newly registered User's
representation, with only his PersonalData.
acceptable request representations:
username={user}&password={pass}available response representations:
User is returned, the links are the
same of /aggregator/service/users/{user_id}User in, creating an associated
authorization token that is then returned as an Authorized-by
header. The token will expire after some time, defined in an
associated expires header returned along with the
token.
returns: The User's
representation, with only his PersonalData.
acceptable request representations:
username={user}&password={pass}available response representations:
User is returned, the links are the
same of /aggregator/service/users/{user_id}User out, removing any associated
authorization token (Note: in order to log out, the 'Authorized-by'
header must be provided in the logout Request).
returns: Only the outcome (HTTP STATUS) of the operation
available response representations:
| parameter | value | description |
|---|---|---|
|
username |
the username (which MUST be an email) |
User. The system will
send an email to the provided email (via the username parameter),
providing a link for the password reset action.
returns: An Hypermedia, containing the links
for the actual password resetting and for repeating the reset request
(i.e. to receive another email).
acceptable request representations:
username={user}available response representations:
| parameter | value | description |
|---|---|---|
|
password |
the new password |
|
|
token |
the token that is in the URL received via email for the password reset |
returns: Just the http status code, which will be 200 OK if the password was changed correctly.
acceptable request representations:
password={password}&token={token}available response representations:
Relations, and provides a description for each one of
them.
returns: A list of all the Relations
defined in the system.
available response representations:
| parameter | value | description |
|---|---|---|
|
REL |
an entry taken from the |
Relation
returns: A single Relation
object
available response representations:
| parameter | value | description |
|---|---|---|
|
REL |
an entry taken from the |
Relation
returns: A textual description of the
semantics associated with this Relation
available response representations:
Users object wrapping a list of all
the registered Users
returns: A Users object,
containing a list of all the Users registered in the
system
available response representations:
User to the
system.
returns: The newly added User's
representation, empty.
available response representations:
User is returned, the links are the
same of /aggregator/service/users/{user_id}| parameter | value | description |
|---|---|---|
|
user_id |
The |
User's representation
from the system.
returns: A User's
representation, with only his PersonalData.
available response representations:
| parameter | value | description |
|---|---|---|
|
user_id |
The |
User in the system.
returns: The updated User's
representation, with only his PersonalData.
acceptable request representations (Request Body):
available response representations:
User is returned, the links are the
same of /aggregator/service/users/{user_id}| parameter | value | description |
|---|---|---|
|
user_id |
The |
User from the system.
returns: Only the outcome (HTTP STATUS) of the operation
available response representations:
| parameter | value | description |
|---|---|---|
|
user_id |
The |
| parameter | value | description |
|---|---|---|
|
fromTime |
The starting date, in ISO8601 format ("yyyy-MM-dd'T'HH:mm:ss.SSSZZ") |
|
|
toTime |
The ending date, in ISO8601 format ("yyyy-MM-dd'T'HH:mm:ss.SSSZZ") |
returns:a Sessions object
wrapping the result of the query.
available response representations:
| parameter | value | description |
|---|---|---|
|
user_id |
The |
Sessions for
a user, wrapped in a Sessions object.
returns: Only the outcome (HTTP STATUS) of the operation
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
session_id |
The |
|
|
user_id |
The |
Session of a user
returns: a representation of the Session
available response representations:
| parameter | value | description |
|---|---|---|
|
session_id |
The |
|
|
user_id |
The |
Session
returns: The updated Session.
acceptable request representations:
available response representations:
Session is returned, the links are the
same of /aggregator/service/users/{user_id}/sessions/{session_id}| parameter | value | description |
|---|---|---|
|
session_id |
The |
|
|
user_id |
The |
returns: Only the outcome (HTTP STATUS) of the operation
available response representations:
| parameter | value | description |
|---|---|---|
|
user_id |
The |
| parameter | value | description |
|---|---|---|
|
fromTime |
The starting date, in ISO8601 format ("yyyy-MM-dd'T'HH:mm:ss.SSSZZ") |
|
|
toTime |
The ending date, in ISO8601 format ("yyyy-MM-dd'T'HH:mm:ss.SSSZZ") |
returns:an Events object
wrapping the result of the query.
available response representations:
| parameter | value | description |
|---|---|---|
|
user_id |
The |
returns: The user's Events that
matched the given example, wrapped in a Events
object.
acceptable request representations:
available response representations:
Events is returned, the links are the
same of /aggregator/service/users/{user_id}/events| parameter | value | description |
|---|---|---|
|
user_id |
The |
Events for a
user, wrapped in a Events object.
returns: Only the outcome (HTTP STATUS) of the operation
acceptable request representations:
available response representations:
| parameter | value | description |
|---|---|---|
|
event_id |
The |
|
|
user_id |
The |
Events
associated to a user.
| parameter | value | description |
|---|---|---|
|
event_id |
The |
|
|
user_id |
The |
Event
returns: The updated Event.
acceptable request representations:
available response representations:
Event is returned, the links are the
same of /aggregator/service/users/{user_id}/events/{event_id}| parameter | value | description |
|---|---|---|
|
event_id |
The |
|
|
user_id |
The |
returns: Only the outcome (HTTP STATUS) of the operation
available response representations:
| parameter | value | description |
|---|---|---|
|
user_id |
The |
returns: a representation of the user0s
settings in a SettingsData object.
available response representations:
| parameter | value | description |
|---|---|---|
|
user_id |
The |
returns: the updated user's SettingsData
acceptable request representations:
available response representations:
SettingsData is returned, the links
are the same of /aggregator/service/users/{user_id}/settings| parameter | value | description |
|---|---|---|
|
user_id |
The |
returns: a representation of the user's
accounts in an AccountsData object.
available response representations:
| parameter | value | description |
|---|---|---|
|
user_id |
The |
returns: the updated user's AccountsData
acceptable request representations:
available response representations:
AccountsData is returned, the links
are the same of /aggregator/service/users/{user_id}/accounts