AcademicRegistrationIsClassAddible

IsClassAddibleService

More information: https://it.byu.edu
Contact Info: api@byu.edu

Base URL: /domains/legacy/academic/registration/isclassaddible

Version: v1

Default response content-types: application/json
Schemes: https

Summary

Path Operation Description
/documentation GET

service definition

/{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number} GET

Find out if the class is addible.

/{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number}/{variable_credit_hours} GET

Find out if the class is addible.

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json

200 OK

Success

Find out if the class is addible.

GET /{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number}

Tags: IsClassAddibleService

Find out if the class is addible.

person_id

string ->

path string
year_term

yearTerm -> [1-2][0-9]{3}[1345]

path string
curriculum_id

string ->

path string
title_code

string ->

path string
section_number

string ->

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/123456789/20185/05620/005/001",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"class_is_addible": "N",
"curriculum_id": "05620",
"holds": [
{
"first": "first"
},
{
"second": "second"
}
]
,
"max_evening_hours": "18.0",
"max_hours": "18.0",
"not_addible_possible_reasons": [
{
"reason_code": "1",
"reason_description": "It is currently during the athlete freeze period where only counselors can change an athlete's class schedule"
},
{
"reason_code": "2",
"reason_description": "You cannot register for a block section and semester section of the same course"
}
]
,
"number_of_reasons": "2",
"person_id": "123456789",
"reasons": [
{
"reason": "You need an ecclesiastical endorsement for Fall Semester 2018. For more information, please contact the Honor Code Office, 4440 WSC, (801) 422-2847",
"reason_code": "3"
},
{
"reason": "You are trying to add a course that has prerequisites that have not been met. In order to register for this class you must complete or register for those prerequisites prior to the semester or term in which you plan to take this class.",
"reason_code": "18"
}
]
,
"section_number": "001",
"title_code": "005",
"year_term": "20185"
}
}
204 No Content

Service request is OK but the response is the empty set - no content found.

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.

Find out if the class is addible.

GET /{person_id}/{year_term}/{curriculum_id}/{title_code}/{section_number}/{variable_credit_hours}

Tags: IsClassAddibleService

Find out if the class is addible.

person_id

string ->

path string
year_term

yearTerm -> [1-2][0-9]{3}[1345]

path string
curriculum_id

string ->

path string
title_code

string ->

path string
section_number

string ->

path string
variable_credit_hours

string ->

path string

Uses default content-types: application/json

200 OK

Service request is OK and a response has been generated.

Example for applications/json
{
"request": {
"attributes": "",
"method": "GET",
"resource": "/123456789/20185/05620/005/001",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"class_is_addible": "N",
"curriculum_id": "05620",
"holds": [
{
"first": "first"
},
{
"second": "second"
}
]
,
"max_evening_hours": "18.0",
"max_hours": "18.0",
"not_addible_possible_reasons": [
{
"reason_code": "1",
"reason_description": "It is currently during the athlete freeze period where only counselors can change an athlete's class schedule"
},
{
"reason_code": "2",
"reason_description": "You cannot register for a block section and semester section of the same course"
}
]
,
"number_of_reasons": "2",
"person_id": "123456789",
"reasons": [
{
"reason": "You need an ecclesiastical endorsement for Fall Semester 2018. For more information, please contact the Honor Code Office, 4440 WSC, (801) 422-2847",
"reason_code": "3"
},
{
"reason": "You are trying to add a course that has prerequisites that have not been met. In order to register for this class you must complete or register for those prerequisites prior to the semester or term in which you plan to take this class.",
"reason_code": "18"
}
]
,
"section_number": "001",
"title_code": "005",
"year_term": "20185"
}
}
204 No Content

Service request is OK but the response is the empty set - no content found.

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

attributes: string

class_is_addible: string

curriculum_id: string

holds: object[]

object

IsClassAddibleService: object

request: request
response: response

max_evening_hours: string

max_hours: string

method: string

not_addible_possible_reason_object: object

reason_code: reason_code
reason_description: reason_description

not_addible_possible_reasons: object[]

number_of_reasons: string

person_id: string

reason: string

reason_code: string

reason_description: string

reason_object: object

reason_code: reason_code
reason: reason

reasons: object[]

request: object

method: method
resource: resource
attributes: attributes
status: status
statusMessage: statusMessage

resource: string

response: object

not_addible_possible_reasons: not_addible_possible_reasons
person_id: person_id
year_term: year_term
curriculum_id: curriculum_id
title_code: title_code
section_number: section_number
max_hours: max_hours
max_evening_hours: max_evening_hours
class_is_addible: class_is_addible
number_of_reasons: number_of_reasons
holds: holds
reasons: reasons

section_number: string

status: number

statusMessage: string

title_code: string

year_term: string

Service Path: 
/domains/legacy/academic/registration/isclassaddible
Domain or University API: 
/domains/D/academic/registration/isclassaddible

Community

 

Don't see your question listed here? Ask!