GeoRenting API documentation

/application

/application/upgrades get

get

Gives you information about the currently possible Upgrade Levels of GeoFences.

Response

HTTP status code 200

Returns the Information about Upgrade Levels. Radius in Meters, Max TTL in Seconds.

Body

Type: application/json

Example:

{
  "min_radius": 100,
  "max_radius": 400,
  "radius": [
    100, 150, 200, 250, 300, 350, 400
  ],
  "rent": [
    1, 1.5, 2, 2.5, 3, 3.5, 4
  ],
  max_ttl: 604800,
  min_ttl: 10
}

/users

/users get

get

/users/refreshToken post

post

Refreshes a Session for a given user. Requires an existing session Token.

Request
Response

Body

Type: application/json

Example:

{
  "token": "asdasdasd.asdasd98asd987.asd89a7"
}

HTTP status code 200

Returns the JWT Token.

Body

Type: application/json

Example:

{
  "token": "asdaisdansd.asdiu088ur98uasd.oaisd982"
  "user": UserObject
}

HTTP status code 403

You sent an invalid JWT token.

/users/auth post delete

post

Authenticate the User. Requires a Google OAuth Token.

delete

Delete the session.

Authenticate the User. Requires a Google OAuth Token.

Request
Response

Body

Type: application/json

Example:

{
  "google_token": "AAAJJJDDDDEEEE"
}

HTTP status code 200

Returns the JWT token.

Body

Type: application/json

Example:

{
  "token": "asdaisdansd.asdiu088ur98uasd.oaisd982"
  "user": UserObject
}

HTTP status code 403

You sent an invalid Google OAuth token.

Delete the session.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Request
Response

Body

Type: application/json

Example:

{
  "token": "asdasdasd.asdpiajsdohuds9f8asdf.asdiasjdo"
}

HTTP status code 200

Body

Type: application/json

Example:

{}

/users/me get

get

Returns information about the currently signed in User.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Response

HTTP status code 200

Returns the JWT token.

Body

Type: application/json

Example:

UserObject

HTTP status code 403

You sent an invalid Google OAuth token.

/users/me/cash get

get

Returns information about the CashFlow of the user in the last 7 days and all time.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Response

HTTP status code 200

Body

Type: application/json

Example:

{
  "earnings_rent_7d": 100.0,
  "expenses_rent_7d": 10.0,
  "expenses_geofence_7d": 100.0,
  "earnings_rent_all": 10000.0,
  "expenses_rent_all": 2342090.0,
  "expenses_geofence_all": 3909090.0
}

HTTP status code 403

The user is not authorized to access this.

/users/me/history get

get

Returns the Activity stream of the User.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Response

HTTP status code 200

Body

Type: application/json

Example:

[{
  'verb': 'ownFenceVisited',
  'date': 2255555555
  'data': {
    'visitor': 'Ulf',
    'fence': 'Pedas Castle',
    'rent': 200
  }
}, {
  'verb': 'foreignFenceVisited',
  'date': 2255555557
  'data': {
    'owner': 'Friedhelm',
    'fence': 'Friedhelms Area',
    'rent': 10
  }
}]

HTTP status code 403

The user is not authorized to access this.

/users/me/gcm post delete

post

Add a GCM ID.

delete

Remove a GCM ID.

Add a GCM ID.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Request

Body

Type: application/json

Example:

{
  "gcm_id": "42ua0sd8n"
}

Remove a GCM ID.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Request
Response

Body

Type: application/json

Example:

{
  "gcm_id": "42ua0sd8n"
}

HTTP status code 200

Body

Type: application/json

Example:

{}

HTTP status code 401

The specified GCM ID could not be deleted.

HTTP status code 403

The user is not authorized to do this.

/scores

/scores/heatmap get

get

Returns data for generating a HeatMap of score values.

Response

HTTP status code 200

Body

Type: application/json

Example:

[{
  lat: 54.01,
  lon: 8.2,
  score: 2
}, {
  lat: 42.1,
  lon: 1.3,
  score: 10
}]

/fences

/fences get post

get

Get Fences by user or around a center location. Returns more Information if the fence is owned by the current user.

post

Create the GeoFence. TTL has to be smaller than MaxTLL, RentMultiplier and Radius have to be valid Values from GET /application/upgrades.

Get Fences by user or around a center location. Returns more Information if the fence is owned by the current user.

Request
Response

Query Parameters

user: (string)
Get all Fences owned by the specified User ID.
latitude: (number)
Get Fences near the specified center location. Requires longitude and radius.
longitude: (number)
Get Fences near the specified center location. Requires latitude and radius.
radius: (integer)
Get Fences near the specified center location. Requires latitude and longitude.
excludeOwn: (boolean)
Exclude GeoFences owned by the current user from the search. Requires Authorization, otherwise will be ignored.

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "id": {
      "type": "string",
      "required": true
    },
    "center_lon": {
      "type": "double"
    },
    "center_lat": {
      "type": "double"
    },
    "name": {
      "type": "string"
    },
    "radius": {
      "type": "integer"
    }
  },
  "required": true,
  "type": "object"
}

Example:

[
  {
    "id": 42
    "center_lon": 54.42,
    "center_lat": 8.5,
    "name": "Ulfs Castle",
    "radius": 200,
    "total_visitors": 23,
    "total_earnings": 55.31,
    "cost": 500.32,
    "dies_at": 14588879,
    "rent_multiplier": 1.5
  },
  {
    "id": 45
    "center_lon": 51.42,
    "center_lat": 4.5,
    "name": "Pedas House",
    "radius": 100,
    "total_visitors": 23,
    "total_earnings": 55.31,
    "cost": 500.32,
    "dies_at": 14588879,
    "rent_multiplier": 1.5
  }
]

Create the GeoFence. TTL has to be smaller than MaxTLL, RentMultiplier and Radius have to be valid Values from GET /application/upgrades.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "id": {
      "type": "string",
      "required": true
    },
    "center_lon": {
      "type": "double"
    },
    "center_lat": {
      "type": "double"
    },
    "name": {
      "type": "string"
    },
    "radius": {
      "type": "integer"
    }
  },
  "required": true,
  "type": "object"
}

Example:

{
  "center_lon": 54.42,
  "center_lat": 8.5,
  "ttl": 1024,
  "rent_multiplier": 1.5,
  "radius": 150
  "name": "Ulfs Castle"
}

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "id": {
      "type": "string",
      "required": true
    },
    "center_lon": {
      "type": "double"
    },
    "center_lat": {
      "type": "double"
    },
    "name": {
      "type": "string"
    },
    "radius": {
      "type": "integer"
    }
  },
  "required": true,
  "type": "object"
}

Example:

{
  "id": "42",
  "center_lon": 54.42,
  "center_lat": 8.5,
  "name": "Ulfs Castle",
  "dies_at": 14588879,
  "rent_multiplier": 1.5,
  "radius": 150
}

HTTP status code 400

The GeoFence is overlapping with another GeoFence in its radius.

HTTP status code 402

The user does not have enough GeoCoins.

HTTP status code 417

Upgrade Values not valid.

/fences/estimateCost post

post

Returns a price estimate for creating a GeoFence at the given location. TTL has to be smaller than MaxTLL, RentMultiplier and Radius have to be valid Values from GET /application/upgrades.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Request
Response

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "id": {
      "type": "string",
      "required": true
    },
    "center_lon": {
      "type": "double"
    },
    "center_lat": {
      "type": "double"
    },
    "name": {
      "type": "string"
    },
    "radius": {
      "type": "integer"
    }
  },
  "required": true,
  "type": "object"
}

Example:

{
  "center_lon": 54.42,
  "center_lat": 8.5,
  "ttl": 1024,
  "rent_multiplier": 1.5,
  "radius": 150
}

HTTP status code 200

Body

Type: application/json

Schema:

CostEstimate

Example:

{
  "cost": 100,
  "can_afford": true
}

HTTP status code 400

The GeoFence is overlapping with another GeoFence in its radius.

HTTP status code 417

Upgrade Values not valid.

/fences/{fenceId} get put delete

get

Get information about the GeoFence.

put

Update the GeoFence. Requires the user to be the owner of it.

delete

Delete the GeoFence. Requires the user to be the owner of it.

Get information about the GeoFence.

Request
Response

URI Parameters

fenceId: required (string)

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "id": {
      "type": "string",
      "required": true
    },
    "center_lon": {
      "type": "double"
    },
    "center_lat": {
      "type": "double"
    },
    "name": {
      "type": "string"
    },
    "radius": {
      "type": "integer"
    }
  },
  "required": true,
  "type": "object"
}

Example:

{
  "id": "42",
  "center_lon": 54.42,
  "center_lat": 8.5,
  "name": "Ulfs Castle",
  "radius": 200
}

HTTP status code 404

Not found.

Update the GeoFence. Requires the user to be the owner of it.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Request
Response

URI Parameters

fenceId: required (string)

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "id": {
      "type": "string",
      "required": true
    },
    "center_lon": {
      "type": "double"
    },
    "center_lat": {
      "type": "double"
    },
    "name": {
      "type": "string"
    },
    "radius": {
      "type": "integer"
    }
  },
  "required": true,
  "type": "object"
}

Example:

{
  "id": "42",
  "center_lon": 54.42,
  "center_lat": 8.5,
  "name": "Ulfs Castle"
}

HTTP status code 200

Body

Type: application/json

Schema:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "properties": {
    "id": {
      "type": "string",
      "required": true
    },
    "center_lon": {
      "type": "double"
    },
    "center_lat": {
      "type": "double"
    },
    "name": {
      "type": "string"
    },
    "radius": {
      "type": "integer"
    }
  },
  "required": true,
  "type": "object"
}

Example:

{
  "id": "42",
  "center_lon": 54.42,
  "center_lat": 8.5,
  "name": "Ulfs Castle",
  "radius": 100
}

HTTP status code 403

The current user is not authorized to update that fence.

HTTP status code 404

Not Found.

Delete the GeoFence. Requires the user to be the owner of it.

Secured by x-jean-auth

Some requests require authentication. Jean-Auth uses a JSON Web Token in a Header to prove the Identity of the user.

Request
Response

URI Parameters

fenceId: required (string)

HTTP status code 200

Body

Type: application/json

Example:

{}

HTTP status code 403

The current user is not authorized to delete the fence.

HTTP status code 404

Not Found.

/fences/{fenceId}/visit post

post

This method will visit a GeoFence. The visitor and the owner will be notified via GCM.

GeoRenting API documentation version v1

Home

Auth

GCM

/application

/application/upgrades get

/users

/users get

/users/refreshToken post

/users/auth post delete

/users/me get

/users/me/cash get

/users/me/history get

/users/me/gcm post delete

/scores

/scores/heatmap get

/fences

/fences get post

/fences/estimateCost post

/fences/{fenceId} get put delete

/fences/{fenceId}/visit post

GeoRenting API documentation version v1

/application

get /application/upgrades

HTTP status code 200

Body

/users

get /users

Query Parameters

post /users/refreshToken

Body

HTTP status code 200

Body

HTTP status code 403

post /users/auth

Body

HTTP status code 200

Body

HTTP status code 403

delete /users/auth

Body

HTTP status code 200

Body

get /users/me

HTTP status code 200

Body

HTTP status code 403

get /users/me/cash

HTTP status code 200

Body

HTTP status code 403

get /users/me/history

HTTP status code 200

Body

HTTP status code 403

post /users/me/gcm

Body

delete /users/me/gcm

Body

HTTP status code 200

Body

HTTP status code 401

HTTP status code 403

/scores

get /scores/heatmap

HTTP status code 200

Body

/fences

get /fences

Query Parameters

HTTP status code 200

Body

post /fences

Body

HTTP status code 200

Body

HTTP status code 400

HTTP status code 402

HTTP status code 417

post /fences/estimateCost

Body

HTTP status code 200

Body

HTTP status code 400

HTTP status code 417

get /fences/{fenceId}

URI Parameters

HTTP status code 200

Body

HTTP status code 404

put /fences/{fenceId}

URI Parameters

Body

HTTP status code 200

Body

HTTP status code 403

HTTP status code 404

delete /fences/{fenceId}

URI Parameters

HTTP status code 200

Body