Ona API
Authentication and Status Codes
Status Codes
Request based Authentication
Using Oauth2 with the Ona API
Making CORS - Cross-Origin Resource Sharing - requests to the Ona API
OpenID Connect Authentication
Charts
List of chart chart endpoints accessible to registered user
Get a list of chart field endpoints for a specific form or dataset.
Get a chart for a specific field in a form
Get a chart for field grouped by another field in the form
Get a chart data for all fields in a form
Data
GET JSON List of data end points
GET JSON List of data end points using limit operators
Fetch XForm ODK data for all forms per account in
csv
format
Stream XForm submission data in
csv
format
GET JSON List of data end points filter by owner
GET JSON list of submitted data for a specific form
GET XML list of submitted data for a specific form
Get FLOIP flow results for a specific form
Get FLOIP flow results for a specific submission
Paginate data of a specific form
Sort submitted data of a specific form using existing fields
Get a single data submission for a given form
Fetch data on select columns for a given form
Get the history of edits made to a submission
Query submitted data of a specific form
Query submitted data of a specific form using date_created
Query submitted data of a specific form using date_modified
Query submitted data of a specific form using last_edited
Query submitted data of a specific form using version
Query submitted data of a specific form using status
Query submitted data of a specific form using uuid
Query submitted data of a specific form using user
Query submitted data of a specific form using submitted_by
Query submitted data of a specific form using survey_type
Query submitted data of a specific form using media_all_received
Query submitted data of a specific form using Tags
Tag a submission data point
Delete a specific tag from a submission
Get list of public data endpoints
Get enketo edit link for a submission instance
Delete a specific submission instance
Delete a subset of submissions
Delete all submissions in a form
Permanent Deletion of Submissions
GEOJSON
OSM
DataView
Definition
Create a new DataView
Retrieve a DataView
List all DataView
Update a DataView
Patch a DataView
Delete a DataView
Retrieving Data from the DataView
Retrieving Data using limit operators
Counting the Data in the DataView
Example
Response
Example
Response
Example
Response
Example
Response
Example
Response
Merged Datasets
Definition
Create a new Merged Dataset
Retrieve a Merged Dataset
List all Merged Datasets
Update a Merged Dataset
Patch a Merged Dataset
Delete a Merged Dataset
Retrieving Data from a Merged Dataset
How data in parent forms differs from and affects the merged xform
Widgets
Definition
Create a new Widget
Retrieve a Widget
List all Widgets
Update a Widget
Patch a Widget
Delete a Widget
Widget Data
Widget Data With Valid Key
Filter Widget Using FormID
Filter Widget Using DataView ID
Stats
Stats Endpoints
Forms
Publish XLSForms, List, Retrieve Published Forms.
Publish FLOIP results data package
Get list of forms
Get list of forms filter by owner
Get a paginated list of forms
Get Form Information
Set Form Information
Replacing a Form
Delete Form
List of form data exports
Export form data asynchronously
Google Sheets Export
Export submitted data of a specific form version
Check progress of exporting form data asynchronously
Delete an XLS form asynchronously
List Forms
Get
JSON
|
XML
|
XLS
Form Representation
Get list of forms with specific tag(s)
Get list of Tags for a specific Form
Tag forms
Delete a specific tag
Get list of forms containing data with osm files
Get webform/enketo link
Get webform/enketo link with default form values
Get single submission url
Get form data in xls, csv format.
Get list of public forms
Share a form with a specific username or usernames
Preview a survey draft
Import CSV data to existing form
Import XLS, XLSX and CSV data to existing form
Upload a XLS form async
List out all retrievable XLS form versions
Retrieve JSON definition of an XLS Form version
Retrieve XML definition of an XLS Form version
Check on XLS form upload progress
FormList endpoints
GET a list of forms
Retreive forms within a project
Retreive a single form
Attachments and Media
Lists attachments of all xforms
Paginate attachment
Retrieve details of an attachment
Retrieve an attachment file
Lists attachments of a specific xform
Lists attachments of a merged dataset
Lists attachments of a filtered dataset
Lists attachments of a specific instance
Lists of attachment filter by attachment type
Retrieve image link of an attachment
Retrieve attachment count for a form
Metadata
Permissions
Get list of metadata
Get list of metadata for a specific form
Get a specific metadata
Add metadata or media file to a form
Link XForm or Dataview as a media to a form
Notes
List all notes
List all notes to a submission
Add a note to a submission
Delete a Note
Files
Redirect to final attachment url
Redirect to thumbnail/resized image of attachment
Projects
Register a new Project
List of Projects
Get a paginated list of Projects
List of Projects filter by owner/organization
Retrieve Project Information
Update Project Information
Available Permission Roles
Share a project with user(s)
Send an email to users on project share
Remove a user from a project
Assign a form to a project
Upload XLSForm to a project
Get forms for a project
Get list of projects with specific tag(s)
Get list of Tags for a specific Project
Tag a Project
Remove a tag from a Project
Add a star to a project
Remove a star to a project
Get user profiles that have starred a project
Get Project Invitation List
Get a list of project invitations with a specific status
Create a new project invitation
Update a project invitation
Resend a project invitation
Revoke a project invitation
Accept a project invitation
Form Submissions
Submit an XML XForm submission
Submit a JSON XForm submission
Submit a FLOIP XForm submission
Edit an existing XForm submission
RestServices
Permissions
Post Payload
Get list of Rest Services
Get a specific Rest Service
Add a Rest Service to a form
Delete a Rest Service
Adding TextIt
Adding Google Sheet Sync
Pushing Data To An Already linked Google Sheet
Overiding The Default Google Oauth2 redirect_uri
Submission Stats
Example
Response
SubmissionReview
Make a Submission Review
Update a Submission Review
Delete a Submission Review
Retrieve a Submission Review
Get a List of Submission Reviews
Bulk Create Submission Review
Filtering by Instance
Filtering by Status
Organizations
Register a new Organization
List of Organizations
List of Organizations Shared with Another User
Retrieve Organization Profile Information
Partial updates of Organization Profile Information
List Organization members
Add a user to an organization
Send an email to a user added to an organization
Change the role of a user in an organization
Remove a user from an organization
Profiles
Register a new User
List User Profiles
Retrieve User Profile Information
Partial updates of User Profile Information
Partial update for email requires password confirmation
Partial update of the metadata profile property
Change authenticated user’s password
Get the total number of monthly submissions
Email verification
Teams
GET List of Teams
GET Team Info for a specific team.
List members of a team
Add a user to a team
Set team default permissions on a project
Remove team default permissions on a project
User
Retrieve profile
Get projects that the authenticating user has starred
Request password reset
Reset user password
Expire temporary token
Users
List Users
List Users excluding organizations
Retrieve a specific user info
Search for a users using email
Flow Results Packages (Experimental)
Overview
Authentication
Onadata-Tableau
Tableau Web Data Connector Endpoints
Messaging
GET All event messages that have been sent for a form
GET List of events that have occured on a form for a specific verb
GET Paginate events messages for a specific verb
Messaging Stats
Example
Response
Ubuntu installation instructions
Get the code
Prepare OS
Database setup
Create a local_settings.py and update it accordingly
Set up and start your virtual environment or sandbox
Run make to set up onadata and for initial db setup
Compile api docs
Copy static files to static dir
Setup uwsgi init script
Setup celery service
Setup nginx
Mac OS Installation Instructions
Step 1: Install dependencies using brew
Step 2: Install pip and virtualenv
Step 3: Clone the sourcecode
Step 4: Install app requirements
Step 5: Install postgres and create your database
Step 6: Test installation using development server
Step 7: Using celery
onadata
onadata package
Ona API
Docs
»
onadata
»
onadata package
»
onadata.apps package
»
onadata.apps.api package
»
onadata.apps.api.models package
View page source
onadata.apps.api.models package
¶
Submodules
¶
onadata.apps.api.models.organization_profile module
¶
onadata.apps.api.models.team module
¶
onadata.apps.api.models.temp_token module
¶
Module contents
¶