AcademicRegistrationDropImplications
Academic Registration Drop Implications - DropClassConfirmService
Base URL: /domains/legacy/academic/registration/drop_implications
Version: v1.0
Summary
Path | Operation | Description |
---|---|---|
/{person_id} | GET | Retrieve all drop implications for classes for the specified person_id. The active year terms are assumed as the list of year terms to retrieve. |
/{person_id}/{year_term} | GET | Retrieve all drop implications for classes for the specified person_id and year_term. |
/{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number} | GET | Retrieve all drop implications for the class for the specified person_id, year_term, curriculum_id, title_code, and section_number. |
/{person_id}/{year_term}/{envelope_id} | GET | Retrieve all drop implications for classes for the specified person_id and year_term and envelope_id |
Paths
GET /{person_id}
Tags: AcademicRegistrationDropRetrieve all drop implications for classes for the specified person_id. The active year terms are assumed as the list of year terms to retrieve.
person_id | string -> | path | string | |
simulate | simulate | 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.
GET /{person_id}/{year_term}
Tags: AcademicRegistrationDropRetrieve all drop implications for classes for the specified person_id and year_term.
person_id | string -> | path | string | |
year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
simulate | simulate | query | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/000000000/20181/11661/000/001",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"action_heading": "Drop Confirmation",
"action_message": "All of your classes for Winter Semester 2018 will be dropped.",
"curriculum_id": "11661",
"discon_msg_list": [
"You are requesting to discontinue for Winter Semester 2018. Please note the following before proceeding:",
"Dropping all your classes beginning the first day of class results in a withdraw date placed on your transcript. If you intend to add more classes, you should add them before dropping the last class on your schedule.",
"If you are a day continuing student wanting to take a Leave of Absence this semester, review the information on Leave of Absence at onestop.byu.edu/leaveofabsence before proceeding.",
"If you have been newly admitted for this enrollment, discontinuing will remove your admission status. If you are planning to return for a future semester/term, you also need to contact the Admissions Office at 801-422-2507 for information on reapplication.",
"If you are an International Student, you must get clearance from International Student Services (1351 WSC, 801-422-2695) before you discontinue.",
"For more information, please visit discontinuance.byu.edu"
],
"discon_reason_list": [
{
"reason_text": "Academic Problems",
"reason_value": "Academic Problems"
}
],
"discontinuing": "Y",
"drop_implications_set": [
{
"course_name": "NES 395R section 001",
"curriculum_id": "11661",
"envelope_id": "",
"impacted": "",
"section_number": "001",
"title_code": "000",
"year_term": "20183"
}
],
"has_postreqs": "N",
"opid": "",
"prereq_info_msg_list": [
"If you drop or withdraw from a class that is a prerequisite to another class for which you have registered in the future, that future class will also be dropped. If that future class is a prerequisite to another class in your future registration, that class will also be dropped. And so on.",
"If any of these classes are part of an envelope that cannot be broken, then those classes and their post-requisites will also be dropped/withdrawn."
],
"prq_drop": "Y",
"section_number": "001",
"title_code": "000",
"year_term": "20181"
}
} - 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.
GET /{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number}
Tags: AcademicRegistrationDropRetrieve all drop implications for the class for the specified person_id, year_term, curriculum_id, title_code, and section_number.
person_id | string -> | path | string | |
year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
curriculum_id | curriculum_id -> [0-9]{5} | path | string | |
title_code | title_code -> [0-9]{3} | path | string | |
section_number | section_number -> [0-9]{3} | path | string | |
simulate | simulate | 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.
GET /{person_id}/{year_term}/{envelope_id}
Tags: AcademicRegistrationDropRetrieve all drop implications for classes for the specified person_id and year_term and envelope_id.
person_id | string -> | path | string | |
year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
envelope_id | envelope_id -> [0-9]{5} | path | string | |
simulate | simulate | 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
- envelope_id: string
-
- section_number: string
-
- title_code: string
-
- curriculum_id: string
-
- course_name: string
-
- year_term: string
-
- impacted: string
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- year_term: string
-
- opid: string
-
- has_postreqs: string
-
- prereq_info_msg_list: string[]
-
string - discontinuing: string
-
- discon_msg_list: string[]
-
string - discon_reason_list: object[]
-
object - reason_value: string
-
- reason_text: string
-
- section_number: string
-
- action_heading: string
-
- action_message: string
-
- title_code: string
-
- curriculum_id: string
-
- prq_drop: string
-
- drop_implications_set: object[]