AcademicRegistrationRegStdFlags
This service can get, modify, update, and delete the Flags and Holds for a particular student in the AIM System.
Base URL: /domains/legacy/academic/registration/regstdflags
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /{identifier_type}/{identifier} | GET | Get the flags and holds for the specified person. |
| /{person_id}* | DELETE | Delete a student's flag or hold. |
| GET | Get the flags and holds for the authenticated user. | |
| PUT | Update student flag or hold |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{identifier_type}/{identifier}
Tags: RegStdFlagsServiceGet the flags and holds for the specified person.
| identifier_type | string -> | path | string | |
| identifier | string -> | 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{
"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": "CDSTDCLI",
"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.
- 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.
- 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.
| person_id | string -> | path | string | |
| flag_name | string -> | query | string | |
| flag_value | string -> | query | string | |
| eff_date | Date originally was effective-DD MM YYYY (spaces required) | query | string (date) | |
| exp_date | Date originally was expired-DD MM YYYY (spaces required) | query | string (date) | |
| new_year_term | New year and term | query | string (date) |
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.
- 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.
Get the flags and holds for the authenticated user.
| person_id | string -> | 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{
"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": "CDSTDCLI",
"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.
- 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.
- 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 student flag or hold
| person_id | string -> | path | string | |
| flag_name | string -> | query | string | |
| flag_value | string -> | query | string | |
| old_effective_date | Date originally was effective-DD MM YYYY (spaces required) | query | string (date) | |
| old_expired_date | Date originally was expired-DD MM YYYY (spaces required) | query | string (date) | |
| new_effective_date | New date becoming effective-DD MM YYYY (spaces required) | query | string (date) | |
| new_expired_date | New date will become expired-DD MM YYYY (spaces required) | query | string (date) | |
| new_year_term | New year and term | query | string (date) |
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.
- 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
- 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
-
- 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
-
- status: status
-
- resource: resource
-
- method: method
-
- attributes: attributes
-
- statusMessage: statusMessage
-
- current_flags_and_holds: object[]
- future_flags_and_holds: object[]
