IdentityPersonPROAddress
This service accesses the Person (PRO) system for the address services
Base URL: /domains/legacy/identity/person/PRO/address
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/delete/{person_id}/EML | GET | Delete email |
/delete/{person_id}/{address_type}/{phone_type}/{phone_no} | GET | Delete phone number |
/delete/{person_id}{address_type} | GET | Delete address. |
/documentation | GET | service definition |
/{person_id} | GET | Gets contact information about a person including addresses and phone numbers. |
/{person_id}/EML | GET | Gets OR updates email |
/{person_id}/{address_type}* | GET | Get an address OR Update an address. |
/{person_id}/{address_type}/{phone_type}/{phone_no}* | GET | Get OR update phone number |
Paths
Delete email
person_id | string -> | path | string |
Uses default content-types: application/json application/xml
- 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.
- 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.
GET /delete/{person_id}/{address_type}/{phone_type}/{phone_no}
Tags: AddressServiceDelete phone number
person_id | string -> | path | string | |
address_type | string -> MAL|PRM|RES|WRK|EML | path | string | |
phone_type | string -> PHONE|FAX|PAGER | path | string | |
phone_no | Phone number | path | string |
Uses default content-types: application/json application/xml
- 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.
- 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.
- 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.
Delete address
person_id | string -> | path | string | |
address_type | string -> MAL|PRM|RES|WRK|EML | path | string |
Uses default content-types: application/json application/xml
- 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.
- 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.
- 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 /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{person_id}
Tags: AddressServiceGets contact information about a person including addresses and phone numbers.
person_id | string -> | 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{
"request": {
"attributes": "",
"method": "GET",
"resource": "/098765432",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"campus_emergency_alert": {
},
"email_address": [
{
"email_address": "oit@byu.edu",
"unlisted": false
}
],
"emergency_contact": [
],
"housing_policy_compliance": {
"compliant": false,
"email_address_invalid": false,
"invalid_address_description": "Your Residential address is not BYU Contracted.",
"mailing_address_invalid": false,
"residential_address_invalid": true
},
"mailing": {
"mailing_address": [
{
"address_line_1": "123 N 321 S an Address",
"address_line_2": "Provo, UT 84604",
"unlisted": false
}
],
"mailing_phone": [
{
"label": "Mobile",
"phone_number": "801-422-2222"
}
]
},
"permanent": {
"permanent_address": [
{
"address_line_1": "123 N 321 S an Address",
"address_line_2": "Springville, UT 84663",
"unlisted": false
}
],
"permanent_phone": [
{
"label": "Unlisted",
"phone_number": "801-422-2222"
}
]
},
"person_summary_line": {
"academic_record": true,
"byu_id": "123456789",
"deceased": false,
"employee_role": "STD/PT/ACT",
"is_employee": true,
"merge_pending": false,
"name": "Joe, Student",
"net_id": "js279",
"non_person_organization": false,
"person_id": "098765432",
"registrar_warning": false,
"restricted": false,
"student_role": "Senior"
},
"residential": {
"residential_address": [
{
"address_line_1": "123 N 321 S an Address",
"address_line_2": "Provo, UT 84604",
"unlisted": false
}
],
"residential_phone": [
]
},
"work": {
"work_address": [
],
"work_phone": [
]
}
}
} - 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.
- 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.
Gets OR updates email
person_id | string -> | path | string | |
line1 | First line - required to update | query | string | |
line2 | Second line - not required to update | query | string | |
line3 | Third line - not required to update | query | string | |
line4 | Fourth line - Not required to update | query | string | |
city | City address is within - required to update | query | string | |
state_province_region | State province or region address is in - required to update | query | string | |
postal_code | Postal code - required to update | query | string | |
country | Country - required to update | query | string | |
unlisted | Is the address unlisted - not required to update | query | boolean | |
campus_address | Is address a campus address - not required to update | query | boolean | |
mailing_residence_same | Is their mailing residence same as address - not required to update | query | 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{
"request": {
"attributes": "",
"method": "GET",
"resource": "/098765432/EML",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"email": {
"email_address": "OIT@byu.edu",
"email_unlisted": true,
"person_summary_line": {
"academic_record": true,
"byu_id": "123456789",
"deceased": false,
"employee_role": "STD/PT/ACT",
"is_employee": true,
"merge_pending": false,
"name": "Joe, Student",
"net_id": "js279",
"non_person_organization": false,
"person_id": "098765432",
"registrar_warning": false,
"restricted": false,
"student_role": "Senior"
},
"work_email_address": ""
}
}
} - 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.
Get an address OR update an address.
person_id | string -> | path | string | |
address_type | string -> MAL|PRM|RES|WRK|EML | path | string | |
line1 | First line - required to update address | query | string | |
line2 | Second line - not required to update | query | string | |
line3 | Third line - not required to update | query | string | |
line4 | Fourth line - Not required to update | query | string | |
city | City address is within - required to update address | query | string | |
state_province_region | State province or region address is in - required to update address | query | string | |
postal_code | Postal code - required to update address | query | string | |
country | Country - required to update address | query | string | |
unlisted | Is the address unlisted - not required to update address | query | boolean | |
campus_address | Is address a campus address - not required to update address | query | boolean | |
mailing_residence_same | Is their mailing residence same as address - not required to update | query | 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{
"request": {
"attributes": "",
"method": "GET",
"resource": "/098765432/MAL/PHONE/801-234-5678",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"address": {
"city": "Provo",
"country_code": "USA",
"iso_country_code_2": "US",
"iso_country_code_3": "USA",
"line1": "123 N 321 S an Address",
"line2r": "Provo, UT 84604",
"line3": "",
"line4": "",
"postal_code": "84604",
"state_province_region": "UT",
"unlisted": "Y"
},
"address_type": "Mailing",
"address_type_description": "Where you want to receive mail, usually your home address.",
"person_summary_line": {
"academic_record": true,
"byu_id": "123456789",
"deceased": false,
"employee_role": "STD/PT/ACT",
"is_employee": true,
"merge_pending": false,
"name": "Joe, Student",
"net_id": "js279",
"non_person_organization": false,
"person_id": "098765432",
"registrar_warning": false,
"restricted": false,
"student_role": "Senior"
},
"phones": [
{
"country_code": "USA",
"is_mobile": true,
"is_primary": true,
"is_tty": false,
"is_unlisted": false,
"phone_index": "1",
"phone_number": "801-422-2222",
"type_of_device": "Phone"
}
]
}
} - 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.
- 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 /{person_id}/{address_type}/{phone_type}/{phone_no}*
Tags: AddressServiceGet OR update phone number
person_id | string -> | path | string | |
address_type | string -> MAL|PRM|RES|WRK|EML | path | string | |
phone_type | string -> PHONE|FAX|PAGER | path | string | |
phone_no | Phone number | path | string | |
line1 | First line - required to update | query | string | |
line2 | Second line - not required to update | query | string | |
line3 | Third line - not required to update | query | string | |
line4 | Fourth line - Not required to update | query | string | |
city | City address is within - required to update | query | string | |
state_province_region | State province or region address is in - required to update | query | string | |
postal_code | Postal code - required to update | query | string | |
country | Country - required to update | query | string | |
unlisted | Is the address unlisted - not required to update | query | boolean | |
campus_address | Is address a campus address - not required to update | query | boolean | |
mailing_residence_same | Is their mailing residence same as address - not required to update | query | 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{
"request": {
"attributes": "",
"method": "GET",
"resource": "/098765432/MAL/PHONE/801-234-5678",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"address": {
"city": "Provo",
"country_code": "USA",
"iso_country_code_2": "US",
"iso_country_code_3": "USA",
"line1": "123 N 321 S an Address",
"line2r": "Provo, UT 84604",
"line3": "",
"line4": "",
"postal_code": "84604",
"state_province_region": "UT",
"unlisted": "Y"
},
"address_type": "Mailing",
"address_type_description": "Where you want to receive mail, usually your home address.",
"person_summary_line": {
"academic_record": true,
"byu_id": "123456789",
"deceased": false,
"employee_role": "STD/PT/ACT",
"is_employee": true,
"merge_pending": false,
"name": "Joe, Student",
"net_id": "js279",
"non_person_organization": false,
"person_id": "098765432",
"registrar_warning": false,
"restricted": false,
"student_role": "Senior"
},
"phones": [
{
"country_code": "USA",
"is_mobile": true,
"is_primary": true,
"is_tty": false,
"is_unlisted": false,
"phone_index": "1",
"phone_number": "801-422-2222",
"type_of_device": "Phone"
}
]
}
} - 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.
- 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
- request: request
-
- response: object
-
- person_summary_line: person_summary_line
-
- address_type: string
-
- address_type_description: string
-
- address: object
-
- line1: string
-
- line2r: string
-
- line3: string
-
- line4: string
-
- city: string
-
- state_province_region: string
-
- country_code: string
-
- postal_code: string
-
- unlisted: string
-
- iso_country_code_2: string
-
- iso_country_code_3: string
-
- phones: object[]
-
object - phone_index: string
-
- phone_number: string
-
- country_code: string
-
- type_of_device: string
-
- is_tty: boolean
-
- is_mobile: boolean
-
- is_unlisted: boolean
-
- is_primary: boolean
-
- request: request
-
- response: object
-
- email: object
-
- person_summary_line: person_summary_line
-
- email_address: string
-
- email_unlisted: boolean
-
- work_email_address: string
-
- request: request
-
- response: object
-
- person_summary_line: person_summary_line
-
- housing_policy_compliance: object
-
- compliant: boolean
-
- mailing_address_invalid: boolean
-
- invalid_address_description: string
-
- residential_address_invalid: boolean
-
- email_address_invalid: boolean
-
- mailing: object
-
- mailing_address: object[]
- mailing_phone: object[]
- residential: object
-
- residential_address: object[]
- residential_phone: object[]
- work: object
-
- work_address: object[]
- work_phone: object[]
- permanent: object
-
- permanent_address: object[]
- permanent_phone: object[]
- email_address: object[]
-
object - email_address: string
-
- unlisted: boolean
-
- emergency_contact: object[]
-
object - campus_emergency_alert: object
-
- 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
-