AcademicRegistrationActions

This service returns the registration action logs for a student in the AIM System.

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

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

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{personId} GET

Returns table of actions performed on the specified account

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

Returns table of actions performed on the specified account

GET /{personId}

Tags: ActionsService

Returns table of actions performed on the specified account

personId

string -> 9 digit number

path string
page_number

string ->

query 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": "page_number=2",
"method": "GET",
"resource": "/123456789",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"actionData": [
{
"actionComments": "",
"actionMessage": "Created 9 DC for 20185",
"actionType": "TERM_STATUS",
"dateTimeUpdated": "2018-01-26T09:03:53",
"updatedById": "net_id",
"updatedByName": "name",
"yearTerm": "20185"
}
]
}
}
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

actionComments: string

actionMessage: string

actionType: string

dateTimeUpdated: string

regStdLogService: object

request: request
response: response

request: object

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

response: object

actionData: object[]
object
updatedById: updatedById
actionType: actionType
yearTerm: yearTerm
dateTimeUpdated: dateTimeUpdated
updatedByName: updatedByName
actionMessage: actionMessage
actionComments: actionComments

updatedById: string

updatedByName: string

yearTerm: string

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

Community

 

Don't see your question listed here? Ask!