Show/hide List Operations Expand Operations

DailySummary

GET /api/daily_summaries.{_format}

Retrieves the collection of DailySummary resources.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Filters

Name

Information

userId

Property	userId
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

username

Property	username
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

date[before]

Property	date
Type	DateTimeInterface
Required	false

date[after]

Property	date
Type	DateTimeInterface
Required	false

order[date]

Property	date
Type	string
Required	false

Return

Parameter	Type	Versions
200
date	datetime	*
pointCount	integer	*
trackingAppNames		*
pointsByHour		*
trackingCompliance		*
id	integer	*
user	IRI	*
userId	integer	*

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/daily_summaries.{_format}

Creates a DailySummary resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Parameters

Parameter	Type	Required?	Format
date	datetime	true	{DateTime Y-m-d\TH:i:sP}
trackingCompliance		false
user	IRI	false

Return

Parameter	Type	Versions
200
date	datetime	*
pointCount	integer	*
trackingAppNames		*
pointsByHour		*
trackingCompliance		*
id	integer	*
user	IRI	*
userId	integer	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/daily_summaries/{id}.{_format}

Retrieves DailySummary resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Return

Parameter	Type	Versions
200
date	datetime	*
pointCount	integer	*
trackingAppNames		*
pointsByHour		*
trackingCompliance		*
id	integer	*
user	IRI	*
userId	integer	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/daily_summaries/{id}.{_format}

Replaces the DailySummary resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Parameters

Parameter	Type	Required?	Format
date	datetime	true	{DateTime Y-m-d\TH:i:sP}
trackingCompliance		false
user	IRI	false

Return

Parameter	Type	Versions
200
date	datetime	*
pointCount	integer	*
trackingAppNames		*
pointsByHour		*
trackingCompliance		*
id	integer	*
user	IRI	*
userId	integer	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

OAuthAccessToken

GET /api/o_auth_access_tokens.{_format}

Retrieves the collection of OAuthAccessToken resources.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Filters

Name

Information

userId

Property	userId
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

username

Property	username
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

Return

Parameter	Type	Versions
200
id	integer	*
client	object (Client)	*
client[id]	integer	*
client[randomId]	string	*
client[redirectUris]		*
client[system]	boolean	*
user	IRI	*
expiresAt	integer	*
scope	string	*
username	string	*
clientCode	string	*
clientRedirectUris		*

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/o_auth_access_tokens/{id}.{_format}

Retrieves OAuthAccessToken resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Return

Parameter	Type	Versions
200
id	integer	*
client	object (Client)	*
client[id]	integer	*
client[randomId]	string	*
client[redirectUris]		*
client[system]	boolean	*
user	IRI	*
expiresAt	integer	*
scope	string	*
username	string	*
clientCode	string	*
clientRedirectUris		*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

OAuthClient

GET /api/o_auth_clients.{_format}

Retrieves the collection of OAuthClient resources.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Filters

Name

Information

randomId

Property	randomId
Type	string
Required	false
Strategy	exact

randomId[]

Property	randomId
Type	string
Required	false
Strategy	exact

userId

Property	userId
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

username

Property	username
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

Return

Parameter	Type	Versions
200
id	integer	*
allowedGrantTypes		*
randomId	string	*
secret	string	*
redirectUris		*
system	boolean	*

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/o_auth_clients.{_format}

Creates a OAuthClient resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Parameters

Parameter	Type	Required?
allowedGrantTypes		false
randomId	string	false
secret	string	false
redirectUris		false
system	boolean	false

Return

Parameter	Type	Versions
200
id	integer	*
allowedGrantTypes		*
randomId	string	*
secret	string	*
redirectUris		*
system	boolean	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/o_auth_clients/{id}.{_format}

Retrieves OAuthClient resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Return

Parameter	Type	Versions
200
id	integer	*
allowedGrantTypes		*
randomId	string	*
secret	string	*
redirectUris		*
system	boolean	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/o_auth_clients/{id}.{_format}

Replaces the OAuthClient resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Parameters

Parameter	Type	Required?
allowedGrantTypes		false
randomId	string	false
secret	string	false
redirectUris		false
system	boolean	false

Return

Parameter	Type	Versions
200
id	integer	*
allowedGrantTypes		*
randomId	string	*
secret	string	*
redirectUris		*
system	boolean	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

OAuthConnect

GET /api/o_auth_connects.{_format}

Retrieves the collection of OAuthConnect resources.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Filters

Name

Information

userId

Property	userId
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

username

Property	username
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

Return

Parameter	Type	Versions
200
id	integer	*
oauthType	string	*
connected	boolean	*
user	IRI	*
nickname	string	*
username	string	*
email	string	*

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/o_auth_connects.{_format}

Creates a OAuthConnect resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Parameters

Parameter	Type	Required?
id	integer	false
oauthType	string	false
connected	boolean	false
user	IRI	false
nickname	string	false
username	string	false
email	string	false

Return

Parameter	Type	Versions
200
id	integer	*
oauthType	string	*
connected	boolean	*
user	IRI	*
nickname	string	*
username	string	*
email	string	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/o_auth_connects/{id}.{_format}

Deletes the OAuthConnect resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/o_auth_connects/{id}.{_format}

Retrieves OAuthConnect resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Return

Parameter	Type	Versions
200
id	integer	*
oauthType	string	*
connected	boolean	*
user	IRI	*
nickname	string	*
username	string	*
email	string	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/o_auth_connects/{id}.{_format}

Replaces the OAuthConnect resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Parameters

Parameter	Type	Required?
id	integer	false
oauthType	string	false
connected	boolean	false
user	IRI	false
nickname	string	false
username	string	false
email	string	false

Return

Parameter	Type	Versions
200
id	integer	*
oauthType	string	*
connected	boolean	*
user	IRI	*
nickname	string	*
username	string	*
email	string	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

Track

GET /api/tracks.{_format}

Retrieves the collection of Track resources.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Filters

Name

Information

localDate

Property	localDate
Type	string
Required	false
Strategy	exact

localDate[]

Property	localDate
Type	string
Required	false
Strategy	exact

order[timestamp]

Property	timestamp
Type	string
Required	false

userId

Property	userId
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

username

Property	username
Type	string
Required	false
Description	Only ROLE_ADMIN is allowed to set this filter

timestamp[before]

Property	timestamp
Type	DateTimeInterface
Required	false

timestamp[after]

Property	timestamp
Type	DateTimeInterface
Required	false

Return

Parameter	Type	Versions
200
longitude	string	*
latitude	string	*
accuracy	string	*
speed	string	*
timestamp	datetime	*
deviceLocaltime	datetime	*
localDate	string	*
user	IRI	*
userId	integer	*

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/tracks/{id}.{_format}

Retrieves Track resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Return

Parameter	Type	Versions
200
longitude	string	*
latitude	string	*
accuracy	string	*
speed	string	*
timestamp	datetime	*
deviceLocaltime	datetime	*
localDate	string	*
user	IRI	*
userId	integer	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

TrackingApp

GET /api/tracking_apps.{_format}

Retrieves the collection of TrackingApp resources.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Return

Parameter	Type	Versions	Description
200

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/tracking_apps.{_format}

Creates a TrackingApp resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Return

Parameter	Type	Versions	Description
200

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/tracking_apps/{id}.{_format}

Deletes the TrackingApp resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/tracking_apps/{id}.{_format}

Retrieves TrackingApp resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Return

Parameter	Type	Versions	Description
200

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/tracking_apps/{id}.{_format}

Replaces the TrackingApp resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Return

Parameter	Type	Versions	Description
200

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

Show/hide List Operations Expand Operations

User

GET /api/participants

Retrieves the collection of User resources.

Documentation
Sandbox

Filters

Name

Information

adminsOnly

Property	adminsOnly
Type	boolean
Required	false
Description	If \"true\", returns admins only

oauthClient

Property	oauthClient
Type	string
Required	false
Description	Filter by oauth client, to which the users granted access to their tracks

username

Property	username
Type	string
Required	false
Strategy	partial

Property	email
Type	string
Required	false
Strategy	partial

Return

Parameter	Type	Versions
200
id	integer	*
enrollmentDate	datetime	*
username	string	*
email	string	*
roles		*
trackCount	integer	*
complianceSummary		*
mobilePhone	string	*

Input

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/security/register

Creates a User resource.

Documentation
Sandbox

Parameters

Parameter	Type	Required?
username	string	true
email	string	true
roles		false
complianceSummary		false
mobilePhone	string	false

Return

Parameter	Type	Versions
200
id	integer	*
enrollmentDate	datetime	*
username	string	*
email	string	*
roles		*
trackCount	integer	*
complianceSummary		*
mobilePhone	string	*

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/users.{_format}

Retrieves the collection of User resources.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
_format

Filters

Name

Information

adminsOnly

Property	adminsOnly
Type	boolean
Required	false
Description	If \"true\", returns admins only

oauthClient

Property	oauthClient
Type	string
Required	false
Description	Filter by oauth client, to which the users granted access to their tracks

username

Property	username
Type	string
Required	false
Strategy	partial

Property	email
Type	string
Required	false
Strategy	partial

Return

Parameter	Type	Versions
200
id	integer	*
enrollmentDate	datetime	*
username	string	*
email	string	*
roles		*
trackCount	integer	*
complianceSummary		*
mobilePhone	string	*

Input

Requirements

= -

Filters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

DELETE /api/users/{id}.{_format}

Deletes the User resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/users/{id}.{_format}

Retrieves User resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Return

Parameter	Type	Versions
200
id	integer	*
enrollmentDate	datetime	*
username	string	*
email	string	*
roles		*
trackCount	integer	*
complianceSummary		*
mobilePhone	string	*

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/users/{id}.{_format}

Replaces the User resource.

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
id
_format

Parameters

Parameter	Type	Required?
username	string	true
email	string	true
roles		false
complianceSummary		false
mobilePhone	string	false

Return

Parameter	Type	Versions
200
id	integer	*
enrollmentDate	datetime	*
username	string	*
email	string	*
roles		*
trackCount	integer	*
complianceSummary		*
mobilePhone	string	*

Input

Requirements

= -

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/admin/servers

Documentation
Sandbox

Status Codes

Status Code	Description
200	Successful

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/admin/statistics

Documentation
Sandbox

Status Codes

Status Code	Description
200	Successful

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/current_project

Documentation
Sandbox

Status Codes

Status Code	Description
200	Successful

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/observe/bg-geo-settings
- Documentation
- Sandbox
Input

Headers
= -

= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line
POST /api/observe/clear-push-token
- Documentation
- Sandbox
Input

Headers
= -

= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/observe/location/{userId}

Documentation
Sandbox

Requirements

Name	Requirement	Type	Description
userId

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/observe/register-device
- clientData: {device: {uuid, platform, version, model},token}
- Documentation
- Sandbox
Input

Headers
= -

= -

Content
= Replaces header if set
Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/observe/servers

Documentation
Sandbox

Requirements

Name	Type	Description
app_name	string	E.g MapMob
app_version	string	E.g 1.0.23
profile	string	dev_profile for Crashlytics and prod_profile for markets

Status Codes

Status Code	Description
200	Successful

Input

Requirements

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/security/check-token

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
token	string	true

Status Codes

Status Code	Description
200	Successful
400	Token is invalid

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/security/login

Documentation
Sandbox

Parameters

Parameter	Type	Required?	Format	Description
username	string	true
password	string	true

Status Codes

Status Code	Description
200	Successful
401	Wrong credentials

Input

Parameters

= -

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/security/user

Documentation
Sandbox

Status Codes

Status Code	Description
200	Successful
401	Token is invalid

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /rapidpro-webhook/register-user

Documentation
Sandbox

Status Codes

Status Code	Description
200	Always

Input

Headers

= -

Content

= Replaces header if set

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /rapidpro-webhook/user-exists

Documentation
Sandbox

Status Codes

Status Code	Description
200	Always

Input

Headers

= -

Content

= Replaces header if set

API documentation

DailySummary

GET /api/daily_summaries.{_format}

Requirements

Filters

Return

200

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

POST /api/daily_summaries.{_format}

Requirements

Parameters

Return

200

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/daily_summaries/{id}.{_format}

Requirements

Return

200

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

PUT /api/daily_summaries/{id}.{_format}

Requirements

Parameters

Return

200

Requirements

Parameters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

OAuthAccessToken

GET /api/o_auth_access_tokens.{_format}

Requirements

Filters

Return

200

Requirements

Filters

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

GET /api/o_auth_access_tokens/{id}.{_format}

Requirements

Return

200

Requirements

Request URL

Request body

Response Headers [Expand] [Profiler]

Response Body [Raw]

Curl Command Line

OAuthClient

GET /api/o_auth_clients.{_format}

Requirements

Filters

Return

200

Requirements

Filters

Request URL