Courses API (v1)

Retrieve courses associated with the keyword query from folio mod-courses

Retrieve courses associated with the keyword query

query Parameters
object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Responses

Response samples

Content type
application/json
"string"

Retrieve reserves associated with the keyword query from folio mod-courses

Retrieve reserves associated with the keyword query

query Parameters
object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Responses

Response samples

Content type
application/json
"string"

Retrieve course departments

Retrieve course departments

query Parameters
object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Responses

Response samples

Content type
application/json
"string"

Retrieve course instructors

Retrieve course instructors

query Parameters
object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

sortBy
string^(name|id)\/sort\.(ascending|descending)$
Example: sortBy=sortBy=name/sort.descending

Param to sort collection results by a specific field

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Responses

Response samples

Content type
application/json
{
  • "instructors": [
    ],
  • "totalRecords": 0
}

Retrieve reserves associated with the course instance id from folio mod-courses

Retrieve reserves associated with course instance id

path Parameters
instanceId
required
string

Course Instance's UUID

query Parameters
object (RequestQueryParameters)

Request query parameters(query, limit, offset and etc.) as object.

header Parameters
x-okapi-tenant
string

x-okapi-tenant header value

x-okapi-token
string

x-okapi-token header value

Responses

Response samples

Content type
application/json
"string"