Location API

romdim Dylan conway

Location API

Enabling location awareness through Checkins, Direction, Events, Reviews and Tips. It is a strong contextual API with location, which can be extracted by a GPS sensor and can be mapped on a map.

Objects

Objects Description Reference Activities Mapping
[place] Represents a physical location. Locations can be represented using geographic coordinates, a physical address, a free-form location name, or any combination of these. [Place Mapping]
[route] A list of certain geo-locations, in order [Route mapping]

Methods

Below there are the generally supported methods that Objects from Location API support. Places are not related to users nevertheless. For special cases, see every object separately.

Method Details Call Method API path Properties Response
Get an Location object This method returns an object with its properties [REST] #GET 
API_PATH/{OBJECT_ID}
 OBJECT_ID an Location object
Get all Location objects for an account This method returns all the Location objects that have been published under an account. The objects are of the same type (i.e. event, place etc.) [REST] #GET 
API_PATH/{ACCOUNT_ID}/objects
e.g. API_PATH/12312313/events		 ACCOUNT_ID A list of same-type Location objects
Get Location objects for an OPENi user Gets all Location objects for the authenticated user, for all her accounts, unless they are filtered. [REST] #GET 
API_PATH/me/objects
e.g. API_PATH/me/events		 accounts={ACCOUNT_ID} A list of same-type Location objects
Post a Location object to a simple account This method uploads an object to an account, given the object. [REST] #POST 
API_PATH/{ACCOUNT_ID}/objects
e.g. API_PATH/12312313/events		 ACCOUNT_ID, {OBJECT}, Location_content A success or error code
Post a Location object to multiple services This method uploads an object to multiple services, given the object and all the account_ids. [REST] #POST 
API_PATH/me/objects
e.g. API_PATH/me/events		 {OBJECT}, Location_content, accounts={ACCOUNT_ID}. A success or error code
Edit a Location object This method can update a Location object. [REST] #PUT 
API_PATH/{OBJECT_ID}
 OBJECT_ID, {OBJECT} A success or error code
Delete a Location object This method deletes an object, owned by the authenticated user [REST] #DELETE 
API_PATH/{OBJECT_ID}
 OBJECT_ID A success or error code
Post a Location object to an aggregation This method uploads an object to an aggregation, given the object,if an aggregation accepts them. [REST] #POST 
API_PATH/{AGGREGATION_ID}/objects
e.g. API_PATH/5553_12312313/events		 AGGREGATION_ID, {OBJECT} A success or error code

Connections (Secondary Objects)

Objects Description Reference Activities Mapping
[review] Represents a primarily prose-based commentary on another object (place). It can be also a tip (Foursquare) AS Schema [Review mapping]

Methods

Method Details Call Method API path Properties Response
Post a connection to an object This method creates a secondary object (connection) to a location object [REST] #POST 
API_PATH/{OBJECT_ID}/connection_names
e.g. API_PATH/12324_4124/checkins		 OBJECT_ID, {object} success code
Delete an activity to an object This method deletes a connection to an activity, given the id of the activity, as a user may has posted multiple connections (e.g. checkin) to an object. [REST] #DELETE 
API_PATH/{OBJECT_ID}
 OBJECT_ID success code
Get all the requested connections from an object This method gets all the connections for a given object [REST] #POST 
API_PATH/{OBJECT_ID}/connection_names
e.g. API_PATH/12324_4124/checkins		 OBJECT_ID a list of objects
Update a connection to an object This method updates the connection to an object, if possible (e.g. a rsvp, the text of the review or the text of a checkin) [REST] #PUT 
API_PATH/{CONNECTION_ID}
e.g. API_PATH/12324_4124_12324244		 CONNECTION_ID, {object} success code

Aggregations

Objects Description Reference Activities Mapping
[travel] A history of visited places, in time order. [Travel mapping]

Methods

Method Details Call Method API path Properties Response
Get a Location aggregation This method returns an object with its properties [REST] #GET 
API_PATH/{AGGREGATION_ID}
 OBJECT_ID a Location aggregation
Get all Location aggregations for an account This method returns all the defined aggregations that have been published under an account. The objects are of the same type (i.e. travel) [REST] #GET 
API_PATH/{ACCOUNT_ID}/aggregations
e.g. API_PATH/12312313/travels		 ACCOUNT_ID A list of same-type objects
Get Location aggregations for an OPENi user Gets all Location objects for the authenticated user, for all her accounts, unless they are filtered. [REST] #GET 
API_PATH/me/objects
e.g. API_PATH/me/tracels		 accounts={ACCOUNT_ID} A list of same-type Location objects
Post a Location object to a simple account This method uploads an object to an account, given the object. [REST] #POST 
API_PATH/{ACCOUNT_ID}/objects
e.g. API_PATH/12312313/travels		 ACCOUNT_ID, {OBJECT} A success or error code
Post a Location aggregation to multiple services This method uploads an object to multiple services, given the object and all the account_ids. [REST] #POST 
API_PATH/me/objects
e.g. API_PATH/me/travels		 {OBJECT}, accounts={ACCOUNT_ID}. A success or error code
Edit a Location aggregation This method can update an aggregation. [REST] #PUT 
API_PATH/{AGGREGATION_ID}
 AGGREGATION_ID, {OBJECT} A success or error code
Delete a Location aggregation This method deletes an aggregation, owned by the authenticated user [REST] #DELETE 
API_PATH/{AGGREGATION_ID}
 AGGREGATION_ID A success or error code

Related

Wiki: REST
Wiki: travel
Wiki: Travel mapping
Wiki: review
Wiki: Review mapping
Wiki: route
Wiki: Route mapping
Wiki: place
Wiki: Place Mapping
Wiki: T31-_OPENi_APIs_Specification
Wiki: T3.1- OPENi APIs Specification