IdentityPersonPROUnlistedInfo

RelationshipService

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

Base URL: /domains/legacy/identity/person/PRO/unlistedinfo

Version: v1

Default response content-types: application/json, application/xml
Schemes: https

Summary

Path Operation Description
/documentation GET

service definition

/{person_id}* GET

Get unlisted information

PUT

Update unlisted information

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

Get unlisted information

GET /{person_id}*

Tags: RelationshipService

Get unlisted information

person_id

string -> 9 digit #

path string

Uses default content-types: application/json application/xml

200 OK

Returns documentation of resource and unlisted information for specific person

Example for application/json
{
"Unlist Information Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789",
"status": "200"
}
,
"resource": {
"URI": "/[personid|netid]",
"attributes": {
"list_address": {
"description": "Identifies the set of address types MAL,RES,PRM, or WRK that should be flagged as listed.",
"examples": [
"MAL,PRM",
"WRK",
"RES,PRM,WRK"
]
,
"required": false
}
,
"list_phone": {
"description": "Identifies the set of phone numbers that should be flagged as listed.",
"examples": [
"801-123-1234,801-234-4567",
"801-123-1234"
]
,
"required": false
}
,
"note": "If an attribute is not present in the PUT request, the current value in the database will be retained.",
"unlist_address": {
"description": "Identifies the set of address types MAL,RES,PRM, or WRK that should be flagged as unlisted.",
"examples": [
"MAL,PRM",
"WRK",
"RES,PRM,WRK"
]
,
"required": false
}
,
"unlist_all": {
"conditions": "If present all other attributes will be ignored",
"description": "A boolean string indicator. If true (has a value) contact information will be flagged as unlisted. If present and not true (does not have a value) contact information will be flagged as listed.",
"required": false
}
,
"unlist_email": {
"description": "A boolean string indicator. If true (has a value) the email address will be flagged as unlisted. If present and not true (does not have a value) the email address will be flagged as listed.",
"required": false
}
,
"unlist_phone": {
"description": "Identifies the set of phone numbers that should be flagged as unlisted.",
"examples": [
"801-123-1234,801-234-4567",
"801-123-1234"
]
,
"required": false
}
,
"unlist_picture": {
"description": "A boolean string indicator. If true (has a value) the individual's picture will be flagged as unlisted. If present and not true (does not have a value) the individual's picture will be flagged as listed.",
"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": {
"addresses": [
{
"description": "Mailing",
"type": "MAL",
"unlisted": false
},
{
"description": "Permanent",
"type": "PRM",
"unlisted": false
},
{
"description": "Residential",
"type": "RES",
"unlisted": false
},
{
"description": "Work",
"type": "WRK",
"unlisted": false
},
{
}
]
,
"email_address": {
"unlisted": true
}
,
"phone_numbers": [
{
"phone_number": "801-000-0000",
"type": "MAL",
"unlisted": false
},
{
"phone_number": "801-000-0000",
"type": "RES",
"unlisted": false
},
{
"phone_number": "801-000-0000",
"type": "PRM",
"unlisted": false
},
{
"phone_number": "801-000-0000",
"type": "WRK",
"unlisted": false
},
{
}
]
,
"picture": {
"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. 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.

Update unlisted information

PUT /{person_id}*

Tags: RelationshipService

Update unlisted information

person_id

string -> 9 digit #

path string
unlist_all

Unlist everything

query string , x ∈ { true , false }
unlist_email

Unlist email

query string
unlist_picture

Unlist picture

query string
unlist_address

Unlist address

query string
list_address

list address

query string
unlist_phone

Unlist phone

query string
list_phone

list phone

query 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.

Schema definitions

addresses: object[]

object
type: string
description: string
unlisted: boolean

documentation: object

WebService: object
name: string
operations: operations
errors: errors
httpStatusCodes: httpStatusCodes

email_address: object

unlisted: boolean

errors: object[]

object
code: integer
name: string
message: string
httpStatusCode: integer

httpStatusCodes: object[]

object
code: integer
message: 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

phone_numbers: object[]

object
type: string
phone_number: string
unlisted: boolean

picture: object

unlisted: boolean

request: object

method: string
resource: string
attributes: string
status: string

resource: object

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
unlist_all: object
description: string
required: boolean
conditions: string
unlist_email: object
description: string
required: boolean
unlist_picture: object
description: string
required: boolean
unlist_address: object
description: string
required: boolean
examples: string[]
string
list_address: object
description: string
required: boolean
examples: string[]
string
unlist_phone: object
description: string
required: boolean
examples: string[]
string
list_phone: object
description: string
required: boolean
examples: string[]
string
note: string

response: object

addresses: addresses
phone_numbers: phone_numbers
email_address: email_address
picture: picture
warnings: warnings

UnlistInfoService: object

Unlist Information Service: object
resource: resource
request: request
response: response

warnings: string[]

string
Service Path: 
/domains/legacy/identity/person/PRO/unlistedinfo
Domain or University API: 
/domains/D/identity/person/PRO/unlistedinfo

Community

 

Don't see your question listed here? Ask!