IdentityAccessPageControl

PageControlService

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

Base URL: /domains/legacy/identity/access/pagecontrol

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{personId}/{webResourceId}/{creditInstitution} GET

Show page control info for the parameters given

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Show page control info for the parameters given

GET /{personId}/{webResourceId}/{creditInstitution}

Tags: PageControlService

Show page control info for the parameters given

personId

string -> 9 digit number

path string
webResourceId

string -> 8 digit number

path string
creditInstitution

string ->

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"PageControlService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789/00001064/BYU PROVO",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"Authorizations": [
{
"InformationalArea": "REGADDDROPVIEW",
"LimitationType": "SOMETYPE",
"LimitationValue": "SomeValue",
"UpdateType": "X"
}
]
,
"CanUpdate": "N",
"FeedbackBCC": "example3@byu.edu",
"FeedbackCC": "example2@byu.edu",
"FeedbackTo": "example@byu.edu",
"IconURL": "AIM@../../user_help/cgi/mainMenu.cgi",
"OutOfService": "N",
"PageName": "Registration",
"ProductID": "001062",
"ProductName": "Registration Management",
"RestrictedFlag": "N",
"SpeedURL": "REG01"
}
}
}
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.

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

Authorizations: object[]

object
InformationalArea: string
LimitationType: string
LimitationValue: string
UpdateType: string

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

pageControl: object

PageControlService: object
request: request
response: response

request: object

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

response: object

PageName: string
SpeedURL: string
ProductID: string
ProductName: string
OutOfService: string
RestrictedFlag: string
IconURL: string
FeedbackTo: string
FeedbackCC: string
FeedbackBCC: string
CanUpdate: string
Authorizations: Authorizations
Service Path: 
/domains/legacy/identity/access/pagecontrol
Domain or University API: 
/domains/D/identity/access/pagecontrol

Community

 

Don't see your question listed here? Ask!