Create Package Category

This operation allows the creation of a package category. Only one category can be created per call. It allows both the basic category information to be set and for assignments to be made. The category can be assigned a child or parent given the child or parent specified exists. Also, the category can be given a name, assigned a rank, and assigned to existing selected packages.

A category name is required and cannot be blank, but all other fields are optional. The rank will default to 1 if not supplied for a parent category. It will be 0 for all child categories regardless of input. The maximum number of assignable packages is equal to the number of selected packages a customer owns.

For each customer, there is a maximum of 10 parent categories and a maximum of 50 children per parent. A category is classified as a parent if either of these cases are true:

  1. The category has one or more categories assigned as a child of it.
  2. The category has no categories assigned as a child of it and it is not assigned as a child of another category.

A category is classified as a child if it has a parent category assigned. A child category can only have one parent. It cannot be both a child and parent category. The operation will fail if an attempt is made to assign both fields.

Please Note: You will need an API key to gain access to the API through our interactive documentation. If you require an API key, please contact EBSCO customer support.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

Details of the category to create

Model used when creating or updating a category

string
required
length between 1 and 300

Name of the category

integer

Id of the category to assign as parent of given category

childIds
array of integers

List of categoryIds that are to be assigned as the children of the category

childIds
listIds
array of integers

Array of listIds that are to be assigned to the category

listIds
integer
1 to 500

Rank of the category

Headers
string
required

Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. You will need an API key to use the interactive documentation. If you require an API key, please contact EBSCO customer support.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json