IdentityPersonPersonLookup

PersonLookupService

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/identity/person/personLookup

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/documentation GET

service definition

/{+searchPattern} GET

Search for person by whatever is in searchPattern. This could be BYU ID, Net ID, Last name, etc.

/{lastName}/{firstName} GET

Search for person by last and first name.

/{searchEngine}/{searchType}/{pageNumber}/{+searchPattern} GET

Specific search where searchPattern corresponds to the searchType. For searchType = name, the searchPattern would be the last name.

/{searchEngine}/{searchType}/{pageNumber}/{+searchPattern}/{+modifier} GET

Specific search where searchPattern corresponds to the searchType. For searchType = name, the searchPattern will be the last name and the modifier will be the first.

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Search for person by whatever is in searchPattern. This could be BYU ID, Net ID, Last name, etc.

GET /{+searchPattern}

Tags: PersonLookupService

Search for person by whatever is in searchPattern. This could be BYU ID, Net ID, Last name, etc.

+searchPattern

string -> Search pattern. Wildcards: ? and * (any char and any # of chars.)

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"Person Lookup Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/Doe/John",
"status": "200"
}
,
"resource": {
"URI": "/[search_engine/search_type/page_number/]search_pattern[/modifier]",
"examples": "/All/Name/1/Smith or /Smith or /Employee/Name/1/Smith/Joseph or /All/Hometown/3/Provo/UT or /All/Phone/1/801-422-4000",
"identifiers": {
"modifier": {
"description": "Search pattern that will be combined with the search pattern identifier to further restricted the result set",
"required": false
}
,
"page_number": {
"description": "The page number of result details to retrieve",
"required": false
}
,
"search_engine": {
"default": "All",
"description": "Identifies what search engine to use. Student, employee (staff, admin, and faculty), or both. Searching for individuals who are not current students or employees required authorization.",
"required": false,
"values": [
"All",
"Student",
"Employee",
"Both"
]
}
,
"search_pattern": {
"conditions": "The characters '?' and '*' can be used to search for any character and any number of characters, respectively. For example: The search pattern J?n matches Jen and Jan. The search pattern J*n matches Jen, Jan, John, Jordan, and Jason. Searching with Johns in the search pattern identifier and Mar in the modifier identifier will match Mary Johns or Martin Johns, but not Martha Johnson. Searching with S* in the search pattern identifier and J* in the modifier identifier is too ambiguous and will not return a response.",
"description": "Search pattern",
"required": true
}
,
"search_type": {
"description": "Type of information to search by. Name, hometown, phone number or person_id.",
"required": false,
"values": [
"Name",
"Hometown",
"Phone",
"PersonId"
]
}
}
,
"methods": {
"options": [
"GET"
]
}
}
,
"response": {
"result_page_count": 1,
"result_set": [
{
"Campus Address Block": {
"address_line_1": "1388 N University Ave",
"address_line_2": "Provo, UT 84602",
"address_line_3": "801-000-0000",
"address_line_4": "",
"address_line_5": ""
}
,
"Home Address Block": {
"address_line_1": "123 Fake St.",
"address_line_2": "Apt. 3",
"address_line_3": "Provo, UT 84604",
"address_line_4": "801-123-4567",
"address_line_5": ""
}
,
"Permanent Address Block": {
"address_line_1": "123 Main St.",
"address_line_2": "Bountiful, UT 84010",
"address_line_3": "801-111-1111",
"address_line_4": "",
"address_line_5": ""
}
,
"department": "",
"email_service": "https://y.byu.edu/ae/prod/person/cgi/sendEmail.cgi?personId=123456789",
"home_state_code": "UT",
"home_town": "Bountiful",
"job_title": "",
"person_id": "123456789",
"registrar_warning": "N",
"sort_name": "Doe, John"
}
]
,
"total_result_size": 1,
"view": "Directory",
"warnings": [
"This information is not to be used for commercial purposes."
]
}
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Search for person by last and first name.

GET /{lastName}/{firstName}

Tags: PersonLookupService

Search for person by last and first name.

lastName

string -> Last Name. Wildcards: ? and * (any char and any # of chars.)

path string
firstName

string -> First Name. Wildcards: ? and * (any char and any # of chars.)

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"Person Lookup Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/Doe/John",
"status": "200"
}
,
"resource": {
"URI": "/[search_engine/search_type/page_number/]search_pattern[/modifier]",
"examples": "/All/Name/1/Smith or /Smith or /Employee/Name/1/Smith/Joseph or /All/Hometown/3/Provo/UT or /All/Phone/1/801-422-4000",
"identifiers": {
"modifier": {
"description": "Search pattern that will be combined with the search pattern identifier to further restricted the result set",
"required": false
}
,
"page_number": {
"description": "The page number of result details to retrieve",
"required": false
}
,
"search_engine": {
"default": "All",
"description": "Identifies what search engine to use. Student, employee (staff, admin, and faculty), or both. Searching for individuals who are not current students or employees required authorization.",
"required": false,
"values": [
"All",
"Student",
"Employee",
"Both"
]
}
,
"search_pattern": {
"conditions": "The characters '?' and '*' can be used to search for any character and any number of characters, respectively. For example: The search pattern J?n matches Jen and Jan. The search pattern J*n matches Jen, Jan, John, Jordan, and Jason. Searching with Johns in the search pattern identifier and Mar in the modifier identifier will match Mary Johns or Martin Johns, but not Martha Johnson. Searching with S* in the search pattern identifier and J* in the modifier identifier is too ambiguous and will not return a response.",
"description": "Search pattern",
"required": true
}
,
"search_type": {
"description": "Type of information to search by. Name, hometown, phone number or person_id.",
"required": false,
"values": [
"Name",
"Hometown",
"Phone",
"PersonId"
]
}
}
,
"methods": {
"options": [
"GET"
]
}
}
,
"response": {
"result_page_count": 1,
"result_set": [
{
"Campus Address Block": {
"address_line_1": "1388 N University Ave",
"address_line_2": "Provo, UT 84602",
"address_line_3": "801-000-0000",
"address_line_4": "",
"address_line_5": ""
}
,
"Home Address Block": {
"address_line_1": "123 Fake St.",
"address_line_2": "Apt. 3",
"address_line_3": "Provo, UT 84604",
"address_line_4": "801-123-4567",
"address_line_5": ""
}
,
"Permanent Address Block": {
"address_line_1": "123 Main St.",
"address_line_2": "Bountiful, UT 84010",
"address_line_3": "801-111-1111",
"address_line_4": "",
"address_line_5": ""
}
,
"department": "",
"email_service": "https://y.byu.edu/ae/prod/person/cgi/sendEmail.cgi?personId=123456789",
"home_state_code": "UT",
"home_town": "Bountiful",
"job_title": "",
"person_id": "123456789",
"registrar_warning": "N",
"sort_name": "Doe, John"
}
]
,
"total_result_size": 1,
"view": "Directory",
"warnings": [
"This information is not to be used for commercial purposes."
]
}
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Specific search where searchPattern corresponds to the searchType. For searchType = name, the searchPattern would be the last name.

GET /{searchEngine}/{searchType}/{pageNumber}/{+searchPattern}

Tags: PersonLookupService

Specific search where searchPattern corresponds to the searchType. For searchType = name, the searchPattern would be the last name.

searchEngine

string -> Options: All, Student, Employee, or Both. Defaults to All.

path string
searchType

string -> Options: Name, Hometown, Phone, or PersonId.

path string
pageNumber

string -> int. The page number that would be on the results page.

path string
+searchPattern

string -> Search pattern. Wildcards: ? and * (any char and any # of chars.)

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"Person Lookup Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/Doe/John",
"status": "200"
}
,
"resource": {
"URI": "/[search_engine/search_type/page_number/]search_pattern[/modifier]",
"examples": "/All/Name/1/Smith or /Smith or /Employee/Name/1/Smith/Joseph or /All/Hometown/3/Provo/UT or /All/Phone/1/801-422-4000",
"identifiers": {
"modifier": {
"description": "Search pattern that will be combined with the search pattern identifier to further restricted the result set",
"required": false
}
,
"page_number": {
"description": "The page number of result details to retrieve",
"required": false
}
,
"search_engine": {
"default": "All",
"description": "Identifies what search engine to use. Student, employee (staff, admin, and faculty), or both. Searching for individuals who are not current students or employees required authorization.",
"required": false,
"values": [
"All",
"Student",
"Employee",
"Both"
]
}
,
"search_pattern": {
"conditions": "The characters '?' and '*' can be used to search for any character and any number of characters, respectively. For example: The search pattern J?n matches Jen and Jan. The search pattern J*n matches Jen, Jan, John, Jordan, and Jason. Searching with Johns in the search pattern identifier and Mar in the modifier identifier will match Mary Johns or Martin Johns, but not Martha Johnson. Searching with S* in the search pattern identifier and J* in the modifier identifier is too ambiguous and will not return a response.",
"description": "Search pattern",
"required": true
}
,
"search_type": {
"description": "Type of information to search by. Name, hometown, phone number or person_id.",
"required": false,
"values": [
"Name",
"Hometown",
"Phone",
"PersonId"
]
}
}
,
"methods": {
"options": [
"GET"
]
}
}
,
"response": {
"result_page_count": 1,
"result_set": [
{
"Campus Address Block": {
"address_line_1": "1388 N University Ave",
"address_line_2": "Provo, UT 84602",
"address_line_3": "801-000-0000",
"address_line_4": "",
"address_line_5": ""
}
,
"Home Address Block": {
"address_line_1": "123 Fake St.",
"address_line_2": "Apt. 3",
"address_line_3": "Provo, UT 84604",
"address_line_4": "801-123-4567",
"address_line_5": ""
}
,
"Permanent Address Block": {
"address_line_1": "123 Main St.",
"address_line_2": "Bountiful, UT 84010",
"address_line_3": "801-111-1111",
"address_line_4": "",
"address_line_5": ""
}
,
"department": "",
"email_service": "https://y.byu.edu/ae/prod/person/cgi/sendEmail.cgi?personId=123456789",
"home_state_code": "UT",
"home_town": "Bountiful",
"job_title": "",
"person_id": "123456789",
"registrar_warning": "N",
"sort_name": "Doe, John"
}
]
,
"total_result_size": 1,
"view": "Directory",
"warnings": [
"This information is not to be used for commercial purposes."
]
}
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Specific search where searchPattern corresponds to the searchType. For searchType = name, the searchPattern will be the last name and the modifier will be the first.

GET /{searchEngine}/{searchType}/{pageNumber}/{+searchPattern}/{+modifier}

Tags: PersonLookupService

Specific search where searchPattern corresponds to the searchType. For searchType = name, the searchPattern will be the last name and the modifier will be the first.

searchEngine

string -> Options: All, Student, Employee, or Both. Defaults to All.

path string
searchType

string -> Options: Name, Hometown, Phone, or PersonId.

path string
pageNumber

string -> int. The page number that would be on the results page.

path string
+searchPattern

string -> Search pattern. Wildcards: ? and * (any char and any # of chars.)

path string
+modifier

string -> First Name. Wildcards: ? and * (any char and any # of chars.)

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"Person Lookup Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/Doe/John",
"status": "200"
}
,
"resource": {
"URI": "/[search_engine/search_type/page_number/]search_pattern[/modifier]",
"examples": "/All/Name/1/Smith or /Smith or /Employee/Name/1/Smith/Joseph or /All/Hometown/3/Provo/UT or /All/Phone/1/801-422-4000",
"identifiers": {
"modifier": {
"description": "Search pattern that will be combined with the search pattern identifier to further restricted the result set",
"required": false
}
,
"page_number": {
"description": "The page number of result details to retrieve",
"required": false
}
,
"search_engine": {
"default": "All",
"description": "Identifies what search engine to use. Student, employee (staff, admin, and faculty), or both. Searching for individuals who are not current students or employees required authorization.",
"required": false,
"values": [
"All",
"Student",
"Employee",
"Both"
]
}
,
"search_pattern": {
"conditions": "The characters '?' and '*' can be used to search for any character and any number of characters, respectively. For example: The search pattern J?n matches Jen and Jan. The search pattern J*n matches Jen, Jan, John, Jordan, and Jason. Searching with Johns in the search pattern identifier and Mar in the modifier identifier will match Mary Johns or Martin Johns, but not Martha Johnson. Searching with S* in the search pattern identifier and J* in the modifier identifier is too ambiguous and will not return a response.",
"description": "Search pattern",
"required": true
}
,
"search_type": {
"description": "Type of information to search by. Name, hometown, phone number or person_id.",
"required": false,
"values": [
"Name",
"Hometown",
"Phone",
"PersonId"
]
}
}
,
"methods": {
"options": [
"GET"
]
}
}
,
"response": {
"result_page_count": 1,
"result_set": [
{
"Campus Address Block": {
"address_line_1": "1388 N University Ave",
"address_line_2": "Provo, UT 84602",
"address_line_3": "801-000-0000",
"address_line_4": "",
"address_line_5": ""
}
,
"Home Address Block": {
"address_line_1": "123 Fake St.",
"address_line_2": "Apt. 3",
"address_line_3": "Provo, UT 84604",
"address_line_4": "801-123-4567",
"address_line_5": ""
}
,
"Permanent Address Block": {
"address_line_1": "123 Main St.",
"address_line_2": "Bountiful, UT 84010",
"address_line_3": "801-111-1111",
"address_line_4": "",
"address_line_5": ""
}
,
"department": "",
"email_service": "https://y.byu.edu/ae/prod/person/cgi/sendEmail.cgi?personId=123456789",
"home_state_code": "UT",
"home_town": "Bountiful",
"job_title": "",
"person_id": "123456789",
"registrar_warning": "N",
"sort_name": "Doe, John"
}
]
,
"total_result_size": 1,
"view": "Directory",
"warnings": [
"This information is not to be used for commercial purposes."
]
}
}
}
400 Bad Request

There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.

403 Forbidden

The user does not have access to the resource.

404 Not Found

The target resource can not be found for the provided resource identifiers.

405 Method Not Allowed

The service method is not supported by the service.

409 Conflict

A conflict has occurred. The response structure may contain information about the conflict.

500 Internal Server Error

An error occurred generating the response to the service request. This is strictly a server error and not an application error.

Schema definitions

addressBlock: object

address_line_1: string
address_line_2: string
address_line_3: string
address_line_4: string
address_line_5: string

documentation: object

WebService: object
name: string
operations: operations
errors: errors
httpStatusCodes: httpStatusCodes

errors: object[]

object
code: integer
name: string
message: string
httpStatusCode: integer

httpStatusCodes: object[]

object
code: integer
message: string

operations: object[]

object
name: string
description: string
method: string
path: string
path_identifiers: object[]
object
name: string
type: string
format: string
query_attributes: object[]
object
name: string
type: string
format: string
required: string

PersonLookup: object

Person Lookup Service: object
resource: resource
request: request
response: response

request: object

method: string
resource: string
attributes: string
status: string

resource: object

methods: object
options: string[]
string
URI: string
examples: string
identifiers: object
search_engine: object
description: string
required: boolean
values: string[]
string
default: string
search_type: object
description: string
required: boolean
values: string[]
string
page_number: object
description: string
required: boolean
search_pattern: object
description: string
required: boolean
conditions: string
modifier: object
description: string
required: boolean

response: object

view: string
total_result_size: integer
result_page_count: integer
result_set: result_set
warnings: string[]
string

result_set: object[]

object
sort_name: string
job_title: string
department: string
home_town: string
home_state_code: string
registrar_warning: string
person_id: string
email_service: string
Home Address Block: addressBlock
Campus Address Block: addressBlock
Permanent Address Block: addressBlock
Service Path: 
/domains/legacy/identity/person/personLookup
Domain or University API: 
/domains/D/identity/person/personLookup

Community

 

Don't see your question listed here? Ask!