Configuration APIs
Server Configuration
Registration Configuration
Authentication APIs
Token-Based Authentication
required
Username
required
Password
required
Client
Authentication
required
Username
required
Password
required
Client
Who Am I
Logout
required
Client
Change Password
required
Username
required
Password
required
New Password
required
Client
Username of user whose password to change
Audit APIs
Audit Read
required
Client
required
Token
Request Type
URI
Client
Device ID
Response Type
ErrorCode
Start Date
End Date
Registration APIs
Self-Registration
required
Username
required
Password
required
Email Address
required
Client
Get ReCaptcha Image
Password Reset
required
Username
required
Email Address
required
Client
User APIs
Create User
required
Token
required
Username
required
Password
required
Client
required
Admin
required
Enabled
New Account
Campaign Creation Privilege
User Read
required
Client
User List
Username Search
Email Address Search
Admin
Enabled
New Account
Campaign Creation Privilege
First Name Search
Last Name Search
Organization Search
Personal ID Search
Campaign ID List
Class ID List
Number to Skip
Number to Return
User Setup
required
Client
required
First Name
required
Last Name
required
Organization
required
Personal ID
User Name Prefix
User Name Digits
User Search
required
Client
Username
Admin
Enabled
New Account
Campaign Creation Privilege
First Name
Last Name
Organization
Personal ID
Email Address
JSON Data
Number to Skip
Number to Return
User Info Read
required
Client
Username
User Stats
required
Campaign ID
required
Username
required
Client
User Update
required
Token
required
Username
Email Address
Admin
Enabled
New Account
Campaign Creation Privilege
Class Creation Privilege
User Setup Privilege
First Name
Last Name
Organization
Personal ID
Delete Personal Info
Client:
User Delete
required
Token
required
User List
required
Client
Campaign APIs
Campaign Create
required
Token
required
Running State
required
Privacy State
required
Class ID List
required
XML
required
Client
Campaign ID
Campaign Name
Description
Campaign Read
required
Output Format
required
Client
Campaign URN List
Class URN List
Name Search
Description Search
Start Date
End Date
Privacy State
Running State
Campaign Role
Campaign Search
required
Client
Campaign URN Search
Campaign Name Search
Description Search
Xml Search
Authored By Search
Start Date
End Date
Privacy State
Running State
Campaign Update
required
Token
required
Campaign ID
Client
New Running State
New Privacy State
Class ID List
XML
Description
User-Role List Add:
User-Role List Remove
Campaign Delete
required
Token
required
Campaign ID
required
Client
Class APIs
Class Create
required
Token
required
Class ID
required
Class Name
required
Client
Description
Class Read
required
Client
required
Class List
optional
Name Search
optional
Description Search
optional
Role
With User List
Class Search
required
Client
Class ID
Class Name
Description
Num to Skip
Num to Return
Class Roster Read
required
Class List
required
Client
Class Update
required
Token
required
Class ID
required
Client
New Name
New Description
User List Add
Privileged User List Add
User List Remove
Class Roster Update
required
Token
required
Roster
required
Client
Class Delete
required
Token
required
Class ID
required
Client
Document APIs
Document Create
required
Token
required
Name
required
Privacy State
required
Document
required
Client
either this ...
Campaign-Role List
... or this
Class-Role List
Description
Document Read
required
Client
required
Personal Documents
Campaign ID List
Class ID List
Name Search
Description Search
Document Read Contents
required
Document ID
required
Client
Document Update
required
Token
required
Document ID
required
Client
New Name
New Privacy State
New Contents
New Description
Campaign-Role List Add
Campaign List Remove
Class-Role List Add
Class List Remove
User-Role List Add
User List Remove
Document Delete
required
Token
required
Document ID
required
Client
Survey APIs
Survey Upload
required
User
required
Password
required
Client
required
Campaign URN
required
Campaign Creation Timestamp
required
Surveys
Images
Auth Token Survey Upload
required
Auth Token
required
Client
required
Campaign URN
required
Campaign Creation Timestamp
required
Surveys
Images
Survey Response Read
required
Campaign ID
required
Column List
required
Output Format
required
User List
Client
either this ...
Survey ID List
... or this
Prompt ID List
Privacy State
Suppress Metadata
Start Date
End Date
Prompt Response Search
Sort Order
Pretty Print
Return ID
Collapse
Survey Response ID List
Num Responses to Skip
Num Responses to Process
Survey Response Update
required
Token
required
Campaign ID
required
Survey ID List
required
Privacy State
required
Client
Image Read
required
Client
required
Image ID
required
Campaign ID
required
Owner
Size
Video Read
required
Client
required
Video ID
Audio Read
required
Client
required
Audio ID
Image ZIP Read
required
Campaign ID
required
User List
Client
either this ...
Survey ID List
... or this
Prompt ID List
Privacy State
Start Date
End Date
Survey Response ID List
Survey Response Function Read
required
Campaign ID
required
Function ID
required
Client
Privacy State Items
Survey Response Delete
required
Token
required
Campaign ID
required
Survey Response ID
required
Client
Mobility APIs
Mobility Upload
required
User
required
Password
required
Client
required
Data
Mobility Dates Read
Start Date
End Date
Username
required
Client
Mobility Read
required
Date
required
Client
Username
either this ...
With Sensor Data (Deprecated)
... or this
Columns
Mobility Read CSV
required
Client
Start Date
End Date
Username
Columns
Mobility Chunked Read
required
Start Date
required
End Date
required
Client
Chunk Minutes
Mobility Update
required
Token
required
Client
required
Mobility ID
Privacy State
Mobility Aggregate Read
required
Start Date
required
End Date
required
Duration
required
Client
Username
Visualization APIs
Survey Response Count Visualization
required
Width
required
Height
required
Campaign ID
Start Date
End Date
Privacy State
Aggregate
required
Client
Survey Responses Privacy State Visualization
required
Width
required
Height
required
Campaign ID
Start Date
End Date
Privacy State
required
Client
Survey Responses Privacy State Over Time Visualization
required
Width
required
Height
required
Campaign ID
Start Date
End Date
Privacy State
Aggregate
required
Client
User Timeseries Visualization
required
Width
required
Height
required
Campaign ID
Start Date
End Date
Privacy State
required
Client
required
Prompt ID
required
User
Prompt Timeseries Visualization
required
Width
required
Height
required
Campaign ID
Start Date
End Date
Privacy State
Aggregate
required
Client
required
Prompt ID
Prompt Distribution Visualization
required
Width
required
Height
required
Campaign ID
Start Date
End Date
Privacy State
required
Client
required
Prompt ID
Scatter Plot Visualization
required
Width
required
Height
required
Campaign ID
Start Date
End Date
Privacy State
required
Client
required
Prompt ID
required
Prompt2 ID
2D Density Visualization
required
Width
required
Height
required
Campaign ID
Start Date
End Date
Privacy State
required
Client
required
Prompt ID
required
Prompt2 ID
Annotation APIs
Create Survey Response Annotation
required
Auth Token
required
Client
required
Survey ID
required
Time
required
Timezone
required
Annotation Text
Read Survey Response Annotation
required
Auth Token
required
Client
required
Survey ID
Create Prompt Response Annotation
required
Auth Token
required
Client
required
Survey ID
required
Prompt ID
Repeatable Set ID
Repeatable Set Iteration
required
Time
required
Timezone
required
Annotation Text
Read Prompt Response Annotation
required
Auth Token
required
Client
required
Survey ID
required
Prompt ID
Repeatable Set ID
Repeatable Set Iteration
Annotation Update
required
Auth Token
required
Client
required
Annotation ID
required
Time
required
Timezone
required
Annotation Text
Annotation Delete
required
Auth Token
required
Client
required
Annotation ID
Observer APIs
Create Observer
required
Auth Token
required
Client
required
Observer XML
Read Observer
required
Auth Token
required
Client
Observer ID
Observer Version
Number to Skip
Number to Return
Update Observer
required
Auth Token
required
Client
required
Observer XML
Data Stream Read
required
Client
required
Observer ID
Observer Version
required
Stream ID
required
Stream Version
Username
Start Date
End Date
Column list
Chronological
Number to Skip
Number to Return
Open mHealth APIs
OMH Authentication
required
Username
required
Password
required
Requester
Registry Create
required
Authentication Token
required
Requester
Payload ID
Registry Read
Payload ID
Payload Version
Number of Results to Skip
Number of Results to Return
Registry Update
required
Authentication Token
required
Requester
Payload ID
OMH Catalog
required
Authentication Token
required
Requester
Payload ID
OMH Read
required
Authentication Token
required
Requester
required
Payload ID
required
Payload Version
Owner
Start Date
End Date
Column List
Number of Results to Skip
Number of Results to Return