New APIs

New APIs

The New APIs table lists the APIs available for the new management of Power Users. These APIs will be fully operational starting on October 27, 2020.

For each new API, the list of parameters is detailed in the following sections.

Unassign Power Users

DELETE /poweruser/v1/powerusers @parameter user_ids [array(integer), required] Array of Power User IDs to unassign, leave an empty array in order to use the all option @parameter user_all [boolean, required] True to take count of all Power Users, false otherwise @parameter user_filters [object, optional] Filter the full Power User list based on the options specified @item search [string, optional] Search PowerUser based on username, firstname, lastname, email. @item profile_id [integer, optional] Filter by the given profile ID @item without_profiles [boolean, optional] Filter for PowerUsers without a profile. Default: false @item without_users [boolean, optional] Filter for PowerUsers without assigned users. Default: false @item without_groups [boolean, optional] Filter for PowerUsers without assigned groups. Default: false @item without_branches [boolean, optional] Filter for PowerUsers without assigned branches. Default: false @item without_courses [boolean, optional] Filter for PowerUsers without assigned courses. Default: false @item without_lps [boolean, optional] Filter for PowerUsers without assigned learning plans. Default: false @item without_categories [boolean, optional] Filter for PowerUsers without assigned categories. Default: false @item without_catalogs [boolean, optional] Filter for PowerUsers without assigned catalogs. Default: false @item without_locations [boolean, optional] Filter for PowerUsers without assigned locations. Default: false

Retrieve the List of Power Users

GET /poweruser/v1/powerusers @parameter profile_id [integer, optional] Filter by the given profile ID @parameter without_profiles [boolean, optional] Filter for PowerUsers without profile. Default: false @parameter without_users [boolean, optional] Filter for PowerUsers without assigned users. Default: false @parameter without_groups [boolean, optional] Filter for PowerUsers without assigned groups. Default: false @parameter without_branches [boolean, optional] Filter for PowerUsers without assigned branches. Default: false @parameter without_courses [boolean, optional] Filter for PowerUsers without assigned courses. Default:  false @parameter without_lps [boolean, optional] Filter for PowerUsers without assigned learning plans. Default: false @parameter without_categories [boolean, optional] Filter for PowerUsers without assigned categories. Default: false @parameter without_catalogs [boolean, optional] Filter for PowerUsers without assigned catalogs. Default: false @parameter without_locations [boolean, optional] Filter for PowerUsers without assigned locations. Default: false @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(username, firstname, lastname, email), optional] Sort attribute. Default value: username @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: asc @parameter search [string, optional] Search for Power User based on username, firstname, lastname, email.

Create Power Users

POST /poweruser/v1/powerusers @parameter user_ids [array(integer), required] Array of normal user IDs that will be promoted to Power Users

Batch Unassign Power Users

DELETE /poweruser/v1/powerusers/batch @parameter items [array, required] Associative array containing the Power User IDs to unassign @item user_id [integer, required] Power User ID

Retrieve the Details of a Power User

GET /poweruser/v1/powerusers/{user_id} @get user_id [integer, required] The Power User ID

Update Power User

PUT  /poweruser/v1/powerusers/{user_id} @get user_id [integer, required] The Power User ID to update @parameter profile_ids [array(integer), required] The list of profile IDs to associate. Leave an empty array to remove all profiles associated

Retrieve the list of Profiles assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/profiles @get user_id [integer, required] Power User ID to retrieve the assigned profiles @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(name, description, created_at), optional] Sort attribute. Default value: created_at @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: desc @parameter search [string, optional] Search for profiles based on name, description @parameter show_assignable_profiles [boolean, optional] If true, retrive the assignable profiles instead of the assigned ones. Default: false

Unassign Profiles

DELETE /poweruser/v1/powerusers/profiles @parameter user_ids [array(integer), required] Array of Power User IDs from which unassign profiles, leave an empty array in order to use the all option @parameter user_all [boolean, required] If True to take count of all Power Users, if false otherwise @parameter user_filters [object, optional] Filter the full Power User list based on the options specified @item search [string, optional] Search Power User based on username, firstname, lastname, email. @item profile_id [integer, optional] Filter by the given profile ID @item without_profiles [boolean, optional] Filter for Power Users without a profile. Default: false @item without_users [boolean, optional] Filter for Power Users without assigned users. Default: false @item without_groups [boolean, optional] Filter for Power Users without assigned groups. Default: false @item without_branches [boolean, optional] Filter for Power Users without assigned branches. Default: false @item without_courses [boolean, optional] Filter for Power Users without assigned courses. Default: false @item without_lps [boolean, optional] Filter for Power Users without assigned learning plans. Default: false @item without_catalogs [boolean, optional] Filter for Power Users without assigned catalogs. Default: false @item without_locations [boolean, optional] Filter for Power Users without assigned locations. Default: false @parameter profile_ids [array(integer), required] Array of the profile IDs to unassign, leave an empty array in order to use the all option @parameter profile_all [boolean, required] True to take count of all profiles, false otherwise @parameter profile_filters [object, optional] Filter the full profile list based on the options specified @item search [string, optional] Search profiles based on name, description @item with_permissions [boolean, optional] Filter for profiles with at least one assigned permission. Default: false @item without_permissions [boolean, optional] Filter for profiles without assigned permissions. Default: false @item with_power_users [boolean, optional] Filter for profiles with at least one Power User. Default: false @item without_power_users [boolean, optional] Filter for profiles without Power Users. Default: false

Assign Profiles to Power Users

PUT /poweruser/v1/powerusers/profiles @parameter user_ids [array(integer), required] Array of power user ids from which assign profiles, leave an empty array in order to use the all option @parameter user_all [boolean, required] True to take count of all power users, false otherwise @parameter user_filters [object, optional] Filter the full power user list based on the options specified @item search [string, optional] Search for Power User based on username, firstname, lastname, email. @item profile_id [integer, optional] Filter by the given profile ID @item without_profiles [boolean, optional] Filter for Power Users without a profile. Default: false @item without_users [boolean, optional] Filter for Power Users without assigned users. Default: false @item without_groups [boolean, optional] Filter for Power Users without assigned groups. Default: false @item without_branches [boolean, optional] Filter for Power Users without assigned branches. Default: false @item without_courses [boolean, optional] Filter for Power Users without assigned courses. Default: false @item without_lps [boolean, optional] Filter for Power Users without assigned learning plans. Default: false @item without_categories [boolean, optional] Filter for Power Users without assigned categories. Default: false @item without_catalogs [boolean, optional] Filter for Power Users without assigned catalogs. Default: false @item without_locations [boolean, optional] Filter for Power Users without assigned locations. Default: false @parameter profile_ids [array(integer), required] Array of profile IDs to assign, leave an empty array in order to use the all option @parameter profile_all [boolean, required] True to take count of all profiles, false otherwise @parameter profile_filters [object, optional] Filter the full profile list based on the options specified @item search [string, optional] Search profiles based on name, description @item with_permissions [boolean, optional] Filter for profiles with at least one assigned permission. Default: false @item without_permissions [boolean, optional] Filter for profiles without assigned permissions. Default: false @item with_power_users [boolean, optional] Filter for profiles with at least one Power User. Default: false @item without_power_users [boolean, optional] Filter for profiles without Power Users. Default: false

Batch Unassign Profiles

DELETE /poweruser/v1/powerusers/profiles/batch @parameter items [array, required] Associative array containing key/value pairs to remove profiles from Power Users @item user_id [integer, required] Power User ID @item profile_id [integer, required] Profile ID

Batch Assign Profiles

PUT /poweruser/v1/powerusers/profiles/batch @parameter items [array, required] Associative array containing key/value pairs of profiles and Power Users to assign @item user_id [integer, required] Power User ID @item profile_id [integer, required] Profile ID

Unassign Users from Power User

DELETE /poweruser/v1/powerusers/{user_id}/users @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of users IDs that will be unassigned from the Power User. It can be omitted if all is passed as true @parameter all [boolean, optional] If true and the id_list is empty, all the unassignable users will be removed from the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search users based on username, firstname, lastname, email

Retrieve the List of Users Assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/users @get user_id [integer, required] Power User ID used for retrieving the assigned users @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(username, firstname, lastname, email, creation), optional] Sort type. Default: username @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: desc @parameter search [string, optional] Search users based on username, firstname, lastname, email @parameter show_assignable[boolean, optional] If true, it shows only users assignable to this Power User. Default: false

Assign Users to Power User

PUT /poweruser/v1/powerusers/{user_id}/users @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of user IDs that will be assigned to the Power User. It can be omitted if all is passed as true @parameter all [boolean, optional] If true and the id_list is empty, all the assignable users will be assigned to the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search users based on username, firstname, lastname, email

Unassign Groups from Power User

DELETE /poweruser/v1/powerusers/{user_id}/groups @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of groups IDs that will be unassigned from the Power User. It can be omitted if all is passed as true @parameter all [boolean, optional] If true and id_list is empty, all the unassignable groups will be removed from the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search groups based on name and description

Retrieve the List of Groups Assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/groups @get user_id [integer, required] Power User ID used for retrieving the assigned groups @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(name, description, members), optional] Sort type. Default: name @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: desc @parameter search [string, optional] Search for groups based on name and description @parameter show_assignable[boolean, optional] If true, it shows only the groups assignable to this Power User. Default: false

Assign Groups to Power User

PUT /poweruser/v1/powerusers/{user_id}/groups @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of group IDs that will be assigned to the Power User. It can be omitted if all is passed as true @parameter all [boolean, optional] If true and the id_list is empty, all of the assignable groups will be assigned to the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search for groups based on name and description

Unassign Branches from Power User

DELETE /poweruser/v1/powerusers/{user_id}/branches @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of branches ID that will be unassigned from the Power User. It can be omitted if all is passed as true @parameter all [boolean, optional] If true, and the id_list is empty, all the unassignable branches will be removed from the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search branches based on name

Retrieve the List of Branches Assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/branches @get user_id [integer, required] Power User ID used for retrieving the assigned branches @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(name, route, descendant), optional] Sort type. Default: name @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: asc @parameter search [string, optional] Search for branches based on their name

Assign Branches to Power User

PUT /poweruser/v1/powerusers/{user_id}/branches @get user_id [integer, required] Power User ID @parameter node_list [array, required] The list of branches that will be assigned to the Power User. It can be an empty array @item [object, optional] @item id [integer, required] The branch id @item with_descendants [boolean, required] If true, the branch descendants are included in the association. False otherwise

Retrieve the List of Categories Assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/categories @get user_id [integer, required] Power User ID used for retrieving the assigned categories @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(name, route, descendant, courses), optional] Sort type. Default: name @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: asc @parameter search [string, optional] Search for categories based on their name

Retrieve the List of Courses Assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/courses @get user_id [integer, required] Power User ID used for retrieving the assigned courses @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(code, name, type), optional] Sort type. Default: name @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: asc @parameter search [string, optional] Search courses based on code and name @parameter show_assignable[boolean, optional] If true, it shows only the courses assignable to this Power User. Default false

Retrieve the List of Learning Plans Assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/lps @get user_id [integer, required] Power User ID used for retrieving the assigned learning plans @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(code, name), optional] Sort type. Default: name @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: asc @parameter search [string, optional] Search learning plans based on code and name @parameter show_assignable[boolean, optional] If true it shows only the learning plans assignable to this Power User. Default: false

Unassign Catalogs from Power User

DELETE /poweruser/v1/powerusers/{user_id}/catalogs @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of catalog IDs that will be unassigned from the Power User. It can be omitted if all is passed as true @parameter all [boolean, optional] If true and the id_list is empty, all the unassignable catalogs will be removed from the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search catalogs based on code and name

Retrieve the List of Catalogs Assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/catalogs @get user_id [integer, required] Power User ID used for retrieving the assigned catalogs @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(code, name), optional] Sort type. Default: name @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: asc @parameter search [string, optional] Search catalogs based on code and name @parameter show_assignable[boolean, optional] If true, it shows only the catalogs assignable to this Power User. Default: false

Assign Catalogs to Power User

PUT /poweruser/v1/powerusers/{user_id}/catalogs @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of catalog IDs that will be assigned to the Power User. It can be an empty array @parameter all [boolean, optional] If true and the id_list is empty, all of the assignable catalogs will be assigned to the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search catalogs based on code and name

Unassign Locations from Power User

DELETE /poweruser/v1/powerusers/{user_id}/locations @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of Locations id that will be unassigned from the Power User. It can be omitted if all is passed as true @parameter all [boolean, optional] If true and id_list is empty all the unassignable Locations will be removed from the Power User according to filter. Default false @parameter filter [object, optional] Filter object @item search [string, optional] Search Locations based on name and address

Retrieve the list of Locations assigned to a Power User

GET /poweruser/v1/powerusers/{user_id}/locations @get user_id [integer, required] Power User ID used for retrieving the assigned Locations @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(name, address, country, classrooms), optional] Sort type. Default: name @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: asc @parameter search [string, optional] Search Locations based on name and address @parameter show_assignable[boolean, optional] If true it shows only the locations assignable to this Power User. Default: false

Assign Locations to Power User

PUT /poweruser/v1/powerusers/{user_id}/locations @get user_id [integer, required] Power User ID @parameter id_list [array(integer), required] The list of location IDs that will be assigned to the Power User. It can be an empty array @parameter all [boolean, optional] If true and the id_list is empty, all the assignable locations will be assigned to the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search locations based on name and address

Unassign Courses, Learning Plans, Categories from Power User Assignments

DELETE /poweruser/v1/powerusers/{user_id}/learning-content @get user_id [integer, required] Power User ID @parameter content_list [array, required] Array of ID and type learning content key-pairs @item id [integer, required] Course, Learning Plan or Category id @item type [enum(course, coursepath, category, category_desc), required] The type of learning content. @parameter all [boolean, optional] If true and the content_list is empty, all the assignable learning content will be unassigned from the Power User according to filter. Default: false @parameter filter [object, optional] Filter object @item search [string, optional] Search courses, learning plans and categories based on code and name @item types [array(string), optional] The types of learning content to delete. Can be 'course', 'coursepath', 'category', 'category_desc'

Retrieve Courses, Learning Plans and Categories assigned to Power User

GET /poweruser/v1/powerusers/{user_id}/learning-content @get user_id [integer, required] Power User ID @parameter page [integer, optional] Number of the page to read. Default value: 1 @parameter page_size [integer, optional] Number of items to read. Default value: 10 @parameter sort_type [enum(code, name, type), optional] Sort type. Default: name @parameter sort_dir [enum(asc, desc), optional] Sorting direction. Default value: asc @parameter search [string, optional] Search learning contents based on code and name @parameter types [array(string), optional] The types of learning content to return. Can be 'course', 'coursepath', 'category', 'category_desc'

Assign Courses, Learning Plans, Categories to Power User

PUT /poweruser/v1/powerusers/{user_id}/learning-content @get user_id [integer, required] Power User ID @parameter course [object, optional] Course parameter object used in order to assign courses to Power Users @item id_list [array(integer), optional] The list of courses’ IDs that will be assigned to the Power User. It can be an empty array @item all [boolean, optional] If true and the id_list is empty, all of the assignable courses will be assigned to the Power User according to filter or wildcard. Default: false @item filter [object, optional] Filter object @item search [string, optional] Search courses based on code and name @parameter lp [object, optional] Learning plan parameter object used in order to assign learning plans to Power User @item id_list [array(integer), optional] The list of the learning plans’ IDs that will be assigned to the Power User. It can be an empty array @item all [boolean, optional] If true and id_list is empty all the assignable learning plans will be assigned to the Power User according to filter or wildcard. Default: false @item filter [object, optional] Filter object @item search [string, optional] Search learning plans based on code and name @parameter category_list [array, optional] Array of category ID and with descendants key-pair @item id [integer, required] The Category id @item with_descendants [boolean, required] If true the category descendants are included in the association. False: otherwise @parameter reason_code [enum(ALL_COURSE, ALL_LP, ALL_COURSE_LP, ALL_COURSE_LP_IN_CATALOG), optional] The wildcard code to assign. ALL_COURSE assigns all existing and future courses, ALL_LP assigns all existing and future learning plans, ALL_COURSE_LP assigns all existing and future courses and learning plans, ALL_COURSE_LP_IN_CATALOG assigns all existing and future courses and learning plans assigned to catalogs visible to Power User. @response data [object, required] Response data @item success [boolean, required] Will be true if the operation goes successfully, false otherwise

Batch Unassign Users from Power Users

DELETE /poweruser/v1/powerusers/{user_id}/users/batch @get user_id [integer, required] Power User ID @parameter items [array, required] Associative array containing the Users id to unassign from the PowerUser @item user_id [integer, required] User ID

Batch Unassign Groups from Power Users

DELETE /poweruser/v1/powerusers/{user_id}/groups/batch @get user_id [integer, required] Power User ID @parameter items [array, required] Associative array containing the groups IDs to unassign from the PowerUser @item group_id [integer, required] Group ID

Batch Unassign Branches from Power Users

DELETE /poweruser/v1/powerusers/{user_id}/branches/batch @get user_id [integer, required] Power User ID @parameter items [array, required] Associative array containing the branches IDs to unassign from the PowerUser @item branch_id [integer, required] branch ID

Batch unassign Catalogs from Power Users

DELETE /poweruser/v1/powerusers/{user_id}/catalogs/batch @get user_id [integer, required] Power User ID @parameter items [array, required] Associative array containing the catalogs IDs to unassign from the PowerUser @item catalog_id [integer, required] Catalog ID

Batch unassign Locations from Power Users

DELETE /poweruser/v1/powerusers/{user_id}/locations/batch @get user_id [integer, required] Power User ID @parameter items [array, required] Associative array containing the locations IDs to unassign from the PowerUser @item location_id [integer, required] Location ID

Batch unassign Learning content from Power Users

DELETE /poweruser/v1/powerusers/{user_id}/learning-content/batch @get user_id [integer, required] Power User ID @parameter items [array, required] Array of id and type learning content key-pairs to unassign from the PowerUser @item id [integer, required] Course, Learning Plan or Category id @item type [enum(course, coursepath, category, category_desc), required] The type of learning content.