The easiest way to start learning about this interface is to try it out. This section shows how to use the curl command line tool to execute sample queries.
The response to all of the above requests have a Content-Type of text/javascript. An example response for the the following above request is shown below:
This section describes the arguments that can be used for search requests.
The value of a CGI argument must always be properly escaped. This can be done via the functional equivalent of JavaScript's encodeURIComponent() method.
Include Page
URL Arguments
URL Arguments
Required URL Arguments
Include Page
Required URL Arguments
Required URL Arguments
The following table lists the required
Other Supported URL arguments
.
Argument
Example
Description
key
key=your-key
This argument supplies the application's key. You can sign up for an API key <INSERT LINK HERE>. It must be a valid key associated with your application. The key is required for this API to implement quality of service rules for this API. If your application is making too many requests it will be throttled to ensure resources are not overloaded during times of peak usage. Also, by supplying a key we can identify and contact you should something go wrong with your application.
v
v=1.0
This argument supplies protocol version number. The only valid value at this point in time is 1.0.
Supported URL arguments
The following table lists the supported URL arguments for each supported URL pattern.
At least one argument should be provided to perform a search. If multiple search criteria are provided an 'AND' search will be performed to match on all arguments.
The results array always contains the parameters listed in this section, even if the value is empty.
Last date any attribute for this person was modified
Property
Description
iamId
modifyDate
Unique University ID created by IAM system. Replaces MOTHRAID.
levelCode
Banner student level code
levelName
Banner student level description
classCode
Banner student class code
className
Banner student class description
collegeCode
Banner college code
collegeName
Banner college name
assocRank
Ranks multiple associations by ZGVOCFS_LFOS_ORDER from Banner.
assocStartDate
Reported start date for the association
assocEndDate
Reported end date for the association
majorCode
Banner major code
majorName
Banner major description
ferpaCode
Banner conf code for FERPA
createDate
The date this association was created in the IAM system
modifyDate
The last date this association was modified in the IAM system
results[]
results[] contains an array of bulk load result objects, one for each result. Each time the API executes, this property is cleared, and each time a API completes, the array is populated. If there are no results to report, the .length property of this array will be set to 0. Therefore, results will never be null, and you can always safely check for results.length == 0.
'responseStatus' Codes and 'responseDetails' Messages
Include Page
IETP:'responseStatus' Response Codes and 'responseDetails' MessagesIETP:'responseStatus'