IdentityPersonPersonIdCard
PersonIdCardService
Base URL: /domains/legacy/identity/person/personIdCard
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
Returns a person Id Card
person_id | Unique identifier of an individual | path | string |
Uses default content-types: application/json
- 200 OK
-
A Person Id Card
Example for application/json{
"ID Card Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": "200"
},
"resource": {
"URI": "/[personid|netid]",
"attributes": {
"lost_stolen": {
"default": "false",
"description": "A boolean indicator. If true indicates that the ID Card has been lost or stolen",
"required": false
},
"unlisted": {
"default": "false",
"description": "A boolean indicator. If true indicates the desire make the ID Card unlisted (unavailable) except to those who have a legitimate need to know",
"required": false
}
},
"examples": [
"/",
"/123456789",
"/byu999"
],
"identifiers": [
{
"personid": {
"default": "Identifier of authenticated individual",
"description": "Unique identifier of an individual",
"required": false
}
},
{
"netid": {
"description": "Online account or network identifier of an individual",
"required": false
}
}
],
"methods": {
"adaptations": [
{
"PUT": [
"Tunnel through a GET with attributes in the query string name value pairs",
"Tunnel through a POST with attributes in POST content name values pairs"
]
}
],
"options": [
"GET",
"PUT"
]
}
},
"response": {
"ID_card_name": "John Albert Doe",
"ID_card_role": "Student",
"beard": false,
"byu_id": "98-765-4321",
"card_status": "",
"dtf": false,
"expiration_date": "31-DEC-2020",
"id_card_roles": {
"current": {
"primary_role": "Student",
"secondary_role": "full time student junior"
},
"when_issued": {
"primary_role": "Student",
"secondary_role": "full time student sophomore"
}
},
"issue_number": "02",
"lost_stolen": false,
"photo_URL": "https://y.byu.edu/ry/ae/prod/person/cgi/personPhoto.cgi/123456789",
"relationships": [
{
"affiliation": "",
"deceased": "",
"employee": "ADM/FT/TRM",
"name": "Jack Doe",
"person_id": "111222333",
"student": "Former Student",
"type": "Child of:"
}
],
"unlisted": false,
"warnings": [
"Non-Directory information is accessible only to yourself and to university personnel with a legitimate need to know"
]
}
}
} - 400 Bad Request
-
There appears to be a syntax error in the composition of the service request.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource
- 404 Not Found
-
The target resource cannot be found for the provided resouce identifiers
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occured. The response structure may contain information about the conflict.
- 500 Internal Server Error
-
An error occurred generating the response to the service request.
PUT /{person_id}*
Updates a person Id Card
person_id | Name of the Id being updated | path | string | |
unlisted | Unlist/List a card from the public directory | query | string | |
lost_stolen | Report a card lost or stolen | query | string |
Uses default content-types: application/json
- 200 OK
-
The Id that was updated
- 400 Bad Request
-
There appears to be a syntax error in the composition of the service request.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource
- 404 Not Found
-
The target resource cannot be found for the provided resouce identifiers
- 405 Method Not Allowed
-
The service method is not supported by the service.
- 409 Conflict
-
A conflict has occured. 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
-
- current: object
-
- primary_role: string
-
- secondary_role: string
-
- when_issued: object
-
- primary_role: string
-
- secondary_role: string
-
- 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
-
- type: string
-
- name: string
-
- person_id: string
-
- deceased: string
-
- employee: string
-
- student: string
-
- affiliation: string
-
- methods: object
-
- options: string[]
-
string - adaptations: object[]
-
object - PUT: string[]
-
string
- URI: string
-
- examples: string[]
-
string - identifiers: object[]
-
object - personid: object
-
- description: string
-
- required: boolean
-
- default: string
-
- netid: object
-
- description: string
-
- required: boolean
-
- attributes: object
-
- unlisted: object
-
- description: string
-
- required: boolean
-
- default: string
-
- lost_stolen: object
-
- description: string
-
- required: boolean
-
- default: string
-
- photo_URL: string
-
- card_status: string
-
- ID_card_name: string
-
- ID_card_role: string
-
- byu_id: string
-
- issue_number: string
-
- dtf: boolean
-
- beard: boolean
-
- expiration_date: string
-
- unlisted: boolean
-
- lost_stolen: boolean
-
- id_card_roles: id_card_roles
-
- relationships: relationships
-
- warnings: warnings
-