API: Organizations endpoints¶
/organizations¶
GET /organizations¶
List owned and managed organizations.
[] Output:
- list
- string code: organization identification string
- string name: title of the organization
/organization¶
GET /organization¶
Get/check organization.
[] Input:
- [!] string organization: organization identification string
[] Output:
- string organization: organization identification string
- string name: title of the organization
/organization:members¶
GET /organization:members¶
List all members in a organization.
[] Input:
- [!] string organization: organization identification string
[] Output:
- list
- string code: user identification string
- string name: name of the member
- string/null department: name of the department (if member)
- list permission
- list organization: permission level to organization
- list content: permission level to contents in organization
POST /organization:members¶
Assign user(s) to a organization. Updates memberships if already member of the organization.
[] Input:
- [!] string organization: organization identification string
- [!] string users: comma-separated list of user identification strings
- string department: optional name of department
- department and permission_ fields should not be used together
- string permission_organization: optional permission level to organization
- possible values: member / teacher / supervisor / admin
- default: member
- string permission_content: optional permission level to contents in organization
- possible values: none / view / control / modify / grant / admin
- default: none
- boolean notify: notify users
- default: false
DELETE /organization:members¶
Remove user(s) from a organization.
[] Input:
- [!] string organization: organization identification string
- [!] string users: comma-separated list of user identification strings
/organizations:members¶
POST /organizations:members¶
Assign user(s) to organization(s). Updates memberships if already member of a organization.
[] Input:
- [!] string organizations: comma-separated list of organization identification strings
- [!] string users: comma-separated list of user identification strings
- string department: optional name of department
- if department is not found in an organization, permission_ fields are used to set permission levels
- string permission_organization: optional permission level to organization
- possible values: member / teacher / supervisor / admin
- default: member
- string permission_content: optional permission level to contents in organization
- possible values: none / view / control / modify / grant / admin
- default: none
- boolean notify: notify users
- default: false
/user:organizations¶
GET /user:organizations¶
List all organizations a user is member of.
[] Input:
- [!] string user: user identification string
[] Output:
- list
- string code: organization identification string
- string name: title of the organization
- string link: link to the organization manager page
- string/null department: name of the department (if member)
- list permission
- list organization: permission level to organization
- list content: permission level to contents in organization
POST /user:organizations¶
Assign user to organization(s). Updates membership if already member of a organization.
[] Input:
- [!] string user: user identification string
- [!] string organizations: comma-separated list of organization identification strings
- string department: optional name of department
- if department is not found in an organization, permission_ fields are used to set permission levels
- string permission_organization: optional permission level to organization
- possible values: member / teacher / supervisor / admin
- default: member
- string permission_content: optional permission level to contents in organization
- possible values: none / view / control / modify / grant / admin
- default: none
- boolean notify: notify user
- default: false
DELETE /user:organizations¶
Remove user from organization(s).
[] Input:
- [!] string user: user identification string
- [!] string organizations: comma-separated list of organization identification strings