Catalog JSON API Documentation

So, you want to develop some tooling around the Catalog API - perhaps some custom reports? Great! This API gives you everything that Catalog has to offer.

Authentication

Visit this page to create an API key. Once you’ve received your key, treat it like a password.

Use SSL for all requests to the API. Non-SSL requests will result in redirects, and your API key will be sent in the clear.

To authenticate, send the API key as a request header. Here’s an example using cURL:

curl https://www.my-catalog.edu/api/v1/products -H 'Authorization: Token token="my-api-key"'

Pagination

All index endpoints support pagination. Specifically, we implement RFC5988.

Pagination Options

You can use ?page= to set the page of data you want to retrieve. If no items exist for that page, the response will be a root key with an empty array.

curl https://www.my-catalog.edu/api/v1/courses?page=2

{
  "courses": []
}

To change the number of items returned for each page, you can use ?per_page=. This defaults to 20 and has a max of 100.

curl https://www.my-catalog.edu/api/v1/courses?per_page=40&page=2

Information about pagination is provided in the Link header. Here is an example of what the header could look like

curl -I https://www.my-catalog.edu/api/v1/courses?page=3

Link: <https://www.my-catalog.edu/api/v1/courses?page=4>; rel="next",  
      <https://www.my-catalog.edu/api/v1/courses?page=15>; rel="last",
      <https://www.my-catalog.edu/api/v1/courses?page=1>; rel="first",
      <https://www.my-catalog.edu/api/v1/courses?page=2>; rel="prev"

Let’s talk about what each link means. rel="next" lets us know that the next page of data is page=4. This make sense given that we requested page 3. rel="prev" lets us know that the page previous to the one we requested is page=2. rel="next" indicates the next page of data to request. rel="last" tells us the last and total number of pages of data that currently exist.

Not all rel= links will exist on every response. For instance, the response for the first page of data will not have rel="first" or rel="prev". The same is true for the last page of data. This means that you can programmatically traverse all pages of data by requesting the first page and continuing to request the rel="next" until the response does not contain a rel="next".

It’s important to note that altering the per_page= will change the total number of pages.

Listing Image

If you are uploading a product image in SVG format. You will need to specify the file type.

curl https://www.my-catalog.edu/api/v1/products -F "course[listing_image]=@somefile.svg;type=image/svg+xml"'

Analytics

The POST request parameters should be sent as JSON in the request body.
If the request is unfiltered, an empty JSON object should be sent as the filter.

Getting enrollments analytics

Ekstremite

POST https://www.my-catalog.edu/api/v1/analytics/enrollments

Paramèt

Name Description Type
account_ids List of account ids Array
product_ids List of product ids Array
product_statuses List of product statuses (OPEN, CLOSED, and/or DELETED) Array
student_ids List of student ids(catalog user id) Array
student_canvas_user_ids List of student ids(canvas user id) Array
enrollment_date_from Enrollment date from Datetime
enrollment_date_to Enrollment date to Datetime
enrollment_statuses List of enrollment statuses (ACTIVE, COMPLETED, DROPPED and/or CONCLUDED) Array
completion_date_from Completion date from Datetime
completion_date_to Completion date to Datetime

Mande

Wout

POST https://www.my-catalog.edu/api/v1/analytics/enrollments

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "account_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    1,
    2,
    3
  ],
  "product_statuses": [
    "OPEN",
    "CLOSED",
    "DELETED"
  ],
  "student_ids": [
    1,
    2,
    3
  ],
  "student_canvas_user_ids": [
    1,
    2,
    3
  ],
  "enrollment_date_from": "2023-06-05T14:46:59.944581+02:00",
  "enrollment_date_to": "2023-06-06T14:46:59.944581+02:00",
  "enrollment_statuses": [
    "ACTIVE",
    "COMPLETED",
    "DROPPED",
    "CONCLUDED"
  ],
  "completion_date_from": "2023-06-05T14:46:59.944581+02:00",
  "completion_date_to": "2023-06-06T14:46:59.944581+02:00"
}

Repons

Branch Repons

Name Description Type
id Enrollment id Integer
account_id Account id Integer
account_name Account name String
product[name] Product name String
product[id] Product id Integer
product[url] Product url (null if product is deleted) String
product[sku] Product sku String
product_status Product status (OPEN, CLOSED, or DELETED) String
canvas_course_id Canvas course id Integer
student[canvas_user_id] Student Canvas user id Integer
student[name] Student name String
student[email] Student email String
student[canvas_user_id_string] Canvas user id in string format String
created_at Creation date Datetime
completed_at Completion date Datetime
enrollment_status Enrollment status (ACTIVE, COMPLETED, DROPPED or CONCLUDED) String
certificate_attainable Product has a certificate Boolean
certificate_offered Certificate offered/earned Boolean
certificate_url Certificate url String

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: 3srVKlbszoDcnH9Ahz51ilh2f7F9OIz7E0I9cTn5qkE6w8PLYGpxo7UDU6oC2XIDp51L67Jf3+Udib1jtAH4Tg==
ETag: W/"06af654158821a78e8ecc139518be344"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=TCtHNnFzb3AweTdlVjF0VTJ4QXJPR3NXdjVIU0N2bDQ3YmYxZTNRL2IxaU5jQzZYM1VIZ3RxVkVBUnJGbXZlYjdPejJoQ1F2d3pxT3FLUWh4cHBES0w1Ni93L1NsQ05RY29YMzQxdkE0eEtjM1dLeTkwZkJzb016UStWdXBGMUJSOVRocnlKbGpWMUJSenQybEx4YitMMW43Ri9pNmVCOXNjTEU5Yzd1U0wxQVp0NCtxaE1pdEEzcTFucXlzMUdiLS1IemsyMVJUdm5jZmRBUkx4M0RIekx3PT0%3D--2fc532e80824f4faf549c3c15833239d1b6472de; path=/; HttpOnly
X-Request-Id: a0676965-847c-4f2e-9641-e8f11f63bc88
X-Runtime: 0.194474
Content-Length: 596

Kò

{
  "enrollments": [
    {
      "id": 25,
      "account_id": 3,
      "account_name": "Sub-Account 1",
      "product": {
        "name": "Course 1",
        "id": 5,
        "url": "https://www.my-catalog.edu/admin/products/1/edit",
        "sku": "sku"
      },
      "product_status": "OPEN",
      "canvas_course_id": 11,
      "student": {
        "canvas_user_id": 1,
        "name": "User 15",
        "email": "user15@instructure.com",
        "canvas_user_id_string": "1"
      },
      "created_at": "2023-06-05T14:46:59.944581+02:00",
      "completed_at": "2023-06-29T12:13:27+02:00",
      "enrollment_status": "COMPLETED",
      "certificate_attainable": true,
      "certificate_offered": true,
      "certificate_url": "https://www.my-catalog.edu/admin/certificates/1.pdf?user_id=1"
    }
  ]
}

Getting orders analytics

Ekstremite

POST https://www.my-catalog.edu/api/v1/analytics/orders

Paramèt

Name Description Type
account_ids List of account ids Array
product_ids List of product ids Array
product_statuses List of product statuses (OPEN, CLOSED, and/or DELETED) Array
student_ids List of student ids(catalog user id) Array
student_canvas_user_ids List of student ids(canvas user id) Array
purchaser_ids List of purchaser ids(catalog user id) Array
purchaser_canvas_user_ids List of purchaser ids(canvas user id) Array
bulk_purchases_only Bulk purchases only Boolean
purchase_date_from Purchase date from Datetime
purchase_date_to Purchase date to Datetime
order_fee List of order fee types (FREE and/or PAID) Array
listing_price_min Listing price minimum Decimal
listing_price_max Listing price maximum Decimal
promo_codes List of promotion code states (APPLIED and/or NOT_APPLIED) Array
revenue_min Revenue minimum Decimal
revenue_max Revenue maximum Decimal

Mande

Wout

POST https://www.my-catalog.edu/api/v1/analytics/orders

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "account_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    1,
    2,
    3
  ],
  "product_statuses": [
    "OPEN",
    "CLOSED",
    "DELETED"
  ],
  "student_ids": [
    1,
    2,
    3
  ],
  "student_canvas_user_ids": [
    1,
    2,
    3
  ],
  "purchaser_ids": [
    1,
    2,
    3
  ],
  "purchaser_canvas_user_ids": [
    1,
    2,
    3
  ],
  "bulk_purchases_only": true,
  "purchase_date_from": "2023-06-05T14:46:59.944581+02:00",
  "purchase_date_to": "2023-06-06T14:46:59.944581+02:00",
  "order_fee": 10.0,
  "listing_price_min": 5.0,
  "listing_price_max": 100.6,
  "promo_codes": [
    "APPLIED",
    "NOT_APPLIED"
  ],
  "revenue_min": 5.0,
  "revenue_max": 1000.1
}

Repons

Branch Repons

Name Description Type
account_id Account id Integer
account_name Account name String
product[name] Product name String
product[id] Product id Integer
product[url] Product url (null if product is deleted) String
product[sku] Product sku String
product_status Product status (OPEN, CLOSED, or DELETED) String
canvas_course_id Canvas course id Integer
purchaser[id] Purchaser Catalog user id Integer
purchaser[canvas_user_id] Purchaser Canvas user id Integer
purchaser[name] Purchaser name String
purchaser[email] Purchaser email String
purchaser[canvas_user_id_string] Purchaser Canvas user id in string format String
purchased_at Purchase date Datetime
order_id Order id Integer
order_item_id Order item id Integer
reference_id Reference id String
list_price Listing price Decimal
currency Currency String
promo_codes List of promotion codes Array
discount Discount Decimal
revenue Revenue Decimal
bulk_purchase Bulk purchase Boolean
seat_count Seat count Integer
bulk_enrollments List of bulk enrolled students Array
bulk_enrollments[id] Bulk enrolled Catalog user id Integer
bulk_enrollments[canvas_user_id] Bulk enrolled Canvas user id Integer
bulk_enrollments[name] Bulk enrolled student name String
bulk_enrollments[email] Bulk enrolled student email String
bulk_enrollments[canvas_user_id_string] Bulk enrolled Canvas user id in string format String
last_modification_date Last modification date of revenue Datetime
revenue_change_history Revenue change history list Array
revenue_change_history[modification_date] Modification date of revenue update Datetime
revenue_change_history[new_value] New revenue value Decimal
revenue_change_history[new_value_currency] New revenue value currency String
revenue_change_history[old_value] Old revenue value Decimal
revenue_change_history[old_value_currency] Old revenue value currency String
revenue_change_history[reason] Reason of revenue update String
revenue_change_history[user_name] Name of the user who updated the revenue String
revenue_change_history[user_profile_link] Link to the user profile String

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: nnFjEBSR7LaBW9coMz7WhrRI33WokqMlqs95+JwMe/T4byC3h/EoOmTbbE/CypRJD8Qru1oxCmedBLaQUzsnLg==
ETag: W/"2bc151db8614f69f334f1698f64f13bf"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=SlNhMmtYbzd0SVp3UkZVaWF4NEs0RFFucnUwc3AvV3AvM3FvUFIxeitlb3FtK21uaDlRQ0FaQ25hZ1ZHdnZYVHdWNU9qK0JKMW1KWnZPaEZFRW9mZUEwR25UdFJJbHRaZmFnMjN2d2xPOTkvUkFrTWJpZVREMHo5TjhaZXdIZ2xVYXpQYXlaT1lsK3BUQU5EbUlsNDBMOVVaOWdsNXkxd3FmUGlGUHRlbUFQWUhXdG9JM3BqMXN2WUlRTkJWd1JRLS1xSllyREd2TWFLU0FCaUs1OWlXM0dBPT0%3D--a27aef35f057e5c71be989ce326ffbb4c2169bfe; path=/; HttpOnly
X-Request-Id: 1c7c44a7-23c7-4126-bcb6-19bc36b903aa
X-Runtime: 0.470175
Content-Length: 1470

Kò

{
  "orders": [
    {
      "account_id": 3,
      "account_name": "Sub-Account 1",
      "product": {
        "name": "Course 1",
        "id": 5,
        "url": "https://www.my-catalog.edu/admin/products/1/edit",
        "sku": "sku"
      },
      "product_status": "OPEN",
      "canvas_course_id": 11,
      "purchaser": {
        "id": 1,
        "canvas_user_id": 1,
        "name": "Purchaser 1",
        "email": "purchaser1@instructure.com",
        "canvas_user_id_string": "1"
      },
      "purchased_at": "2023-07-02T23:30:59.052239+02:00",
      "order_id": 81,
      "order_item_id": 123,
      "reference_id": "PR-81-82",
      "list_price": 5.0,
      "currency": "USD",
      "promo_codes": [
        "PROMO1",
        "PROMO2"
      ],
      "discount": 10.0,
      "revenue": 5.0,
      "bulk_purchase": true,
      "seat_count": 3,
      "bulk_enrollments": [
        {
          "id": 141,
          "canvas_user_id": 74,
          "name": "User 17",
          "email": "user17@instructure.com",
          "canvas_user_id_string": "74"
        },
        {
          "id": 138,
          "canvas_user_id": 73,
          "name": "User 16",
          "email": "user16@instructure.com",
          "canvas_user_id_string": "73"
        }
      ],
      "last_modification_date": "2023-07-09T23:30:59.052239+02:00",
      "revenue_change_history": [
        {
          "modification_date": "2023-07-09T23:30:59.052239+02:00",
          "new_value": 5.0,
          "new_value_currency": "USD",
          "old_value": 2.0,
          "old_value_currency": "USD",
          "reason": "This is very important",
          "user_name": "user19@instructure.com",
          "user_profile_link": "https://www.my-catalog.edu/accounts/2/users/1"
        },
        {
          "modification_date": "2023-07-08T23:30:59.052239+02:00",
          "new_value": 2.0,
          "new_value_currency": "USD",
          "old_value": 11.0,
          "old_value_currency": "USD",
          "reason": "This is important",
          "user_name": "user20@instructure.com",
          "user_profile_link": "https://www.my-catalog.edu/accounts/2/users/2"
        }
      ]
    }
  ]
}

Getting products analytics

Ekstremite

POST https://www.my-catalog.edu/api/v1/analytics/products

Paramèt

Name Description Type
account_ids List of account ids Array
product_ids List of product ids Array
product_statuses List of product statuses (OPEN, CLOSED, and/or DELETED) Array
creation_date_from Creation date from Datetime
creation_date_to Creation date to Datetime
enrollment_count_min Enrollment count minimum Integer
enrollment_count_max Enrollment count maximum Integer
completion_count_min Completion count minimum Integer
completion_count_max Completion count maximum Integer
dropped_count_min Dropped count minimum Integer
dropped_count_max Dropped count maximum Integer
listing_price_min Listing price minimum Decimal
listing_price_max Listing price maximum Decimal
promo_codes List of promotion code states (APPLIED and/or NOT_APPLIED) Array
revenue_min Revenue minimum Decimal
revenue_max Revenue maximum Decimal
certificate_offered Certificate offered for the product Boolean

Mande

Wout

POST https://www.my-catalog.edu/api/v1/analytics/products

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "account_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    1,
    2,
    3
  ],
  "product_statuses": [
    "OPEN",
    "CLOSED",
    "DELETED"
  ],
  "creation_date_from": "2023-06-05T14:46:59.944581+02:00",
  "creation_date_to": "2023-06-06T14:46:59.944581+02:00",
  "enrollment_count_min": 0,
  "enrollment_count_max": 5,
  "completion_count_min": 0,
  "completion_count_max": 5,
  "dropped_count_min": 0,
  "dropped_count_max": 5,
  "listing_price_min": 10.1,
  "listing_price_max": 1000.5,
  "promo_codes": [
    "APPLIED",
    "NOT_APPLIED"
  ],
  "revenue_min": 10.1,
  "revenue_max": 500.5,
  "certificate_offered": true
}

Repons

Branch Repons

Name Description Type
account_id Account id Integer
account_name Account name String
product[name] Product name String
product[id] Product id Integer
product[url] Product url (null if product is deleted) String
product[sku] Product sku String
product_status Product status (OPEN, CLOSED, or DELETED) String
created_at Product creation date Datetime
canvas_course_id Canvas course id Integer
enrollment_count Enrollment count Integer
dropped_count Dropped count Integer
completion_count Completion count Integer
currency Currency String
list_price Listing price Decimal
promo_codes List of promotion codes Array
discount Discount Decimal
revenue Revenue Decimal
points Points (null if account measurement is not point) Decimal
ceus CEUs (null if account measurement is not CEU) Decimal
credits Credits (null if account measurement is not credit) Decimal
certificate_offered Certificate offered for this product Boolean

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: HYcOZwxZ94Xp/KDThpd0JUtX7CRAQrmCLGDzUlhHvQqhu8pUoENdNXqUtyRfIcgcTg2XlQOQN7gM6yHLYegrLA==
ETag: W/"5a2f0129ae43f07ed8a378bdee3c6555"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=N3I5QWMrQmVtUkdOd2xxUm1rN2VUM0FQM1hwS0R5Q0FSY0VCdmFVV0ZSWTU3eFhoby9MYTdlTUFlUjZCem5LeVh2UXIzajU0U3FmYnp6M2RqN1FicUY2bUFIT2tteVhXNXl3MFZCUjIweldNay9WNjlQeTRQeWFjbVVOZWsrc2F4MzZ1NERKVFRlMHEvc0w5Sk1JZUcvaDYzQTVyRFkxeG1MT3VtV28xVlRFdHdaS0g1amFIQmV5YlVlWFYwaS9ZLS1TOGhvN3BaMkF6QTFkd1dBVlNBWFd3PT0%3D--dd8f89b439fb2e22e46ab6c16578a9eb9cbb65f5; path=/; HttpOnly
X-Request-Id: d0109616-0ad1-43db-8500-ebe3ddfa9824
X-Runtime: 0.204763
Content-Length: 463

Kò

{
  "products": [
    {
      "account_id": 3,
      "account_name": "Sub-Account 1",
      "product": {
        "name": "Course 1",
        "id": 5,
        "url": "https://www.my-catalog.edu/admin/products/1/edit",
        "sku": "sku"
      },
      "product_status": "OPEN",
      "created_at": "2023-06-05T14:46:59.944581+02:00",
      "canvas_course_id": 11,
      "enrollment_count": 7,
      "dropped_count": 3,
      "completion_count": 2,
      "currency": "USD",
      "list_price": 10.0,
      "promo_codes": [
        "PROMO1",
        "PROMO2"
      ],
      "discount": 10.0,
      "revenue": 60.0,
      "credits": 5.0,
      "certificate_offered": true
    }
  ]
}

Getting users analytics

Ekstremite

POST https://www.my-catalog.edu/api/v1/analytics/users

Paramèt

Name Description Type
account_ids List of account ids Array
student_ids List of student ids(catalog user id) Array
student_canvas_user_ids List of student ids(canvas user id) Array
enrollment_count_min Enrollment count minimum Integer
enrollment_count_max Enrollment count maximum Integer
last_enrollment_date_from Last enrollment date from Datetime
last_enrollment_date_to Last enrollment date to Datetime
registration_date_from Registration date from Datetime
registration_date_to Registration date to Datetime
registered_through List of registration sources (CANVAS and/or CATALOG) Array

Mande

Wout

POST https://www.my-catalog.edu/api/v1/analytics/users

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "account_ids": [
    1,
    2,
    3
  ],
  "student_ids": [
    1,
    2,
    3
  ],
  "student_canvas_user_ids": [
    1,
    2,
    3
  ],
  "enrollment_count_min": 0,
  "enrollment_count_max": 5,
  "last_enrollment_date_from": "2023-06-05T14:46:59.944581+02:00",
  "last_enrollment_date_to": "2023-06-06T14:46:59.944581+02:00",
  "registration_date_from": "2023-06-05T14:46:59.944581+02:00",
  "registration_date_to": "2023-06-06T14:46:59.944581+02:00",
  "registered_through": [
    "CANVAS",
    "CATALOG"
  ]
}

Repons

Branch Repons

Name Description Type
id Catalog user id Integer
canvas_user_id Canvas user id Integer
name User name String
email User email String
account_id Account id Integer
account_name Account name String
registered_through Registration source (CANVAS or CATALOG) String
registered_at Registration date Datetime
enrollment_count Enrollment count Integer
last_enrolled_at Last Enrollment date Datetime
custom_fields List of custom fields (consist of key and value) Array

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: LEm/g6y8sHvS28Q9xpk9AJwl836oRfWaO2q1/jWxQ7BDbyVUWTWQw10V4FA9YvN4ojMapDcQotQ2R6sL+kh/nw==
ETag: W/"3f46c5f82398422e33e636e29c143dfd"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=VE5Rc0V6WlQyUndjWmJ0M0dKRGttMFVOUkxmVDRTRjZiRjZnOEI4cU9jOGw0dis3ZzVKYk5rUjlDVGZQVFIzQW1EUWJJR1BOWjEzVWhyZTB5eC9sR2QwU0JYZldRUGpHMXloQlFCOEg0Y1RnNlh3SDlvdU1MWTl2Qk5qbFEvYXNnMFlzWkZMZTlmWFRsbmJENytzWlZVekVuY3pkck05T2lWTzlPRW5rQUtvOGdEZ2hZZmZRSlpUamlpWGYxcGx4LS03YzB5bC84TUIxTnNSMGNWTTBYRmFBPT0%3D--6f2d26e3a63d3273e8593ddf3a7551ac0234128a; path=/; HttpOnly
X-Request-Id: b58d9884-f8b9-4f5a-82e2-ddd29809b3e1
X-Runtime: 0.213232
Content-Length: 386

Kò

{
  "users": [
    {
      "id": 150,
      "canvas_user_id": 77,
      "name": "User 19",
      "email": "user19@instructure.com",
      "account_id": 3,
      "account_name": "Sub-Account 1",
      "registered_through": "CATALOG",
      "registered_at": "2023-07-03T15:03:57.597+02:00",
      "enrollment_count": 2,
      "last_enrolled_at": "2023-07-06T17:30:50.991764+02:00",
      "custom_fields": [
        {
          "key": "text udf",
          "value": "awesome udf"
        },
        {
          "key": "checkbox udf",
          "value": "1"
        }
      ]
    }
  ]
}

Catalogs

Getting a specific catalog

Ekstremite

GET https://www.my-catalog.edu/api/v1/catalogs/:id

Mande

Wout

GET https://www.my-catalog.edu/api/v1/catalogs/5

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Identifier for this catalog. Integer
created_at The creation date for the catalog. Datetime
updated_at The last time the catalog was updated. Datetime
name The name of the catalog. String
canvas_domain Domain for the corresponding canvas account. String
canvas_id Id for the corresponding canvas account. String
logo URL for the catalog logo. String
locale Three character locale for the catalog. String
url Url for the catalog String
user_defined_fields An array of serialized user defined field records provided to the catalog either through direct assignment or inheritance. Array
user_defined_field[name] Name of the user defined field String
user_defined_field[label] Label that will be shown with the field String
user_defined_field[field_type] HTML input type of the field String
user_defined_field[required] Indicates if the custom field is required Boolean
parent[id] The id of the parent catalog Integer
parent[name] The name of the parent catalog Integer
settings[privacy_policy_url] Url of the privacy policy for this catalog. String
settings[terms_url] Url of the terms used for this catalog. String
settings[currency] Three character currency code. String
settings[time_zone] Timezone configured for this catalog. String
settings[country] Two character country code. String
settings[email_from_name] Name that appears as the sender in emails. String
settings[allow_user_registration] Indicates if new users allowed to enroll classes. Boolean
settings[title_tag] Used for custom titles in HTML. String
settings[meta_description] Used to a meta tag description in HTML. String
settings[custom_head_content] Used to add custom head content to HTML. String
settings[custom_body_content] Used to add custom body content to HTML. String
settings[show_listings_in_parent] Indicates if this catalogs listings will show in a parent catalog. Boolean
settings[skus_enabled] Indicates if the course displays the sku field. Boolean

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: wkdKxcO4GKZyzW/Ti5T4F4nRnXmdBaw63JfpQep7lJy2qZEMUFfkplyUWHTzc5/93iF89LZ3UPhqisQwp1Mvgw==
ETag: W/"0f839308c8e0a2865dec3f2e59214a24"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=dnZJclhOb3lxMlhzaE1EQ0VJRFlUZk0rYnEwM05HUEo1OWNHZHlSUFBNNk9uMzFMTWtOME51ZWJpWTluRXRSM01oNGMraTc0YnZKTXRiU2tmMU9qOXZrT3VCS09EZithS25Ha3hOM2NKSFdjb3BmMXJPRFRKZGpDay9Fam5BOERtSVpUVHBxL0lzbmlQL3kxc21iUkVST3lBcE5uSTNoZmladXRvRXdPVzdsZXIvd3lreVZvT0pZZjhkdkUrRTF4LS0wU3FQZ1ZYcE1DMC8vcDFZeGY0THhnPT0%3D--ceb239751a73586732ed88a7fd9a84fbf625275c; path=/; HttpOnly
X-Request-Id: d829e98e-c50c-4162-8a6b-9190dbfca681
X-Runtime: 0.351870
Content-Length: 1923

Kò

{
  "account": {
    "id": 5,
    "name": "Domain Account 5",
    "parent": null,
    "created_at": "2024/01/26 16:13:44 +0000",
    "updated_at": "2024/01/26 16:13:44 +0000",
    "canvas_domain": "www.canvas-domain-5.com",
    "canvas_id": 5,
    "settings": {
      "privacy_policy_url": "https://www.instructure.com/policies/privacy/",
      "terms_url": "https://www.instructure.com/policies/acceptable-use",
      "currency": "USD",
      "supported_payment_types": "standard",
      "time_zone": null,
      "country": "US",
      "measurement": "credit",
      "email_from_name": "Canvas Catalog",
      "email_from_address": "notifications@instructure.com",
      "allow_user_registration": true,
      "title_tag": null,
      "meta_description": null,
      "custom_head_content": null,
      "custom_body_content": null,
      "show_listings_in_parent": true,
      "order_id_prefix": null,
      "inherit_categories": false,
      "inherit_user_defined_fields": false,
      "beta_canvas_domain": null,
      "skus_enabled": false,
      "canvas_enrollment_events": false,
      "include_noncatalog_courses_in_dashboard": true,
      "external_idp_logout_workflow": false,
      "private_catalog": false,
      "bulk_purchase_disabled": false,
      "enroll_button_behavior": "cart",
      "shopping_cart_enabled": true,
      "external_registration_url": null,
      "external_registration_public_key": null,
      "redirect_external_registration_condition": "authenticated",
      "include_captcha": false,
      "user_registration_domain_restriction_type": "inherit",
      "user_registration_domain_deny_list": "",
      "user_registration_domain_allow_list": "",
      "frame_ancestors": "",
      "disabled_new_registration": false,
      "email_reply_to": "",
      "has_sso_warning": false,
      "measurement_id": null,
      "redirect_non_admins_to_root_url": false,
      "canvas_feature_send_usage_metrics": false,
      "disable_passive_login": false,
      "new_storefront": false,
      "tags_permission_default_value": true,
      "cross_listing_permission_default_value": false
    },
    "user_defined_fields": [

    ],
    "logo": "https://test-bucket.s3.amazonaws.com/test/logos/edcf6c8db8822697cecea622a64f4e3d88d1fa70.jpeg",
    "locale": "en",
    "url": "http://www.my-catalog.edu",
    "measurement": "credit",
    "storefront_theme_id": null
  }
}

Listing catalogs

Ekstremite

GET https://www.my-catalog.edu/api/v1/catalogs

Mande

Wout

GET https://www.my-catalog.edu/api/v1/catalogs

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Identifier for this catalog. Integer
created_at The creation date for the catalog. Datetime
updated_at The last time the catalog was updated. Datetime
name The name of the catalog. String
canvas_domain Domain for the corresponding canvas account. String
canvas_id Id for the corresponding canvas account. String
logo URL for the catalog logo. String
locale Three character locale for the catalog. String
url Url for the catalog String
user_defined_fields An array of serialized user defined field records provided to the catalog either through direct assignment or inheritance. Array
user_defined_field[name] Name of the user defined field String
user_defined_field[label] Label that will be shown with the field String
user_defined_field[field_type] HTML input type of the field String
user_defined_field[required] Indicates if the custom field is required Boolean
parent[id] The id of the parent catalog Integer
parent[name] The name of the parent catalog Integer
settings[privacy_policy_url] Url of the privacy policy for this catalog. String
settings[terms_url] Url of the terms used for this catalog. String
settings[currency] Three character currency code. String
settings[time_zone] Timezone configured for this catalog. String
settings[country] Two character country code. String
settings[email_from_name] Name that appears as the sender in emails. String
settings[allow_user_registration] Indicates if new users allowed to enroll classes. Boolean
settings[title_tag] Used for custom titles in HTML. String
settings[meta_description] Used to a meta tag description in HTML. String
settings[custom_head_content] Used to add custom head content to HTML. String
settings[custom_body_content] Used to add custom body content to HTML. String
settings[show_listings_in_parent] Indicates if this catalogs listings will show in a parent catalog. Boolean
settings[skus_enabled] Indicates if the course displays the sku field. Boolean

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: hCdqHq7ugTohalQ75a3QP+7SGAUmsI6AP5kto2UmiYeRXJ/zfUuFPQK/GF/6az+037OjTXFzomjka979bPYP9w==
ETag: W/"890668021e2672dccc71a7fcb2399ec1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=bmFkR0JKSk12NEU5R2pkMDlhSEVKTTJXR0g4OVkrNjYxdHQyWnd3UkZBNityVzBvOEpVbmo3aDdwbzJXVEt1UjNEdnRCcnZHVGtXdFZQK1F2TWhjWXdmNlAwZWpGU1JvdlZ5VkdqU1NZOUZsYjByRXNvMHgxeWxMZFJxd3ZpNi8xVGtXRmliMGkrdDVSenlmTWM0YnE4bEMxeG1jbUV4ak9TUEpvVFphS2V1dDUyS05GQVJXTmRkYUNwMmZqQTdqLS1icU1udlRIRzFyeWM1bEd5emhQaXRnPT0%3D--0498d68ef062c6c155095123c5ff576576a23b76; path=/; HttpOnly
X-Request-Id: 622af3a5-d99a-496e-9f28-54fa8d23ef12
X-Runtime: 1.590647
Content-Length: 2368

Kò

{
  "catalogs": [
    {
      "id": 1,
      "name": "Domain Account 1",
      "parent": null,
      "created_at": "2024/01/26 16:13:42 +0000",
      "updated_at": "2024/01/26 16:13:42 +0000",
      "canvas_domain": "www.canvas-domain-1.com",
      "canvas_id": 1,
      "settings": {
        "privacy_policy_url": "https://www.instructure.com/policies/privacy/",
        "terms_url": "https://www.instructure.com/policies/acceptable-use",
        "currency": "USD",
        "supported_payment_types": "standard",
        "time_zone": null,
        "country": "US",
        "measurement": "credit",
        "email_from_name": "Canvas Catalog",
        "email_from_address": "notifications@instructure.com",
        "allow_user_registration": true,
        "title_tag": null,
        "meta_description": null,
        "custom_head_content": null,
        "custom_body_content": null,
        "show_listings_in_parent": true,
        "order_id_prefix": null,
        "inherit_categories": false,
        "inherit_user_defined_fields": false,
        "beta_canvas_domain": null,
        "skus_enabled": false,
        "canvas_enrollment_events": false,
        "include_noncatalog_courses_in_dashboard": true,
        "external_idp_logout_workflow": false,
        "private_catalog": false,
        "bulk_purchase_disabled": false,
        "enroll_button_behavior": "cart",
        "shopping_cart_enabled": true,
        "external_registration_url": null,
        "external_registration_public_key": null,
        "redirect_external_registration_condition": "authenticated",
        "include_captcha": false,
        "user_registration_domain_restriction_type": "inherit",
        "user_registration_domain_deny_list": "",
        "user_registration_domain_allow_list": "",
        "frame_ancestors": "",
        "disabled_new_registration": false,
        "email_reply_to": "",
        "has_sso_warning": false,
        "measurement_id": null,
        "redirect_non_admins_to_root_url": false,
        "canvas_feature_send_usage_metrics": false,
        "disable_passive_login": false,
        "new_storefront": false,
        "tags_permission_default_value": true,
        "cross_listing_permission_default_value": false
      },
      "user_defined_fields": [
        {
          "list_order": 0,
          "name": "favorite_color",
          "label": "Favorite Color",
          "field_type": "text",
          "required": false,
          "required_message": "Favorite Color is required"
        },
        {
          "list_order": 1,
          "name": "code_of_conduct",
          "label": "Code of Conduct",
          "field_type": "checkbox",
          "required": true,
          "required_message": "You must accept the Code of Conduct."
        },
        {
          "list_order": 2,
          "name": "age",
          "label": "Age",
          "field_type": "text",
          "required": true,
          "required_message": "You must provide an Age."
        }
      ],
      "logo": "https://test-bucket.s3.amazonaws.com/test/logos/1ea123b46e1ed77e42f1dfd1389b9264d3ed79ce.jpeg",
      "locale": "en",
      "url": "http://www.my-catalog.edu",
      "measurement": "credit",
      "storefront_theme_id": null
    }
  ]
}

Certificates

Creating a Certificate

Ekstremite

POST https://www.my-catalog.edu/api/v1/certificates

Paramèt

Name Description Type
certificate[listing_id] obligatwa Id of the Listing Integer
certificate[name] obligatwa Name of the Certificate String
certificate[active] State of the Certificate, defaults to true Boolean
certificate[template] obligatwa Template for Certificate contents String
certificate[pdf_settings][orientation] 'Landscape' or 'Portrait' mode for PDF. Defaults to Landscape. String
days_to_expire Days until the certificate expires after it is awarded. Defaults to null. Must not be present when expires_at is present. Integer
expires_at Date of certificate expiration. Defaults to null. Must not be present when days_to_expire is present. Datetime

Mande

Wout

POST https://www.my-catalog.edu/api/v1/certificates

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "certificate": {
    "listing_id": 2,
    "name": "API Name",
    "active": true,
    "template": "<H1>This is a template</h1>",
    "pdf_settings": {
      "orientation": "Landscape"
    }
  }
}

Repons

Branch Repons

Name Description Type
certificate[id] Certificate ID Integer
certificate[listing_id] Corresponding listing ID Integer
certificate[name] Certificate name String
certificate[active] Whether the certificate is enabled String
certificate[template] HTML template used to generate issued certificates String
certificate[pdf_settings] An object containing extra params for PDF generation Object
certificate[created_at] The creation date of the certificate Datetime
certificate[updated_at] The last time the certificate was updated Datetime
certificate[days_to_expire] Number of days for which issued certificates remain valide Integer
certificate[expires_at] A fixed datetime when issued certificates expire Datetime

Estati

201

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: TmijQt0J1/dTqgVzxWN2irOXSDjz92XN1yA/tYU3ungKOho7+uEwNquLLP17FZbIi+vNoK81u8AbpoBwkU04XQ==
ETag: W/"7ff3d838e6c71383434564e61af82990"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=VHlJUzZPMmR0anE3VFVET3NRa2Z2K0FiN2Z1blR6WXdDejdPWVQ0d0U3bjhkLzBReERWY0s5RzRCU1U0eEZSUWVoMXNtQXpjUGRzdHRJK2lYcHJZS1FxZ1lmdzBsUHBXdFBxYTlhYnNqZk5rVElOSlNBcEVXQjBQdWRoVlcxUFRlek44ODhCaWJKSkJYV1BhNTgvSlVpeDdHaXoxZS94Z0IzNTVDWFFGSTB5SjJzU1R4T0ZrbGdwRXdMOVlIWC80LS1EbkoyWFBrMW0ydDZ1ZjRzYzRqd3h3PT0%3D--e82a2f0ca511eea4772d2d786569279052d7dabf; path=/; HttpOnly
X-Request-Id: 4da0be49-a235-439a-ae78-545cd18a39f9
X-Runtime: 1.101659
Content-Length: 297

Kò

{
  "certificate": {
    "id": 2,
    "listing_id": 2,
    "name": "API Name",
    "active": true,
    "template": "<H1>This is a template</h1>",
    "pdf_settings": {
      "orientation": "Landscape"
    },
    "created_at": "2024/01/26 16:13:49 +0000",
    "updated_at": "2024/01/26 16:13:49 +0000",
    "days_to_expire": null,
    "expires_at": null
  }
}

Deleting a Certificate

Ekstremite

DELETE https://www.my-catalog.edu/api/v1/certificates

Paramèt

Name Description Type
certificate[listing_id] obligatwa Id of the Listing Integer
nullify_requirements_completed_at Should nullify the requirements_completed_at for the enrollments, defaults to false Boolean

Mande

Wout

DELETE https://www.my-catalog.edu/api/v1/certificates

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "certificate": {
    "listing_id": 4
  },
  "nullify_requirements_completed_at": true
}

Repons

Estati

204

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
X-CSRF-Token: 67xc4tnCy+1ewet6/8ehtd+K6M1Z0XkcRA8XR+24JJTjdjYwA0F/2/NiYdsU5ch/B41U8Au+jkVlPAiywp3dHw==
Cache-Control: no-cache
Set-Cookie: _gallery_session=dlpxam9QeWswcHlBcUE4cTI1RTJ1UmYrc2F3Zy9JcCt5c0I1ejBWdXJubTFoMmYwdkdCVmxwN0poL21lNjJOeGxEYnVKRjI2ZTlsNlh0TE9VTisvUWpZcU5tRW1mME9sZ050ZW9FY054dHNVMGRYTG8rWDVRSENOWXE5RWVmR3NFaGtmQk03SE9TUEE4d3RMQ2hHUjhqWXhrMFBXdDk0RmdHQysyeUVHZGViZ0lvbDhua1VhaEZHUzdZaWtnQjVrLS1jWDhvU0NTMW1OR0g1ZTVUdFNvN1R3PT0%3D--cf79cc4b3b1de5aa02586535eacc3910af3834e7; path=/; HttpOnly
X-Request-Id: 3d7fe73a-cd4e-4f40-8306-8f1435501436
X-Runtime: 0.224797

Getting a listing Certificate

Ekstremite

GET https://www.my-catalog.edu/api/v1/certificates

Paramèt

Name Description Type
certificate[listing_id] obligatwa Id of the Listing Integer

Mande

Wout

GET https://www.my-catalog.edu/api/v1/certificates?certificate[listing_id]=3

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Paramèt Rekèt

certificate={"listing_id"=>"3"}

Repons

Branch Repons

Name Description Type
certificate[id] Certificate ID Integer
certificate[listing_id] Corresponding listing ID Integer
certificate[name] Certificate name String
certificate[active] Whether the certificate is enabled String
certificate[template] HTML template used to generate issued certificates String
certificate[pdf_settings] An object containing extra params for PDF generation Object
certificate[created_at] The creation date of the certificate Datetime
certificate[updated_at] The last time the certificate was updated Datetime
certificate[days_to_expire] Number of days for which issued certificates remain valide Integer
certificate[expires_at] A fixed datetime when issued certificates expire Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: uwAyOjBbIc26ZJednnhrrKpKoSocSaieo5SC41Z6GTcg2pKe2YIOi/48M8XfW7aUZi1Gxk2rQUMEKgTH3lxJRw==
ETag: W/"6904cb8e0fb575dcb402f08f514ffe2e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=SjlYelFHWHdGS2xqVjVYanFmOUF0UmN5NVpCc0RJTlZocVhFSnV3Z1NIMXJVUEhPYzF2RnovOEtIb3oyOUpDekdKcHQ2bnZLclptaFJUTFZGaUgySmlUZWVoa2xuRXhLeG9qeTdxNUlzVGJRTDh0YThzbDZydzhVbmZsU2lIenVkK3I3V05wYlI1dDJDS2kybFllbVcyVHRnYjZsRVFndkJGQTBoSVgvb3dFbUpYRElxQUFMa1lYSTN4cGg1NzM1LS1DdW5zRktodkc1TW1hK0RHd0kxbEZnPT0%3D--4267f72c49d5758d80c50a7df38ca854e2f5ccac; path=/; HttpOnly
X-Request-Id: 5f37224b-932c-4dc4-b95b-493a8f11412e
X-Runtime: 0.276767
Content-Length: 267

Kò

{
  "certificate": {
    "id": 3,
    "listing_id": 3,
    "name": "Certificate of Training",
    "active": true,
    "template": "Congrats, {{student_name}}!",
    "pdf_settings": {
    },
    "created_at": "2024/01/26 16:13:49 +0000",
    "updated_at": "2024/01/26 16:13:49 +0000",
    "days_to_expire": null,
    "expires_at": null
  }
}

Mande

Wout

GET https://www.my-catalog.edu/api/v1/certificates?certificate[listing_id]=3

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie: _gallery_session=SjlYelFHWHdGS2xqVjVYanFmOUF0UmN5NVpCc0RJTlZocVhFSnV3Z1NIMXJVUEhPYzF2RnovOEtIb3oyOUpDekdKcHQ2bnZLclptaFJUTFZGaUgySmlUZWVoa2xuRXhLeG9qeTdxNUlzVGJRTDh0YThzbDZydzhVbmZsU2lIenVkK3I3V05wYlI1dDJDS2kybFllbVcyVHRnYjZsRVFndkJGQTBoSVgvb3dFbUpYRElxQUFMa1lYSTN4cGg1NzM1LS1DdW5zRktodkc1TW1hK0RHd0kxbEZnPT0%3D--4267f72c49d5758d80c50a7df38ca854e2f5ccac

Paramèt Rekèt

certificate={"listing_id"=>"3"}

Repons

Branch Repons

Name Description Type
certificate[id] Certificate ID Integer
certificate[listing_id] Corresponding listing ID Integer
certificate[name] Certificate name String
certificate[active] Whether the certificate is enabled String
certificate[template] HTML template used to generate issued certificates String
certificate[pdf_settings] An object containing extra params for PDF generation Object
certificate[created_at] The creation date of the certificate Datetime
certificate[updated_at] The last time the certificate was updated Datetime
certificate[days_to_expire] Number of days for which issued certificates remain valide Integer
certificate[expires_at] A fixed datetime when issued certificates expire Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: pdb33lGdh8SqfRNb1+fRTyCL8LVFRZtci8FdD0jYDR4+DFd6uESogu4ltwOWxAx37OwXWRSncoEsf9srwP5dbg==
ETag: W/"6904cb8e0fb575dcb402f08f514ffe2e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=VnhZZXNxTEEzL25icjlUOVhZZW1UOWJXRVRldkc2YmdicG0weGZsRkhnU1dRK0pmK2E1MzZlbHUxUndnN05wMWJvcjFBUW5SQUtqcGpISlJxb2VTdzRZeFAzSGxIMlJTM3VOWVBjWENjL1MwZVhHTERBQ2c4SEhYOHVPbDlnNW83YncyZ21KaGcyaEs4R21XMzlJQlp0a2dGQVJkK1Q3QzNLYllGMTQ5QTZQaTNiRGhuWTRLK2puYXgyMFdZcTFsLS1rOGEvSTVOSkJic0liVGdwN2M3K0FnPT0%3D--8a6df87c0e0faf412685ba8943030c8a7aa740f1; path=/; HttpOnly
X-Request-Id: 028289dd-328e-4742-85a8-7fdd46781e7a
X-Runtime: 0.307749
Content-Length: 267

Kò

{
  "certificate": {
    "id": 3,
    "listing_id": 3,
    "name": "Certificate of Training",
    "active": true,
    "template": "Congrats, {{student_name}}!",
    "pdf_settings": {
    },
    "created_at": "2024/01/26 16:13:49 +0000",
    "updated_at": "2024/01/26 16:13:49 +0000",
    "days_to_expire": null,
    "expires_at": null
  }
}

Revoking Users Certificate

Ekstremite

PUT https://www.my-catalog.edu/api/v1/certificates/revoke_users_certificate

Paramèt

Name Description Type
certificate[listing_id] obligatwa Id of the Listing Integer
certificate[canvas_user_ids] obligatwa List of Canvas User Id's Array

Mande

Wout

PUT https://www.my-catalog.edu/api/v1/certificates/revoke_users_certificate

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "certificate": {
    "listing_id": 1,
    "canvas_user_ids": [
      1
    ]
  }
}

Repons

Branch Repons

Name Description Type
revoked_certificates[canvas_user_id] Canvas User ID Integer
revoked_certificates[canvas_course_id] Canvas Course ID Integer
revoked_certificates[listing_id] Catalog Product Listing ID Integer

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: ifbcanRDHujLQsq0/16EOz4+Eh2Ju6so1cjQx0Wzj9vvC+7MK4cGPMluIikq6R977h4LLBHXJXVHoZlhcGk29g==
ETag: W/"26e373435ce658d1751db3efbc63412b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=VWc2eEx0UUhXVThxaVBzMm94MnY2dmMwMjN5dkpGV0R5cWFPa0hha3Z4dGdvbDV5Wm1keEtjbXZkTHYwd3h4VDc0OGE5d1FJbityQ2V4aGtjU1B0Skx5cm9nZDhHc1h3dTljYkxtYVN1TkRXdnJaakZ1YkRpMWVlV2lXNFdJelE1cGtTT0dRRGVGUFFDanpQZVRubkFlWHVLbmhlMzJDeUxLNHBqQ1RtQ2VrSGthVE5ZVnJrOUNUNzQ1VUh6OHJxLS0xbk9YZlAxK25SbnpkSUlpOVFUa0V3PT0%3D--7312d14d87fee922195922812995a27ef6d4047e; path=/; HttpOnly
X-Request-Id: 4bacc86a-b16a-43e6-a8b9-0c8f9bf11535
X-Runtime: 0.407728
Content-Length: 86

Kò

{
  "revoked_certificates": [
    {
      "canvas_user_id": 1,
      "canvas_course_id": 1001,
      "listing_id": 1
    }
  ]
}

Completed Certificates

listing a user's completions with a certificate

Ekstremite

GET https://www.my-catalog.edu/api/v1/completed_certificates

Paramèt

Name Description Type
user_id obligatwa Canvas Id of the user Integer
only_certificates Indicates if the courses without certificates should be included, default is to include all courses Boolean

Mande

Wout

GET https://www.my-catalog.edu/api/v1/completed_certificates?user_id=1&only_certificates=true

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Paramèt Rekèt

user_id=1
only_certificates=true

Repons

Branch Repons

Name Description Type
canvas_course_id Canvas Course ID Integer
catalog_title catalog course title String
canvas_course_name Canvas Course name String
certificate_url URL for Course Certificate String
canvas_course_workflow_state Canvas Course Workflow State String
completed_at Canvas Course Completion Date Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: PDElLDXGbPWbJZyK+ZNcHHHqZbJHHHNXULZTC707Bd/y+0iGg915w6+OXBBp8JN5qhvmoghxM8Pc3YpGeFQzcA==
ETag: W/"1f7f1f2ebcd935d59d34fe45b6b12b0a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=WDdKSlZYb0x6VWluUmFYT0R2N01PU0tqd1Bwa3Z5REZCcEUxWWIyZk9RcDVaM1VzMGN4ZzRqRW1zZGZNUWwxeHdZWWpPNWtnQ1h4V3pBVXd0VHh4MWNKaEpQM1Q0UWl2MklQSkovdWU5WGtCUzhwWEl6MytiQUxBemVjbTdlSk5FMEQzd0hlMFFNdnJoeWxFMk5hSnc1RTJFWmw1UDVTMHR6OC9ucHNyZ1ZXcE1SMkRLL2c2MGMwWHdxT1dyTkMwLS1yOGJpWVJNSWZDMmhueG5NTmFhWnl3PT0%3D--aa48e8628bf89317fdc9660f7dcc475dddb54a78; path=/; HttpOnly
X-Request-Id: 19f08245-8e78-4e3e-b49b-9e8171f019b0
X-Runtime: 0.421681
Content-Length: 262

Kò

{
  "completed_certificates": [
    {
      "canvas_course_id": 15,
      "catalog_title": "Course 29",
      "canvas_course_name": "Course 29",
      "certificate_url": "https://www.domain-31.com/certificates/certificate-numero-1-5.pdf",
      "canvas_course_workflow_state": "available",
      "completed_at": null
    }
  ]
}

Courses

Creating a course

Ekstremite

POST https://www.my-catalog.edu/api/v1/courses

Paramèt

Name Description Type
course[title] obligatwa Listing title String
course[description] obligatwa Full listing description String
course[path] obligatwa Path to the listing. Used in URLs String
course[teaser] obligatwa A shorter description of the listing String
course[enrollment_open] Indicates if the listing is current accepting new students Boolean
course[enrollment_open_from] If specified, enrollment is open only from this date-time Datetime
course[enrollment_open_to] If specified, enrollment is open only to this date-time Datetime
course[visibility] Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
course[enrollment_cap] A limit for the total number of enrollments Integer
course[enrollment_fee] Enrollment fee Decimal
course[allowed_payment_types] Allowed payment methods Array
course[days_to_complete] The number of days a student has to complete the requirements Integer
course[account_id] The id of the account to associate the listing to. Can be an id of any subcatalog of the catalog making the API request. Defaults to the catalog making the API request. Integer
course[list_order] Order in which the listing is shown in the catalog Integer
course[waitlist] Waitlist enabled (defaults to false) Boolean
course[waitlist_cap] Wait List Limit for the total number of wait listed enrollments Integer
course[listing_image] URL or file upload for the image to be shown with this listing. String
course[tag_names] List of tags applied to this listing Array
course[show_free_banner] Show the 'FREE' mark on the card of the listing if free Boolean
course[associated_account_ids] Other account ids where this product should be listed Array
course[canvas_course_id] obligatwa Id of the related canvas course Integer
course[credits] Credit value of the course Decimal
sku Listing SKU for a course String

Mande

Wout

POST https://www.my-catalog.edu/api/v1/courses

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "course": {
    "title": "Course 1",
    "description": "This is a very important course.",
    "path": "course-1",
    "canvas_course_id": 10010010,
    "teaser": "This is an example teaser",
    "enrollment_open": true,
    "visibility": "listed",
    "enrollment_cap": 150,
    "waitlist": true,
    "waitlist_cap": 25,
    "enrollment_fee": 49.99,
    "days_to_complete": 45,
    "list_order": 123,
    "credits": 4,
    "sku": "abc1234",
    "tag_names": [
      "Tag",
      "Another Tag"
    ]
  }
}

Repons

Branch Repons

Name Description Type
id Identifier for this listing. Integer
visibility Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
enrollment_open Open for enrollment Boolean
enrollment_open_from If specified, enrollment is open only from this date-time Datetime
enrollment_open_to If specified, enrollment is open only to this date-time Datetime
enrollment_cap A limit for the total number of enrollments Integer
waitlist Waitlist enabled Boolean
waitlist_cap Wait List Limit for the total number of wait listed enrollments Integer
title Title of the listing String
enrollment_fee Enrollment fee Decimal
currency The three digit currency code associated to the enrollment fee String
listing_path Path to the listing. Used in URLs String
listing_url The URL of the listing String
short_description A short description for this listing String
list_order Order in which the listing is listed in the catalog Integer
tag_names List of tags applied to this listing Array
detail_code Payment detail code for a course (only if enabled with :payment_detail_code_enabled feature flag) String
show_free_banner Show the 'FREE' mark on the card of the listing if free Boolean
associated_account_ids Other account ids where this product should be listed Array
start_date When the Canvas course starts if specified Datetime
end_date When the Canvas course ends if specified Datetime
canvas_section_id The Canvas course's section's id Integer
catalog[id] Id for the catalog that owns this listing Integer
catalog[name] Name for the catalog that owns this listing String
created_at The creation date for the listing. Datetime
updated_at The last time the listing was updated. Datetime
canvas_course[id] Corresponding Canvas id Integer
credits Credit value of the course Decimal
sku Listing SKU for a course String

Estati

201

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Location: https://www.my-catalog.edu/api/v1/courses/35
Content-Type: application/json; charset=utf-8
X-CSRF-Token: ChQpgqWmsJR1w1xFvhVswVkq0RvNdTGy7Sn7FDNeLGOuF/zgmD4Dy70K1iNRccHYe+bJFIYsF3mARV5UPryg3g==
ETag: W/"0813f62832bbd06af3ead8380426c731"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=M2tCaE50ck90YVpkVXZFS0JHdWZrbTViYVlHZ1BMRTVNSW5WeGl4bm94NTBPSlZTcFh0THVBWm8xbzVRWnQzQllDY1dBM241VGRjV1dXM2JoWklndTBLMWc5S3RNUzE3K3NGNXFLWnRDem9ISHl3Tkx3UE5RNGE0UGFLUzBqcVo2LzRSN0RtRFlET3dITm1ldW1kRnpPbkxpM2Z6b25hQ0dkWG93ZElIUHFKRm5KN0hEN2xkeldQZGxPRWo2NU5qLS1UTitjUjd2L091ZkZ2OWdielpiM2ZRPT0%3D--d35466c3516872dcebedc8c1def67b3f019c187d; path=/; HttpOnly
X-Request-Id: 4e6c741c-d855-412e-9c9d-860582f69974
X-Runtime: 0.651391
Content-Length: 889

Kò

{
  "course": {
    "id": 35,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": 150,
    "description": "This is a very important course.",
    "enrollment_fee": "49.99",
    "created_at": "2024/01/26 16:14:10 +0000",
    "credits": 4.0,
    "measurement": "credit",
    "updated_at": "2024/01/26 16:14:10 +0000",
    "short_description": "This is an example teaser",
    "listing_path": "course-1",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 45,
      "name": "Domain Account 46"
    },
    "type": "Course",
    "title": "Course 1",
    "list_order": 123,
    "waitlist": true,
    "waitlist_cap": 25,
    "sku": "abc1234",
    "show_free_banner": true,
    "image_alt_text": null,
    "allowed_payment_types": [
      "standard"
    ],
    "tag_names": [
      "Tag",
      "Another Tag"
    ],
    "listing_url": "http://www.my-catalog.edu/courses/course-1",
    "start_date": null,
    "end_date": null,
    "canvas_section_id": null,
    "associated_account_ids": [

    ],
    "canvas_course": {
      "id": 10010010
    }
  }
}

Deleting a specific course

Ekstremite

DELETE https://www.my-catalog.edu/api/v1/courses/:id

Mande

Wout

DELETE https://www.my-catalog.edu/api/v1/courses/39

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded
Cookie:

Repons

Estati

204

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
X-CSRF-Token: mFmlAzkHOzd/hEq47S8HIqv7VpWucIudi3jAGXcr6lriuCBw5pzyTHYKwa9clCVoYDiyujkOjpYGyLFWCaew1g==
Cache-Control: no-cache
Set-Cookie: _gallery_session=QnlJMGZSWkJqYWFnVUxwajZIRTluL1FXdU0xTmlkM0picnFBZFB4RSt6dUF0N2NzVmRxa2lxSy9vbkdlVkZrUld5d1AzU1I1ZnhwcWQxaGhib2JiOGFBTVlDelF5a3VhZE9FbmZyaythUWtCK0FiMW9IdThWa3V1RjlUd29WblZZKzVXVC9ud0J5Z0hQTmIxNXRpOEo2ZmpxcVVkRHkybHgybnhsR2ZTdisydjdSbUFGZ29GQkE3b0hDVlZEVlVQLS1sK2wzc2JEQk9iazQ2RTN5QTlMOGVRPT0%3D--d1fb6d88e0471b728c15b420e7af52372dbd1994; path=/; HttpOnly
X-Request-Id: b859ee89-4141-47d8-89b8-1c2335ce7786
X-Runtime: 0.243536

Getting a specific course

Ekstremite

GET https://www.my-catalog.edu/api/v1/courses/:id

Mande

Wout

GET https://www.my-catalog.edu/api/v1/courses/37

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Identifier for this listing. Integer
visibility Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
enrollment_open Open for enrollment Boolean
enrollment_open_from If specified, enrollment is open only from this date-time Datetime
enrollment_open_to If specified, enrollment is open only to this date-time Datetime
enrollment_cap A limit for the total number of enrollments Integer
waitlist Waitlist enabled Boolean
waitlist_cap Wait List Limit for the total number of wait listed enrollments Integer
title Title of the listing String
enrollment_fee Enrollment fee Decimal
currency The three digit currency code associated to the enrollment fee String
listing_path Path to the listing. Used in URLs String
listing_url The URL of the listing String
short_description A short description for this listing String
list_order Order in which the listing is listed in the catalog Integer
tag_names List of tags applied to this listing Array
detail_code Payment detail code for a course (only if enabled with :payment_detail_code_enabled feature flag) String
show_free_banner Show the 'FREE' mark on the card of the listing if free Boolean
associated_account_ids Other account ids where this product should be listed Array
start_date When the Canvas course starts if specified Datetime
end_date When the Canvas course ends if specified Datetime
canvas_section_id The Canvas course's section's id Integer
catalog[id] Id for the catalog that owns this listing Integer
catalog[name] Name for the catalog that owns this listing String
created_at The creation date for the listing. Datetime
updated_at The last time the listing was updated. Datetime
canvas_course[id] Corresponding Canvas id Integer
credits Credit value of the course Decimal
sku Listing SKU for a course String

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: AwsFu3Xkew3ODAeq4qLfFCpLiEo/3MmFMeN5/8jTP+Cdn0uMLOR87n5wajamQEOYcMXBn5wue4p1qBnhkTU9DA==
ETag: W/"1d227c9b5c034fd2c579204b63761669"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=MTRGbWxienRRd205bmNvOElGdWRkWEtNb0puYk9UOHVmVWYxd1I3UFUxNnpHN1IxcEpHRXMyQVQzSElwTFlaSlBtd010MnFVWG5wUWZ2MitrRjBLNzg1OVlTZ0NIK2wvaCs2aHVBcHhHYnhYZWdsNEpUYk5EQVI4QlgrT1NHSjJMZ3ZlZ3dMaVhkOUpNQm54L01CK1FONXNYUHMvN1JuRDE4N0VpRmlLdGZ5eS9VWStVSlJlL0VKNVBoN1IwM0E0LS1udUlQYUJLUXdScm5MRGJXZnl5cm9BPT0%3D--973e836968e9042ebb6fc59561b960eda8913dff; path=/; HttpOnly
X-Request-Id: f62d7d32-42cc-49c9-874c-1a00640f49ef
X-Runtime: 0.268938
Content-Length: 910

Kò

{
  "course": {
    "id": 37,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": null,
    "description": "description_35",
    "enrollment_fee": "0.0",
    "created_at": "2024/01/26 16:14:12 +0000",
    "credits": 3.0,
    "measurement": "credit",
    "updated_at": "2024/01/26 16:14:12 +0000",
    "short_description": "teaser_35",
    "listing_path": "course-path-35",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 47,
      "name": "Domain Account 48"
    },
    "type": "Course",
    "title": "Course 35",
    "list_order": null,
    "waitlist": false,
    "waitlist_cap": null,
    "sku": "sku_21",
    "show_free_banner": true,
    "image_alt_text": null,
    "allowed_payment_types": [
      "standard"
    ],
    "tag_names": [
      "Another Tag",
      "Tag"
    ],
    "listing_url": "http://www.my-catalog.edu/courses/course-path-35",
    "start_date": "2024/01/19 16:14:12 +0000",
    "end_date": "2024/02/02 16:14:12 +0000",
    "canvas_section_id": null,
    "associated_account_ids": [

    ],
    "canvas_course": {
      "id": 21
    }
  }
}

Listing courses

Ekstremite

GET https://www.my-catalog.edu/api/v1/courses

Mande

Wout

GET https://www.my-catalog.edu/api/v1/courses

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: g90hvRMCD06dhah6oqFB5YUkbSf2bSTMWXhHSp15yKab0pZ5Cs2LLCPARcC+DLuMOq2vbhhJ+epRvxt7X/kBPw==
ETag: W/"2b8f25bcd848245933f9b61beb5d292a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=ZkNDbE44VDNUeFQzMlRiVlNQV0pYckw4VFkxKzBjemxjOENYT002WHBKM0dVeGh6TnhNQUNtSys5NFR1cjNDMHllQzV1RmczVWZ4OXlidGNLSmtxWVBHUXdYN3M1NEtsckJuc2lTY2ZZRWdsbldiOCtGRkh5RUN0Vit0WHYrNEhrMFF5VjV4YnBzSTlFL2RrUmpMUmRHZUh0cjJCUjlISUdpZWVXVVlpZW1IeGs4dWh5MFY1WGxXV1NiM2xIK3Y4LS1DL2tlRzVQeXVSN2t6SFYxTG1uSEFBPT0%3D--2a3cee1e1076979a8c593c30e5b9ef9d0d15b265; path=/; HttpOnly
X-Request-Id: 34cfcb49-e474-4d89-a88e-62adb52cc040
X-Runtime: 0.442707
Content-Length: 913

Kò

{
  "courses": [
    {
      "id": 36,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_34",
      "enrollment_fee": "0.0",
      "created_at": "2024/01/26 16:14:11 +0000",
      "credits": 3.0,
      "measurement": "credit",
      "updated_at": "2024/01/26 16:14:11 +0000",
      "short_description": "teaser_34",
      "listing_path": "course-path-34",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 46,
        "name": "Domain Account 47"
      },
      "type": "Course",
      "title": "Course 34",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": "sku_20",
      "show_free_banner": true,
      "image_alt_text": null,
      "allowed_payment_types": [
        "standard"
      ],
      "tag_names": [
        "Another Tag",
        "Tag"
      ],
      "listing_url": "http://www.my-catalog.edu/courses/course-path-34",
      "start_date": "2024/01/19 16:14:11 +0000",
      "end_date": "2024/02/02 16:14:11 +0000",
      "canvas_section_id": null,
      "associated_account_ids": [

      ],
      "canvas_course": {
        "id": 20
      }
    }
  ]
}

Updating Course SKUs

Ekstremite

PUT https://www.my-catalog.edu/api/v1/courses/update_skus

Paramèt

Name Description Type
attachment obligatwa CSV containing a Catalog Course ID and Catalog Course SKU header file

Mande

Wout

PUT https://www.my-catalog.edu/api/v1/courses/update_skus

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Host: www.my-catalog.edu
Cookie:

Kò

------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="attachment"; filename="missing_header1.csv"
content-type: text/plain
content-length: 69

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Repons

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: 4Qrtgg1xy37QYYkTPXroSno2jMmkhmdUvK2URIJhmHt1My6AIK+SB/yTTVQOFAPG1ixKhVjno9ZqTGpW4kSeWw==
ETag: W/"816e537e629e005719618d3dd748b6d9"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=VEhzcmhXTlVjdmVCdFhmaVFWdFRRR1F2WnpUOVBXU3pIVm4zNU5EaHVjSkxaN1JOVUIzSmdUTm1jM2dGeUhSZFVmZ1MxR2o5bUs2ZkNqbDFiMkNMU2Fha3dSMlNheGVKeVZJQUZCLzYrdjdnaHB3N09xY2M3RjlzNC9wVU9naVhMZ1RROElBeU5tVjAzV1FnbmdrVWtlSWdTMnI0aEJaemZPK084R1paTlV0NnBmZlkrQmNNUWQzUzhDc2hCUFd4LS1xenVoLzZ4a2Nvc1VTN3FXTGFYSVNnPT0%3D--c40a4ba4afdaa3fcac3f8d020a8a01fcbbf6b2f6; path=/; HttpOnly
X-Request-Id: ef396bc2-fa1b-44f2-9dc1-573787273590
X-Runtime: 0.307306
Content-Length: 206

Kò

{
  "progress": {
    "id": 2,
    "account_id": 44,
    "canvas_user_id": null,
    "completion_percent": null,
    "workflow_state": "queued",
    "payload": {
    },
    "created_at": "2024/01/26 16:14:10 +0000",
    "updated_at": "2024/01/26 16:14:10 +0000"
  }
}

Updating a course

Ekstremite

PUT https://www.my-catalog.edu/api/v1/courses/:id

Paramèt

Name Description Type
course[title] Listing title String
course[description] Full listing description String
course[path] Path to the listing. Used in URLs String
course[teaser] A shorter description of the listing String
course[enrollment_open] Indicates if the listing is current accepting new students Boolean
course[enrollment_open_from] If specified, enrollment is open only from this date-time Datetime
course[enrollment_open_to] If specified, enrollment is open only to this date-time Datetime
course[visibility] Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
course[enrollment_cap] A limit for the total number of enrollments Integer
course[enrollment_fee] Enrollment fee Decimal
course[allowed_payment_types] Allowed payment methods Array
course[days_to_complete] The number of days a student has to complete the requirements Integer
course[account_id] The id of the account to associate the listing to. Can be an id of any subcatalog of the catalog making the API request. Defaults to the catalog making the API request. Integer
course[list_order] Order in which the listing is shown in the catalog Integer
course[waitlist] Waitlist enabled (defaults to false) Boolean
course[waitlist_cap] Wait List Limit for the total number of wait listed enrollments Integer
course[listing_image] URL or file upload for the image to be shown with this listing. String
course[tag_names] List of tags applied to this listing Array
course[show_free_banner] Show the 'FREE' mark on the card of the listing if free Boolean
course[associated_account_ids] Other account ids where this product should be listed Array
course[canvas_course_id] Id of the related canvas course Integer
course[credits] Credit value of the course Decimal
sku Listing SKU for a course String

Mande

Wout

PUT https://www.my-catalog.edu/api/v1/courses/38

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "course": {
    "title": "Course 1",
    "description": "This is a very important course.",
    "path": "course-1",
    "canvas_course_id": 10010010,
    "teaser": "This is an example teaser",
    "enrollment_open": true,
    "visibility": "listed",
    "enrollment_cap": 150,
    "waitlist": true,
    "waitlist_cap": 25,
    "enrollment_fee": 49.99,
    "days_to_complete": 45,
    "list_order": 123,
    "credits": 4,
    "sku": "abc1234",
    "tag_names": [
      "Tag",
      "Another Tag"
    ]
  }
}

Repons

Estati

204

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
X-CSRF-Token: dDBwTMJxA6LCu7CgpKnxZw7PC2fjZZrRzVDfCpLKKrUiN0klD/4Hd6MHOrw/mLhe2OkbFAUPZpoIm7zQiWngKg==
Cache-Control: no-cache
Set-Cookie: _gallery_session=TGd4cHZtVWM0MlRyZk0wcFNWZWltZ0UrNktNckpGdkdoclpYYkFYUTlIdWE3VDdxcmhnQmhNY3hVV1NtYmZ1WUNHU2FzdWhidTkwcjFmYmdHNFE3dEtZalo1cmNyYW1VTGtMeE4xeTg3eENrYUhVdDVPQkhoR3NVbFNMSEVMbUx1dGlTbjVERlQ2Sk0yWC9MWUQ5d3U2S2tKRGJEd3JqOUJZMmVoeG5XZ1QwV3VudnNKTnlKUHJPZDRza0lGdE5hLS0rSDVyYTlGZlJZQ2s0Z0c2SkErU2tRPT0%3D--25a2fd76821d0f8cdb174d1dd0a8e9368d3a8ae7; path=/; HttpOnly
X-Request-Id: 4f52e322-2abf-4474-ad4d-15c27e4ad30f
X-Runtime: 0.413245

Enrollments

Creating an enrollment

Ekstremite

POST https://www.my-catalog.edu/api/v1/enrollments

Paramèt

Name Description Type
create_order Create an order record for this enrollment, defaults to true Boolean
send_email Send an enrollment email to the user, defaults to true Boolean
enrollment[listing_id] obligatwa Id of the Listing Integer
enrollment[canvas_user_id] obligatwa Id of the Canvas user Integer

Mande

Wout

POST https://www.my-catalog.edu/api/v1/enrollments

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "enrollment": {
    "listing_id": 33,
    "canvas_user_id": 1
  }
}

Repons

Branch Repons

Name Description Type
id Identifier for this enrollment Integer
user[id] Corresponding Canvas user id for this enrollment. Integer
listing[id] Identifier for the listing Integer
listing[title] The name of the listing String
listing[type] The type of listing (Course or Program) String
listing[canvas_course_id] Canvas course ID (nil for Program enrollments) String
enrolled_at The time of enrollment (UTC) Datetime
status Enrollment status (active, dropped or concluded) String

Estati

201

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: x95PJqaXJ6ZZLUQSXial3bDmuLG0TZtEVh74w04Egvl+sd8hDc1p2loruPCQQ8ae6NE4cvgKLJiGrcvwERdsYw==
ETag: W/"9593b44026910fb93bfa0502bbeb3149"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=OS8wdVJuTE03QU45Z3VFUTVnaWlxaWxab1Z2ODdYNFVoUlJYOHdNNjcvM25sYlZFbmpiSU4wTDhqMmI4S2h5TFBwT21QUFZ6b1ZVSFNESjQ1ZXFjWUF6eWpMbXBZYnUvUWRPbFJveWYwazB2aXQ4ZVdyWlVwRk11a3lpOWNqR21ud0IwMVMyd0Naem5rMGdkNWVybzR2Y1hGaE8yWHlCZFFoR1pXbFJ4bGEweU1MeEFtM0U4M2c2YVhldStKRjhQLS1GZGRmcmltZm1xNDBkMWZ0djhjV3lnPT0%3D--907c7613d18ca1515e19ec83242759f0b8cbedfa; path=/; HttpOnly
X-Request-Id: 5bf6aef8-6ae7-48af-abbf-847884677ab3
X-Runtime: 0.326061
Content-Length: 177

Kò

{
  "enrollment": {
    "id": 6,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 33,
      "title": "Course 32",
      "type": "Course",
      "canvas_course_id": 18
    },
    "enrolled_at": "2024/01/26 16:14:08 +0000",
    "status": "active"
  }
}

Deleting an enrollment

An additional request must be made to Canvas to delete the enrollment and remove it from the Catalog Student Dashboard

Ekstremite

DELETE https://www.my-catalog.edu/api/v1/enrollments/:id

Mande

Wout

DELETE https://www.my-catalog.edu/api/v1/enrollments/4

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded
Cookie:

Repons

Branch Repons

Name Description Type
id Identifier for this enrollment Integer
user[id] Corresponding Canvas user id for this enrollment. Integer
listing[id] Identifier for the listing Integer
listing[title] The name of the listing String
listing[type] The type of listing (Course or Program) String
listing[canvas_course_id] Canvas course ID (nil for Program enrollments) String
enrolled_at The time of enrollment (UTC) Datetime
status Enrollment status (active, dropped or concluded) String

Estati

204

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
X-CSRF-Token: SSeM8UGZUc/lt/TUKVEBItTn5X8sQHtubyszKl8HavxRV8IAAzy6k1/fgmLiRToAibh7HuSzShpcGB1wv0BQhA==
Cache-Control: no-cache
Set-Cookie: _gallery_session=NWN0SlFVdCtjdXpDdisyTkJ1cHFnWXVaaE5BRW1mU0lMWVR6d3d3eFEyVDJ3RWx5cUlaKzMxdU40c0hzRXBOQXdXRzJwTXlxZVpUV0x2dlVaZE03cU9FUXQ5a0JESlBwakNwalp0c3lnMDhTME1ZRzZPcUR0ZmhhUG9tRDBWMXdsbThOWjI2WHU4YjhVVkEzaWRyWThoaDhVOE5JT3M0emFJUUJ5dEJXRjFTaDRFRnBjK1oyamppOW4rYVhjemYyLS1yajFkaXNpZmJKMHhLcUNYbzl4ZFpBPT0%3D--e79cf0635405efd08ab9b7a49e44613932f63582; path=/; HttpOnly
X-Request-Id: daac2a79-5e27-40d4-b6e1-13078a3930a4
X-Runtime: 0.214240

Getting a specific bulk enrollment

Ekstremite

GET https://www.my-catalog.edu/api/v1/order_items/history/bulk_enrollments/:id

Paramèt

Name Description
id Order id (Integer)

Getting a specific enrollment

Ekstremite

GET https://www.my-catalog.edu/api/v1/enrollments/:id

Mande

Wout

GET https://www.my-catalog.edu/api/v1/enrollments/5

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Identifier for this enrollment Integer
user[id] Corresponding Canvas user id for this enrollment. Integer
listing[id] Identifier for the listing Integer
listing[title] The name of the listing String
listing[type] The type of listing (Course or Program) String
listing[canvas_course_id] Canvas course ID (nil for Program enrollments) String
enrolled_at The time of enrollment (UTC) Datetime
status Enrollment status (active, dropped or concluded) String

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: EUUrKpGbND8Qd8ESqG4MR8Otzv58dbHmkoGnXxi0yFX4Gk8t+KsudLB0JLr0hTHywxQe0yT6HjzpZJeiqKZoHw==
ETag: W/"6c9e13099d0694c713185376764defa7"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=Tlc1VktmOTIzeUdlZm5JTUczQ2I5QUxuR1VnTlc1eXRNdEtZd29uK3poY3VQcW4vZkhBTFk5RVhyNEZzKytjZFJhQytJa0Rsb2NXWkRuWHVJYlFHWWdWQUgrL2tvNUNuYTBJem92cUcxVVoxTkdySE9Dd3BETUJaVEtMWldYN01oV1I2NFB3WDZYeHRnUDkzcGtvRTcyRDMyc2ZQNExSaHZXZVNkSURjVVhGSmZudDBEM3VuOWZvV21RTTViNGttLS1Mb09NS1MzaHFyaEF6bVlzZWl3bVlBPT0%3D--2b9cfe14154268f0f22e1ebe4bf21d72cb491a2d; path=/; HttpOnly
X-Request-Id: 42496695-7658-4511-8c2a-c2eaf8c2ff5d
X-Runtime: 0.216884
Content-Length: 177

Kò

{
  "enrollment": {
    "id": 5,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 32,
      "title": "Course 31",
      "type": "Course",
      "canvas_course_id": 17
    },
    "enrolled_at": "2024/01/26 16:14:08 +0000",
    "status": "active"
  }
}

Listing bulk enrollments

Ekstremite

GET https://www.my-catalog.edu/api/v1/order_items/history/bulk_enrollments

Paramèt

Name Description
from Only include bulk enrollments from this date (optional, DateTime)
to Only include bulk enrollments to this date (optional, DateTime)
canvas_user_ids Only include bulk enrollments for the specified canvas user ids (optional, Integer[])

Listing enrollments

Ekstremite

GET https://www.my-catalog.edu/api/v1/enrollments

Paramèt

Name Description
listing_id Only include enrollments for the specified listing (optional, Integer)

Mande

Wout

GET https://www.my-catalog.edu/api/v1/enrollments

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: YniftIz5R3lloa6WuvKag0XA/gcrSZRoyQkGJcr71nSwLFdCYdtnuI0uQQYfmmCzc40rNOgEX079lOP/UbAEPg==
ETag: W/"b2eed5e50bcb5d2b2f32f54fbf8d9a53"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=S2wvY2t2RFVScngwTG80YTF6RzhnRFRweEttN3pOVVFsSjRBKzc4by90d2JCOUxCQU1XUU01dzZtTm95ZDMrNXkvYXdpM3VqNWlIQ0VUcHc4YUNkaG5xWlRZbjFhRCs3WG9uTElnbFNjRlE1YXlhcTdMTzRRQWNmNkUydDdTQVNpWnQzaTVnWXhSd0ZoSkhWYTNsTlp0YUxGRlEyRzA3VHAzVHhGOWU0bE1qM3pOQlRUbVAyVWFjcFlGRys3VUZaLS0wUTBuTDM1VW1sYnFIK2Rvd2dTc3h3PT0%3D--aee63605d4e2a27ad19aca52562d2f1fdc4b7479; path=/; HttpOnly
X-Request-Id: 70633daf-193a-48fa-9eb1-cd6252dee8a7
X-Runtime: 0.191626
Content-Length: 180

Kò

{
  "enrollments": [
    {
      "id": 7,
      "user": {
        "id": 2
      },
      "listing": {
        "id": 34,
        "title": "Course 33",
        "type": "Course",
        "canvas_course_id": 19
      },
      "enrolled_at": "2024/01/26 16:14:09 +0000",
      "status": "active"
    }
  ]
}

Orders

Getting a specific order

Ekstremite

GET https://www.my-catalog.edu/api/v1/orders/:id

Mande

Wout

GET https://www.my-catalog.edu/api/v1/orders/2

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Identifier for this order. Integer
full_id Full ID for this order, including prefix. String
catalog_id DEPRECATED: Use catalog['id'] instead. Integer
catalog[id] Identifier for the catalog the order is linked to Integer
catalog[name] Name of the catalog this order is linked to String
user[id] Canvas ID of the user who placed the order Integer
user[name] Name of the user who placed the order String
user[email] E-mail address of the user who placed the order String
listings Array of purchased listings (courses and programs). Fields below: Array
listing[id] Identifier for a listing purchased with this order Integer
listing[catalog_id] Catalog ID associated to this listing Integer
listing[canvas_course_id] Canvas course ID associated to this listing Integer|null
listing[title] The name of the listing String
listing[amount] Listing price at the time of purchase Decimal
listing[discounted_amount] Discounted price by promotions Decimal
promotions Array of promotions used. Fields below: Array
promotion[id] Identifier for a promotion used with this order Integer
promotion[listing_id] Identifier for the listing this promotion is used for Integer
promotion[code] Promo code used for this order String
promotion[amount] Discount amount Decimal
payments Array of payments. Fields below: Array
payment[reference_id] Identifier from the payment redirector String
payment[status] Status of the payment. Can be success, error, or pending. String
payment[amount] Amount of the payment Decimal
total Total cost charged to the user Decimal
currency Currency used for the transaction String
purchased_at Time the transaction was successfully completed. This field is nil for unsuccessful or unpaid orders. Datetime
created_at Time the order was initiated. Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: W8NPl2Oafw8PS7YDMlIe/Q/xum+diqx7OzcPEi2dgVIepq4xB/UhRgDPhnda4WhVSLfJt6KxyFYIdHJroIQKRg==
ETag: W/"255daaf226558950ce9c0b063880cf53"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=YXR2NXZncXc0UXVjT1U2KzNwTVFUdjVibTBWY0tpOW1vc09nRFhsbEx4Ri8rck5YQU8wNTBMa2c5Y0NDT1ZYNUIxSFBSYm9jRzdIelJKUlg3ZUpvMFUzZTAzYnFyc2o3RWNuWTgzRkJQYUtZdjA2amsvOStJcFYwdlNhcStHcWxTdUFobXV6ZkxWOHJVblA0aWNpd0xMM0VBNFJibEVjWlFWUkV0STdsQ3d0UHNNNHZTNFU2SjFydDJkbWFGY2xmLS1rM1oxMHE1dEtKTFlIQjF1eU5QU05RPT0%3D--a1753d8de9a91d09bb01c0a3157bf31f6f040a22; path=/; HttpOnly
X-Request-Id: 98918691-e737-4627-b730-751fdc4fe3fb
X-Runtime: 0.285667
Content-Length: 544

Kò

{
  "order": {
    "id": 2,
    "full_id": "2",
    "catalog_id": 22,
    "catalog": {
      "id": 22,
      "name": "Domain Account 22"
    },
    "user": {
      "id": 1,
      "name": "Saul Goodman",
      "email": "bettercall@saul.com"
    },
    "listings": [
      {
        "id": 9,
        "canvas_course_id": 5,
        "title": "Course 9",
        "amount": "100.0",
        "discounted_amount": "90.0",
        "catalog_id": 22
      }
    ],
    "promotions": [
      {
        "id": 2,
        "listing_id": 9,
        "code": "PROMO2",
        "amount": "-10.0"
      }
    ],
    "payments": [
      {
        "reference_id": "123",
        "status": "success",
        "amount": "90.0"
      }
    ],
    "total": "90.0",
    "currency": "USD",
    "purchased_at": "2024/01/26 16:13:55 +0000",
    "created_at": "2024/01/26 16:13:55 +0000"
  }
}

Listing orders

Ekstremite

GET https://www.my-catalog.edu/api/v1/orders

Paramèt

Name Description
from Earliest date/time to return (optional, String). Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
to Latest date/time to return (optional, String). See 'from' above for format.
canvas_user_id Return only orders for the specified Canvas user ID (optional, String|Array)
completed When set, only return orders that were completed successfully (optional)

Mande

Wout

GET https://www.my-catalog.edu/api/v1/orders

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: MbhOjt1DEPNyeZpYX12qetlQIhEFWOjQsUgDhHn/kCXhkUpTaFLqgvSYSVgPWVypZP5iUWo6aPQga6qP6PMJeA==
ETag: W/"781ad6d623ba0bba811a76e74e3198c9"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=YXZtcVdUS0dFSTZDRXd2Q3dTUEV6TWdyMXQzR0tpSHJCczNsYVd0Zzc2aE5teklLZGdDSURza20zWnl6U2IwaHRPY1ZvRDZTZ0YxNmliTTQrUTRXOVRPL1BReUhOelErdXNJRldadWdUbXpJSVhMcnU0R3dIVENXRlVjdE9uNGgwMjBvVDgxaXhoZ1ZaaEZMTkdUbmFvS3BpcjNmbjBLOEFOTjM4aVNJQjUvOWQybjF5WXVNK2lzS3ZCekh2V1dCLS01WnlwdG1rbFo5YnZyUzdSWko5L3NRPT0%3D--1629a4cdbcd98c9acbecea7b5de808a156eb96ef; path=/; HttpOnly
X-Request-Id: db647773-a854-4ddc-bf2c-548240edd3e3
X-Runtime: 0.352367
Content-Length: 547

Kò

{
  "orders": [
    {
      "id": 1,
      "full_id": "1",
      "catalog_id": 21,
      "catalog": {
        "id": 21,
        "name": "Domain Account 21"
      },
      "user": {
        "id": 1,
        "name": "Saul Goodman",
        "email": "bettercall@saul.com"
      },
      "listings": [
        {
          "id": 8,
          "canvas_course_id": 4,
          "title": "Course 8",
          "amount": "100.0",
          "discounted_amount": "90.0",
          "catalog_id": 21
        }
      ],
      "promotions": [
        {
          "id": 1,
          "listing_id": 8,
          "code": "PROMO1",
          "amount": "-10.0"
        }
      ],
      "payments": [
        {
          "reference_id": "123",
          "status": "success",
          "amount": "90.0"
        }
      ],
      "total": "90.0",
      "currency": "USD",
      "purchased_at": "2024/01/26 16:13:55 +0000",
      "created_at": "2024/01/26 16:13:54 +0000"
    }
  ]
}

Programs

Creating a program

Ekstremite

POST https://www.my-catalog.edu/api/v1/programs

Paramèt

Name Description Type
program[title] obligatwa Listing title String
program[description] obligatwa Full listing description String
program[path] obligatwa Path to the listing. Used in URLs String
program[teaser] obligatwa A shorter description of the listing String
program[enrollment_open] Indicates if the listing is current accepting new students Boolean
program[enrollment_open_from] If specified, enrollment is open only from this date-time Datetime
program[enrollment_open_to] If specified, enrollment is open only to this date-time Datetime
program[visibility] Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
program[enrollment_cap] A limit for the total number of enrollments Integer
program[enrollment_fee] Enrollment fee Decimal
program[allowed_payment_types] Allowed payment methods Array
program[days_to_complete] The number of days a student has to complete the requirements Integer
program[account_id] The id of the account to associate the listing to. Can be an id of any subcatalog of the catalog making the API request. Defaults to the catalog making the API request. Integer
program[list_order] Order in which the listing is shown in the catalog Integer
program[waitlist] Waitlist enabled (defaults to false) Boolean
program[waitlist_cap] Wait List Limit for the total number of wait listed enrollments Integer
program[listing_image] URL or file upload for the image to be shown with this listing. String
program[tag_names] List of tags applied to this listing Array
program[show_free_banner] Show the 'FREE' mark on the card of the listing if free Boolean
program[associated_account_ids] Other account ids where this product should be listed Array
program[requirement_ids] Ordered array of listing IDs that represent requirements for completing the program Array
program[sequential] Indicates if students are required to complete requirements in order Boolean

Mande

Wout

POST https://www.my-catalog.edu/api/v1/programs

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "program": {
    "title": "Program 1",
    "description": "This is a very awesome program.",
    "path": "program-1",
    "teaser": "This is an example teaser",
    "enrollment_open": true,
    "visibility": "listed",
    "enrollment_cap": 150,
    "waitlist": true,
    "waitlist_cap": 12,
    "enrollment_fee": 49.99,
    "days_to_complete": 45,
    "list_order": 123,
    "requirement_ids": [

    ],
    "sequential": true,
    "tag_names": [
      "Tag",
      "Another Tag"
    ]
  }
}

Repons

Branch Repons

Name Description Type
id Identifier for this listing. Integer
visibility Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
enrollment_open Open for enrollment Boolean
enrollment_open_from If specified, enrollment is open only from this date-time Datetime
enrollment_open_to If specified, enrollment is open only to this date-time Datetime
enrollment_cap A limit for the total number of enrollments Integer
waitlist Waitlist enabled Boolean
waitlist_cap Wait List Limit for the total number of wait listed enrollments Integer
title Title of the listing String
enrollment_fee Enrollment fee Decimal
currency The three digit currency code associated to the enrollment fee String
listing_path Path to the listing. Used in URLs String
listing_url The URL of the listing String
short_description A short description for this listing String
list_order Order in which the listing is listed in the catalog Integer
tag_names List of tags applied to this listing Array
detail_code Payment detail code for a course (only if enabled with :payment_detail_code_enabled feature flag) String
show_free_banner Show the 'FREE' mark on the card of the listing if free Boolean
associated_account_ids Other account ids where this product should be listed Array
start_date When the Canvas course starts if specified Datetime
end_date When the Canvas course ends if specified Datetime
canvas_section_id The Canvas course's section's id Integer
catalog[id] Id for the catalog that owns this listing Integer
catalog[name] Name for the catalog that owns this listing String
created_at The creation date for the listing. Datetime
updated_at The last time the listing was updated. Datetime
sequential Indicates if students are required to complete requirements in order Boolean
requirements A nested array of the programs requirements. This includes courses and subprograms which can be distinguished by the type key. Array
credits Cumulative credit value of the program's requirements Decimal

Estati

201

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Location: https://www.my-catalog.edu/api/v1/programs/22
Content-Type: application/json; charset=utf-8
X-CSRF-Token: hAeUKdKL0LUGKnZ3NJxVZKY+fi5bPJCllAFvvMGQjFp4DRBdQDA0vzqZR+ui11K2ZgA3do509mnkh5qCVmFvSQ==
ETag: W/"fa0d3bd6823b9e45cfb6da1068b33f64"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=d3Z2RkRzWk5hTHZGMTFYN0l3N0hDenRTdHZsRFEwNWk3ODk4UWhpS3Y0Ly9Xd0lhcUFlS2l4aFNrL0lHajM4bFIwRlloSTRSOTNOQXhTMFRuNmZsMkdpclhDM3ZwYTV0dmNSV0xMRkkwaXhTWHprbUNUaERkMGJrNGxGWEE4MlBsVGZmM25wWVVoUVVLSnBFNmdtWFFORXlyb1MwTUtaTzFWckZFSE1SanBEWGVzcVFxRWdkWHBySWFxZGlnTnZiLS0vbXk5ak5qSWVJRTVzcTFPY2lPejJnPT0%3D--521a4c392f350257536720d2151f9dab982294a5; path=/; HttpOnly
X-Request-Id: 9de89c7b-5b2e-4ae2-9ddb-fd38226a46d2
X-Runtime: 0.467779
Content-Length: 894

Kò

{
  "program": {
    "id": 22,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": 150,
    "description": "This is a very awesome program.",
    "enrollment_fee": "49.99",
    "created_at": "2024/01/26 16:13:59 +0000",
    "credits": null,
    "measurement": "credit",
    "updated_at": "2024/01/26 16:13:59 +0000",
    "short_description": "This is an example teaser",
    "listing_path": "program-1",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 25,
      "name": "Domain Account 25"
    },
    "type": "Program",
    "title": "Program 1",
    "list_order": 123,
    "waitlist": true,
    "waitlist_cap": 12,
    "sku": null,
    "show_free_banner": true,
    "image_alt_text": null,
    "allowed_payment_types": [
      "standard"
    ],
    "tag_names": [
      "Tag",
      "Another Tag"
    ],
    "listing_url": "http://www.my-catalog.edu/programs/program-1",
    "start_date": null,
    "end_date": null,
    "canvas_section_id": null,
    "associated_account_ids": [

    ],
    "sequential": true,
    "requirements": [

    ]
  }
}

Deleting a specific program

Ekstremite

DELETE https://www.my-catalog.edu/api/v1/programs/:id

Mande

Wout

DELETE https://www.my-catalog.edu/api/v1/programs/16

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded
Cookie:

Repons

Estati

204

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
X-CSRF-Token: +IZl01RiIhZvbTmTzwHKmod4SWShN1/2hNmcPJxMaKN8XQZhsPqV4+Zj8/BXuEw8k+7/ogq51VZpthR+XBqDrA==
Cache-Control: no-cache
Set-Cookie: _gallery_session=amNteDlqaXp2WS9KS2Z5VzhlMWlLMGJuZVdmVTFiRUlrdXgzTGdFb2tBMnlTcGlwMGdCK2ZWOUVscVlQankvUUNzZ3NGSnczUUJyZm5PcVlVaEZ6SUQ0bndjMWQySUg3NklXaXQvaFE4RGJSSmc1SFRxYlpQdk1ZeC8vZThDSXFoNStJRmVuQ1lRMjM0c3Z4RFRIczcvWnJLM0hzM1pzKzM0OE1qK2ZBeWxBaXc2eEhiWU53d0tQc1NLZEhES2UxLS1QU1o0VE9TcnJ3YWZEajNQNncwUVhBPT0%3D--b2abe7cb4b94ce1bb7214d3c6af832a07c11169d; path=/; HttpOnly
X-Request-Id: c7cd33af-e967-4d0f-b40a-75c10ebdad56
X-Runtime: 0.428346

Getting a specific program

Ekstremite

GET https://www.my-catalog.edu/api/v1/programs/:id

Mande

Wout

GET https://www.my-catalog.edu/api/v1/programs/10

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Identifier for this listing. Integer
visibility Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
enrollment_open Open for enrollment Boolean
enrollment_open_from If specified, enrollment is open only from this date-time Datetime
enrollment_open_to If specified, enrollment is open only to this date-time Datetime
enrollment_cap A limit for the total number of enrollments Integer
waitlist Waitlist enabled Boolean
waitlist_cap Wait List Limit for the total number of wait listed enrollments Integer
title Title of the listing String
enrollment_fee Enrollment fee Decimal
currency The three digit currency code associated to the enrollment fee String
listing_path Path to the listing. Used in URLs String
listing_url The URL of the listing String
short_description A short description for this listing String
list_order Order in which the listing is listed in the catalog Integer
tag_names List of tags applied to this listing Array
detail_code Payment detail code for a course (only if enabled with :payment_detail_code_enabled feature flag) String
show_free_banner Show the 'FREE' mark on the card of the listing if free Boolean
associated_account_ids Other account ids where this product should be listed Array
start_date When the Canvas course starts if specified Datetime
end_date When the Canvas course ends if specified Datetime
canvas_section_id The Canvas course's section's id Integer
catalog[id] Id for the catalog that owns this listing Integer
catalog[name] Name for the catalog that owns this listing String
created_at The creation date for the listing. Datetime
updated_at The last time the listing was updated. Datetime
sequential Indicates if students are required to complete requirements in order Boolean
requirements A nested array of the programs requirements. This includes courses and subprograms which can be distinguished by the type key. Array
credits Cumulative credit value of the program's requirements Decimal

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: s0GkEg/CNRwgkMSin+2jPInrrSZI6poYteGghEo7+Edc+Xdm8wTeDMNXdGOAHS5hDChBk7JH/XFRkI8pj/IC8g==
ETag: W/"a85f7a7f9a1da5fc492b43705fe08619"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=YmhNQktIV3JGNFltMlhmWStEZ3duM1ljcDJSUmVjcW5Nb0d1cmZ1WG10b0QwbENZQ2xiT0ZmSkxhM1FuWVppYmxhcTM0UHMvNWhTdVI5YkVTM1RDeGFQUlF4dmVBaE1FcjlNNGc3blRPU3BsYnREdEVoamRhakVQN2Q0TVo0WWZpVVp6Wm9ySFNGR0lUSnJoMmZQbDJwVXV1WENqWGxXeTVEbXBrWkNIeE1RckdaUVQzOXZvRlZ0bGJUMXQraDN0LS1palRuQ1FOMTlIbHFpa0JCVkFzY29BPT0%3D--2773bf4b1500c5b0eaf500577656491f7758eedb; path=/; HttpOnly
X-Request-Id: 03dda709-882d-454b-b850-c19a50433143
X-Runtime: 0.517954
Content-Length: 5271

Kò

{
  "program": {
    "id": 10,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": null,
    "description": "description_10",
    "enrollment_fee": "0.0",
    "created_at": "2024/01/26 16:13:56 +0000",
    "credits": 9.0,
    "measurement": "credit",
    "updated_at": "2024/01/26 16:13:56 +0000",
    "short_description": "teaser_10",
    "listing_path": "program-path-10",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 23,
      "name": "Domain Account 23"
    },
    "type": "Program",
    "title": "Program 10",
    "list_order": null,
    "waitlist": false,
    "waitlist_cap": null,
    "sku": null,
    "show_free_banner": true,
    "image_alt_text": null,
    "allowed_payment_types": [
      "standard"
    ],
    "tag_names": [
      "Another Tag",
      "Tag"
    ],
    "listing_url": "http://www.my-catalog.edu/programs/program-path-10",
    "start_date": "2024/01/19 16:13:56 +0000",
    "end_date": null,
    "canvas_section_id": null,
    "associated_account_ids": [

    ],
    "sequential": true,
    "requirements": [
      {
        "id": 11,
        "visibility": "listed",
        "enrollment_open": true,
        "enrollment_open_from": null,
        "enrollment_open_to": null,
        "enrollment_cap": null,
        "description": "description_11",
        "enrollment_fee": "0.0",
        "created_at": "2024/01/26 16:13:56 +0000",
        "credits": 3.0,
        "measurement": "credit",
        "updated_at": "2024/01/26 16:13:56 +0000",
        "short_description": "teaser_11",
        "listing_path": "program-path-11",
        "listing_image": null,
        "currency": "USD",
        "catalog": {
          "id": 23,
          "name": "Domain Account 23"
        },
        "type": "Program",
        "title": "Program 11",
        "list_order": null,
        "waitlist": false,
        "waitlist_cap": null,
        "sku": null,
        "show_free_banner": true,
        "image_alt_text": null,
        "allowed_payment_types": [
          "standard"
        ],
        "tag_names": [

        ],
        "listing_url": "http://www.my-catalog.edu/programs/program-path-11",
        "start_date": "2024/01/19 16:13:56 +0000",
        "end_date": null,
        "canvas_section_id": null,
        "associated_account_ids": [

        ],
        "sequential": true,
        "requirements": [
          {
            "id": 13,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_13",
            "enrollment_fee": "0.0",
            "created_at": "2024/01/26 16:13:56 +0000",
            "credits": 3.0,
            "measurement": "credit",
            "updated_at": "2024/01/26 16:13:56 +0000",
            "short_description": "teaser_13",
            "listing_path": "course-path-13",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 23,
              "name": "Domain Account 23"
            },
            "type": "Course",
            "title": "Course 13",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_6",
            "show_free_banner": true,
            "image_alt_text": null,
            "allowed_payment_types": [
              "standard"
            ],
            "tag_names": [

            ],
            "listing_url": "http://www.my-catalog.edu/courses/course-path-13",
            "start_date": "2024/01/19 16:13:56 +0000",
            "end_date": "2024/02/02 16:13:56 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [

            ],
            "canvas_course": {
              "id": 6
            }
          }
        ]
      },
      {
        "id": 12,
        "visibility": "listed",
        "enrollment_open": true,
        "enrollment_open_from": null,
        "enrollment_open_to": null,
        "enrollment_cap": null,
        "description": "description_12",
        "enrollment_fee": "0.0",
        "created_at": "2024/01/26 16:13:56 +0000",
        "credits": 6.0,
        "measurement": "credit",
        "updated_at": "2024/01/26 16:13:56 +0000",
        "short_description": "teaser_12",
        "listing_path": "program-path-12",
        "listing_image": null,
        "currency": "USD",
        "catalog": {
          "id": 23,
          "name": "Domain Account 23"
        },
        "type": "Program",
        "title": "Program 12",
        "list_order": null,
        "waitlist": false,
        "waitlist_cap": null,
        "sku": null,
        "show_free_banner": true,
        "image_alt_text": null,
        "allowed_payment_types": [
          "standard"
        ],
        "tag_names": [

        ],
        "listing_url": "http://www.my-catalog.edu/programs/program-path-12",
        "start_date": "2024/01/19 16:13:56 +0000",
        "end_date": null,
        "canvas_section_id": null,
        "associated_account_ids": [

        ],
        "sequential": true,
        "requirements": [
          {
            "id": 14,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_14",
            "enrollment_fee": "0.0",
            "created_at": "2024/01/26 16:13:56 +0000",
            "credits": 3.0,
            "measurement": "credit",
            "updated_at": "2024/01/26 16:13:56 +0000",
            "short_description": "teaser_14",
            "listing_path": "course-path-14",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 23,
              "name": "Domain Account 23"
            },
            "type": "Course",
            "title": "Course 14",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_7",
            "show_free_banner": true,
            "image_alt_text": null,
            "allowed_payment_types": [
              "standard"
            ],
            "tag_names": [

            ],
            "listing_url": "http://www.my-catalog.edu/courses/course-path-14",
            "start_date": "2024/01/19 16:13:56 +0000",
            "end_date": "2024/02/02 16:13:56 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [

            ],
            "canvas_course": {
              "id": 7
            }
          },
          {
            "id": 15,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_15",
            "enrollment_fee": "0.0",
            "created_at": "2024/01/26 16:13:56 +0000",
            "credits": 3.0,
            "measurement": "credit",
            "updated_at": "2024/01/26 16:13:56 +0000",
            "short_description": "teaser_15",
            "listing_path": "course-path-15",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 23,
              "name": "Domain Account 23"
            },
            "type": "Course",
            "title": "Course 15",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_8",
            "show_free_banner": true,
            "image_alt_text": null,
            "allowed_payment_types": [
              "standard"
            ],
            "tag_names": [

            ],
            "listing_url": "http://www.my-catalog.edu/courses/course-path-15",
            "start_date": "2024/01/19 16:13:56 +0000",
            "end_date": "2024/02/02 16:13:56 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [

            ],
            "canvas_course": {
              "id": 8
            }
          }
        ]
      }
    ]
  }
}

Listing programs

Ekstremite

GET https://www.my-catalog.edu/api/v1/programs

Mande

Wout

GET https://www.my-catalog.edu/api/v1/programs

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 3
Content-Type: application/json; charset=utf-8
X-CSRF-Token: /V3nmV0OoII5TAab/4NZ6KxuhnSAuQrAokmqhxlnUVECsqVxxLRHQB6ur1CGK9pFx+BjVosiNgG0TdsOJIOCxg==
ETag: W/"b64e016421126e7366be4d0d7eeaf4aa"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=ajdrMXN4VTVuRFovK3RxOHBhazBqZTlhTDhuMUFhZ0ZRN1lDZzNrdGxIYzZLNHhmd1FQbitxc3p2VFBLRy9QVG9STy9PM1VsZ0cxMjBQWEZ1SXR6TmwxOHlTTzVJSlpRSW5JcXFlb2hodURSQStQZTNrWmc5RExzK2Z4V2JzREg5TWhEa1loeFlraStjUzJOdXVjRnJ6OVM4M2FObW1WbXhwZ0NpYWV6dnM3ZEhmSnYrNm5sREEzYUQ1NVozTUh1LS1VUHROWXFDeVpOZzUybm1Ud1YrN1NnPT0%3D--ca930f426611c269b8422b397215afaeb5f68b6a; path=/; HttpOnly
X-Request-Id: a70c500d-e78f-41a7-988d-06aa7c5c68ef
X-Runtime: 0.635411
Content-Length: 9659

Kò

{
  "programs": [
    {
      "id": 23,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_22",
      "enrollment_fee": "0.0",
      "created_at": "2024/01/26 16:13:59 +0000",
      "credits": 9.0,
      "measurement": "credit",
      "updated_at": "2024/01/26 16:13:59 +0000",
      "short_description": "teaser_22",
      "listing_path": "program-path-22",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 26,
        "name": "Domain Account 26"
      },
      "type": "Program",
      "title": "Program 22",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": null,
      "show_free_banner": true,
      "image_alt_text": null,
      "allowed_payment_types": [
        "standard"
      ],
      "tag_names": [
        "Another Tag",
        "Tag"
      ],
      "listing_url": "http://www.my-catalog.edu/programs/program-path-22",
      "start_date": "2024/01/19 16:13:59 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [

      ],
      "sequential": true,
      "requirements": [
        {
          "id": 24,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_23",
          "enrollment_fee": "0.0",
          "created_at": "2024/01/26 16:13:59 +0000",
          "credits": 3.0,
          "measurement": "credit",
          "updated_at": "2024/01/26 16:13:59 +0000",
          "short_description": "teaser_23",
          "listing_path": "program-path-23",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 26,
            "name": "Domain Account 26"
          },
          "type": "Program",
          "title": "Program 23",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": null,
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [

          ],
          "listing_url": "http://www.my-catalog.edu/programs/program-path-23",
          "start_date": "2024/01/19 16:13:59 +0000",
          "end_date": null,
          "canvas_section_id": null,
          "associated_account_ids": [

          ],
          "sequential": true,
          "requirements": [
            {
              "id": 26,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_25",
              "enrollment_fee": "0.0",
              "created_at": "2024/01/26 16:13:59 +0000",
              "credits": 3.0,
              "measurement": "credit",
              "updated_at": "2024/01/26 16:13:59 +0000",
              "short_description": "teaser_25",
              "listing_path": "course-path-25",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 26,
                "name": "Domain Account 26"
              },
              "type": "Course",
              "title": "Course 25",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_12",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [

              ],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-25",
              "start_date": "2024/01/19 16:13:59 +0000",
              "end_date": "2024/02/02 16:13:59 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [

              ],
              "canvas_course": {
                "id": 12
              }
            }
          ]
        },
        {
          "id": 25,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_24",
          "enrollment_fee": "0.0",
          "created_at": "2024/01/26 16:13:59 +0000",
          "credits": 6.0,
          "measurement": "credit",
          "updated_at": "2024/01/26 16:13:59 +0000",
          "short_description": "teaser_24",
          "listing_path": "program-path-24",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 26,
            "name": "Domain Account 26"
          },
          "type": "Program",
          "title": "Program 24",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": null,
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [

          ],
          "listing_url": "http://www.my-catalog.edu/programs/program-path-24",
          "start_date": "2024/01/19 16:13:59 +0000",
          "end_date": null,
          "canvas_section_id": null,
          "associated_account_ids": [

          ],
          "sequential": true,
          "requirements": [
            {
              "id": 27,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_26",
              "enrollment_fee": "0.0",
              "created_at": "2024/01/26 16:13:59 +0000",
              "credits": 3.0,
              "measurement": "credit",
              "updated_at": "2024/01/26 16:13:59 +0000",
              "short_description": "teaser_26",
              "listing_path": "course-path-26",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 26,
                "name": "Domain Account 26"
              },
              "type": "Course",
              "title": "Course 26",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_13",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [

              ],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-26",
              "start_date": "2024/01/19 16:13:59 +0000",
              "end_date": "2024/02/02 16:13:59 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [

              ],
              "canvas_course": {
                "id": 13
              }
            },
            {
              "id": 28,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_27",
              "enrollment_fee": "0.0",
              "created_at": "2024/01/26 16:13:59 +0000",
              "credits": 3.0,
              "measurement": "credit",
              "updated_at": "2024/01/26 16:13:59 +0000",
              "short_description": "teaser_27",
              "listing_path": "course-path-27",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 26,
                "name": "Domain Account 26"
              },
              "type": "Course",
              "title": "Course 27",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_14",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [

              ],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-27",
              "start_date": "2024/01/19 16:13:59 +0000",
              "end_date": "2024/02/02 16:13:59 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [

              ],
              "canvas_course": {
                "id": 14
              }
            }
          ]
        }
      ]
    },
    {
      "id": 24,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_23",
      "enrollment_fee": "0.0",
      "created_at": "2024/01/26 16:13:59 +0000",
      "credits": 3.0,
      "measurement": "credit",
      "updated_at": "2024/01/26 16:13:59 +0000",
      "short_description": "teaser_23",
      "listing_path": "program-path-23",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 26,
        "name": "Domain Account 26"
      },
      "type": "Program",
      "title": "Program 23",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": null,
      "show_free_banner": true,
      "image_alt_text": null,
      "allowed_payment_types": [
        "standard"
      ],
      "tag_names": [

      ],
      "listing_url": "http://www.my-catalog.edu/programs/program-path-23",
      "start_date": "2024/01/19 16:13:59 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [

      ],
      "sequential": true,
      "requirements": [
        {
          "id": 26,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_25",
          "enrollment_fee": "0.0",
          "created_at": "2024/01/26 16:13:59 +0000",
          "credits": 3.0,
          "measurement": "credit",
          "updated_at": "2024/01/26 16:13:59 +0000",
          "short_description": "teaser_25",
          "listing_path": "course-path-25",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 26,
            "name": "Domain Account 26"
          },
          "type": "Course",
          "title": "Course 25",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_12",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [

          ],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-25",
          "start_date": "2024/01/19 16:13:59 +0000",
          "end_date": "2024/02/02 16:13:59 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [

          ],
          "canvas_course": {
            "id": 12
          }
        }
      ]
    },
    {
      "id": 25,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_24",
      "enrollment_fee": "0.0",
      "created_at": "2024/01/26 16:13:59 +0000",
      "credits": 6.0,
      "measurement": "credit",
      "updated_at": "2024/01/26 16:13:59 +0000",
      "short_description": "teaser_24",
      "listing_path": "program-path-24",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 26,
        "name": "Domain Account 26"
      },
      "type": "Program",
      "title": "Program 24",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": null,
      "show_free_banner": true,
      "image_alt_text": null,
      "allowed_payment_types": [
        "standard"
      ],
      "tag_names": [

      ],
      "listing_url": "http://www.my-catalog.edu/programs/program-path-24",
      "start_date": "2024/01/19 16:13:59 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [

      ],
      "sequential": true,
      "requirements": [
        {
          "id": 27,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_26",
          "enrollment_fee": "0.0",
          "created_at": "2024/01/26 16:13:59 +0000",
          "credits": 3.0,
          "measurement": "credit",
          "updated_at": "2024/01/26 16:13:59 +0000",
          "short_description": "teaser_26",
          "listing_path": "course-path-26",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 26,
            "name": "Domain Account 26"
          },
          "type": "Course",
          "title": "Course 26",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_13",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [

          ],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-26",
          "start_date": "2024/01/19 16:13:59 +0000",
          "end_date": "2024/02/02 16:13:59 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [

          ],
          "canvas_course": {
            "id": 13
          }
        },
        {
          "id": 28,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_27",
          "enrollment_fee": "0.0",
          "created_at": "2024/01/26 16:13:59 +0000",
          "credits": 3.0,
          "measurement": "credit",
          "updated_at": "2024/01/26 16:13:59 +0000",
          "short_description": "teaser_27",
          "listing_path": "course-path-27",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 26,
            "name": "Domain Account 26"
          },
          "type": "Course",
          "title": "Course 27",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_14",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [

          ],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-27",
          "start_date": "2024/01/19 16:13:59 +0000",
          "end_date": "2024/02/02 16:13:59 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [

          ],
          "canvas_course": {
            "id": 14
          }
        }
      ]
    }
  ]
}

Updating a program

Ekstremite

PUT https://www.my-catalog.edu/api/v1/programs/:id

Paramèt

Name Description Type
program[title] Listing title String
program[description] Full listing description String
program[path] Path to the listing. Used in URLs String
program[teaser] A shorter description of the listing String
program[enrollment_open] Indicates if the listing is current accepting new students Boolean
program[enrollment_open_from] If specified, enrollment is open only from this date-time Datetime
program[enrollment_open_to] If specified, enrollment is open only to this date-time Datetime
program[visibility] Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
program[enrollment_cap] A limit for the total number of enrollments Integer
program[enrollment_fee] Enrollment fee Decimal
program[allowed_payment_types] Allowed payment methods Array
program[days_to_complete] The number of days a student has to complete the requirements Integer
program[account_id] The id of the account to associate the listing to. Can be an id of any subcatalog of the catalog making the API request. Defaults to the catalog making the API request. Integer
program[list_order] Order in which the listing is shown in the catalog Integer
program[waitlist] Waitlist enabled (defaults to false) Boolean
program[waitlist_cap] Wait List Limit for the total number of wait listed enrollments Integer
program[listing_image] URL or file upload for the image to be shown with this listing. String
program[tag_names] List of tags applied to this listing Array
program[show_free_banner] Show the 'FREE' mark on the card of the listing if free Boolean
program[associated_account_ids] Other account ids where this product should be listed Array
program[requirement_ids] Ordered array of listing IDs that represent requirements for completing the program Array
program[sequential] Indicates if students are required to complete requirements in order Boolean

Mande

Wout

PUT https://www.my-catalog.edu/api/v1/programs/29

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "program": {
    "title": "Program 1",
    "description": "This is a very awesome program.",
    "path": "program-1",
    "teaser": "This is an example teaser",
    "enrollment_open": true,
    "visibility": "listed",
    "enrollment_cap": 150,
    "waitlist": true,
    "waitlist_cap": 12,
    "enrollment_fee": 49.99,
    "days_to_complete": 45,
    "list_order": 123,
    "requirement_ids": [

    ],
    "sequential": true,
    "tag_names": [
      "Tag",
      "Another Tag"
    ]
  }
}

Repons

Estati

204

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
X-CSRF-Token: qHARog+07U4oZduwVpskH6pHkxSFWg+z0OpeLqFyYVWTyAZ7RpLEcen12aR/uT3SEF7dOUzMev069fAYc1BlvA==
Cache-Control: no-cache
Set-Cookie: _gallery_session=NDk3ejltSG9VRFhGSFk5bEtPbUdvZ2wrZ2VadVpLZzR5dHdlVlJrZ0JIcjZEbEM0dzhaSTk4RVZvSHlwVzJpbEYvV0x3YWNTV01UWDdUWVFQZFNsWGJ6S0tpZHpuQWpSMGZyVHE5c3hKcEtGcjQzUFM5OUlCK3I4Ly9Lclp2Tk5Kc3JRU2lPK21GVUcwNlhzS2VBdWFJUitROHB3SUFSVitnbjk2VkI2ZE5iWGdLQ3d0bUVBUGJTTmwxanY0SE9OLS1YQzI4b1ZOUk5SZzRNRjU2cWlhMWVBPT0%3D--f234488833cb5d87c23fdca7edc38a1a5f6915c4; path=/; HttpOnly
X-Request-Id: f753c506-2af4-4983-828d-6ea55e921da2
X-Runtime: 0.560337

Progresses

Getting a specific progress

Ekstremite

GET https://www.my-catalog.edu/api/v1/progresses/:id

Mande

Wout

GET https://www.my-catalog.edu/api/v1/progresses/1

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Progress ID Integer
account_id Catalog Account ID Integer
canvas_user_id The Canvas User ID of the user who initiated the job Integer
completion_percent The completion percent of the job Integer
workflow_state The status of the progress String
payload Any data or errors returned by the job Array
created_at The creation date for the progress job Datetime
updated_at The last time the progress job was updated Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: plRH81O2N0MMLHwhnQfudUxBrlUgne/VXs87zOZYCl8QLD5cg48j/lQiseRy00j7sOYFyTAKwhyIgxaRuzud1w==
ETag: W/"4b67098ce150289c8f893adc6525942b"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=cHRWSlFyQWQrdVo4SUJTWTZRRUlKVG03UFFRZjRNb1ZNNkU5cUJBNnlGdjF0WGw5SDNOZWFWbjY2aDR5YW54Q1BZcE5GSVBnN1doSTMvQWlkd2xoNTF2M3Y1QVUrVUNjYUNUNk1aWVdtUFZNV2RQb0dLUzZDdHRDcEVUNnBUaTQwMmJPaEFjWk9oUlRXcFFCMFREQ2IyYlVtbytQUDZBZzFVQm9iZ3dYaDhEK3lEUUNpYllwd2JZVG4zZzNOUy9GLS11TUtnWVNlSFhQd2VsM3lSdXQ3Rk1RPT0%3D--ddbe0dcf0eba4716bdedb409ed149fe0b5ec1fa9; path=/; HttpOnly
X-Request-Id: f2382441-8b78-46f7-b7c9-ab11dba47dae
X-Runtime: 0.450456
Content-Length: 205

Kò

{
  "progress": {
    "id": 1,
    "account_id": 7,
    "canvas_user_id": null,
    "completion_percent": null,
    "workflow_state": "queued",
    "payload": {
    },
    "created_at": "2024/01/26 16:13:46 +0000",
    "updated_at": "2024/01/26 16:13:46 +0000"
  }
}

Tags

The request parameters should be sent as JSON in the request body.

Creating a Tag

Ekstremite

POST https://www.my-catalog.edu/api/v1/tags

Paramèt

Name Description Type
name obligatwa Tag name (minimum 1 and maximum 255 characters) String
product_ids List of product ids associate to this tag Array

Mande

Wout

POST https://www.my-catalog.edu/api/v1/tags

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "name": "Tag 1",
  "product_ids": [
    1,
    2,
    3
  ]
}

Repons

Branch Repons

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Products associate to this tag Array
assigned_listings[id] Product id Integer
assigned_listings[title] Product title String
assigned_listings[type] Product type (COURSE or PROGRAM) String
assigned_listings[canvas_course_id] Product Canvas course id Integer
assigned_categories Returns empty list to indicate there are no associated categories to the newly created tag Array

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: TQ082z/bbqrV+lrSa2iVcMmoF+u//KjDABMMd5xxBxfYUJ11ds08EMpwkhzjUHtiq2Hk7FQ3ylMubluSdwluYw==
ETag: W/"729f420efa5ba7de47b211df4fb90865"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=QmhPQWNTMnN3aHFnMlcvek9Meis1Ymg4Q21rNDJCbVhVMmZ4eWhwenc0NWl5VTFsa0dRMUxlZ1pwaXZod3ZhRlUrc0dqVERIMXEyRFJYRHRUNDlQMDNPTFFRVll5V1E5bVViQ2NXNm9PSmhvN2FYRW16Tm5zcWluRk8yYkJQTTdwRG16WDY1S1BuSWVzNlViQjFDN1M5RlN2ZGlDY0tJdVBiQ1BuZGxuajRmNUxQR2tPQkJOOXJmMjU1eVVmOVlkLS1CM24yQnFwUjM5N05Rd3JtR0wxOHF3PT0%3D--b285303dcb1acb99c93547e2f6ef870f015d9894; path=/; HttpOnly
X-Request-Id: e9d28b53-f1b3-47a9-8ea9-52c5e05ce8da
X-Runtime: 0.415006
Content-Length: 347

Kò

{
  "id": 9,
  "account_id": 1,
  "name": "Tag 1",
  "assigned_listings": [
    {
      "id": 1,
      "title": "Course 1",
      "type": "COURSE",
      "canvas_course_id": 2
    },
    {
      "id": 2,
      "title": "Course 2",
      "type": "COURSE",
      "canvas_course_id": 3
    },
    {
      "id": 3,
      "title": "Program 1",
      "type": "PROGRAM"
    }
  ],
  "assigned_categories": [

  ],
  "created_at": "2023-08-07T09:45:45.535989Z",
  "updated_at": "2023-08-07T09:45:45.535989Z"
}

Deleting a specific Tag

Ekstremite

DELETE https://www.my-catalog.edu/api/v1/tags/:id

Mande

Wout

DELETE https://www.my-catalog.edu/api/v1/tags/9

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Returns empty list to indicate associated products to this tag are deleted Array
assigned_categories Returns empty list to indicate associated categories to this tag are deleted Array
is_deleted Returns true to indicate tag is deleted Boolean

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: 5vaAOeDfNkkXlW2Jz2aOoDQrmJ+nirg59vN3T3a9RnP4fvtTlvqYfswIhiyxgoNBQ4FGGXRbFCv1PK3beM1wWA==
ETag: W/"bb8f9a8b9204f479c86628e6aa1f79a4"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=SFlrZWE5b09nSHFUR2RXSzBoaFl1ekdQM2puUXF2RHBJa3VjaUdoQXdIMXdtVDgwOUdyTTQremxlbVhkb0pxODVCdllhV3FLVzRFdEpSOXBJRWV3V2U3YkV1SW9nSFZ1c1RrTGVJb0x3UzJNR1p0dHBScmw4d3VXN1lINS9vcWRXQ25KYTdSaFZ5QS8rOEYyRDBocmFvbCs5V1ZNSGdWODl1MDVNbmNtZ1UrcWFPcHcxcmNNeHRYc05qTHVFUzRILS1CNllvWkJRNEVhRytNS082enNyMHRnPT0%3D--4e16c0a13b5d04169cdfeeeebade71a55e0bbc85; path=/; HttpOnly
X-Request-Id: 6e20082c-e140-432e-82c2-9387a1c70387
X-Runtime: 0.205084
Content-Length: 190

Kò

{
  "id": 9,
  "account_id": 1,
  "name": "Tag 1",
  "assigned_listings": [

  ],
  "assigned_categories": [

  ],
  "created_at": "2023-08-07T09:45:45.535989Z",
  "updated_at": "2023-08-07T09:45:45.535989Z",
  "is_deleted": true
}

Getting a specific Tag

Ekstremite

GET https://www.my-catalog.edu/api/v1/tags/:id

Mande

Wout

GET https://www.my-catalog.edu/api/v1/tags/9

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Products associate to this tag Array
assigned_listings[id] Product id Integer
assigned_listings[title] Product title String
assigned_listings[type] Product type (COURSE or PROGRAM) String
assigned_listings[canvas_course_id] Product Canvas course id Integer
assigned_categories Categories associate to this tag Array
assigned_categories[id] Category id Integer
assigned_categories[account_id] Account id Integer
assigned_categories[tag_id] Tag id Integer
assigned_categories[created_at] Category created at Datetime
assigned_categories[updated_at] Category updated at Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: mbXeDr/4+dZPzdloAoo/DH5mwWM3RrzCSob1+IGRYG+PRMcrc/ejAOU7aARrN9Q4Q6rBVVk+M1U4bf0vcD4rqw==
ETag: W/"caf9af9a544b5cd6aa0d9c47f1fff7e6"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=NXdNMWpHS00wSTUwYjVtMUFsNlpYVVZKWk1sdmFZYUhYMndiajJPVUhGWEdSVTh1azZJSTgxdStYMkd2M0ZmWWZVNUpBM2ZqNlZvL1dqS2tqbmI4cDduakRIcTZJZHQ3Y3dZa1JDeUd4RHZ5RVBTdDZIMk56L3UvMWlXdmFaUnhiK2RyanpHcThDT2xsaU04ZjZhcVM2MHJ4VmxDR2NWeGJ6QlZBMlNkSlZ0bk4xOW1rVUZ1Sm5YSWVBNXdGM28zLS0xdDJzZjZ4VzFHemk4bVh0RzI2QVpRPT0%3D--02e24ceb69f522a7a2d4ee7f79943383865de82e; path=/; HttpOnly
X-Request-Id: d97d7fc4-c9ec-4102-93d9-bf6b2cdb0b6b
X-Runtime: 0.313303
Content-Length: 357

Kò

{
  "id": 9,
  "account_id": 1,
  "name": "Tag 1",
  "assigned_listings": [
    {
      "id": 3,
      "title": "Course 1",
      "type": "COURSE",
      "canvas_course_id": 4
    }
  ],
  "assigned_categories": [
    {
      "id": 12,
      "account_id": 5,
      "tag_id": 9,
      "created_at": "2023-08-22T06:33:38.991906Z",
      "updated_at": "2023-08-24T06:33:38.991906Z"
    }
  ],
  "created_at": "2023-08-07T09:45:45.535989Z",
  "updated_at": "2023-08-07T09:45:45.535989Z"
}

Listing Tags

Ekstremite

GET https://www.my-catalog.edu/api/v1/tags

Paramèt

Name Description Type
product_ids List of product ids (maximum 20 ids) Array
name Search value which will be searched in tag name and associated products names String
has_category Tag has category or not Boolean
updated_at_from Updated at from Datetime
updated_at_to Updated at to Datetime
created_at_from Created at from Datetime
created_at_to Created at to Datetime

Mande

Wout

GET https://www.my-catalog.edu/api/v1/tags?product_ids=1%2C2%2C3&name=tag+1&has_category=true&updated_at_from=2023-08-06T14%3A46%3A59.944581%2B02%3A00&updated_at_to=2023-08-10T14%3A46%3A59.944581-05%3A00&created_at_from=2023-08-05T14%3A46%3A59.944581%2B02%3A00&created_at_to=2023-08-09T14%3A46%3A59.944581-05%3A00

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Paramèt Rekèt

product_ids=1,2,3
name=tag 1
has_category=true
updated_at_from=2023-08-06T14:46:59.944581+02:00
updated_at_to=2023-08-10T14:46:59.944581-05:00
created_at_from=2023-08-05T14:46:59.944581+02:00
created_at_to=2023-08-09T14:46:59.944581-05:00

Repons

Branch Repons

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Products associate to this tag Array
assigned_listings[id] Product id Integer
assigned_listings[title] Product title String
assigned_listings[type] Product type (COURSE or PROGRAM) String
assigned_listings[canvas_course_id] Product Canvas course id Integer
assigned_categories Categories associate to this tag Array
assigned_categories[id] Category id Integer
assigned_categories[account_id] Account id Integer
assigned_categories[tag_id] Tag id Integer
assigned_categories[created_at] Category created at Datetime
assigned_categories[updated_at] Category updated at Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: Ukzlk+6X3RXy/Q49d26DLVRw4DlN9pgFo8tE8aUVmlOEetHhcJYEiCzJ6Rf2lf286QNHVmwIKidPr4DTgK60Tw==
ETag: W/"05187bc38a68958fdb9df1ee2b495c0a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=ZnpITDQwTjRzaFZPUVoyaVg4SjE5OFpYWnFDbkJPTnpSN09iVkhHRlcyK1FFT1lQaW9uZnBRd0FRRERZbGJ0dHVqT2VTdGY5NlBqKzA2L0RoOEdCRmFiOThZMzl3V3BJQTM5WWQwWVJzWG1xbjMwUEVTVk9VOEt1OFVwV2RGTXBrcno2cURYQ2ZnUTNadUdqM2IrWHlDU1ZZY0xWek5YdUIxM0plMVpRdU5WSDZDNXZJRFBKMXBNenl3Si9qSUtxLS1oTllTUklrZ1pmSFV0OUowazZSUXNnPT0%3D--6674a23031e43a1d47ae5dfda36e6fc50ae2877f; path=/; HttpOnly
X-Request-Id: 446a34ea-cf2e-44be-922b-921e3a4839ae
X-Runtime: 0.272717
Content-Length: 368

Kò

{
  "tags": [
    {
      "id": 9,
      "account_id": 1,
      "name": "Tag 1",
      "assigned_listings": [
        {
          "id": 3,
          "title": "Course 1",
          "type": "COURSE",
          "canvas_course_id": 4
        }
      ],
      "assigned_categories": [
        {
          "id": 12,
          "account_id": 5,
          "tag_id": 9,
          "created_at": "2023-08-22T06:33:38.991906Z",
          "updated_at": "2023-08-24T06:33:38.991906Z"
        }
      ],
      "created_at": "2023-08-07T09:45:45.535989Z",
      "updated_at": "2023-08-07T09:45:45.535989Z"
    }
  ]
}

Updating a specific Tag

Ekstremite

PUT https://www.my-catalog.edu/api/v1/tags/:id

Paramèt

Name Description Type
name obligatwa New tag name (minimum 1 and maximum 255 characters) String

Mande

Wout

PUT https://www.my-catalog.edu/api/v1/tags/9

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "name": "New tag name"
}

Repons

Branch Repons

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Products associate to this tag Array
assigned_listings[id] Product id Integer
assigned_listings[title] Product title String
assigned_listings[type] Product type (COURSE or PROGRAM) String
assigned_listings[canvas_course_id] Product Canvas course id Integer
assigned_categories Categories associate to this tag Array
assigned_categories[id] Category id Integer
assigned_categories[account_id] Account id Integer
assigned_categories[tag_id] Tag id Integer
assigned_categories[created_at] Category created at Datetime
assigned_categories[updated_at] Category updated at Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: 7oB9ELvuy6fCXxoFRbU6jVF5JvIldRj4CpO1UOTsz6VcAZQ0ytW6/rYcGtBVfEZo3ScGKy80aA+1hvYW2d1Qcg==
ETag: W/"733be57c5f7ab9c54f6d55282af46f1e"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=R1ZoZ2VhQnI4ay92MXNIWTZLV2xQcm5BVXNKVXU2eXFHeE94YUlXeGcrTkNHanV4aHQwVkRVZzB4YlM2cnBTOHZEK010NWh6a1ZyVHRhZ3dWdHpoYlFNTWk2dUQ3NGtYaFNZY0dHeUFTc0ZzZnh0ei9jdGJpVmc2K0I1bVJ6N3BDWlpNQjNXVzlSY1ZHMjBwdVk2YUl3c1RZOCtKalluTmNtSWFuS1VvdFc4OXdFek9XUk0vNEZ4R0J3UjY5cmxELS04QXVBYktCdmtiVFFqVENMTy8wTFZRPT0%3D--6a41af7c548477d774d9d57070b154b68e80fc6e; path=/; HttpOnly
X-Request-Id: 5eb4082e-f62c-4812-a85c-1d027dd7b4cf
X-Runtime: 0.279879
Content-Length: 364

Kò

{
  "id": 9,
  "account_id": 1,
  "name": "New tag name",
  "assigned_listings": [
    {
      "id": 3,
      "title": "Course 1",
      "type": "COURSE",
      "canvas_course_id": 4
    }
  ],
  "assigned_categories": [
    {
      "id": 12,
      "account_id": 5,
      "tag_id": 9,
      "created_at": "2023-08-22T06:33:38.991906Z",
      "updated_at": "2023-08-24T06:33:38.991906Z"
    }
  ],
  "created_at": "2023-08-07T09:45:45.535989Z",
  "updated_at": "2023-08-07T09:45:45.535989Z"
}

User registrations

Getting a specific user registration

Ekstremite

GET https://www.my-catalog.edu/api/v1/user_registrations/:id

Paramèt

Name Description
id Canvas user ID

Mande

Wout

GET https://www.my-catalog.edu/api/v1/user_registrations/1

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
canvas_user_id Canvas user ID Integer
name Full name String
email E-mail address String
custom_fields Custom field values, e.g. { 'phone': '(999) 123-4567' } Object
created_at Date/time registration was recorded Datetime
updated_at Date/time last updated Datetime
catalog[id] Id for the catalog this user registered for Integer
catalog[name] Name for the catalog this user registered for String

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: l0fe+a9gdXJRdMARWpILJ465zV+GUJbda0rbIZjqrH8rxTrDZFCbzvflg0ip/PoamUdjkR+2RXBcQolR0F6Fnw==
ETag: W/"938369e6d16161045cb4dad08ca0b39c"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=ejRNWHAwcm8yWmRCRm9LR0F6V0hHTXdUQzk2Q2lBLzN2S3ljaTZUN1U0SzJMaUlvWEZqanE0NUJmUElldEY1K0ZML2kzd2JnN1dNVVc5QnptQmk5RTVyRER6SkJWSitTMUZpYk9Wbzkzdno2aTBzdGhzZU8vU3V1V3ZuTTYxVnZ4dERONmFVOFNvZTVsd095VkxwK0FtaW1HVldFa3lpTFhjazJ5bjBFVERoZmJQOTVLR3FWRFFHUW1NcVdBeWxhLS1qelVnck8zUlpNb2x2aysycHE1ejNBPT0%3D--611eb195efb40db2e2a0b4e72a339a4a65ee230f; path=/; HttpOnly
X-Request-Id: b4ce5644-f36b-4e9d-866f-810dcd7d5c83
X-Runtime: 0.434244
Content-Length: 293

Kò

{
  "user_registration": {
    "canvas_user_id": 1,
    "catalog": {
      "id": 28,
      "name": "Domain Account 28"
    },
    "name": "User 1",
    "email": "user1@example.com",
    "custom_fields": {
      "favorite_color": "#BADA55",
      "code_of_conduct": "1",
      "age": "19"
    },
    "created_at": "2024/01/26 16:14:01 +0000",
    "updated_at": "2024/01/26 16:14:01 +0000"
  }
}

Listing user registrations

Ekstremite

GET https://www.my-catalog.edu/api/v1/user_registrations

Paramèt

Name Description
from Earliest date/time to return (optional, String). Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
to Latest date/time to return (optional, String). See 'from' above for format.

Mande

Wout

GET https://www.my-catalog.edu/api/v1/user_registrations

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: lawZYeIGeWlQmfvEK69c1HWF/bcOo6EAV7moxmJnX2l+H4yngI6NmbITS6uzMGqg4lDTEQvHkGKgAgl/AvSmSg==
ETag: W/"9070c6f8418d813575b22296d7d9f077"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=ckhKWThjTXJTOW1VZWk1UGhBWGxoK2xEYkJCQVlNcmdJRHdHVFI2akFrdUxoNjhiR0RLbmd1SHVSMTlTZ05zbzJTakFDRmlTY1VOMERiRjhoS3FubTNmWmh0ZytmNjNBZ3ZoTVFTU2RYVWVZaTlQMVdxbmZMTFh4aXZjbGRoVUlPUFRNWVZ0eVJuRjJJQkw0TEpMckxSa3RySTN5RmhyTFdhblIvUkRDeTBlU0pLeGJZVGJEbm5KRXd2eTU2b21yLS1wQVZudzhOWHhkRFVtaXZYRTdPRkRnPT0%3D--e08445effd5d64e346137a9eb858f4c6f719c390; path=/; HttpOnly
X-Request-Id: 98ee67d9-1820-4249-a57d-2d2fdb185d2e
X-Runtime: 0.275950
Content-Length: 296

Kò

{
  "user_registrations": [
    {
      "canvas_user_id": 3,
      "catalog": {
        "id": 30,
        "name": "Domain Account 30"
      },
      "name": "User 3",
      "email": "user3@example.com",
      "custom_fields": {
        "favorite_color": "#BADA55",
        "code_of_conduct": "1",
        "age": "19"
      },
      "created_at": "2024/01/26 16:14:03 +0000",
      "updated_at": "2024/01/26 16:14:03 +0000"
    }
  ]
}

Registering a user

Ekstremite

POST https://www.my-catalog.edu/api/v1/user_registrations

Paramèt

Name Description
name Full name
email E-mail address (will also serve as login)
catalog_id ID of subcatalog to associate with user (optional)
custom_fields Hash of custom field values, e.g. { 'phone': '867-5309' } (optional)

Mande

Wout

POST https://www.my-catalog.edu/api/v1/user_registrations

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu
Cookie:

Kò

{
  "user_registration": {
    "name": "Barack Obama",
    "email": "barack@obama.com",
    "custom_fields": {
      "phone": "(999) 123-4567"
    }
  }
}

Repons

Branch Repons

Name Description Type
canvas_user_id Canvas user ID Integer
name Full name String
email E-mail address String
custom_fields Custom field values, e.g. { 'phone': '(999) 123-4567' } Object
created_at Date/time registration was recorded Datetime
updated_at Date/time last updated Datetime
catalog[id] Id for the catalog this user registered for Integer
catalog[name] Name for the catalog this user registered for String

Estati

201

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: gw3iPaZI8k+s9cLlM1NY8CNwf+rYll5HPOqBGljvJ34Lge/0oTXZZS8KOqizneC6MvJPEeMo6NstFWIOiuOjaA==
ETag: W/"b94fc21b1ff66257d1158466912502d1"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=VlJhRnhWQkJXN212cUR1VFZ4MWJzM29jNmFnWkwzWHg3Rzh1Z2l1YTJwN2wyNmUrSDJwQ3NhTXJhTy9SZVVFT1RhWHROV3ZwVCtYWGVtWkVmQWtXYnBrUzFXZFlZTDdtYXErYTNUaG10WjRwN2JCMFFJTTBWVHlPb0hteW1zeXU5c0dXRkE5cS9GYmJNeWJYMW96OTlIZEl6K2xSd0JhOGhZTFZCSFVZT0ZlazlnMWNkWUNtUjk3QjNIbGwzNWRzLS1uUXQvUFZORTU1UG5EK09XNVpsa0NRPT0%3D--71fee7c39f0059efed9c88f526f2643bdc6bec05; path=/; HttpOnly
X-Request-Id: 14974d1c-9eb8-4cbc-979f-0274abd84a66
X-Runtime: 0.724651
Content-Length: 242

Kò

{
  "user_registration": {
    "canvas_user_id": 1234,
    "catalog": {
      "id": 29,
      "name": "Domain Account 29"
    },
    "name": "Barack Obama",
    "email": "barack@obama.com",
    "custom_fields": {
    },
    "created_at": "2024/01/26 16:14:03 +0000",
    "updated_at": "2024/01/26 16:14:03 +0000"
  }
}

Users

This endpoint will delete requested existing Catalog user if the user is in the root catalog or one of sub-catalog of the root catalog that api key is generated.
When only_orders_and_enrollments parameter is TRUE, it will delete only user dependencies that are orders, enrollments, payments, bulk invitations that he created, and applicants (wait list) for that user.
When only_orders_and_enrollments is FALSE or not specified, it will delete user dependencies including user itself and its related account admins.

Deleting a specific user with dependencies

Ekstremite

DELETE https://www.my-catalog.edu/api/v1/users/:id?only_orders_and_enrollments=:only_orders_and_enrollments

Paramèt

Name Description Type
id obligatwa Catalog user id Integer
only_orders_and_enrollments Delete only orders and enrollments (user dependencies) except user and related account admins OR delete user dependencies including user and related account admins Boolean

Mande

Wout

DELETE https://www.my-catalog.edu/api/v1/users/1?only_orders_and_enrollments=true

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded
Cookie:

Paramèt Rekèt

only_orders_and_enrollments=true

Repons

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
ETag: W/"ecbd8a0c9ccb07f73d936ef4d2299de9"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=OWwvaXJwVTB6UGdRNjh5M3FOanpFR1RXR3ByNFNoeUNwcFBlN0c1eWxxQ2JNUTJYem8yVnkwMFBkcmNZNWFCaHBzUkdYV2FicFIwUzJnb1I1YWRXcnFxcjdaa2M5ZCtSZit1aXVDaWJUTld2UGxES1BnWFM1MTV2ZW4zWjdYcUNha0JteCtBN2RpbHBaR3VVdVhhVlRING9tSlBEa0JHeDA4STBUWWJJbCtBS3FvNWRSV0ZrcEdPQ3B6MDBxL0NGLS1UbmtTWDdodXNvajBSMDJrL3BLc1lnPT0%3D--a2c662028fb4892fa48acf7f7c5d1a497652acdb; path=/; HttpOnly
X-Request-Id: 2698480d-ec0c-449f-af27-ca2aee7224c5
X-Runtime: 0.370386
Content-Length: 29

Kò

{
  "error": null,
  "details": null
}

Waitlist applicants

Delete applicants

Ekstremite

DELETE https://www.my-catalog.edu/api/v1/applicants

Paramèt

Name Description
listing_id obligatwa applicants for the specified listing (Integer)
canvas_user_id delete for the specific canvas user id (optional, Integer)

Mande

Wout

DELETE https://www.my-catalog.edu/api/v1/applicants

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded
Cookie:

Kò

listing_id=6

Repons

Estati

204

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
X-CSRF-Token: jDu3UrNfx4XGp5TA6Y2qlxeI7J+8gvZx33K8cY9i8vaFOyQ1BOzjne0cOM2clvpMy2uW20mbuBeTQmFTtTXYQQ==
Cache-Control: no-cache
Set-Cookie: _gallery_session=WWFyR3hORllURk1vTWpkbEpvVUJVVHBERXd2RVNLaVpaeDA1QUdKM2tuWTRLM0dIRlJTdFBkSjcxV2FCQVNvSUZtZG9EbFg0bk15bCtBUGIyZ0VkMjhCUHZ1MW9GYmZYQ3Nyd1ZhRGs4MUFpUjFxeEFMaTJPeHp0SUlwRmxPNFBmSmdqWFlSSmE3ZFl3RVBUdWluWVlZQmJaUVV2UUJUY09pdWZIdDZMSEJFM3cxaTBDalhCTlA0dTBxUjdCUTczLS1xK2Z3MU1USGgxWVFDc3F6MStvMURRPT0%3D--84753efbf695e95e95171285b8c4aa4c74ebefc1; path=/; HttpOnly
X-Request-Id: 5706a94d-c17f-4f71-8d10-8daebc8aecaa
X-Runtime: 0.214642

Getting a specific applicant record

Ekstremite

GET https://www.my-catalog.edu/api/v1/applicants/:id

Mande

Wout

GET https://www.my-catalog.edu/api/v1/applicants/1

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Branch Repons

Name Description Type
id Identifier for this applicant Integer
listing[id] Identifier for listing Integer
listing[title] Listing title String
user[id] User ID Integer
user[name] Full name String
user[email] E-mail address String
status Status (waitlist, accepted, expired, or error) String
notified_of_opening_at Time user was notified of opening Datetime
created_at The creation date for the applicant Datetime
updated_at The last time the applicant was updated Datetime

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/json; charset=utf-8
X-CSRF-Token: ao+tg3b0egUf2hDDGHXa5Nw9p2Rz5kqj7rSXkeqFM+pmTX+ZmRkDA5iVAp3sags59ulfv5YzCZaFBKC0SEYW+w==
ETag: W/"b95355330af657d38f5ec6b1434b5f55"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=aTl4T3MyNkEwRWxOU3RCUVRPaUJIcml6dWxnNk1PNGpQVWh2Tzg4dmxPUTJmZE11d0hoUVpnOXZ4QlN4a3kwNXN0VDVBOFoza3ZFKzV5MWlaMkFpaUVxM2tLMGc3aW8yZFNRcFdGSStqczROaVJpNGpzWXgrK3pnVjNpZjVPdHlvSFdYTXFqckdLRlc4TzZlWnVOK0xkcmNQenpmQWU2QWdrR0d0bU9sTHgwdlRVOWNtUGdyVlUvL25hU1U4WmRpLS1BR1paOVpnRkh3RFZjcWp1THRwMFlBPT0%3D--90cea6798fc505def9185cbe2cb2416766e34a1c; path=/; HttpOnly
X-Request-Id: 9af337b9-449d-41fb-bad4-fed24915044d
X-Runtime: 0.219858
Content-Length: 253

Kò

{
  "applicant": {
    "id": 1,
    "user": {
      "id": 1,
      "name": "Applicant",
      "email": "plz@letmein.com"
    },
    "listing": {
      "id": 5,
      "title": "Course 5"
    },
    "notified_of_opening_at": null,
    "status": "waitlist",
    "created_at": "2024/01/26 16:13:53 +0000",
    "updated_at": "2024/01/26 16:13:53 +0000"
  }
}

Listing applicants

Ekstremite

GET https://www.my-catalog.edu/api/v1/applicants

Paramèt

Name Description
listing_id Only include applicants for the specified listing (optional, Integer)
status Only include applicants for the specified status (optional, String)

Mande

Wout

GET https://www.my-catalog.edu/api/v1/applicants

Antèt

Version: HTTP/1.0
Authorization: Token token="my-token"
Host: www.my-catalog.edu
Cookie:

Repons

Estati

200

Antèt

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Per-Page: 20
Total: 1
Content-Type: application/json; charset=utf-8
X-CSRF-Token: 82uzjHZcS+Um/i3Lzod0FgV7YwZUX2DVgAbyMLsfZOZNCc43siA7xxTaxpXOgpNtPYPLGxX6OCD+/97EqbMaEg==
ETag: W/"c882bbf88a6e81882969b28a45f1911a"
Cache-Control: max-age=0, private, must-revalidate
Set-Cookie: _gallery_session=eGszNEN2YitpcWVTYlhENENxWU81N21XUjBRZURMRHdVOGNYbDRmcldtbmxzUkwxdTh4ZTNEVmtQKzdhdnZWcGg5S2N2VHRSb2ZqM2VOdHNHMTkvTkViZ0FLZ1hydFE1eSsvVkVTTUU4dWp2aUxyOUJSVis1Q245aWttSXFqeGxNemhpZ20vUndXM1hnMHFYa0lMZGRaVlRzL2wwN0FDeDY1NitSVHpVZFM5Y1lHWGNkR3BkOWNYUElXeFYrUXBtLS1COU9ZOFNhd3ZXeXgzeWJpSW9sai9nPT0%3D--50569e4f0bd72fa3393e6162b8e9cb2f1924c1a9; path=/; HttpOnly
X-Request-Id: d17dda49-5336-4bb7-8335-d4c313f522c7
X-Runtime: 0.195956
Content-Length: 256

Kò

{
  "applicants": [
    {
      "id": 3,
      "user": {
        "id": 3,
        "name": "Applicant",
        "email": "plz@letmein.com"
      },
      "listing": {
        "id": 7,
        "title": "Course 7"
      },
      "notified_of_opening_at": null,
      "status": "waitlist",
      "created_at": "2024/01/26 16:13:54 +0000",
      "updated_at": "2024/01/26 16:13:54 +0000"
    }
  ]
}