AcademicControlsAIMParameters
This service maintains the parameters that control the AIM system
Base URL: /domains/legacy/academic/controls/aimparameters
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /delete/{parm_name}/{year_term} | GET | Deletes a parameter |
| /documentation | GET | service definition |
| /{parm_name} | GET | Shows parameters belonging to the parameter name given |
| /{parm_name}/{parm_type}/{parm_value}/{year_term} | GET | Updates an existing parameter |
| /{parm_name}/{year_term} | GET | Inserts a new parameter |
Paths
Deletes a parameter
| parm_name | string -> | path | string | |
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| parm_owner | string -> | query | string | |
| parm_type | string -> | query | string | |
| parm_value | string -> | query | string | |
| end_date | string -> dd Mon YYYY | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Parameter deleted.
- 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.
- 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 parameters belonging to the parameter name given
| parm_name | string -> | path | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Retrieves parameter values
- 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.
- 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 /{parm_name}/{parm_type}/{parm_value}/{year_term}
Tags: aimparametersServiceUpdates an existing parameter
| parm_name | string -> | path | string | |
| parm_type | string -> | path | string | |
| parm_value | string -> | path | string | |
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| new_parm_value | string -> | query | string | |
| new_start_date | string -> dd Mon YYYY | query | string | |
| new_end_date | string -> dd Mon YYYY | query | string | |
| new_year_term | string -> | query | string | |
| new_description | string -> | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Parameter modified
- 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.
- 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 a new parameter
| parm_name | string -> | path | string | |
| year_term | yearTerm -> [1-2][0-9]{3}[1345] | path | string | |
| parm_owner | string -> | query | string | |
| parm_type | string -> | query | string | |
| parm_value | string -> | query | string | |
| start_date | string -> dd Mon YYYY | query | string | |
| end_date | string -> dd Mon YYYY | query | string | |
| description | string -> | query | string |
Uses default content-types: application/json application/xml
- 200 OK
-
Inserts a parameter
- 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.
- 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
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- parm_type: parm_type
-
- parm_value: parm_value
-
- year_term: year_term
-
- start_date: start_date
-
- end_date: end_date
-
- parm_owner: parm_owner
-
- description: description
-
- date_time_updated: date_time_updated
-
- updated_by_name: updated_by_name
-
