IdentityPersonPersonIds
Person ID Service
Base URL: /domains/legacy/identity/person/personIds
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /{person_id}* | GET | GET |
| PUT | PUT |
Paths
GET /documentation
service definition
Uses default content-types: application/json
- 200 OK
-
Success
Gets information about a person's identifiers
| person_id | Unique identifier of an individual | path | string |
Uses default content-types: application/json
- 200 OK
-
Information returned about a person's identifiers.
Example for application/json{
"PersonIdsService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"identifiers": {
"net_id": "johnd",
"prox_id": "",
"ssn": "000-00-0000"
},
"person_summary_line": {
"academic_record": true,
"byu_id": "987654321",
"deceased": false,
"employee_role": "STD/PT/ACT",
"is_employee": true,
"merge_pending": false,
"name": "Doe, John Albert",
"net_id": "johnd",
"non_person_organization": false,
"person_id": "123456789",
"registrar_warning": false,
"restricted": false,
"student_role": "Junior"
}
}
}
} - 400 Bad Request
-
There appears to be a syntax error in the composition of the service request.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource cannot 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.
Update a person's identifiers
| person_id | Unique identifier of an individual | path | string | |
| ssn | social security number of person to be updated | query | string | |
| prox_id | query | string |
Uses default content-types: application/json
- 200 OK
-
The resource has been updated
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request.
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource cannot 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.
Schema definitions
- WebService: object
-
- name: string
-
- operations: operations
-
- errors: errors
-
- httpStatusCodes: httpStatusCodes
-
- 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
-
- name: string
-
- net_id: string
-
- byu_id: string
-
- person_id: string
-
- student_role: string
-
- employee_role: string
-
- academic_record: boolean
-
- is_employee: boolean
-
- non_person_organization: boolean
-
- restricted: boolean
-
- deceased: boolean
-
- merge_pending: boolean
-
- registrar_warning: boolean
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: integer
-
- statusMessage: string
-
- person_summary_line: person_summary_line
-
- identifiers: identifiers
-
