IdentityPersonDirectoryLookup2.0

This service accesses the directory service associated with the Person (PRO) System. It is the web service version of the web page FINDPRSN in the PRO System.

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

Base URL: /domains/legacy/identity/person/directorylookup2.0

Version: v1

Default response content-types: application/json, application/xml
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 application/xml

200 OK

Success

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

GET /{+searchPattern}

Tags: LoadTestService

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 application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"PersonLookupService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/All/Name/1/Doe",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"information": [
{
"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": ""
}
,
"department": "",
"email": "Unlisted",
"home_address_block": {
"address_line_1": "123 Fake St.",
"address_line_2": "Provo, UT 84604",
"address_line_3": "801-000-0000",
"address_line_4": "",
"address_line_5": ""
}
,
"home_state_code": "UT",
"home_town": "Bountiful",
"job_title": "",
"permanent_address_block": {
"address_line_1": "123 Main St.",
"address_line_2": "Bountiful, UT 84010",
"address_line_3": "801-123-4567",
"address_line_4": "",
"address_line_5": ""
}
,
"person_id": "123456789",
"sort_name": "Doe, Derek James"
}
]
,
"result_page_count": 1,
"total_result_size": 23,
"view_type": "Directory"
}
}
}
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: DirectoryLookup2.0

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 application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"PersonLookupService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/All/Name/1/Doe",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"information": [
{
"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": ""
}
,
"department": "",
"email": "Unlisted",
"home_address_block": {
"address_line_1": "123 Fake St.",
"address_line_2": "Provo, UT 84604",
"address_line_3": "801-000-0000",
"address_line_4": "",
"address_line_5": ""
}
,
"home_state_code": "UT",
"home_town": "Bountiful",
"job_title": "",
"permanent_address_block": {
"address_line_1": "123 Main St.",
"address_line_2": "Bountiful, UT 84010",
"address_line_3": "801-123-4567",
"address_line_4": "",
"address_line_5": ""
}
,
"person_id": "123456789",
"sort_name": "Doe, Derek James"
}
]
,
"result_page_count": 1,
"total_result_size": 23,
"view_type": "Directory"
}
}
}
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.

401 Unauthorized

Failure to authenticate

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.

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: DirectoryLookup2.0

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 application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"PersonLookupService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/All/Name/1/Doe",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"information": [
{
"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": ""
}
,
"department": "",
"email": "Unlisted",
"home_address_block": {
"address_line_1": "123 Fake St.",
"address_line_2": "Provo, UT 84604",
"address_line_3": "801-000-0000",
"address_line_4": "",
"address_line_5": ""
}
,
"home_state_code": "UT",
"home_town": "Bountiful",
"job_title": "",
"permanent_address_block": {
"address_line_1": "123 Main St.",
"address_line_2": "Bountiful, UT 84010",
"address_line_3": "801-123-4567",
"address_line_4": "",
"address_line_5": ""
}
,
"person_id": "123456789",
"sort_name": "Doe, Derek James"
}
]
,
"result_page_count": 1,
"total_result_size": 23,
"view_type": "Directory"
}
}
}
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.

401 Unauthorized

Failure to authenticate

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.

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: DirectoryLookup2.0

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 application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"PersonLookupService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/All/Name/1/Doe/D*",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"information": [
{
"byu_id": "98-765-4321",
"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": ""
}
,
"date_of_birth": "31 Mar 1996",
"deceased": "N",
"department": "",
"email": "Unlisted",
"empStatus": "Non-Employee",
"gender": "F",
"home_address_block": {
"address_line_1": "123 Fake St.",
"address_line_2": "Provo, UT 84604",
"address_line_3": "801-000-0000",
"address_line_4": "",
"address_line_5": ""
}
,
"home_state_code": "UT",
"home_town": "Bountiful",
"job_title": "",
"merge_pending": "N",
"net_id": "derekjd",
"organization": "",
"permanent_address_block": {
"address_line_1": "123 Main St.",
"address_line_2": "Bountiful, UT 84010",
"address_line_3": "801-123-4567",
"address_line_4": "",
"address_line_5": ""
}
,
"person_id": "123456789",
"registrar_warning": "N",
"restricted": "",
"sort_name": "Doe, Derek James",
"stdStatus": "Non-Matriculated"
}
]
,
"result_page_count": 1,
"total_result_size": 15,
"view_type": "Secure"
}
}
}
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.

401 Unauthorized

Failure to authenticate

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.

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

documentation: object

WebService: object
name: 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
errors: object[]
object
code: integer
name: string
message: string
httpStatusCode: integer
httpStatusCodes: object[]
object
code: integer
message: string

PersonLookup: object

PersonLookupService: object

PersonLookupRequest: object

method: string
resource: string
attributes: string
status: integer
statusMessage: string

PersonLookupResponse: object

total_result_size: integer
result_page_count: integer
view_type: string
information: object[]
object
sort_name: string
job_title: string
department: string
home_town: string
home_state_code: string
person_id: string
net_id: string
byu_id: string
restricted: string
email: string
date_of_birth: string
gender: string
empStatus: string
stdStatus: string
deceased: string
merge_pending: string
registrar_warning: string
organization: string
home_address_block: object
address_line_1: string
address_line_2: string
address_line_3: string
address_line_4: string
address_line_5: string
campus_address_block: object
address_line_1: string
address_line_2: string
address_line_3: string
address_line_4: string
address_line_5: string
permanent_address_block: object
address_line_1: string
address_line_2: string
address_line_3: string
address_line_4: string
address_line_5: string
Service Path: 
/domains/legacy/identity/person/directorylookup2.0
Domain or University API: 
/domains/D/identity/person/directorylookup2.0

Community

 

Don't see your question listed here? Ask!