AdmissionsGraduateEssay

This service gives you information about a student's Graduate Admission Essays and Graduate Admission Work Experience.

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

Base URL: /domains/legacy/admissions/graduate/essay

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/{personId_netId} GET

Returns grad work experience and program options.

/{personId_netId}/{program} GET

Returns grad work experience, program options and essay types.

/{personId_netId}/{program}/{essayType} GET

Returns grad work experience and essay for selected person, program and essay type.

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

Returns grad work experience and program options.

GET /{personId_netId}

Tags: EssayService

Returns grad work experience and program options.

personId_netId

string -> 9 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
{
"GradAdmEssayService": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/johnd",
"status": 200,
"statusMessage": "Service request is OK and a response has been generated."
}
,
"response": {
"EMPHASIS": "",
"ESSAY": "",
"ESSAY_TYPE": "",
"PROGRAM": "",
"essayList": [
]
,
"otherProgramList": "UNDERGRAD",
"workList": [
{
"delete": "",
"duties": "System Integration",
"employedFrom": "JUL 2013",
"employedTo": "",
"employerLocation": "Provo, Utah",
"employerName": "BYU OIT",
"workType": "Part Time"
}
]
}
}
}
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.

Returns grad work experience, program options and essay types.

GET /{personId_netId}/{program}

Tags: EssayService

Returns grad work experience, program options and essay types.

personId_netId

string -> 9 digit number

path string
program

string -> Value from otherProgramList

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.

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 grad work experience and essay for selected person, program and essay type.

GET /{personId_netId}/{program}/{essayType}

Tags: EssayService

Returns grad work experience and essay for selected person, program and essay type.

personId_netId

string -> 9 digit number

path string
program

string -> Value from otherProgramList

path string
essayType

string -> Value from essayList

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.

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

documentation: object

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

GradEssay: object

GradAdmEssayService: object
request: request
response: response

request: object

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

response: object

PROGRAM: string
EMPHASIS: string
otherProgramList: string
essayList: object[]
object
ESSAY_TYPE: string
ESSAY: string
workList: object[]
object
delete: string
workType: string
employedFrom: string
employedTo: string
employerName: string
employerLocation: string
duties: string
Service Path: 
/domains/legacy/admissions/graduate/essay
Domain or University API: 
/domains/D/admissions/graduate/essay

Community

 

Don't see your question listed here? Ask!