Developers
Products19

List access schedules

GET/products/{product_id}/access-schedules

Lists the access schedules of a product. Results are paginated with a cursor.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string

Public ID of the product, prefixed with prd_.

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
tag_id?string

Only access schedules that apply to the tag with this public ID.

deleted?boolean

When true, returns only items in the trash. Items in the trash are excluded by default.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/access-schedules"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "default": true,      "deleted": true,      "deliveries": [        {          "id": "string"        }      ],      "deliveries_count": 0,      "id": "string",      "name": "string",      "object": "access_schedule",      "product_id": "string",      "revision": "string",      "rules_count": 0,      "tag_id": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Delete a product DELETE

Moves the product to the trash, together with its modules, its lessons, and its copies in replicated accounts. The product is no longer available to users in the student area until it is restored with the update operation by setting `deleted` to `false`. Users' access and reports related to the product are preserved. Restoring the product does not restore its copies in replicated accounts. Replicated products are read-only and cannot be deleted; these requests return the `replica_readonly` error code.

Create an access schedule POST

Creates an access schedule for the product, identified by the supplied tag. Each tag and product pair has at most one access schedule. If one already exists for the pair, the existing schedule is returned with `200 OK` and no new schedule is created. Access schedules cannot be created for replicated products; these requests return the `replica_readonly` error code.