AdmissionsCESCESApplicantAttribute

Gets and updates data on the CES Applicant attribute table in the CES admissions system.

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

Base URL: /domains/legacy/admissions/CES/cesapplicantattribute

Version: v1

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

Summary

Path Operation Description
/documentation GET

service definition

/SAVE PUT

saves the ces applicant attribute

/{person_id_list} GET

load ces applicant attribute

/{person_id}/{attribute_name}/{attribute_type}/{attribute_value} DELETE

deletes the ces applicant attribute

Paths

service definition

GET /documentation

service definition

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

200 OK

Success

saves the ces applicant attribute

PUT /SAVE

Tags: CESApplicantAttributeService

saves the ces applicant attribute

person_id

string ->

query string
attribute_name

string ->

query string
attribute_type

string ->

query string
attribute_value

string ->

query 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.

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.

load ces applicant attribute

GET /{person_id_list}

Tags: CESApplicantAttributeService

load ces applicant attribute

person_id_list

string -> Add all person ID's to search for with no spaces ',' or '/'

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.

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.

deletes the ces applicant attribute

DELETE /{person_id}/{attribute_name}/{attribute_type}/{attribute_value}

Tags: CESApplicantAttributeService

deletes the ces applicant attribute

person_id

string ->

path string
attribute_name

string ->

path string
attribute_type

string ->

path string
attribute_value

string ->

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.

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

CES_APPLICANT_ATTRIBUTES: object

credit_institution: string
person_id: string
ces_applicant_attribute_name: string
ces_applicant_attribute_type: string
ces_applicant_attribute_value: string
updated_by_id: string
date_time_updated: string

dd Mon yyyy

CesApplicantAttributeService: object

request: request
response: response

error_data: object

code: string
name: string
message: string
httpStatusCode: number

ErrorResponse: object

request: request
errors: errors
response: object

errors: object[]

identifiers: object

person_id: object
description: string
required: string
action: object
attribute_name: string
required: string
object: object
attribute_value: string
required: string

request: object

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

resource: object

methods: object[]
object
URI: string
examples: object[]
object
identifiers: identifiers

response: object

resource: resource
CES_APPLICANT_ATTRIBUTES: object[]
Service Path: 
/domains/legacy/admissions/CES/cesapplicantattribute
Domain or University API: 
/domains/D/admissions/CES/cesapplicantattribute

Community

 

Don't see your question listed here? Ask!