Object IDs, SIS IDs, and special IDs
Throughout the API, objects are referenced by internal IDs. You can also
reference objects by SIS ID, by prepending the SIS ID with the name of
the SIS field, like
sis_course_id:. For instance, to retrieve the
list of assignments for a course with SIS ID of
The following objects support SIS IDs in the API:
Additionally, some objects support special IDs:
- Users support
selfto mean the current user.
- Accounts support
selfto mean the root account for the current domain,
defaultto mean the Default account, and
site_adminto mean the Site Admin account.
- Terms support
defaultto mean the default term, and
currentto mean the term that is currently active according to term dates. A term must have a start date or an end date to be considered the current term. If there is more than one term that's active,
currentwill not be found.
Encoding and Escaping
SIS IDs should be encoded as UTF-8, and then escaped normally for inclusion in
a URI. For instance the SIS ID
CS/101.11é is encoded and escaped as
Note that some web servers have difficulties with escaped characters, particularly forward slashes. They may require special configuration to properly pass encoded slashes to Rails.
For Apache and Passenger, the following settings should be set:
Also beware that if you use
you should enable the
nocanon option. Similarly,
should use the
noescape flag. Other modules may also need additional configuration to
prevent double-escaping of
%2f (/) as
Prior versions of this API documentation described using a hex encoding to circumvent these issues, since the proper Apache/Passenger configuration was not known at the time. This format is deprecated, and will no longer be described, but will continue to be handled by the server for backwards compatibility.