autoreg

Base URL: /regapi/carts

Version: 0.0.1

Default request content-types: application/json

Default response content-types: application/json

Schemes: https

Summary

Path	Operation	Description
/	GET
/	OPTIONS
/check	GET
/check	OPTIONS
/health	GET
/health	OPTIONS
/nolog	GET
/nolog	OPTIONS
/{person_id},{year_term}	GET
	OPTIONS
	POST
/{person_id},{year_term}/checkout_status	OPTIONS	autoreg
/{person_id},{year_term}/checkout_status	PUT
/{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number}	DELETE
	OPTIONS	autoreg
	PUT
/{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number},{credit_hours}	OPTIONS	autoreg
	PUT
/{person_id},{year_term}/envelope_requests/{envelope_id}	DELETE
	OPTIONS	autoreg
	PUT
/{person_id},{year_term}/nolog	GET
/{person_id},{year_term}/nolog	OPTIONS
/{person_id},{year_term}/prioritizeClassEnvelope	OPTIONS	autoreg
/{person_id},{year_term}/prioritizeClassEnvelope	PUT
/{person_id},{year_term}/status	GET
/{person_id},{year_term}/status	OPTIONS	autoreg
/{person_id},{year_term}/waitlist_status	OPTIONS
/{person_id},{year_term}/waitlist_status	PUT
/{person_id}/yearTerms	GET
/{person_id}/yearTerms	OPTIONS

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

carts
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No carts satisfy the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

OPTIONS /

Uses default content-types: application/json

200 OK: supported http methods are not customizable with swagger

GET /check

check endpoint

Uses default content-types: application/json

200 OK: Success

carts
default: Error

ErrorResponse

OPTIONS /check

Uses default content-types: application/json

200 OK: supported http methods are not customizable with swagger

GET /health

health check endpoint

Uses default content-types: application/json

200 OK: Success

carts
default: Error

ErrorResponse

OPTIONS /health

Uses default content-types: application/json

200 OK: supported http methods are not customizable with swagger

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

carts
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No carts satisfy the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

OPTIONS /nolog

Uses default content-types: application/json

200 OK: supported http methods are not customizable with swagger

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

cart
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

OPTIONS /{person_id},{year_term}


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: supported http methods are not customizable with swagger

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

processed_cart
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

autoreg

OPTIONS /{person_id},{year_term}/checkout_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: supported http methods are not customizable with swagger

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

checkout_status
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse

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

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

autoreg

OPTIONS /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number}


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: supported http methods are not customizable with swagger

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

class_body_parameters


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

class_request
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

autoreg

OPTIONS /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number},{credit_hours}


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

Uses default content-types: application/json

200 OK: supported http methods are not customizable with swagger

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

class_request
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

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

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

autoreg

OPTIONS /{person_id},{year_term}/envelope_requests/{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
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

200 OK: supported http methods are not customizable with swagger

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

envelope_request
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

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

cart
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

OPTIONS /{person_id},{year_term}/nolog


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: supported http methods are not customizable with swagger

autoreg

OPTIONS /{person_id},{year_term}/prioritizeClassEnvelope


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: supported http methods are not customizable with swagger

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

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse

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

ErrorResponse

autoreg

OPTIONS /{person_id},{year_term}/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: supported http methods are not customizable with swagger

OPTIONS /{person_id},{year_term}/waitlist_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: supported http methods are not customizable with swagger

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

waitlist_status
400 Bad Request: Invalid Request - unable to interpret request

ErrorResponse
401 Unauthorized: Authentication required to access data

ErrorResponse
403 Forbidden: Access denied to protected data

ErrorResponse
404 Not Found: No cart satisfies the query paramters - the collection is empyt"

ErrorResponse
default: Error

ErrorResponse

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

carts
default: Error

ErrorResponse

OPTIONS /{person_id}/yearTerms


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: supported http methods are not customizable with swagger

Parameter definitions


body_checkout	checkout_status	The class structure to be added to the cart	body	object
body_credit_hours	class_hrs_body_parameters	The class structure to be added to the cart	body	object
body_priority	priority	The class and envelope priority list	body	object
body_envelope	envelope	The envelope structure to be added to the cart	body	object
body_waitlist	waitlist_status	The waitliat status to be added to the cart	body	object
credit_hours	credit_hours	The credit_hours of variable credit hour classes	path	string
curriculum_id	curriculum_id	The curriculum_id of the class to be added to the cart	path	string
envelope_id	envelope_id	The envelope_id of the envelope request to be added to the class	path	string
person_id	person_id	The person_id of the student for whom the cart is for	path	string
query_person_id	person_id	The person_id of the student for whom the cart is for	query	string
query_year_term_list	year_term_list	The comma separated list of year terms to get	query	string
section_number	section_number	The section_number of the class to be added to the cart	path	string
title_code	title_code	The title-code of the class to be added to the cart	path	string
year_term	year_term	The year_term for which the cart pertains	path	string

Schema definitions

cart: object

a cart representing student class and encelope requests for a semester

carts: object

A collection of carts

links: object

Hypermedia links that impact the entire collection of Carts

carts.info: link
carts.prev: link
carts.next: link

metadata: metadata

values: object[]

cart

checkout_status: object

links: object

Hypermedia links that impacr the entire collection of class_requests

class_request.info: link

checkout: boolean

postPriority: boolean

current_state: string

next_state: string

updated: updated

checkout_status_item: object

checkout: boolean

class_body_parameters: object

person_id: string
year_term: string
curriculum_id: string
title_code: string
section_number: string

class_envelope_priority: object[]

An array containing the ordering of classes and envelopes

object

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.

class_hrs_body_parameters: object

person_id: string
year_term: string
curriculum_id: string
title_code: string
section_number: string
credit_hours: string

class_request: object

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

contexts: object

Contexts

all: object[]: object

envelope_request: object

ErrorResponse: object

message: string

field_set_strings: string , x ∈ { basic }

List of available field sets

link: object

Hypermedia link format

rel: string
href: string (uri)
method: string , x ∈ { DELETE , GET , OPTIONS , POST , PUT }
title: string

metadata: object

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_set_strings
field_sets_available: object[]: field_set_strings
default_field_sets: object[]: field_set_strings
contexts: contexts
validation_response: validation_response

processed_cart: object

person_id: string
year_term: string
waitlist: boolean
checkout: boolean
processed: boolean
processed_date_time: number
processed_success: boolean
processed_envelopes: object[]: processed_envelope
processed_classes: object[]: processed_class

processed_class: 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

processed_envelope: object

person_id: string
year_term: string
envelope_id: string
envelope_log_id: string
processed_classes: object[]: processed_class

updated: object

person_id: string
name: string
date_time: number

validation_response: object

return_code: integer
response: string

waitlist_status: object

links: object

Hypermedia links that impacr the entire collection of class_requests

class_request.info: link

waitlist: boolean

current_state: string

next_state: string

updated: updated

waitlist_status_item: object

waitlist: boolean

Service Path:

/regapi/carts

Domain or University API:

/regapi/carts

Tags:

regapi

carts

autoreg

autoreg

Summary

Paths

GET /

OPTIONS /

GET /check

OPTIONS /check

GET /health

OPTIONS /health

GET /nolog

OPTIONS /nolog

GET /{person_id},{year_term}

OPTIONS /{person_id},{year_term}

POST /{person_id},{year_term}

OPTIONS /{person_id},{year_term}/checkout_status

PUT /{person_id},{year_term}/checkout_status

DELETE /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number}

OPTIONS /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number}

PUT /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number}

OPTIONS /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number},{credit_hours}

PUT /{person_id},{year_term}/class_requests/{curriculum_id},{title_code},{section_number},{credit_hours}

DELETE /{person_id},{year_term}/envelope_requests/{envelope_id}

OPTIONS /{person_id},{year_term}/envelope_requests/{envelope_id}

PUT /{person_id},{year_term}/envelope_requests/{envelope_id}

GET /{person_id},{year_term}/nolog

OPTIONS /{person_id},{year_term}/nolog

OPTIONS /{person_id},{year_term}/prioritizeClassEnvelope

PUT /{person_id},{year_term}/prioritizeClassEnvelope

GET /{person_id},{year_term}/status

OPTIONS /{person_id},{year_term}/status

OPTIONS /{person_id},{year_term}/waitlist_status

PUT /{person_id},{year_term}/waitlist_status

GET /{person_id}/yearTerms

OPTIONS /{person_id}/yearTerms

Parameter definitions

Schema definitions

cart: object

carts: object

checkout_status: object

checkout_status_item: object

class_body_parameters: object

class_envelope_priority: object[]

class_hrs_body_parameters: object

class_request: object

contexts: object

envelope_request: object

ErrorResponse: object

field_set_strings: string , x ∈ { basic }

link: object

metadata: object

processed_cart: object

processed_class: object

processed_envelope: object

updated: object

validation_response: object

waitlist_status: object

waitlist_status_item: object

Community

View This API in the API Store

Get Elevated Access

Tags