IdentityPersonPRORelationship

RelationshipService

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

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

Version: v1

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

Summary

Path Operation Description
/ GET

Shows page using the current user's person Id

/delete/{parm_name}/{parm_type}/{parm_value}/{year_term} GET

Not currently supported

/documentation GET

service definition

/{parm_name}/{parm_type}/{parm_value}/{year_term} PUT

Not currently supported

/{personID} GET

Shows page using the specified person Id

Paths

Shows page using the current user's person Id

GET /

Tags: RelationshipService

Shows page using the current user's person Id

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.

Not currently supported

GET /delete/{parm_name}/{parm_type}/{parm_value}/{year_term}

Tags: RelationshipService

Not currently supported

parm_name

parameter name

path string
parm_type

parameter type

path string
parm_value

parameter value

path string
year_term

Year and term

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.

service definition

GET /documentation

service definition

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

200 OK

Success

Not currently supported

PUT /{parm_name}/{parm_type}/{parm_value}/{year_term}

Tags: RelationshipService

Not currently supported

parm_name

parameter name

path string
parm_type

parameter type

path string
parm_value

parameter value

path string
year_term

Year and term

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.

Shows page using the specified person Id

GET /{personID}

Tags: RelationshipService

Shows page using the specified person Id

personID

string -> 9 digit #

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
{
"RelationshipService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"maximumAllowedRelationships": "20",
"relationshipInformation": [
{
"age": 23,
"employeeRole": "Non-Employee",
"gender": "F",
"maritalStatus": "Married",
"personID": "888777666",
"preferredName": "Jane Doe",
"relationship": "Spouse",
"studentRole": "Non-Matriculated",
"verified": "HR"
}
]
,
"relationshipsSaved": "1",
"spouse": "Y"
}
}
}
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

documentation: object

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

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

Relationship: object

RelationshipService: object
request: request
response: response

relationshipInformation: object[]

object
preferredName: string
relationship: string
maritalStatus: string
age: integer
gender: string
studentRole: string
employeeRole: string
personID: string
verified: string

request: object

method: string
resource: string
attributes: string
status: integer
statusMessage: string

response: object

relationshipsSaved: string
spouse: string
relationshipInformation: relationshipInformation
maximumAllowedRelationships: string
Service Path: 
/domains/legacy/identity/person/PRO/relationship
Domain or University API: 
/domains/D/identity/person/PRO/relationship

Community

 

Don't see your question listed here? Ask!