Course Object
The Course Object contains fixed-length and variable-length fields from course records, as well as data for the items on reserve (from the bibliographic or item record).
Click the links below to view the Course Object properties and an example.
Course Object Properties
id
string
(Always returned in the response.)
The record ID.
Example:
"id": "1000005"
beginDate
string (optional)
The start date and time of the course, in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZZ).
Example:
"beginDate": "2020-08-01T07:00:00Z"
endDate
string (optional)
The end date and time of the course, in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZZ).
Example:
"endDate": "2020-12-23T07:00:00Z"
locationCode
string (optional)
The code from the course record for the physical location of the items placed on reserve.
Example:
"locationCode": "av"
ccode1
string (optional)
Library-defined course code. Commonly used as statistical category fields or to suppress inactive course records.
Example:
"ccode1": "a"
ccode2
string (optional)
Library-defined course code. Commonly used as statistical category fields or to suppress inactive course records.
Example:
"ccode2": "t"
ccode3
string (optional)
Library-defined course code. Commonly used as statistical category fields or to suppress inactive course records.
Example:
"ccode3": "6"
professorInstructors
array
The name of the course instructor, last name first. A course can have multiple instructors. The example below shows a course with two instructors.
Example:
"professorInstructors": [
"Herman, Dr. Jane",
"Smith, Mark"
]
courseNames
array
The name of the course. A course can have multiple names. The example below shows a course with two names.
Example:
"courseNames": [
"LIBR 210",
"LIBRARY SCIENCE 210"
]
courseUrls
array
The URL associated with the course record.
Example:
"courseUrls": [https://www.library.edu/prof_page.html]
courseNotes
array
Free text note field. A course can contain multiple note fields.
Example:
"courseNotes": [
"Sum/Fall 2020"
]
reserves
array
The reserves property contains a list of items that are on reserve for the course. The child properties contain information from bibliographic or item records for each reserved item.
Example:
"reserves": [
{
"id": "https://progress-app-beta.iii.com/iii/sierra-api/v6/bibs/1144916",
"recordType": "b",
"statusCode": "a",
"until": "2020-12-31T08:00:00Z"
}
]
Child Properties
id
string
The link to the reserved record.
Example:
"id": "https://example-library.edu.iii.com/iii/sierra-api/v6/bibs/1144916"
recordType
string
The type of record on reserve. Possible values are "b" for a bibliographic record and "i" for an item record.
Example:
"recordType": "b"
statusCode
string (optional)
The status code of the item on reserve.
Example:
"statusCode": "a"
until
string (optional)
The status change date of a course reserve record.
Example:
"until": "2020-12-31T08:00:00Z"
locationCode
string (optional)
The location code from the bibliographic or item record for the item on reserve.
Example:
"locationCode": "av"
The preceding list order reflects the sequence in which the data returns.
Course Object Example
Example response for:
https://example-library.edu:443/iii/sierra-api/v6/courses{
"total": 2,
"entries": [
{
"id": "1000005",
"beginDate": "2020-07-01T07:00:00Z",
"locationCode": "av",
"ccode1": "-",
"ccode2": "-",
"ccode3": "-",
"professorInstructors": [
"LIU, M. (KING COURSE RESERVES)"
],
"courseNames": [
"LIBR 210",
"LIBRARY SCIENCE 210"
],
"courseUrls": [],
"courseNotes": [
"Sum/Fall 2020"
],
"reserves": [
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/2124024",
"recordType": "i",
"statusCode": "a",
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416297",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416300",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416298",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416301",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416302",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416305",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416304",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/vv6/items/4416303",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416316",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416315",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416314",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4416317",
"recordType": "i",
"statusCode": "a"
}
]
},
{
"id": "1000014",
"beginDate": "2020-07-01T07:00:00Z",
"locationCode": "av",
"ccode1": "-",
"ccode2": "-",
"ccode3": "-",
"professorInstructors": [
"MORA-TORRES, G. (KING COURSE RESERVES)"
],
"courseNames": [
"MAS 175",
"MEXICAN AMERICAN STUDIES 175"
],
"courseUrls": [],
"courseNotes": [
"FALL 2020 (c)"
],
"reserves": [
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4442789",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4442790",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4442792",
"recordType": "i",
"statusCode": "a"
},
{
"id": "https://example-library.edu:443/iii/sierra-api/v6/items/4442793",
"recordType": "i",
"statusCode": "a"
}
]
}
]
}