Special characters are defined as characters other than alphanumeric (A-Z, 0-9). For example, special characters include backslash (
\ ), forward slash (
/ ), single quote (
' ), and so on. As with any URL, some special characters are reserved for special functions, such as
#. If you need to use these characters in a URL, you should URL encode them; for example, the URL encoding of
URL encoding primarily applies when using overloads in place of IDs for user and course identifiers. You may want to use special characters such as a slash in users' login IDs (usernames). If so, they should be URL encoded. Generally, we recommend against using reserved characters in overloads.
Allowed Special Characters
The LearningStudio API allows only a subset of special characters in the API URIs. The following table contains descriptions of the allowed special characters and the specific conditions when they are allowed. Use of any special character not specifically listed below may cause the API request to fail or other unexpected results.
|Special Character||Description||Conditions When It's Allowed Unencoded|
|@||At sign||Allowed as not encoded for user overloads. This supports using email addresses as user names. Do not use @ in course call numbers (course ID overloads).|
|_||Underscore||Allowed as not encoded for both user and course overloads.|
|-||Hyphen||Allowed as not encoded for user overloads. Do not use hyphens in course call numbers (course ID overloads).|
|.||Period||Allowed as not encoded for user overloads. Do not use periods in course call numbers (course ID overloads).|
Disallowed Special Characters
LearningStudio does not allow the following special characters in the password or the user ID fields, nor in the course call number.
% ] [ + " ; ' = : / | \ ;