IdentityPersonPersonLookup
PersonLookupService
Base URL: /domains/legacy/identity/person/personLookup/v1
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /{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. |
| /{searchPattern} | GET | Search for person by whatever is in searchPattern. This could be BYU ID, Net ID, Last name, etc. |
Paths
GET /documentation
service definition
Uses default content-types: application/json
- 200 OK
-
Success
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.
- 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.
GET /{searchEngine}/{searchType}/{pageNumber}/{searchPattern}
Tags: PersonLookupServiceSpecific 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.
- 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.
GET /{searchEngine}/{searchType}/{pageNumber}/{searchPattern}/{modifier}
Tags: PersonLookupServiceSpecific 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.
- 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.
GET /{searchPattern}
Tags: PersonLookupServiceSearch 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.
- 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
- address_line_1: address_line_1
-
- address_line_2: address_line_2
-
- address_line_3: address_line_3
-
- address_line_4: address_line_4
-
- address_line_5: address_line_5
-
- address_line_1: address_line_1
-
- address_line_2: address_line_2
-
- address_line_3: address_line_3
-
- address_line_4: address_line_4
-
- address_line_5: address_line_5
-
- sort_name: sort_name
-
- job_title: job_title
-
- department: department
-
- home_town: home_town
-
- home_state_code: home_state_code
-
- person_id: person_id
-
- net_id: net_id
-
- byu_id: byu_id
-
- restricted: restricted
-
- email: email
-
- date_of_birth: date_of_birth
-
- gender: gender
-
- empStatus: empStatus
-
- stdStatus: stdStatus
-
- deceased: deceased
-
- merge_pending: merge_pending
-
- registrar_warning: registrar_warning
-
- organization: organization
-
- home_address_block: home_address_block
-
- permanent_address_block: permanent_address_block
-
- campus_address_block: campus_address_block
-
- address_line_1: address_line_1
-
- address_line_2: address_line_2
-
- address_line_3: address_line_3
-
- address_line_4: address_line_4
-
- address_line_5: address_line_5
-
- method: method
-
- resource: resource
-
- attributes: attributes
-
- status: status
-
- statusMessage: statusMessage
-
- total_result_size: total_result_size
-
- result_page_count: result_page_count
-
- view_type: view_type
-
- information: information
-
