HipGeo Objects

Place Object

A place object contains information about a specific venue. This venue specific information can be attached to a location object to provide additional information about the user's experience at a specific coordinate.

A place's coordinates may not be unique. In other words, there may be more than one place object for a single coordinate or the coordinates may be so close that the difference is insignificant.

The place object supports and GET, PUT, and DELETE methods as indicated in the examples below. To PUT data to a place (update) or DELETE a place, the authenticated user must be the owner (creator) of the place (see place endpoint for more information).

The information about a place that is provided depends on it's permissions and the rights of the authenticated user. If the user does not have sufficient rights, details about the place will not be provided.

GET Place Object Example

GET http://api.hipgeo.com/p_6261?access_token=TOKENVALUE

Returns:
{
  "place":{
    "id":"p_6261",
    "name":"St Denis Church",
    "title":"St Denis Church, Diamond Bar, CA",
    "privacy":0,
    "shareable":1,
    "owner":"u_",
    "coord":{
      "lat":33.985802,
      "lon":-117.825996,
      "radius":0,
      "alt":0
    },
    "src":2,
    "address":{
      "street":"2151 S Diamond Bar Blvd",
      "city":"Diamond Bar",
      "state":"CA",
      "postcode":"91765",
      "country":"US"
    },
    "phone":"+1 909 861 7106"
  },
  "result":"success"
} 

Error Code	Possible Errors
400	Requires an ID
401	Authentication failed Token expired
404	ID not found

GET Private Place Example

GET http://api.hipgeo.com/p_8645

Returns:
{
  "place":{
    "id":"p_8654",
    "title":"Private Place, Wilmington, CA",
    "name":"Private",
    "priv":128
  },
  "result":"success"
} 

Error Code	Possible Errors
400	Requires an ID
404	ID not found

PUT Place Object Example

PUT http://api.hipgeo.com/p_18829?access_token=TOKENVALUE

Data:
{
   "name":"St. Denis Church",
   "description":"Catholic Church",
   "phone":"1-909-861-7106",
   "privacy":0,
   "address":{
      "street":"Diamond Bar Blvd",
      "city":"Diamond Bar",
      "state":"CA",
      "postcode":"91765",
      "country":"USA"
   }
}

Returns:
{
  "id":"p_18829",
  "shareable":1,
  "result":"success"
} 

Delete Place Object Example

DELETE http://api.hipgeo.com/p_1232?auth_token=accessToken

Returns:
{
  "id":"p_1232",
  "result":"success"
} 

Error Code	Possible Errors
400	Requires an ID - missing objectId Not supported yet
401	Authentication failed Token expired Insufficient Permissions