AcademicRegistrationStudentFlags

AcademicRegistrationStudentFlags

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

Base URL: /domains/legacy/academic/registration/student_flags

Version: v1

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

Summary

Path Operation Description
/{person_id} GET

Get the flags and holds for the authenticated user.

PUT

Create a new flag or hold.

/{person_id}/{flag_name}/{flag_value} DELETE

Delete a student's flag or hold.

PUT

Update a student's flag or hold.

Paths

Get the flags and holds for the authenticated user.

GET /{person_id}

Tags: AcademicRegistrationStudentFlags

Get the flags and holds for the authenticated user.

person_id

string ->

path string

Uses default content-types: application/json

200 OK
Example for applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/joestud",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"current_flags_and_holds": [
{
"blocks": "N/A",
"byu_id": "123456789",
"contact": "Contact Academic Support Office, 2500 WSC, (801) 422-2723",
"credit_institution": "BYU PROVO",
"dateset": "27 Dec 2016",
"description": "Academic Support Flag/Hold",
"effective_date": "08 Jan 2018",
"expired_date": "31 Dec 2999",
"name": "ACDSTD",
"set_by_byu_id": "",
"user": "ACDSTDCLI",
"value": "GOOD",
"yearterm": ""
},
{
"blocks": "N/A",
"byu_id": "123456789",
"contact": "Registration Office B-130 ASB (801) 422-2631",
"credit_institution": "BYU PROVO",
"dateset": "22 Sep 2017",
"description": "Registration Priority Flag",
"effective_date": "08 Jan 2018",
"expired_date": "25 Apr 2018",
"name": "REGTIME",
"set_by_byu_id": "",
"user": "BATCH",
"value": "16",
"yearterm": "Winter 2018"
},
{
"blocks": "N/A",
"byu_id": "123456789",
"contact": "Academic Support Office, 2500 WSC, (801) 422-2723",
"credit_institution": "BYU PROVO",
"dateset": "03 Jan 2018",
"description": "Academic Threshold",
"effective_date": "08 Jan 2018",
"expired_date": "31 Dec 2999",
"name": "ACDSTD THRESHOLD",
"set_by_byu_id": "",
"user": "ACDSTDCLC",
"value": "N/A",
"yearterm": ""
}
]
,
"future_flags_and_holds": [
{
"blocks": "N/A",
"byu_id": "123456789",
"contact": "Registration Office B-130 ASB (801) 422-2631",
"credit_institution": "BYU PROVO",
"dateset": "26 Jan 2018",
"description": "Registration Priority Flag",
"effective_date": "04 Sep 2018",
"expired_date": "20 Dec 2018",
"name": "REGTIME",
"set_by_byu_id": "",
"user": "BATCH",
"value": "15",
"yearterm": "Fall 2018"
}
]
}
}
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.

Create a new flag or hold.

PUT /{person_id}

Tags: AcademicRegistrationStudentFlags

Create a new flag or hold.

person_id

string ->

path string
new_flag_name

string ->

query string
new_flag_value

string ->

query string
new_effective_date

string -> DD Mon YYYY (note: Spaces are required!)

query string
new_expired_date

string -> DD Mon YYYY (note: Spaces are required!)

query string
new_year_term

string ->

query string

Uses default content-types: application/json

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.

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 a student's flag or hold.

DELETE /{person_id}/{flag_name}/{flag_value}

Tags: AcademicRegistrationStudentFlags

Delete a student's flag or hold.

person_id

string ->

path string
flag_name

string ->

path string
flag_value

string ->

path string
new_year_term

string ->

query string
old_effective_date

string -> DD Mon YYYY (note: Spaces are required!)

query string
old_expired_date

string -> DD Mon YYYY (note: Spaces are required!)

query string

Uses default content-types: application/json

204 No Content

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.

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.

Update a student's flag or hold.

PUT /{person_id}/{flag_name}/{flag_value}

Tags: AcademicRegistrationStudentFlags

Update a student's flag or hold.

person_id

string ->

path string
flag_name

string ->

path string
flag_value

string ->

path string
old_effective_date

string -> DD Mon YYYY (note: Spaces are required!)

query string
old_expired_date

string -> DD Mon YYYY (note: Spaces are required!)

query string
new_effective_date

string -> DD Mon YYYY (note: Spaces are required!)

query string
new_expired_date

string -> DD Mon YYYY (note: Spaces are required!)

query string
new_year_term

string -> DD Mon YYYY (note: Spaces are required!)

query string

Uses default content-types: application/json

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.

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

attributes: string

blocks: string

byu_id: string

contact: string

credit_institution: string

current_flags_and_holds: object[]

dateset: string

description: string

effective_date: string

expired_date: string

flag_details: object

byu_id: byu_id
credit_institution: credit_institution
name: name
value: value
description: description
blocks: blocks
dateset: dateset
user: user
yearterm: yearterm
effective_date: effective_date
expired_date: expired_date
contact: contact
set_by_byu_id: set_by_byu_id

future_flags_and_holds: object[]

method: string

name: string

RegStdFlagsService: object

request: request
response: response

request: object

method: method
resource: resource
attributes: attributes
status: status
statusMessage: statusMessage

resource: string

response: object

current_flags_and_holds: current_flags_and_holds
future_flags_and_holds: future_flags_and_holds

set_by_byu_id: string

status: integer

statusMessage: string

user: string

value: string

yearterm: string

Service Path: 
/domains/legacy/academic/registration/student_flags
Domain or University API: 
/domains/D/academic/registration/student_flags

Community

 

Don't see your question listed here? Ask!