AcademicRegistrationDrop
DropClassService
Base URL: /domains/legacy/academic/registration/drop
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/{person_id}/{year_term} | DELETE | Drop all classes for the specified person_id and year_term. |
/{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number} | DELETE | Drops class for the specified person_id, year_term, curriculum_id, title_code, and section_number, and drops all postrequisites of the class (prerequisites that are registered for any future year terms), and if the class is part of an envelope that cannot be broken, it will drop any other classes in the envelope and their cascading effects. |
/{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number}?* | DELETE | Drops class for the specified person_id, year_term, curriculum_id, title_code, and section_number, and drops all postrequisites of the class (prerequisites that are registered for any future year terms), and if the class is part of an envelope that cannot be broken, it will drop any other classes in the envelope and their cascading effects. |
/{person_id}/{year_term}/{envelope_id} | DELETE | Drop all classes for the specified person_id and year_term and envelope_id. |
Paths
DELETE /{person_id}/{year_term}
Tags: AcademicRegistrationDropDrop all 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 |
Uses default content-types: application/json
- 204 No Content
-
Service request is OK and the Drop has been completed.
- 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 /{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number}
Tags: AcademicRegistrationDropDrops class for the specified person_id, year_term, curriculum_id, title_code, and section_number, and drops all postrequisites of the class (prerequisites that are registered for any future year terms), and if the class is part of an envelope that cannot be broken, it will drop any other classes in the envelope and their cascading effects.
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 | |
event_source | client source indicator iOS, Android etc... Temporary until we can get this from the app id. | query | string |
Uses default content-types: application/json
- 204 No Content
-
Service request is OK and the Drop has been completed.
- 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 /{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number}?*
Tags: AcademicRegistrationDropDrops class for the specified person_id, year_term, curriculum_id, title_code, and section_number, and drops all postrequisites of the class (prerequisites that are registered for any future year terms), and if the class is part of an envelope that cannot be broken, it will drop any other classes in the envelope and their cascading effects.
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 | |
event_source | client source indicator iOS, Android etc... Temporary until we can get this from the app id. | query | string |
Uses default content-types: application/json
- 204 No Content
-
Service request is OK and the Drop has been completed.
- 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 /{person_id}/{year_term}/{envelope_id}
Tags: AcademicRegistrationDropDrop all 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 |
Uses default content-types: application/json
- 204 No Content
-
Service request is OK and the Drop has been completed.
- 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.