AcademicRecordsCWAIM
This service accesses previous and current Independent Studies and Conferences and Workshops class registration information for an individual, adds Independent Studies or Conferences and Workshops classes for an individual, and modifies grades for Independent Studies or Conferences and Workshops classes for an individual in the AIM System.
Base URL: /domains/legacy/academic/records/CWAIM
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/ | GET | Shows classes uploaded for Independent Study or Conferences and Workshops for logged in user |
/cw | GET | Shows classes uploaded for Conferences and Workshops for logged in user |
/cw/{person_id} | GET | Shows classes uploaded for Conferences and Workshops for identified person |
/documentation | GET | service definition |
/is | GET | Shows classes uploaded for Independent Study for logged in user |
/is/{person_id} | GET | Shows classes uploaded for Independent Study for identified person |
/save | POST | Inserts a new class or updates if the class already exists OR perform a delete by changing add_drops)action name/value pair to a 'D' |
/{person_id} | GET | Shows classes uploaded for Independent Study or Conferences and Workshops for identified person |
Paths
GET /
Tags: CwAimServiceShows classes uploaded for Independent Study or Conferences and Workshops for logged in user
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"request": {
"attributes": null,
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"CLASSES": [
{
"added_by": "IndStudy",
"block": "20161",
"catalog_number": "316",
"credit_hours": "3.00",
"curriculum_id": "01857",
"date_added": "23 Apr 2016",
"date_graded": "23 Apr 2016",
"date_updated": "23 Apr 2016",
"grade": "A",
"graded_by": null,
"honors": null,
"lab_quiz": null,
"repeat": null,
"section_number": "029",
"section_type": "IND STUDY",
"service_learning": "N",
"teaching_area": "ENGL",
"title_code": "005",
"updated_by": "IndStudy"
}
],
"byu_id": "123456789",
"message": "1 Conferences and Workshops or Independent Study classes found",
"net_id_or_ssn": "net_id",
"person_id": "123456789",
"status": "A"
}
} - 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.
Shows classes uploaded for Conferences and Workshops for logged in user
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"request": {
"attributes": null,
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"CLASSES": [
{
"added_by": "IndStudy",
"block": "20161",
"catalog_number": "316",
"credit_hours": "3.00",
"curriculum_id": "01857",
"date_added": "23 Apr 2016",
"date_graded": "23 Apr 2016",
"date_updated": "23 Apr 2016",
"grade": "A",
"graded_by": null,
"honors": null,
"lab_quiz": null,
"repeat": null,
"section_number": "029",
"section_type": "IND STUDY",
"service_learning": "N",
"teaching_area": "ENGL",
"title_code": "005",
"updated_by": "IndStudy"
}
],
"byu_id": "123456789",
"message": "1 Conferences and Workshops or Independent Study classes found",
"net_id_or_ssn": "net_id",
"person_id": "123456789",
"status": "A"
}
} - 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.
GET /cw/{person_id}
Tags: CwAimServiceShows classes uploaded for Conferences and Workshops for identified person
person_id | string -> a string of numbers 9 digits long | 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{
"request": {
"attributes": null,
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"CLASSES": [
{
"added_by": "IndStudy",
"block": "20161",
"catalog_number": "316",
"credit_hours": "3.00",
"curriculum_id": "01857",
"date_added": "23 Apr 2016",
"date_graded": "23 Apr 2016",
"date_updated": "23 Apr 2016",
"grade": "A",
"graded_by": null,
"honors": null,
"lab_quiz": null,
"repeat": null,
"section_number": "029",
"section_type": "IND STUDY",
"service_learning": "N",
"teaching_area": "ENGL",
"title_code": "005",
"updated_by": "IndStudy"
}
],
"byu_id": "123456789",
"message": "1 Conferences and Workshops or Independent Study classes found",
"net_id_or_ssn": "net_id",
"person_id": "123456789",
"status": "A"
}
} - 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.
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
Shows classes uploaded for Independent Study for logged in user
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"request": {
"attributes": null,
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"CLASSES": [
{
"added_by": "IndStudy",
"block": "20161",
"catalog_number": "316",
"credit_hours": "3.00",
"curriculum_id": "01857",
"date_added": "23 Apr 2016",
"date_graded": "23 Apr 2016",
"date_updated": "23 Apr 2016",
"grade": "A",
"graded_by": null,
"honors": null,
"lab_quiz": null,
"repeat": null,
"section_number": "029",
"section_type": "IND STUDY",
"service_learning": "N",
"teaching_area": "ENGL",
"title_code": "005",
"updated_by": "IndStudy"
}
],
"byu_id": "123456789",
"message": "1 Conferences and Workshops or Independent Study classes found",
"net_id_or_ssn": "net_id",
"person_id": "123456789",
"status": "A"
}
} - 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.
GET /is/{person_id}
Tags: CwAimServiceShows classes uploaded for Independent Study for identified person
person_id | string -> a string of numbers 9 digits long | 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{
"request": {
"attributes": null,
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"CLASSES": [
{
"added_by": "IndStudy",
"block": "20161",
"catalog_number": "316",
"credit_hours": "3.00",
"curriculum_id": "01857",
"date_added": "23 Apr 2016",
"date_graded": "23 Apr 2016",
"date_updated": "23 Apr 2016",
"grade": "A",
"graded_by": null,
"honors": null,
"lab_quiz": null,
"repeat": null,
"section_number": "029",
"section_type": "IND STUDY",
"service_learning": "N",
"teaching_area": "ENGL",
"title_code": "005",
"updated_by": "IndStudy"
}
],
"byu_id": "123456789",
"message": "1 Conferences and Workshops or Independent Study classes found",
"net_id_or_ssn": "net_id",
"person_id": "123456789",
"status": "A"
}
} - 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.
POST /save
Tags: CwAimServiceInserts a new class or updates if the class already exists OR perform a delete by changing add_drops)action name/value pair to a 'D'
SavesClass
reference_no | A string of numbers 7 digits long | query | string | |
net_id_or_ssn | query | string (A string of characters up to 15 digits long or a string of numbers 9 digits long) | ||
person_id | A string of numbers 9igits long | query | string | |
rest_of_name | query | string (A string of letters up to 80 digits long) | ||
date of birth | A string of numbers 8 digits long YYYYMMDD | query | string | |
gender | query | string (A string 1 digit long: M|F) | ||
curriculum_id | A string of numbers 5 digits long | query | string | |
title_code | query | string (A string of numbers 3 digits long) | ||
grade | A string of letters 5 digits long | query | string | |
credit_hours | query | string (A string of characters 5 digits long) | ||
section_number | A string of numbers 3 digits long | query | string | |
address_line_1 | query | string (A string of characters up to 40 digits long) | ||
address_line_2 | A string of characters up to 40 digits long | query | string | |
address_line_3 | query | string (A string of characters up to 40 digits long) | ||
address_line_4 | A string of characters up to 40 digits long | query | string | |
country_code | query | string (A string of characters up to 40 digits long) | ||
city | A string of characters up to 30 digits long | query | string | |
state_code | query | string (A string of characters up to 6 digits long) | ||
postal_code | A string of characters up to 20 digits long | query | string | |
address_unlisted | query | string (A string of letters 1 digit long Y|N) | ||
phone_number | A string of numbers up to 30 digits long | query | string | |
phone_country_code | query | string (A string of numbers up to 3 digits long) | ||
phone_unlisted | A string of letters 1 digit long Y|N | query | string | |
email_address | query | string (A string of characters up to 70 digits long) | ||
email_unlisted | A string of letters 1 digit long Y|N | query | string | |
byu_id | query | string (A string of numbers 9 digits long) | ||
year_term | A specific year and term | query | string | |
section_type | query | string (A string of characters up to 10 digits long) | ||
add_drops_action | A string of letters 1 digit long A|D | query | string | |
grade_change | query | string (A string of letters 1 digit long Y|N) | ||
surname | A string of numbers 40 digits long | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Service request is OK and a response has been generated.
- 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.
GET /{person_id}
Tags: CwAimServiceShows classes uploaded for Independent Study or Conferences and Workshops for identified person
person_id | string -> a string of numbers 9 digits long | 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{
"request": {
"attributes": null,
"method": "GET",
"resource": "/json/",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"CLASSES": [
{
"added_by": "IndStudy",
"block": "20161",
"catalog_number": "316",
"credit_hours": "3.00",
"curriculum_id": "01857",
"date_added": "23 Apr 2016",
"date_graded": "23 Apr 2016",
"date_updated": "23 Apr 2016",
"grade": "A",
"graded_by": null,
"honors": null,
"lab_quiz": null,
"repeat": null,
"section_number": "029",
"section_type": "IND STUDY",
"service_learning": "N",
"teaching_area": "ENGL",
"title_code": "005",
"updated_by": "IndStudy"
}
],
"byu_id": "123456789",
"message": "1 Conferences and Workshops or Independent Study classes found",
"net_id_or_ssn": "net_id",
"person_id": "123456789",
"status": "A"
}
} - 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
- request: object
-
- method: string
-
- resource: string
-
- attributes: string,null
-
- status: number
-
- statusMessage: string
-
- response: object
-
- 0: object
-
- teaching_area: string
-
- catalog_number: string
-
- section_number: string
-
- block: string
-
- curriculum_id: string
-
- title_code: string
-
- lab_quiz: string
-
- section_type: string
-
- credit_hours: string
-
- honors: string
-
- service_learning: string
-
- date_added: string
-
- added_by: string
-
- grade: string
-
- repeat: string
-
- date_graded: string
-
- graded_by: string
-
- date_updated: string
-
- updated_by: string
-
- status: #/definitions/status
-
- message: #/definitions/message
-
- person_id: #/definitions/person_id
-
- byu_id: #/definitions/byu_id
-
- net_id_or_ssn: #/definitions/net_id_or_ssn
-
- CLASSES: CLASSES
-
- request: object
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- errors: errors
-
- response: object
-
- request: object
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- response: object
-
- status: string
-
- message: string
-
- person_id: string
-
- byu_id: string
-
- net_id_or_ssn: string
-
- CLASSES: string[]
-
string