Deleting categories via API

You can delete categories from a course catalog of the tenant via the LMS365 Admin Center or use LMS365 API endpoint for this.

In this article we provide the steps to perform to delete a category using API.

 

To delete a category from via API, perform the following steps: 

1. Go to https://api.365.systems/ and authorize with the relevant API key. You can find more about the authorization process here.

TIP   

You can skip this step if you already have the ID of a category you want to delete.

2. Find the CourseCategories section, expand it, find the GET method /odata/v2/CourseCategories with the Returns All Categories description, and select Try it out in the top left-hand corner.

 

 

Go to the Responses block to check the results:

  • Number 2xx (for example, 200) under Code shows that the request worked correctly.
  • In the Response body field, you will see all the categories of the tenant and their data, including ID. 
  • You can use the Download button to save the results to your computer in .JSON format.
  • You can use search via Ctrl+F to find the required category and then copy its ID to use be able to delete it via API. 

 

 

3. In the CourseCategories section, find the DELETE method /odata/v2/CourseCategories({Id}) with the Deletes Category by Id description, and select Try it out in the top left-hand corner.

 

 

4. In the key:Id field paste the ID of the category you want to delete and select the Execute button to run the request.

 

 

5. Go to the Responses block to check the results:

  • Number 2xx (for example, 200) under Code shows that the request worked correctly.
  • In the Response body field, you will see the data related to the category's deletion including the exact date and time. You can check the category is deleted from the list of categories in the LMS365 Admin Center > Catalog Settings > Categories

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments

Article is closed for comments.