AdmissionsGraduateLetterRequest
This service shows the list of programs, list of letters, and list of programs for a given student.
Base URL: /domains/legacy/admissions/graduate/letterrequest
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /{person_id_net_id} | GET | Gets the list of programs for the given student |
| /{person_id_net_id}/letterList | GET | Gets the list of letter names for letters |
| /{person_id_net_id}/{program_code} | GET | Gets the list of letters for the given student assigned to given program |
Paths
GET /documentation
service definition
Uses default content-types: application/json
- 200 OK
-
Success
Gets the list of programs for the given student
| person_id_net_id | string -> nine digit number or net ID | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"LetterRequestService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/net_id",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"programs": [
{
"programCode": "",
"programName": "None"
}
]
}
}
} - 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 /{person_id_net_id}/letterList
Tags: LetterRequestServiceGets the list of letter names for letters
| person_id_net_id | string -> nine digit number or net ID | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"LetterRequestService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/dwa3/letterList",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"letterNames": [
]
}
}
} - 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 /{person_id_net_id}/{program_code}
Tags: LetterRequestServiceGets the list of letters for the given student assigned to given program
| person_id_net_id | string -> nine digit number or net ID | path | string | |
| program_code | string -> six digit number | path | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"LetterRequestService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/johnd/394998",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"PROGRAMCODE": "394998",
"studentLetterData": [
{
"dateToBeProduced": "02/15/2017",
"emailAddress": "john@example.com",
"emailed": "Y",
"letterName": "G First Mis Bach Notice",
"printed": "Y",
"producedDate": "02/20/2017",
"requestedBy": "Jane Smith",
"requestedDate": "02/10/2017"
}
]
}
}
} - 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
- WebService: object
-
- name: string
-
- operations: object[]
-
object - name: string
-
- description: string
-
- method: string
-
- path: string
-
- path_identifiers: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- query_attributes: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- required: string
-
- errors: object[]
-
object - code: integer
-
- name: string
-
- message: string
-
- httpStatusCode: integer
-
- httpStatusCodes: object[]
-
object - code: integer
-
- message: string
-
- programCode: programCode
-
- programName: programName
-
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- programs: programs
-
- letterNames: letterNames
-
- PROGRAMCODE: PROGRAMCODE
-
- studentLetterData: studentLetterData
-
- letterName: letterName
-
- dateToBeProduced: dateToBeProduced
-
- producedDate: producedDate
-
- requestedDate: requestedDate
-
- requestedBy: requestedBy
-
- printed: printed
-
- emailed: emailed
-
- emailAddress: emailAddress
-
