search.md

UWaterloo Whitepages Directory Search

GET /directory/{user_id}.{format}

Description

This method returns user information for a given WatIAM ID

Summary

Name	Value	Name	Value
Request Protocol	GET	Requires API Key	Yes
Method ID	1201	Enabled	Yes
Service Name	directory	Service ID	251
Information Steward	IST Department	Data Type	LDAP Database
Update Frequency	Realtime LDAP lookup	Cache Time	0 seconds

Notes

• All calls on this endpoint are logged as a security measure
• Reverse searching or indexing this catalogue is not permitted
• Any value can be null

Sources

• http://watiam.uwaterloo.ca/search/app/

Parameters

GET /directory/{user_id}.{format}

Parameter	Type	Required	Description
key	filter	yes	Your API key
callback	filter	no	JSONP callback format

Output Formats

• json
• xml

Examples

GET /directory/{user_id}.{format}

• https://api.uwaterloo.ca/v2/directory/ktalwar.json
• https://api.uwaterloo.ca/v2/directory/kartik.talwar.xml
• https://api.uwaterloo.ca/v2/directory/lwsmith.json?callback=myResponse

Response

Field Name	Type	Value Description
full_name	string	Full Name
given_name	string	Given Name
last_name	string	Last Name
user_id	string	User's WatIAM user ID
department	string	User's Department/Faculty Association
common_names	list	Other names of the user
offices	list	Office(s) of the user
telephone_numbers	list	All telephone numbers of the user with phone extension
homepage	string	User's personal/department website from their profile

Any value can be null

Output

JSON

{
  "meta":{
    "requests":789770,
    "timestamp":1451857158,
    "status":200,
    "message":"Request successful",
    "method_id":1201,
    "method":{
      
    }
  },
  "data":{
    "full_name":"Kartik Talwar",
    "given_name":"Kartik",
    "last_name":"Talwar",
    "user_id":"ktalwar",
    "department":"SCI\/Science",
    "common_names":[
      "Kartik Talwar"
    ],
    "email_addresses":[
      "ktalwar@uwaterloo.ca",
      "kartik.talwar@uwaterloo.ca"
    ],
    "offices":[
      "EC2 2033"
    ],
    "telephone_numbers":[
      "519-888-4567 x41238"
    ],
    "homepage":"http:\/\/science.uwaterloo.ca\/~ktalwar\/"
  }
}