API Endpoints

ping

The ping endpoint is used to initiate a location request from the authenticated user to a specific user. The caller may optionally supply their own location in the "gll" field (see example below). The "when" field is required.

Example: Ping for Location

POST http://api.hipgeo.com/u_777/ping?access_token=TOKENVALUE

{
"gll":{"lat":33.494020,"lon":-117.487901, "hacc":10, "vel":10},
 "when":"2011-01-01 11:00:00"
}

Returns:
{
  "message":"Edward is at Edward's House, Diamond Bar, CA and wants your location",
  "ios_dev":0,
  "coord":{
    "lat":33.494020,
    "lon":-117.4958390,
    "radius":0
  },
  "result":"success"
}

On a successful ping, a push notification is sent to the specified user with the message: "[Username] has requested your location" {"type":"ping","token":"TOKENVALUE"}

Error Code Possible Errors
400
  1. Cannot ping specified user
401
  1. Authentication failed
  2. Token expired
404
  1. Invalid user for ping
  2. Bad ID
HipGeo Icon