Skip to content
API Reference
/
catalog
/
catalog_programs_destroy

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

catalog_programs_create

Request

Add or update a program. Accepts a list of courses and updates or creates a program.

Security
PlatformApiKeyAuthentication
Body
required
program_idstringrequired

Program ID

program_keystring

Program key

namestringrequired

Program name

slugstring

Program slug

orgstring

Organization

platform_keystring

Platform key

enabledboolean

Whether the program is enabled

Default true
course_listArray of objectsrequired

List of courses in the program with course_id and optional position

course_list[].​property name*anyadditional property
program_typestring

Program type

dataany

Additional program data

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/catalog/programs/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "program_id": "string",
    "program_key": "string",
    "name": "string",
    "slug": "string",
    "org": "string",
    "platform_key": "string",
    "enabled": true,
    "course_list": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "program_type": "string",
    "data": null
  }'

Responses

Bodyapplication/json
idintegerread-onlyrequired
institutionobjectread-onlyrequired
institution.​idintegerread-onlyrequired
institution.​namestring<= 100 charactersrequired
institution.​institution_typestring(InstitutionTypeEnum)
  • university - University
  • college - College
  • institute - Institute
  • academy - Academy
  • other - Other
Enum"university""college""institute""academy""other"
institution.​locationstring or null<= 100 characters
institution.​websitestring or null(uri)<= 255 characters
institution.​accreditationstring or null<= 100 characters
institution.​established_yearinteger or null[ 0 .. 2147483647 ]
institution.​dataany or null

Metadata

institution.​metadataany or null

Metadata

institution.​created_atstring(date-time)
institution.​updated_atstring(date-time)read-onlyrequired
namestring<= 100 charactersrequired
program_typestring(ProgramTypeEnum)required
  • bachelors - Bachelor's Degree
  • masters - Master's Degree
  • phd - PhD
  • diploma - Diploma
  • certificate - Certificate
  • ungraded - Ungraded
  • other - Other
Enum"bachelors""masters""phd""diploma""certificate""ungraded""other"
durationinteger[ 0 .. 2147483647 ]required

Duration in months

descriptionstring or null
dataany or null

Metadata

metadataany or null

Metadata

created_atstring(date-time)
updated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "id": 0,
  "institution": {
    "id": 0,
    "name": "string",
    "institution_type": "university",
    "location": "string",
    "website": "http://example.com",
    "accreditation": "string",
    "established_year": 2147483647,
    "data": null,
    "metadata": null,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  },
  "name": "string",
  "program_type": "bachelors",
  "duration": 2147483647,
  "description": "string",
  "data": null,
  "metadata": null,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

catalog_programs_destroy

Request

Remove a program from the database. Requires program_id and org as parameters.

Security
PlatformApiKeyAuthentication
Query
orgstringnon-emptyrequired

Organization of the program

program_idstringnon-emptyrequired

Program ID to delete

curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/programs/?org=string&program_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired

Number of programs deleted

typeobjectrequired

Types of objects deleted

type.​property name*anyadditional property
Response
application/json
{
  "count": 0,
  "type": {
    "property1": null,
    "property2": null
  }
}

catalog_recommendation_courses_retrieve

Request

GET Get a 'next' course

This method retrieves the next recommended course for a user based on the provided parameters. It expects the following parameters in the request query:

  • user_id: The ID of the user for whom the next course is being recommended.
  • course_id: The ID of the current course.
  • org: The organization associated with the course.

Returns:

  • A serialized representation of the next course if found, with a status code of 200.
  • A status code of 400 if the course_id is not provided.
  • A status code of 200 with a None response if no next course is found.

Error Conditions:

  • Returns a 400 status code if the course_id is missing from the request parameters.

Side Effects:

  • None
Security
PlatformApiKeyAuthentication
Query
course_idstringnon-emptyrequired

Current course ID

orgstringnon-empty

Organization to filter recommendations

user_idstringnon-empty

User ID for personalized recommendations

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/catalog/recommendation/courses/?course_id=string&org=string&user_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
course_idstringread-onlyrequired

The edX course ID string for the course.

namestringread-onlyrequired

The display name of the course. (Should match edX)

slugstring or null^[-a-zA-Z0-9_]+$read-onlyrequired

An additional unique slug field. (Optional)

orgstring
Response
application/json
{
  "course_id": "string",
  "name": "string",
  "slug": "string",
  "org": "string"
}

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com