autoreg
Base URL: /regapi/carts
Version: 0.0.1
Summary
Paths
GET /
Retrieve a collection of carts
person_id | The person_id of the student for whom the cart is for | query | string | #/parameters/query_person_id |
year_term_list | The comma separated list of year terms to get | query | string | #/parameters/query_year_term_list |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No carts satisfy the query paramters - the collection is empyt"
- default
-
Error
GET /check
check endpoint
Uses default content-types: application/json
- 200 OK
-
Success
- default
-
Error
GET /health
health check endpoint
Uses default content-types: application/json
- 200 OK
-
Success
- default
-
Error
GET /nolog
Retrieve a collection of carts
person_id | The person_id of the student for whom the cart is for | query | string | #/parameters/query_person_id |
year_term_list | The comma separated list of year terms to get | query | string | #/parameters/query_year_term_list |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No carts satisfy the query paramters - the collection is empyt"
- default
-
Error
GET /{person_id},{year_term}
Retrieve cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
POST /{person_id},{year_term}
Process Cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
PUT /{person_id},{year_term}/checkout_status
sets the checkout status of the cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
checkout_status | The class structure to be added to the cart | body | object | #/parameters/body_checkout |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
DELETE /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number}
Removes a class from the cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
curriculum_id | The curriculum_id of the class to be added to the cart | path | string | #/parameters/curriculum_id |
title_code | The title-code of the class to be added to the cart | path | string | #/parameters/title_code |
section_number | The section_number of the class to be added to the cart | path | string | #/parameters/section_number |
Uses default content-types: application/json
- 204 No Content
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
PUT /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number}
adds class request to the cart
Uses default content-types: application/json
The class structure to be added to the cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
curriculum_id | The curriculum_id of the class to be added to the cart | path | string | #/parameters/curriculum_id |
title_code | The title-code of the class to be added to the cart | path | string | #/parameters/title_code |
section_number | The section_number of the class to be added to the cart | path | string | #/parameters/section_number |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
PUT /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number},{credit_hours}
adds class request to the cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
curriculum_id | The curriculum_id of the class to be added to the cart | path | string | #/parameters/curriculum_id |
title_code | The title-code of the class to be added to the cart | path | string | #/parameters/title_code |
section_number | The section_number of the class to be added to the cart | path | string | #/parameters/section_number |
credit_hours | The credit_hours of variable credit hour classes | path | string | #/parameters/credit_hours |
class_hrs_body_parameters | The class structure to be added to the cart | body | object | #/parameters/body_credit_hours |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
DELETE /{person_id},{year_term}/envelope_requests/{envelope_id}
Removes an envelope request from the cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
envelope_id | The envelope_id of the envelope request to be added to the class | path | string | #/parameters/envelope_id |
Uses default content-types: application/json
- 204 No Content
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
PUT /{person_id},{year_term}/envelope_requests/{envelope_id}
Adds an envelope request to the cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
envelope_id | The envelope_id of the envelope request to be added to the class | path | string | #/parameters/envelope_id |
envelope | The envelope structure to be added to the cart | body | object | #/parameters/body_envelope |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
GET /{person_id},{year_term}/nolog
Retrieve cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
PUT /{person_id},{year_term}/prioritizeClassEnvelope
set the class and envelope priority using an array of class objects containing priorityIndex, curriculum_id, title_code and section_number and envelope objects containing a priorityIndex and envelope_id
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
priority | The class and envelope priority list | body | object | #/parameters/body_priority |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
GET /{person_id},{year_term}/status
retrieve the cart status
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
Uses default content-types: application/json
- 200 OK
-
Success
- 401 Unauthorized
-
Authentication required to access data
PUT /{person_id},{year_term}/waitlist_status
sets the waitlist property of the cart
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
year_term | The year_term for which the cart pertains | path | string | #/parameters/year_term |
waitlist_status | The waitliat status to be added to the cart | body | object | #/parameters/body_waitlist |
Uses default content-types: application/json
- 200 OK
-
Success
- 400 Bad Request
-
Invalid Request - unable to interpret request
- 401 Unauthorized
-
Authentication required to access data
- 403 Forbidden
-
Access denied to protected data
- 404 Not Found
-
No cart satisfies the query paramters - the collection is empyt"
- default
-
Error
GET /{person_id}/yearTerms
get year terms with carts
person_id | The person_id of the student for whom the cart is for | path | string | #/parameters/person_id |
Uses default content-types: application/json
- 200 OK
-
Success
- default
-
Error
Parameter definitions
Schema definitions
- person_id: string
-
- year_term: string
-
- curriculum_id: string
-
- title_code: string
-
- section_number: string
-
An array containing the ordering of classes and envelopes
This is either a class object containing priorityIndex, curriculum_id, title_code and section_number or an envelope object containing a priorityIndex and envelope_id. Since swagger doesn't have an expression for "objectA or objectB" i've left it as just an object.
- person_id: string
-
- year_term: string
-
- curriculum_id: string
-
- title_code: string
-
- section_number: string
-
- credit_hours: string
-
- person_id: string
-
- year_term: string
-
- curriculum_id: string
-
- title_code: string
-
- section_number: string
-
- dept_name: string
-
- catalog_number: string
-
- catalog_suffix: string
-
- course: string
-
- credit_hours: string
-
- course_title: string
-
- audit_type: string
-
- instructor: string
-
- days_taught: string
-
- time_taught: string
-
- location: string
-
- updated: updated
-
- links: object
-
Hypermedia links that impact this Class_Request
- classes.remove_class: link
-
Hypermedia link format
- rel: string
-
- href: string (uri)
-
- method: string , x ∈ { DELETE , GET , OPTIONS , POST , PUT }
-
- title: string
-
- collection_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_start: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_end: integer , { x ∈ ℤ | x ≥ 0 }
-
- page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
-
- maximum_page_size: integer , { x ∈ ℤ | x ≥ 0 }
-
- field_sets_returned: object[]
- field_sets_available: object[]
- default_field_sets: object[]
- contexts: contexts
-
- validation_response: validation_response
-
- person_id: string
-
- year_term: string
-
- waitlist: boolean
-
- checkout: boolean
-
- processed: boolean
-
- processed_date_time: number
-
- processed_success: boolean
-
- processed_envelopes: object[]
- processed_classes: object[]
- person_id: string
-
- year_term: string
-
- curriculum_id: string
-
- title_code: string
-
- section_number: string
-
- class_log_id: string
-
- dept_name: string
-
- catalog_number: string
-
- catalog_suffix: string
-
- credit_hours: string
-
- course_title: string
-
- person_id: string
-
- year_term: string
-
- envelope_id: string
-
- envelope_log_id: string
-
- processed_classes: object[]