AcademicAdvisementWaivers

This service retrieves a student's program waivers, substitutions, and additional requirements from the AIM System.

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

Base URL: /domains/legacy/academic/advisement/waivers

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{person_id} GET

get a list of all waivers and their corresponding courses and year term dates

Paths

service definition

GET /documentation

service definition

Uses default content-types: application/json application/xml

200 OK

Success

get a list of all waivers and their corresponding courses and year term dates

GET /{person_id}

Tags: WaiversService

get a list of all waivers and their corresponding courses and year term dates

person_id

string ->

path string

Uses default content-types: application/json application/xml

200 OK

Service request is OK and a response has been generated.

Example for application/json
{
"StdWaiverService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/json/123456789/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"other_requirements": [
]
,
"programs": [
{
"description": "University Core 2004-Prese",
"hierarchies": [
{
"academic_unit_id": "1449",
"unit_name": "Undergraduate Education",
"unit_type": "COLLEGE"
}
]
,
"program_code": "111120",
"program_type": "GE",
"year_term": "Fall 2011"
},
{
"description": "Computer Scien",
"hierarchies": [
{
"academic_unit_id": "1323",
"unit_name": "Computer Science",
"unit_type": "DEPARTMENT"
},
{
"academic_unit_id": "1017",
"unit_name": "Physical & Math Sciences",
"unit_type": "COLLEGE"
}
]
,
"program_code": "693220",
"program_type": "MAJOR",
"year_term": "Winter 2017"
}
]
,
"waivers": [
{
"catalog_number": "106",
"catalog_suffix": "",
"curriculum_id": "11099",
"date_time_updated": "01 Apr 2010 04:01:21",
"dept_name": "G E",
"note": "",
"num_classes": "1",
"num_hours": "0.00",
"section_number": "",
"sub_catalog_number": "",
"sub_catalog_suffix": "",
"sub_curriculum_id": "",
"sub_dept_name": "",
"sub_title_code": "",
"title_code": "000",
"updated_by_name": "BATCH",
"waiver_level": "U",
"waiver_level_value": "",
"waiver_type": "TWV",
"year_term": ""
}
]
}
}
}
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.

401 Unauthorized

Failure to authenticate.

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

academic_unit_id: string

catalog_number: string

catalog_suffix: string

curriculum_id: string

date_completed: string

date_time_updated: string

dept_name: string

description: string

hierarchies: object[]

object
unit_type: unit_type
unit_name: unit_name
academic_unit_id: academic_unit_id

note: string

num_classes: string

num_hours: string

program_code: string

program_description: string

program_type: string

req_level: string

req_type: string

section_number: string

StdWaiver: object

A list of a student's waivers.

StdWaiverService: object
request: StdWaiverRequest
response: StdWaiverResponse

StdWaiverRequest: object

method: string

REST method for request service.

resource: string
attributes: string
status: number
statusMessage: string

Explanation of return status of request.

StdWaiverResponse: object

programs: object[]
object
program_code: program_code
program_type: program_type
year_term: year_term
description: description
hierarchies: hierarchies
waivers: object[]
object
waiver_type: waiver_type
waiver_level: waiver_level
waiver_level_value: waiver_level_value
curriculum_id: curriculum_id
title_code: title_code
dept_name: dept_name
catalog_number: catalog_number
catalog_suffix: catalog_suffix
sub_curriculum_id: sub_curriculum_id
sub_title_code: sub_title_code
sub_dept_name: sub_dept_name
sub_catalog_number: sub_catalog_number
sub_catalog_suffix: sub_catalog_suffix
year_term: year_term
section_number: section_number
num_hours: num_hours
num_classes: num_classes
note: note
date_time_updated: date_time_updated
updated_by_name: updated_by_name
other_requirements: object[]
object
program_code: program_code
program_description: program_description
req_type: req_type
req_level: req_level
description: description
date_completed: date_completed
updated_date: updated_date
updated_by: updated_by

sub_catalog_number: string

sub_catalog_suffix: string

sub_curriculum_id: string

sub_dept_name: string

sub_title_code: string

title_code: string

unit_name: string

unit_type: string

updated_by: string

updated_by_name: string

updated_date: string

waiver_level: string

waiver_level_value: string

waiver_type: string

year_term: string

Service Path: 
/domains/legacy/academic/advisement/waivers
Domain or University API: 
/domains/D/academic/advisement/waivers

Community

 

Don't see your question listed here? Ask!