AcademicAdvisementStudentPlanLog

This service accesses a log of a graduate student's study plan in the AIM System.

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

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

Version: v1

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

Summary

Path Operation Description
/delete/{person_id}/{program_id}/{action}/{action_type}/{action_date_time} DELETE

Deletes the program row

/{person_id} GET

Returns log for specified person ID

PUT

Inserts new note.

/{person_id}/{program_id}/{action}/{action_type}/{action_date_time} GET

Returns note for specified log row

PUT

Updates note and note name

/{person_id}/{program_id}/{action}/{action_type}/{action_date_time}/comment PUT

Updates program comment.

Paths

Deletes the program row

DELETE /delete/{person_id}/{program_id}/{action}/{action_type}/{action_date_time}

Tags: StudentPlanLogService

Deletes the program row

person_id

string -> [0-9]{9} 9 digit number or identifier. (net_id can also be used)

path string
program_id

string -> 5 digit number. Perform a get to find. Under noteProgramId.

path string
action

string -> String

path string
action_type

string -> String

path string
action_date_time

date -> DD MMM YYYY HH:MM:SS (Use Military Time)

path 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.

Returns log for specified person ID

GET /{person_id}

Tags: StudentPlanLogService

Returns log for specified person ID

person_id

string -> [0-9]{9} 9 digit number or string identifier (net_id can also be used)

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": "",
"method": "GET",
"resource": "/js279",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"log": [
{
"action": "ADD",
"action_by_name": "",
"action_date": "2014-02-25T20:18:16",
"action_source": "ADV07",
"action_text": "Inserted GE - University Core 2004-Present (PRE)",
"action_type": "PROGRAM",
"info": [
]
,
"int": "1",
"note": [
{
"hasNote": "yes",
"noteProgramId": "data list is missing ending delimiter"
}
]
,
"program_code": "111120"
}
]
,
"numLogs": "9",
"programDegree": "",
"programDescription": "",
"programType": "",
"programs": [
{
"degree": "(BS)",
"description": "Computer Science",
"major": "Major:",
"programId": "33082"
}
]
}
}
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.

Inserts new note.

PUT /{person_id}

Tags: StudentPlanLogService

Inserts new note.

person_id

string -> [0-9]{9} 9 digit number or string identifier (net_id can also be used)

path string
action_text

string -> string

query string
action_comment

string -> string

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.

Returns note for specified log row

GET /{person_id}/{program_id}/{action}/{action_type}/{action_date_time}

Tags: StudentPlanLogService

THIS ACTION IS CURRENTLY BROKEN! THIS NEEDS TO GO BACK AND BE LOOKED AT THE SINGLE GET IS TRYING TO MATCH THE UPDATED BY ID WITH THE PERSON ID AND RUNNING INTO CIRCLES

person_id

string -> [0-9]{9} 9 digit number or identifier. (net_id can also be used)

path string
program_id

string -> 5 digit number. Perform a get to find. Under noteProgramId.

path string
action

string -> String

path string
action_type

string -> String

path string
action_date_time

date -> DD MMM YYYY HH:MM:SS (Use Military Time and spaces)

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": "",
"method": "GET",
"resource": "/js279",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"log": [
{
"action": "ADD",
"action_by_name": "",
"action_date": "2014-02-25T20:18:16",
"action_source": "ADV07",
"action_text": "Inserted GE - University Core 2004-Present (PRE)",
"action_type": "PROGRAM",
"info": [
]
,
"int": "1",
"note": [
{
"hasNote": "yes",
"noteProgramId": "data list is missing ending delimiter"
}
]
,
"program_code": "111120"
}
]
,
"numLogs": "9",
"programDegree": "",
"programDescription": "",
"programType": "",
"programs": [
{
"degree": "(BS)",
"description": "Computer Science",
"major": "Major:",
"programId": "33082"
}
]
}
}
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.

Updates note and note name

PUT /{person_id}/{program_id}/{action}/{action_type}/{action_date_time}

Tags: StudentPlanLogService

THIS ACTION IS CURRENTLY BROKEN! THIS NEEDS TO GO BACK AND BE LOOKED AT THE SINGLE GET IS TRYING TO MATCH THE UPDATED BY ID WITH THE PERSON ID AND RUNNING INTO CIRCLES

person_id

string -> [0-9]{9} 9 digit number or identifier. (net_id can also be used)

path string
program_id

string -> 5 digit number. Perform a get to find. Under noteProgramId.

path string
action

string -> String

path string
action_type

string -> String

path string
action_date_time

date -> DD MMM YYYY HH:MM:SS (Use Military Time)

path string
action_text

string -> string

query string
action_comment

string -> string

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.

Updates program comment.

PUT /{person_id}/{program_id}/{action}/{action_type}/{action_date_time}/comment

Tags: StudentPlanLogService

Updates program comment.

person_id

string -> [0-9]{9} 9 digit number or identifier. (net_id can also be used)

path string
program_id

string -> 5 digit number. Perform a get to find. Under noteProgramId.

path string
action

string -> String

path string
action_type

string -> String

path string
action_date_time

date -> DD MMM YYYY HH:MM:SS (Use Military Time)

path string
action_comment

string -> string

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.

Schema definitions

log: object[]

object
int: string
info: string[]
string
program_code: string
action_source: string
action: string
action_type: string
action_text: string
note: note
action_date: string
action_by_name: string

note: object[]

Could not find a solid example for this data could hold problems

object
noteProgramId: string
hasNote: string

programs: object[]

object
programId: string
major: string
description: string
degree: string

StdPlanLogRequest: object

method: string

REST method for request service.

resource: string

A resource.

attributes: string
status: number

Return status of a REST request to determine success.

statusMessage: string

Explanation of return status of request.

StdPlanLogResponse: object

programType: string
programDescription: string
programDegree: string
numLogs: string
programs: programs
log: log

StdPlanLogService: object

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

Community

 

Don't see your question listed here? Ask!