C3 Beacon API documentation version v2
http://api.c3wireless.com/v2
/users
Collection of available users
get
Get a list of users
post
Add a new user
get /users
Get a list of users
Query Parameters
- orderby: (string)
Order by field
- order: (one of desc, asc - default: desc)
Order
- offset: (integer)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - query: (string)
JSON array [["field1","value1","operator1"],["field2","value2","operator2"],...,["fieldN","valueN","operatorN"]]
Example:
[["mac", "ab1%", "like"],["name","Lobby", "="]]
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://jsonschema.net",
"required": true,
"properties": {
"data": {
"type": "array",
"required": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"usertype": {
"type": "string",
"required": true
},
"username": {
"type": "string",
"required": true
},
"password": {
"type": "string",
"required": false
},
"firstname": {
"type": "string",
"required": false
},
"lastname": {
"type": "string",
"required": false
},
"email": {
"type": "string",
"required": true
}
}
}
},
"status": {
"type": "integer",
"required": true
},
"error": {
"type": "string",
"required": false
}
}
}
Example:
{
"data": [
{
"id": 17,
"name": "Imani Jackson",
"email": "ijackson@gmail.com",
"usertype": "ADMIN"
},
{
"id": 21,
"name": "Tiana Hightower",
"email": "thigh47@gmail.com",
"usertype": "MEMBER"
}
],
"status": 200,
}
post /users
Add a new user
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"usertype": {
"type": "string",
"required": true
},
"username": {
"type": "string",
"required": true
},
"password": {
"type": "string",
"required": false
},
"firstname": {
"type": "string",
"required": false
},
"lastname": {
"type": "string",
"required": false
},
"email": {
"type": "string",
"required": true
}
}
}
Example:
{
"id": 17,
"username": "jackson",
"firstname": "Imani",
"lastname": "Jackson",
"email": "ijackson778@gmail.com",
"usertype": "ADMIN"
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"id": 21,
"status": 201
}
HTTP status code 400
Error in submitted data
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 400,
"error": "Required field missing."
}
get
Retrieve a known user
put
Update a known user
delete
Delete a user
get /users/{user_id}
Retrieve a known user
URI Parameters
- user_id: required (string)
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"usertype": {
"type": "string",
"required": true
},
"username": {
"type": "string",
"required": true
},
"password": {
"type": "string",
"required": false
},
"firstname": {
"type": "string",
"required": false
},
"lastname": {
"type": "string",
"required": false
},
"email": {
"type": "string",
"required": true
}
}
}
Example:
{
"id": 17,
"username": "jackson",
"firstname": "Imani",
"lastname": "Jackson",
"email": "ijackson778@gmail.com",
"usertype": "ADMIN"
}
HTTP status code 404
Requested user not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
put /users/{user_id}
Update a known user
URI Parameters
- user_id: required (string)
HTTP status code 200
user updated successfully
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"usertype": {
"type": "string",
"required": true
},
"username": {
"type": "string",
"required": true
},
"password": {
"type": "string",
"required": false
},
"firstname": {
"type": "string",
"required": false
},
"lastname": {
"type": "string",
"required": false
},
"email": {
"type": "string",
"required": true
}
}
}
Example:
{
"id": 17,
"username": "jackson",
"firstname": "Imani",
"lastname": "Jackson",
"email": "ijackson778@gmail.com",
"usertype": "ADMIN"
}
HTTP status code 404
user not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
delete /users/{user_id}
Delete a user
URI Parameters
- user_id: required (string)
HTTP status code 200
user successfully deleted
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 200
}
HTTP status code 404
user record not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
/listeners
Collection of available listeners
get
Get a list of listeners
post
Add a new listener
get /listeners
Get a list of listeners
Query Parameters
- orderby: (string)
Order by field
- order: (one of desc, asc - default: desc)
Order
- offset: (integer)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - query: (string)
JSON array [["field1","value1","operator1"],["field2","value2","operator2"],...,["fieldN","valueN","operatorN"]]
Example:
[["mac", "ab1%", "like"],["name","Lobby", "="]]
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "https://api.c3wireless.com/",
"required": true,
"properties": {
"data": {
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"disabled": {
"type": "boolean",
"required": false
},
"state": {
"type": "string",
"required": false
},
"name": {
"type": "string",
"required": true
},
"mac": {
"type": "string",
"required": true,
"minLength": 12,
"maxLength": 12
},
"description": {
"type": "string",
"required": false
},
"keywords": {
"type": "string",
"required": false
},
"map_x": {
"type": "number",
"required": false
},
"map_y": {
"type": "number",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"missing": {
"type": "boolean",
"required": false
}
}
}
},
"status": {
"type": "integer",
"required": true
},
"error": {
"type": "string",
"required": false
}
}
}
Example:
{
"data": [
{
"id": 17
"disabled": false
"name": "Lobby"
"mac": "0123456789ab"
"map_x": 100.384
"map_y": 203.23
"zone_id": 17
"missing": false
},
{
"id": 21
"disabled": false
"name": "Foyer"
"mac": "23456789abcd"
"map_x": 90.384
"map_y": 213.23
"zone_id": 17
"missing": false
}
],
"status": 200
}
post /listeners
Add a new listener
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"owner_id": {
"type": "integer",
"required": false
},
"last_seen": {
"type": "timestamp",
"required": false
},
"state": {
"type": "string",
"required": false
},
"name": {
"type": "string",
"required": true
},
"mac": {
"type": "string",
"required": true,
"minLength": 12,
"maxLength": 12
},
"description": {
"type": "string",
"required": false
},
"geom": {
"type": "string",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
}
}
}
Example:
{
"id": 17,
"name": "Lobby",
"mac": "0123456789ab",
"geom": "0101000020110F00009E584C953E773041F4B0867357D15541",
"zone_id": 17,
"state": false,
"owner_id": null
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"id": 21,
"status": 201
}
HTTP status code 400
Error in submitted data
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 400,
"error": "Required field missing."
}
get
Retrieve a known listener
put
Update a known listener
delete
Delete a listener
get /listeners/{listener_id}
Retrieve a known listener
URI Parameters
- listener_id: required (string)
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"owner_id": {
"type": "integer",
"required": false
},
"last_seen": {
"type": "timestamp",
"required": false
},
"state": {
"type": "string",
"required": false
},
"name": {
"type": "string",
"required": true
},
"mac": {
"type": "string",
"required": true,
"minLength": 12,
"maxLength": 12
},
"description": {
"type": "string",
"required": false
},
"geom": {
"type": "string",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
}
}
}
Example:
{
"id": 17,
"name": "Lobby",
"mac": "0123456789ab",
"geom": "0101000020110F00009E584C953E773041F4B0867357D15541",
"zone_id": 17,
"state": false,
"owner_id": null
}
HTTP status code 404
Requested listener not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
put /listeners/{listener_id}
Update a known listener
URI Parameters
- listener_id: required (string)
HTTP status code 200
listener updated successfully
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"owner_id": {
"type": "integer",
"required": false
},
"last_seen": {
"type": "timestamp",
"required": false
},
"state": {
"type": "string",
"required": false
},
"name": {
"type": "string",
"required": true
},
"mac": {
"type": "string",
"required": true,
"minLength": 12,
"maxLength": 12
},
"description": {
"type": "string",
"required": false
},
"geom": {
"type": "string",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
}
}
}
Example:
{
"id": 17,
"name": "Lobby",
"mac": "0123456789ab",
"geom": "0101000020110F00009E584C953E773041F4B0867357D15541",
"zone_id": 17,
"state": false,
"owner_id": null
}
HTTP status code 404
listener not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
delete /listeners/{listener_id}
Delete a listener
URI Parameters
- listener_id: required (string)
HTTP status code 200
listener successfully deleted
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 200
}
HTTP status code 404
listener record not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
/beacons
Collection of available beacons
get
Get a list of beacons
post
Add a new beacon
get /beacons
Get a list of beacons
Query Parameters
- orderby: (string)
Order by field
- order: (one of desc, asc - default: desc)
Order
- offset: (integer)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - query: (string)
JSON array [["field1","value1","operator1"],["field2","value2","operator2"],...,["fieldN","valueN","operatorN"]]
Example:
[["mac", "ab1%", "like"],["name","Lobby", "="]]
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "https://api.c3wireless.com/",
"required": true,
"properties": {
"data": {
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"disabled": {
"type": "boolean",
"required": false
},
"name": {
"type": "string",
"required": true
},
"state": {
"type": "string",
"required": false
},
"categoryid": {
"type": "integer",
"required": false
},
"subcategoryid": {
"type": "integer",
"required": false
},
"mac": {
"type": "string",
"required": true,
"minLength": 17,
"maxLength": 17
},
"major": {
"type": "integer",
"required": true
},
"minor": {
"type": "integer",
"required": true
},
"description": {
"type": "string",
"required": false
},
"keywords": {
"type": "string",
"required": false
},
"last_battery": {
"type": "integer",
"required": false,
"maxValue": 100,
"minValue": 0
},
"map_x": {
"type": "number",
"required": false
},
"map_y": {
"type": "number",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"uuid": {
"type": "string",
"required": true,
"maxLength": 16,
"minLength": 16
},
"missing": {
"type": "boolean",
"required": false
}
}
}
},
"status": {
"type": "integer",
"required": true
},
"error": {
"type": "string",
"required": false
}
}
}
Example:
{
"data": [
{
"id": 17,
"name": "Dr. Brown",
"categoryid": 5,
"mac": "01:23:45:67:89:ab",
"major": 21,
"minor": 17,
"description": "Beacon embedded in Dr. Trevone Brown's badge",
"last_battery": 67,
"map_x": 267.87,
"map_y": 2057.44,
"zone_id": 12,
"uuid": "0123456789abcdef",
"missing": false
},
{
"id": 21,
"name": "Dr. Freeman",
"categoryid": 5,
"mac": "23:45:67:89:ab:cd",
"major": 20,
"minor": 16,
"description": "Beacon embedded in Dr. Freeman's badge",
"last_battery": 99,
"map_x": 2670.87,
"map_y": 205.44,
"zone_id": 45,
"uuid": "23456789abcdef01",
"missing": false
}
],
"status": 200
}
post /beacons
Add a new beacon
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": true
},
"state": {
"type": "string",
"required": false
},
"owner_id": {
"type": "integer",
"required": false
},
"last_seen": {
"type": "timestamp",
"required": false
},
"major": {
"type": "integer",
"required": true
},
"minor": {
"type": "integer",
"required": true
},
"description": {
"type": "string",
"required": false
},
"battery": {
"type": "integer",
"required": false,
"maxValue": 100,
"minValue": 0
},
"geom": {
"type": "string",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"uuid": {
"type": "string",
"required": true,
"maxLength": 16,
"minLength": 16
}
}
}
Example:
{
"id": 17,
"name": "Dr. Brown",
"major": 21,
"minor": 17,
"description": "Beacon embedded in Dr. Trevone Brown's badge",
"battery": 67,
"geom": "0101000020110F00002026E17E467730411CAB5E4354D15541",
"zone_id": 12,
"uuid": "0123456789abcdef",
"state": null
"last_seen": 1452702712,
"owner_id": null
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"id": 21,
"status": 201
}
HTTP status code 400
Error in submitted data
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 400,
"error": "Required field missing."
}
get
Retrieve a known beacon
put
Update a known beacon
delete
Delete a beacon
get /beacons/{beacon_id}
Retrieve a known beacon
URI Parameters
- beacon_id: required (string)
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": true
},
"state": {
"type": "string",
"required": false
},
"owner_id": {
"type": "integer",
"required": false
},
"last_seen": {
"type": "timestamp",
"required": false
},
"major": {
"type": "integer",
"required": true
},
"minor": {
"type": "integer",
"required": true
},
"description": {
"type": "string",
"required": false
},
"battery": {
"type": "integer",
"required": false,
"maxValue": 100,
"minValue": 0
},
"geom": {
"type": "string",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"uuid": {
"type": "string",
"required": true,
"maxLength": 16,
"minLength": 16
}
}
}
Example:
{
"id": 17,
"name": "Dr. Brown",
"major": 21,
"minor": 17,
"description": "Beacon embedded in Dr. Trevone Brown's badge",
"battery": 67,
"geom": "0101000020110F00002026E17E467730411CAB5E4354D15541",
"zone_id": 12,
"uuid": "0123456789abcdef",
"state": null
"last_seen": 1452702712,
"owner_id": null
}
HTTP status code 404
Requested beacon not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
put /beacons/{beacon_id}
Update a known beacon
URI Parameters
- beacon_id: required (string)
HTTP status code 200
beacon updated successfully
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": true
},
"state": {
"type": "string",
"required": false
},
"owner_id": {
"type": "integer",
"required": false
},
"last_seen": {
"type": "timestamp",
"required": false
},
"major": {
"type": "integer",
"required": true
},
"minor": {
"type": "integer",
"required": true
},
"description": {
"type": "string",
"required": false
},
"battery": {
"type": "integer",
"required": false,
"maxValue": 100,
"minValue": 0
},
"geom": {
"type": "string",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"uuid": {
"type": "string",
"required": true,
"maxLength": 16,
"minLength": 16
}
}
}
Example:
{
"id": 17,
"name": "Dr. Brown",
"major": 21,
"minor": 17,
"description": "Beacon embedded in Dr. Trevone Brown's badge",
"battery": 67,
"geom": "0101000020110F00002026E17E467730411CAB5E4354D15541",
"zone_id": 12,
"uuid": "0123456789abcdef",
"state": null
"last_seen": 1452702712,
"owner_id": null
}
HTTP status code 404
beacon not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
delete /beacons/{beacon_id}
Delete a beacon
URI Parameters
- beacon_id: required (string)
HTTP status code 200
beacon successfully deleted
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 200
}
HTTP status code 404
beacon record not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
Collection of history
get
Get a list of history
get /beacons/{beacon_id}/history
Get a list of history
URI Parameters
- beacon_id: required (string)
Query Parameters
- orderby: (string)
Order by field
- order: (one of desc, asc - default: desc)
Order
- offset: (integer)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - query: (string)
JSON array [["field1","value1","operator1"],["field2","value2","operator2"],...,["fieldN","valueN","operatorN"]]
Example:
["username", "jackson", "="]
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "https://api.c3wireless.com/",
"required": true,
"properties": {
"data": {
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"beacon_id": {
"type": "integer",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"map_x": {
"type": "number",
"required": false
},
"map_y": {
"type": "number",
"required": false
},
"timestamp": {
"type": "string",
"required": true
},
"state": {
"type": "string",
"required": false
}
}
}
},
"status": {
"type": "integer",
"required": true
},
"error": {
"type": "string",
"required": false
}
}
}
Example:
{
"data": [
{
"beacon_id": 17,
"map_x": 102.99,
"map_y": 349.4,
"zone_id": null,
"timestamp": "2015-08-12 13:45:56",
"state": "Missing"
},
]
"status": 200
}
/zones
Collection of available zones
get
Get a list of zones
post
Add a new zone
get /zones
Get a list of zones
Query Parameters
- orderby: (string)
Order by field
- order: (one of desc, asc - default: desc)
Order
- offset: (integer)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - query: (string)
JSON array [["field1","value1","operator1"],["field2","value2","operator2"],...,["fieldN","valueN","operatorN"]]
Example:
[["mac", "ab1%", "like"],["name","Lobby", "="]]
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "https://api.c3wireless.com/",
"required": true,
"properties": {
"data": {
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"disabled": {
"type": "boolean",
"required": false
},
"name": {
"type": "string",
"required": true
},
"grid_string": {
"type": "string",
"required": true
},
"color": {
"type": "string",
"required": "true"
}
}
}
},
"status": {
"type": "integer",
"required": true
},
"error": {
"type": "string",
"required": false
}
}
}
Example:
{
"data": [
{
"id": 17,
"disabled": false,
"name": "Entryway",
"grid_string": "1,2,3,67,8,191",
"color": "00ffaa"
},
{
"id": 21,
"disabled": false,
"name": "Recovery Area",
"grid_string": "17,72,73,767,78,171",
"color": "ffffaa"
}
],
status: 200
}
post /zones
Add a new zone
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"geom": {
"type": "string",
"required": false
}
}
}
Example:
{
"name": "Office",
"id": 40,
"owner_id": 4
"geom": "0103000020110F00000100000006000000A08438C58D2061C1969C5307FBE048416AC09BC48D2061C1016904A3F6E04841349957C88B2061C1295891A0F6E04841A02191C98B2061C1BD8BE004FBE04841A02191C98B2061C1BD8BE004FBE04841A08438C58D2061C1969C5307F
BE04841"
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"id": 21,
"status": 201
}
HTTP status code 400
Error in submitted data
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 400,
"error": "Required field missing."
}
get
Retrieve a known zone
put
Update a known zone
delete
Delete a zone
get /zones/{zone_id}
Retrieve a known zone
URI Parameters
- zone_id: required (string)
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"geom": {
"type": "string",
"required": false
}
}
}
Example:
{
"name": "Office",
"id": 40,
"owner_id": 4
"geom": "0103000020110F00000100000006000000A08438C58D2061C1969C5307FBE048416AC09BC48D2061C1016904A3F6E04841349957C88B2061C1295891A0F6E04841A02191C98B2061C1BD8BE004FBE04841A02191C98B2061C1BD8BE004FBE04841A08438C58D2061C1969C5307F
BE04841"
}
HTTP status code 404
Requested zone not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
put /zones/{zone_id}
Update a known zone
URI Parameters
- zone_id: required (string)
HTTP status code 200
zone updated successfully
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": false
},
"geom": {
"type": "string",
"required": false
}
}
}
Example:
{
"name": "Office",
"id": 40,
"owner_id": 4
"geom": "0103000020110F00000100000006000000A08438C58D2061C1969C5307FBE048416AC09BC48D2061C1016904A3F6E04841349957C88B2061C1295891A0F6E04841A02191C98B2061C1BD8BE004FBE04841A02191C98B2061C1BD8BE004FBE04841A08438C58D2061C1969C5307F
BE04841"
}
HTTP status code 404
zone not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
delete /zones/{zone_id}
Delete a zone
URI Parameters
- zone_id: required (string)
HTTP status code 200
zone successfully deleted
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 200
}
HTTP status code 404
zone record not found
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 404,
"error": "Not Found"
}
Collection of available listeners
get
Get a list of listeners
post
Add a new listener
get /zones/{zone_id}/listeners
Get a list of listeners
URI Parameters
- zone_id: required (string)
Query Parameters
- orderby: (string)
Order by field
- order: (one of desc, asc - default: desc)
Order
- offset: (integer)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - query: (string)
JSON array [["field1","value1","operator1"],["field2","value2","operator2"],...,["fieldN","valueN","operatorN"]]
Example:
[["mac", "ab1%", "like"],["name","Lobby", "="]]
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "https://api.c3wireless.com/",
"required": true,
"properties": {
"data": {
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"disabled": {
"type": "boolean",
"required": false
},
"state": {
"type": "string",
"required": false
},
"name": {
"type": "string",
"required": true
},
"mac": {
"type": "string",
"required": true,
"minLength": 12,
"maxLength": 12
},
"description": {
"type": "string",
"required": false
},
"keywords": {
"type": "string",
"required": false
},
"map_x": {
"type": "number",
"required": false
},
"map_y": {
"type": "number",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"missing": {
"type": "boolean",
"required": false
}
}
}
},
"status": {
"type": "integer",
"required": true
},
"error": {
"type": "string",
"required": false
}
}
}
Example:
{
"data": [
{
"id": 17
"disabled": false
"name": "Lobby"
"mac": "0123456789ab"
"map_x": 100.384
"map_y": 203.23
"zone_id": 17
"missing": false
},
{
"id": 21
"disabled": false
"name": "Foyer"
"mac": "23456789abcd"
"map_x": 90.384
"map_y": 213.23
"zone_id": 17
"missing": false
}
],
"status": 200
}
post /zones/{zone_id}/listeners
Add a new listener
URI Parameters
- zone_id: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"owner_id": {
"type": "integer",
"required": false
},
"last_seen": {
"type": "timestamp",
"required": false
},
"state": {
"type": "string",
"required": false
},
"name": {
"type": "string",
"required": true
},
"mac": {
"type": "string",
"required": true,
"minLength": 12,
"maxLength": 12
},
"description": {
"type": "string",
"required": false
},
"geom": {
"type": "string",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
}
}
}
Example:
{
"id": 17,
"name": "Lobby",
"mac": "0123456789ab",
"geom": "0101000020110F00009E584C953E773041F4B0867357D15541",
"zone_id": 17,
"state": false,
"owner_id": null
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"id": 21,
"status": 201
}
HTTP status code 400
Error in submitted data
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 400,
"error": "Required field missing."
}
Collection of available beacons
get
Get a list of beacons
post
Add a new beacon
get /zones/{zone_id}/beacons
Get a list of beacons
URI Parameters
- zone_id: required (string)
Query Parameters
- orderby: (string)
Order by field
- order: (one of desc, asc - default: desc)
Order
- offset: (integer)
Skip over a number of elements by specifying an offset value for the query
Example:
20 - limit: (integer - default: 10)
Limit the number of elements on the response
Example:
80 - query: (string)
JSON array [["field1","value1","operator1"],["field2","value2","operator2"],...,["fieldN","valueN","operatorN"]]
Example:
[["mac", "ab1%", "like"],["name","Lobby", "="]]
Body
Type: application/json
Type: text/html
HTTP status code 200
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "https://api.c3wireless.com/",
"required": true,
"properties": {
"data": {
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"disabled": {
"type": "boolean",
"required": false
},
"name": {
"type": "string",
"required": true
},
"state": {
"type": "string",
"required": false
},
"categoryid": {
"type": "integer",
"required": false
},
"subcategoryid": {
"type": "integer",
"required": false
},
"mac": {
"type": "string",
"required": true,
"minLength": 17,
"maxLength": 17
},
"major": {
"type": "integer",
"required": true
},
"minor": {
"type": "integer",
"required": true
},
"description": {
"type": "string",
"required": false
},
"keywords": {
"type": "string",
"required": false
},
"last_battery": {
"type": "integer",
"required": false,
"maxValue": 100,
"minValue": 0
},
"map_x": {
"type": "number",
"required": false
},
"map_y": {
"type": "number",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"uuid": {
"type": "string",
"required": true,
"maxLength": 16,
"minLength": 16
},
"missing": {
"type": "boolean",
"required": false
}
}
}
},
"status": {
"type": "integer",
"required": true
},
"error": {
"type": "string",
"required": false
}
}
}
Example:
beacon-collection.samplepost /zones/{zone_id}/beacons
Add a new beacon
URI Parameters
- zone_id: required (string)
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"required": false
},
"name": {
"type": "string",
"required": true
},
"state": {
"type": "string",
"required": false
},
"owner_id": {
"type": "integer",
"required": false
},
"last_seen": {
"type": "timestamp",
"required": false
},
"major": {
"type": "integer",
"required": true
},
"minor": {
"type": "integer",
"required": true
},
"description": {
"type": "string",
"required": false
},
"battery": {
"type": "integer",
"required": false,
"maxValue": 100,
"minValue": 0
},
"geom": {
"type": "string",
"required": false
},
"zone_id": {
"type": "integer",
"required": false
},
"uuid": {
"type": "string",
"required": true,
"maxLength": 16,
"minLength": 16
}
}
}
Example:
{
"id": 17,
"name": "Dr. Brown",
"major": 21,
"minor": 17,
"description": "Beacon embedded in Dr. Trevone Brown's badge",
"battery": 67,
"geom": "0101000020110F00002026E17E467730411CAB5E4354D15541",
"zone_id": 12,
"uuid": "0123456789abcdef",
"state": null
"last_seen": 1452702712,
"owner_id": null
}
HTTP status code 201
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"id": 21,
"status": 201
}
HTTP status code 400
Error in submitted data
Body
Type: application/json
Schema:
{
"type": "object",
"$schema": "http://json-schema.org/draft-03/schema",
"id": "http://api.c3wireless.com",
"required": true,
"properties": {
"id": {
"type": "integer",
"required": false
},
"error": {
"type": "string",
"required": false
},
"status": {
"type": "number",
"required": true
}
}
}
Example:
{
"status": 400,
"error": "Required field missing."
}