Copyright 2016 Adminotech Oy
This specification is licensed under the [FIWARE Open Specification License] (http://forge.fiware.org/plugins/mediawiki/wiki/fiware/index.php/FI-WARE_Open_Specification_Legal_Notice_%28implicit_patents_license%29).
FIWARE Points of Interest Generic Enabler R5
FIWARE POI (Points of interest) Generic Enabler API facilitates
Storing information related to locations
Relate any information to places, e.g.
...
Search information by location and other criteria
Store information by location
Develop an application that utilizes those capabilities
Specially FIWARE POI Generic Enabler API allows you to
combine your own data with public POI data
speed up mobile operation by fetching only the data your application needs
define and use own data structures, if need for extra flexibility
distribute your service and data to several separately managed servers
store texts and links in several languages
Final version of the FIWARE POI DP GE API R5
Return the list of POI data components available from this server.
ParametersAuthorization token. Not needed, if POI-DP is configured as open data.
Return the data of POIs within a given distance from a given location.
ParametersAuthorization token. Not needed, if POI-DP is configured as open data.
When time of interest begins. ISO 8601 adaptation format is used for times. However, it is allowed to leave the time zone definition out. If time zone is missing, the local time zone of the POI is used.
POI category/categories to be included to results. Several categories can be given by separating them with commas. If this parameter is not given, all categories are included.
POI data component names to be included to results. Several component names can be given by separating them with commas. If this parameter is not given, all components are included.
When time of interest ends. Format as for begin_time. Required, if begin_time is defined.
Latitude of the center of the search circle [degrees]
Longitude of the center of the search circle [degrees]
Maximum number of POIs returned.
Minimum time of availability in minutes. Optional. If begin_time is defined, default: a short time > 0.
Radius of the search circle [meters], default is implementation dependent
Return the data of POIs within a given bounding box.
ParametersAuthorization token. Not needed, if POI-DP is configured as open data.
When time of interest begins. ISO 8601 adaptation format is used for times. However, it is allowed to leave the time zone definition out. If time zone is missing, the local time zone of the POI is used.
POI category/categories to be included to results. Several categories can be given by separating them with commas. If this parameter is not given, all categories are included.
POI data component names to be included to results. Several component names can be given by separating them with commas. If this parameter is not given, all components are included.
Longitude of the eastern edge of the bounding box [degrees]
When time of interest ends. Format as for begin_time. Required, if begin_time is defined.
Maximum number of POIs returned.
Minimum time of availability in minutes. Optional. If begin_time is defined, default: a short time > 0.
Latitude of the northern edge of the bounding box [degrees]
Latitude of the southern edge of the bounding box [degrees]
Longitude of the western edge of the bounding box [degrees]
Return the data of POIs listed in the query. This is intended to get additional information - other components - about interesting POIs.
ParametersAuthorization token. Not needed, if POI-DP is configured as open data.
POI data component names to be included to results. Several component names can be given by separating them with commas. If this parameter is not given, all components are included.
The components requested are returned with all language and other variants and possible metadata for inspection and edit. Moreover a last_update.timestamp
is included to reveal a possible update conflict.
UUID of the POI. Several UUIDs can be given by separating them with commas.
Update operations should require authorization in order to prevent misuse. The details of the authorization mechanism are out of the scope of this specification.
This function is used for adding a new POI entity into a database. The POI data is given as JSON in HTTP POST request. It generates a UUID for the new POI and returns it to the client in JSON format including the timestamp of the POI creation. The client can include different data components to the new POI by sending them along with the request.
The POSTed JSON must include only the content of a single POI, i.e. it must not contain a UUID as key as it is automatically generated by the server.
ParametersAuthorization token.
ID for the new POI.
This function is used for updating data of an existing POI entity. Existing data components can be modified or new ones can be added. Each data component contains a last_update.timestamp
in order to prevent concurrency issues.
The updated POI data is given as JSON in HTTP POST request. The server responds with HTTP status messages indicating the success or failure of the operation.
ParametersAuthorization token.
Delete existing POI using HTTP DELETE request. The UUID of the POI to be deleted is given in the request as a URL parameter
ParametersAuthorization token.
The UUID of the POI to be deleted
This function is used for logging in to a POI data provider and obtaining the authorization token for further use.
The auth_p
parameter specifies the authentication provider that is used to obtain the identity of the user. The possible values are implementation dependent, e.g.:
google
- for Google authentication
fiware_lab
- for FIWARE Lab authentication
The user_id
parameter specifies the user_id for the selected account, if multiple user accounts are associated to the authentication.
The content is the authentication token got from the authentication provider.
ParametersAuthorization provider.
Needed, if multiple user accounts are associated to the authentication.
This function is used for finishing the session and to invalidate the authorization token.
ParametersAuthorization token.
Headers
Content-Type: application/json
Body
{
"fw_core": {
"categories": ["cafe"],
"location": {
"wgs84" {
"latitude": 65.059334,
"longitude": 25.4664775
}
},
"name": {
"__": "Aulakahvila"
}
}
}
Headers
Content-Type: application/json
Body
{
"created_poi": {
"uuid": "6be4752b-fe6f-4c3a-98c1-13e5ccf01721",
"timestamp": 1394525977
}
}
Headers
Content-Type: application/json
Body
{
"6be4752b-fe6f-4c3a-98c1-13e5ccf01721": {
"fw_core": {
"categories": ["cafe"],
"location": {
"wgs84" {
"latitude": 65.059334,
"longitude": 25.4664775
}
},
"name": {
"__": "Aulakahvila"
},
"description": {
"__": "Cafe at the Univesity of Oulu"
},
"last_update": {
"timestamp": 1394525977
}
}
}
}
Headers
Content-Type: text/plain
Body
POI data updated succesfully
Headers
Content-Type: text/plain
Body
rEZhDInMYUVTNCAYyTy7MjXGDYJKR6
Headers
Content-Type: application/json
Body
{
"login":true,
"auth_t":"1207fbad2f158011dafe594f6db0e7f0e9221a19"
}