761156509",
"departmentNumber": "061419",
"eduPersonAffiliation" : "staff",
"cn": "Curtis L Bray",
"givenName": "Curtis",
"sn": "Bray",
"mail" : "clbray@ucdavis.edu",
"ou": "APPLICATION DEVELOPMENT & DATA ADMINISTRATION",
"postalAddress": "3820 Chiles Rd$Davis, CA 95618",
"telephoneNumber" : "+1 530 754 6199",
"l": "Davis",
"postalCode" : "95618",
"street": "3820 Chiles Rd",
"st": "CA",
"title": "Manager",
"displayName": "Curtis Bray"
},
{ ...<More results>.... }
],
"responseDetails" : null,
"responseStatus" : 0
}
|
JSON referenceUnlike the core JavaScript interface, the JSON interface is exposed through a uniform URL that contains CGI arguments. Your application can use an HTTP stack of its choosing. In order to use the JSON interface: - You must construct a properly formatted URL with all necessary CGI arguments.
- You must send an HTTP referer header that accurately identifies your application.
- You must process the JSON-encoded response.
URL base address The standard URL for the IET Middleware Online Directory Bulk Load API is: https://iet-ws.ucdavis.edu/api/directory/search URL argumentsThis 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. Required URL argumentsThe following table lists the required 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. |
Search URL argumentsThe following table lists the possible search query URL arguments. 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. Wildcard Searches: Any argument may use a wildcard within the query value. You may use multiple wildcards in any position in the search criteria. See examples below.* Argument | Example | Description |
---|
cn | cn=Curtis%20Bray | Full name(s) of the form (as components are defined): First Last, Nick Last, First Middle Last | displayName | displayName=*Bray | Name formatted per white pages rules | givenName | givenName=*urtis | First name | sn | sn=Bray | Last name |
Example search arguments: Code Block |
---|
title | Search for anyone with last name of 'Bray' |
---|
| /api/directory/search?sn=Bray&key=myKeyv&v=1.0 |
Code Block |
---|
title | Search for anyone with first name of 'Curtis' and last name starting with 'B' |
---|
| /api/directory/search?givenName=Curtis&sn=B*&key=myKeyv&v=1.0 |
Code Block |
---|
title | Search for anyone with a displayName that starts with 'J' and ends with 'Jones' |
---|
| /api/directory/search?displayName=J*Jones&key=myKey&v=1.0 |
Each response follow this general format: |