API Specification

CBO Web Portal API documentation version 1.0

http://api.cboportaldev.com/1.0

---

/

The root of the application

/

• get: return the description of the supported operations/methods by this API endpoint

/auth

/auth

• post: Application post to this endpoint to get a bearer token. Return bearer token.
• delete: Revoke the current token used to authenticate the call.

/user

Provides methods to work on with the current logged in user information. Calls to this endpoint is allowed only after authentication.

/user

• get (secured): Get a detailed information of a user
• put (secured): Update an existing user

/organizations

Provide methods to list the organizations that the current logged in user have access to, and ability for the user to create a new organization.

/organizations

• get (secured): Get a list of organizations
• post (secured): Add a new organization

/check

Check availability of a subdomain name to be used as a campaign URL (public endpoint).

/check

• post:

/{organization_id}

/{organization_id}

• get (secured): return the description of the supported operations/methods by this API endpoint

/{organization_id}/profile

General information and setup of an organization.

• get (secured): Get a detailed information of a profile
• put (secured): Update an existing profile

/{organization_id}/users

Users as identified by emails that have access to the organization, and their access permission.

• get (secured): Get a list of users
• post (secured): Add a new user

/{organization_id}/users/{user_id}

• get (secured): Get a detailed information of a user

• put (secured): Update the specific user data/permissions related to the organization, only the admin of the organization can do this.

• delete (secured): Delete an existing user

/{organization_id}/programs

Programs represent a program that an organization has.

• get (secured): Get a list of programs
• post (secured): Add a new program

/{organization_id}/programs/{program_id}

• get (secured): Get a detailed information of a program
• put (secured): Update an existing program
• delete (secured): Delete an existing program

/{organization_id}/programs/{program_id}/students

List the students that is enrolled in this program.

• get (secured): Get a list of students
• post (secured): Add a new student

/{organization_id}/students

• get (secured): Get a list of students
• post (secured): Insert or update a student. An update will be performed, and a response code 200 will be returned, if the student matched first name, last name, and e-mail address. An insert will be performed and a response code of 201 will be returned, if the first name, last name and email address didn't match any current student in the organization.

/{organization_id}/students/{student_id}

• get (secured): Get a detailed information of a student
• put (secured): Update an existing student
• delete (secured): Delete an existing student

/{organization_id}/students/{student_id}/backpack

Return the information about a student from the district (Student backpack).

• get (secured): Get a detailed information of a backpack

/{organization_id}/students/{student_id}/programs

• get (secured): Get a list of programs
• post (secured): Add a new program

/{organization_id}/tags

• get (secured): Get a list of tags
• post (secured): Add a new tag

/{organization_id}/tags/{tag_id}

• get: Get a detailed information of a tag
• put: Update an existing tag
• delete: Delete an existing tag

/{organization_id}/assets

• get (secured): Get a list of assets
• post (secured): Add a new asset

/{organization_id}/assets/{asset_id}

• get: Get a detailed information of a asset
• put: Update an existing asset
• delete: Delete an existing asset