AcademicControlsFlagsAndHolds

This service allows for maintenance of flag names and values

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

Base URL: /domains/legacy/academic/controls/flagsandholds

Version: v1

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

Summary

Path Operation Description
/ GET

Shows a list of 100 flags after the given search parameter, if you would like the next 100 search the last record in the list

/documentation GET

service definition

/{flag_name} GET

Shows a list of valid owners

PUT

Creates a new flag with all of the given parameters

Paths

Shows a list of 100 flags after the given search parameter, if you would like the next 100 search the last record in the list

GET /

Tags: FlagsAndHoldsService

Shows a list of 100 flags after the given search parameter, if you would like the next 100 search the last record in the list

search

string ->

query string

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

200 OK

Shows a list of 100 flags based on the search value

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"Flags": [
{
"Credit_Institution": "BYU PROVO",
"Description": "Academic Block Hold",
"Flag_Name": "ACDBLK",
"Flag_Owner": "OWNER-ACDSUPPORT"
}
]
}
}
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

Shows a list of valid owners

GET /{flag_name}

Tags: FlagsAndHoldsService

Shows a list of valid owners

flag_name

string ->

path string

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

200 OK

Shows the owner(s) and values of a given flag

Example for application/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/ACDBLK/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"flag_name": "ACDBLK",
"flag_owner": "OWNER-ACDSUPPORT",
"flag_values": [
{
"date_time_updated": "21 Nov 2002",
"description": "Need Academic Plan",
"effective_date": "01 Jan 1900",
"expired_date": "31 Dec 2999",
"flag_value": "PLAN",
"hold_type": "REGISTRATION",
"status": "current"
}
]
,
"flags": [
{
"date_time_updated": "23 Nov 2016",
"description": "Academic Block Hold",
"effective_date": "01 Jan 1900",
"expired_date": "31 Dec 2999",
"requires_value_flag": "Y",
"requires_year_term_flag": "N",
"status": "current",
"stored_value": "Y",
"updated_by_name": "Person, Name"
}
]
,
"output": ""
}
}
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.

Creates a new flag with all of the given parameters

PUT /{flag_name}

Tags: FlagsAndHoldsService

Creates a new flag with all of the given parameters

flag_name

string ->

path string
flag_owner

string ->

query string
stored_value

string ->

query boolean
new_effective_date

string -> ddMonYYYY

query string
new_expired_date

string ->

query string
description

string ->

query string

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

200 OK

Adds a new flag to the system with the given parameter values

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

Credit_Institution: string

date_time_updated: string

description: string

Description: string

effective_date: string

expired_date: string

Flag_Name: string

flag_name: string

Flag_Owner: string

flag_owner: string

flag_value: string

flag_values: object[]

object
status: status
flag_value: flag_value
effective_date: effective_date
expired_date: expired_date
hold_type: hold_type
description: description
date_time_updated: date_time_updated

flagResponse: object

output: output
flag_name: flag_name
flag_owner: flag_owner
flags: flags
flag_values: flag_values

Flags: object[]

object
Flag_Name: Flag_Name
Flag_Owner: Flag_Owner
Description: Description
Credit_Institution: Credit_Institution

flags: object[]

object
status: status
requires_year_term_flag: requires_year_term_flag
requires_value_flag: requires_value_flag
stored_value: stored_value
effective_date: effective_date
expired_date: expired_date
date_time_updated: date_time_updated
updated_by_name: updated_by_name
description: description

FlagsService: object

request: request
response: response

hold_type: string

output: string

request: object

method: string
resource: string
attributes: string
status: number
statusMessage: string

requires_value_flag: string

requires_year_term_flag: string

response: object

Flags: Flags

SpecificFlag: object

request: request
response: flagResponse

status: string

stored_value: string

updated_by_name: string

Service Path: 
/domains/legacy/academic/controls/flagsandholds
Domain or University API: 
/domains/D/academic/controls/flagsandholds

Community

 

Don't see your question listed here? Ask!