AdmissionsGraduateOfficialCommunication
This service returns the list of programs, graduate offering communications for a student, and the note for a given letter.
Base URL: /domains/legacy/admissions/graduate/officialcommunication
Version: v1
Summary
| Path | Operation | Description |
|---|---|---|
| /documentation | GET | service definition |
| /{net_id}/{program_code}/{note_type}/{sequence_number} | GET | Gets the note for the given letter |
| /{person_id_net_id} | GET | Gets the list of programs for the given student |
| /{person_id_net_id}/{program_code} | GET | Gets the Graduate Offering Communications for the given student |
Paths
GET /documentation
service definition
Uses default content-types: application/json application/xml
- 200 OK
-
Success
GET /{net_id}/{program_code}/{note_type}/{sequence_number}
Tags: OfficialCommunicationServiceGets the note for the given letter
| net_id | string -> net ID | path | string | |
| program_code | string -> six digit number | path | string | |
| note_type | string -> DENY, PROG_REPT_NOTE, WITHDRAW_REASON, PROVISION, or APP_PROBLEM | path | string | |
| sequence_number | string -> sequence number of the note | 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{
"GradOffCommService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/johnd/394998/PROG_REPT_NOTE/1",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"NOTE": "",
"NOTETYPE": "PROG_REPT_NOTE",
"PROGRAM": "394998",
"SEQUENCENO": "1",
"message": ""
}
}
} - 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.
- 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 /{person_id_net_id}
Tags: OfficialCommunicationServiceGets 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 application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"GradOffCommService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/johnd",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"message": "",
"programList": [
{
"degree_type": "MS",
"program": "Mechanical Engineering",
"program_code": "394998"
}
]
}
}
} - 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.
- 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 /{person_id_net_id}/{program_code}
Tags: OfficialCommunicationServiceGets the Graduate Offering Communications for the given student
| 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 application/xml
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"GradOffCommService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/johnd/394998",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
},
"response": {
"GRADADMAPP": "N",
"GRADADMOGS": "D",
"PERSON_ID": "123456789",
"PROGRAM": "394998",
"PROGRAMNAME": "Mechanical Engineering",
"authorized": "Y",
"message": "",
"notes": [
],
"updatable": "N"
}
}
} - 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.
- 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
- method: string
-
- resource: string
-
- attributes: string
-
- status: number
-
- statusMessage: string
-
- message: string
-
- programList: object[]
-
object - program_code: string
-
- program: string
-
- degree_type: string
-
- message: string
-
- notes: object[]
-
object - PROGRAM: string
-
- PERSON_ID: string
-
- PROGRAMNAME: string
-
- GRADADMOGS: string
-
- GRADADMAPP: string
-
- authorized: string
-
- updatable: string
-
