Programs

List programs

get

Authorizations

api_key

AuthorizationstringRequired

Query parameters

querystringOptional

General search query

tag_namestringOptional

Search by tag name

Responses

200

programs listed

application/json

get/api/v1/programs

HTTPcURLJavaScriptPython

GET /api/v1/programs HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

programs listed

{
  "programs": [
    {
      "id": 1,
      "visibility": "text",
      "enrollment_open": true,
      "enrollment_open_from": "text",
      "enrollment_open_to": "text",
      "enrollment_cap": 1,
      "hide_enrollment_info": true,
      "description": "text",
      "enrollment_fee": 1,
      "created_at": "text",
      "credits": 1,
      "measurement": "text",
      "updated_at": "text",
      "short_description": "text",
      "listing_path": "text",
      "listing_image": "text",
      "currency": "text",
      "catalog": {
        "id": 1,
        "name": "text"
      },
      "type": "text",
      "title": "text",
      "list_order": 1,
      "waitlist": true,
      "waitlist_cap": 1,
      "sku": "text",
      "show_free_banner": true,
      "image_alt_text": "text",
      "allowed_payment_types": [
        "text"
      ],
      "tag_names": [
        "text"
      ],
      "listing_url": "text",
      "start_date": "text",
      "end_date": "text",
      "canvas_section_id": 1,
      "associated_account_ids": [
        1
      ],
      "archived_at": "text",
      "sequential": true,
      "auto_enroll_courses": true,
      "requirements": [
        {
          "id": 1,
          "visibility": "text",
          "enrollment_open": true,
          "enrollment_open_from": "text",
          "enrollment_open_to": "text",
          "enrollment_cap": 1,
          "hide_enrollment_info": true,
          "description": "text",
          "enrollment_fee": 1,
          "created_at": "text",
          "credits": 1,
          "measurement": "text",
          "updated_at": "text",
          "short_description": "text",
          "listing_path": "text",
          "listing_image": "text",
          "currency": "text",
          "catalog": {
            "id": 1,
            "name": "text"
          },
          "type": "text",
          "title": "text",
          "list_order": 1,
          "waitlist": true,
          "waitlist_cap": 1,
          "sku": "text",
          "show_free_banner": true,
          "image_alt_text": "text",
          "allowed_payment_types": [
            "text"
          ],
          "tag_names": [
            "text"
          ],
          "listing_url": "text",
          "start_date": "text",
          "end_date": "text",
          "canvas_section_id": 1,
          "associated_account_ids": [
            1
          ],
          "archived_at": "text",
          "sequential": true,
          "auto_enroll_courses": true,
          "canvas_course": {
            "id": 1
          },
          "instructor_names": [
            "text"
          ],
          "primary_instructor_name": "text",
          "requirements": [
            {}
          ]
        }
      ]
    }
  ]
}

Create a program

post

Authorizations

api_key

AuthorizationstringRequired

Body

application/json

Responses

201

program created

application/json

post/api/v1/programs

HTTPcURLJavaScriptPython

POST /api/v1/programs HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "program": {
    "title": "text",
    "description": "text",
    "path": "text",
    "teaser": "text",
    "enrollment_open": true,
    "visibility": "text",
    "enrollment_cap": 1,
    "enrollment_fee": 1,
    "days_to_complete": 1,
    "waitlist": true,
    "waitlist_cap": 1,
    "list_order": 1,
    "sku": "text",
    "requirement_ids": [
      1
    ],
    "sequential": true,
    "tag_names": [
      "text"
    ]
  }
}

201

program created

{
  "program": {
    "id": 1,
    "visibility": "text",
    "enrollment_open": true,
    "enrollment_open_from": "text",
    "enrollment_open_to": "text",
    "enrollment_cap": 1,
    "hide_enrollment_info": true,
    "description": "text",
    "enrollment_fee": 1,
    "created_at": "text",
    "credits": 1,
    "measurement": "text",
    "updated_at": "text",
    "short_description": "text",
    "listing_path": "text",
    "listing_image": "text",
    "currency": "text",
    "catalog": {
      "id": 1,
      "name": "text"
    },
    "type": "text",
    "title": "text",
    "list_order": 1,
    "waitlist": true,
    "waitlist_cap": 1,
    "sku": "text",
    "show_free_banner": true,
    "image_alt_text": "text",
    "allowed_payment_types": [
      "text"
    ],
    "tag_names": [
      "text"
    ],
    "listing_url": "text",
    "start_date": "text",
    "end_date": "text",
    "canvas_section_id": 1,
    "associated_account_ids": [
      1
    ],
    "archived_at": "text",
    "sequential": true,
    "auto_enroll_courses": true,
    "requirements": [
      {
        "id": 1,
        "visibility": "text",
        "enrollment_open": true,
        "enrollment_open_from": "text",
        "enrollment_open_to": "text",
        "enrollment_cap": 1,
        "hide_enrollment_info": true,
        "description": "text",
        "enrollment_fee": 1,
        "created_at": "text",
        "credits": 1,
        "measurement": "text",
        "updated_at": "text",
        "short_description": "text",
        "listing_path": "text",
        "listing_image": "text",
        "currency": "text",
        "catalog": {
          "id": 1,
          "name": "text"
        },
        "type": "text",
        "title": "text",
        "list_order": 1,
        "waitlist": true,
        "waitlist_cap": 1,
        "sku": "text",
        "show_free_banner": true,
        "image_alt_text": "text",
        "allowed_payment_types": [
          "text"
        ],
        "tag_names": [
          "text"
        ],
        "listing_url": "text",
        "start_date": "text",
        "end_date": "text",
        "canvas_section_id": 1,
        "associated_account_ids": [
          1
        ],
        "archived_at": "text",
        "sequential": true,
        "auto_enroll_courses": true,
        "canvas_course": {
          "id": 1
        },
        "instructor_names": [
          "text"
        ],
        "primary_instructor_name": "text",
        "requirements": [
          {}
        ]
      }
    ]
  }
}

Get a specific program

get

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Identifier for this program

Responses

200

program found

application/json

get/api/v1/programs/{id}

HTTPcURLJavaScriptPython

GET /api/v1/programs/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

200

program found

{
  "program": {
    "id": 1,
    "visibility": "text",
    "enrollment_open": true,
    "enrollment_open_from": "text",
    "enrollment_open_to": "text",
    "enrollment_cap": 1,
    "hide_enrollment_info": true,
    "description": "text",
    "enrollment_fee": 1,
    "created_at": "text",
    "credits": 1,
    "measurement": "text",
    "updated_at": "text",
    "short_description": "text",
    "listing_path": "text",
    "listing_image": "text",
    "currency": "text",
    "catalog": {
      "id": 1,
      "name": "text"
    },
    "type": "text",
    "title": "text",
    "list_order": 1,
    "waitlist": true,
    "waitlist_cap": 1,
    "sku": "text",
    "show_free_banner": true,
    "image_alt_text": "text",
    "allowed_payment_types": [
      "text"
    ],
    "tag_names": [
      "text"
    ],
    "listing_url": "text",
    "start_date": "text",
    "end_date": "text",
    "canvas_section_id": 1,
    "associated_account_ids": [
      1
    ],
    "archived_at": "text",
    "sequential": true,
    "auto_enroll_courses": true,
    "requirements": [
      {
        "id": 1,
        "visibility": "text",
        "enrollment_open": true,
        "enrollment_open_from": "text",
        "enrollment_open_to": "text",
        "enrollment_cap": 1,
        "hide_enrollment_info": true,
        "description": "text",
        "enrollment_fee": 1,
        "created_at": "text",
        "credits": 1,
        "measurement": "text",
        "updated_at": "text",
        "short_description": "text",
        "listing_path": "text",
        "listing_image": "text",
        "currency": "text",
        "catalog": {
          "id": 1,
          "name": "text"
        },
        "type": "text",
        "title": "text",
        "list_order": 1,
        "waitlist": true,
        "waitlist_cap": 1,
        "sku": "text",
        "show_free_banner": true,
        "image_alt_text": "text",
        "allowed_payment_types": [
          "text"
        ],
        "tag_names": [
          "text"
        ],
        "listing_url": "text",
        "start_date": "text",
        "end_date": "text",
        "canvas_section_id": 1,
        "associated_account_ids": [
          1
        ],
        "archived_at": "text",
        "sequential": true,
        "auto_enroll_courses": true,
        "canvas_course": {
          "id": 1
        },
        "instructor_names": [
          "text"
        ],
        "primary_instructor_name": "text",
        "requirements": [
          {}
        ]
      }
    ]
  }
}

Update a program

put

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Identifier for this program

Body

application/json

Responses

204

program updated

No content

put/api/v1/programs/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/programs/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 303

{
  "program": {
    "title": "text",
    "description": "text",
    "path": "text",
    "teaser": "text",
    "enrollment_open": true,
    "visibility": "text",
    "enrollment_cap": 1,
    "enrollment_fee": 1,
    "days_to_complete": 1,
    "waitlist": true,
    "waitlist_cap": 1,
    "list_order": 1,
    "sku": "text",
    "requirement_ids": [
      1
    ],
    "sequential": true,
    "tag_names": [
      "text"
    ]
  }
}

204

program updated

No content

Delete a program

delete

Authorizations

api_key

AuthorizationstringRequired

Path parameters

idintegerRequired

Identifier for this program

Responses

204

program deleted

No content

delete/api/v1/programs/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/programs/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*

204

program deleted

No content

Archive or reactivate programs

put

Authorizations

api_key

AuthorizationstringRequired

Body

application/json

product_actionstringRequired

archive or reactivate

product_idsinteger[]Required

Responses

200

all programs processed

No content

422

some programs could not be processed

put/api/v1/programs/archived

HTTPcURLJavaScriptPython

PUT /api/v1/programs/archived HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "product_action": "text",
  "product_ids": [
    1
  ]
}

No content