AcademicAdvisementAdvLog
This service accesses advisement logs using the AIM system.
Base URL: /domains/legacy/academic/advisement/advlog
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /{net_id} | GET | Returns advisement log for specified net ID |
| /{net_id}/{sequence}/{dateTimeUpdated} | GET | Returns advisement log note for specified net ID |
Paths
Returns advisement log for specified net ID (PERSON ID IS ALSO A VALID PATH PARAMETER)
| net_id | The BYU net_id associated with a specific person (PERSON ID IS ALSO A VALID PATH PARAMETER) | 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": {
"method": "GET",
"resource": "/js279",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Advisement_log": [
{
"action_message": "Inserted (BS) degree for MAJOR Computer Science",
"action_type": "DEGREE",
"date_time_updated": "13 Feb 2014 10:18:16",
"delete": "",
"note": [
{
"dateTimeUpdatedNote": "13 Feb 2014 10:18:16",
"hasNote": "Y",
"sequenceNumber": 2
}
],
"update": "",
"updated_by_name": "Student, Joe"
}
]
}
} - 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
-
Failed 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 /{net_id}/{sequence}/{dateTimeUpdated}
Tags: AdvLogServiceReturns advisement log note for specified net ID(PERSON ID IS ALSO A VALID PATH PARAMETER)
| net_id | string representing the net id associated with the BYU person(PERSON ID IS ALSO A VALID PATH PARAMETER) | path | string | |
| sequence | Sequence number associated with the id and the action implemented | path | string | |
| dateTimeUpdated | a string formatted like the following -> DD MMM YYYY HH:MM:SS | path | string (date-time) |
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": {
"method": "GET",
"resource": "/js279",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Advisement_log": [
{
"action_message": "Inserted (BS) degree for MAJOR Computer Science",
"action_type": "DEGREE",
"date_time_updated": "13 Feb 2014 10:18:16",
"delete": "",
"note": [
{
"dateTimeUpdatedNote": "13 Feb 2014 10:18:16",
"hasNote": "Y",
"sequenceNumber": 2
}
],
"update": "",
"updated_by_name": "Student, Joe"
}
]
}
} - 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
-
Failed 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
{
"action_message": "Inserted (BS) degree for MAJOR Computer Science",
"action_type": "DEGREE",
"date_time_updated": "13 Feb 2014 10:18:16",
"delete": "",
"note": [
{
"dateTimeUpdatedNote": "13 Feb 2014 10:18:16",
"hasNote": "Y",
"sequenceNumber": 2
}
],
"update": "",
"updated_by_name": "Student, Joe"
} - update: string
-
- delete: string
-
- action_type: string
-
- action_message: string
-
- note: object[]
- date_time_updated: string
-
- updated_by_name: string
-
An advisement log
{
"request": {
"method": "GET",
"resource": "/js279",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"Advisement_log": [
{
"action_message": "Inserted (BS) degree for MAJOR Computer Science",
"action_type": "DEGREE",
"date_time_updated": "13 Feb 2014 10:18:16",
"delete": "",
"note": [
{
"dateTimeUpdatedNote": "13 Feb 2014 10:18:16",
"hasNote": "Y",
"sequenceNumber": 2
}
],
"update": "",
"updated_by_name": "Student, Joe"
}
]
}
} - request: AdvLogRequest
-
- response: AdvLogResponse
-
{
"method": "GET",
"resource": "/js279",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
} - method: string
-
REST method for request service.
- resource: string
-
A resource.
- status: number
-
Return status of a REST request to determine success.
- statusMessage: string
-
Explanation of return status of request.
{
"Advisement_log": [
{
"action_message": "Inserted (BS) degree for MAJOR Computer Science",
"action_type": "DEGREE",
"date_time_updated": "13 Feb 2014 10:18:16",
"delete": "",
"note": [
{
"dateTimeUpdatedNote": "13 Feb 2014 10:18:16",
"hasNote": "Y",
"sequenceNumber": 2
}
],
"update": "",
"updated_by_name": "Student, Joe"
}
]
} - Advisement_log: object[]
- request: AdvLogRequest
-
- errors: errors
-
- response: object
-
