Admissions Packet API
An API for admissions packets.
More information: https://it.byu.edu
Contact Info: api@byu.edu
Base URL: /domain/admissions/packets
Version: v1
Default response content-types: application/json
Schemes: https
Summary
| Path | Operation | Description |
|---|---|---|
| / | GET | Retrieve a set of admissions packets. |
| /{packet_id} | GET | Get an admission packet |
| POST | Add an admissions packet | |
| /{packet_id}/academics | GET | Get the packet academic field set |
| PUT | Modify packet academic information | |
| /{packet_id}/biographical | GET | Get the packet biographical field set |
| /{packet_id}/decision | GET | Get the packet decision field set |
| PUT | Modify packet decision information | |
| /{packet_id}/evaluations | GET | Get the packet evaluations field set |
| PUT | Modify packet evaluations | |
| /{packet_id}/flags | GET | Get the packet flags field set |
| PUT | Modify packet flags | |
| /{packet_id}/model_results | GET | Get the packet model scores field set |
| POST | Add a packet model score | |
| /{packet_id}/model_results/{model_id} | DELETE | Get the packet model scores field set |
| /{packet_id}/packet | GET | Get the packet metadata field set |
| PUT | Modify packet metadata | |
| /{packet_id}/processes | GET | Get the packet processes field set |
| PUT | Modify packet process information | |
| /{packet_id}/religion | GET | Get the packet religion field set |
| /{packet_id}/scoring | GET | Get the packet scoring field set |
Paths
Returns the set of admissions packets matching the query parameters.
| applicant_type | Filter by applicant type | query | string | #/parameters/applicant_type |
| context | Select a predefined set of subresources | query | string | #/parameters/context |
| field_sets | select which subresources are to be returned | query | string | #/parameters/field_sets |
| flags | Return the packets with the given flag(s) set | query | string | #/parameters/flags |
| institution | Filter by institution | query | string | #/parameters/institution |
| page_start | Skip into a large collection to this item | query | string | #/parameters/page_start |
| page_size | Return this many items of a large collection | query | string | #/parameters/page_size |
| process | Return the packets currently in the given process | query | string | #/parameters/process |
| year_term | Filter by admit period (Year/Term) | query | string | #/parameters/year_term |
Uses default content-types: application/json
- 200 OK
-
Retrieved set of packets
Example for application/json{
"links": {
"packet__add": {
"href": "https://api.byu.edu/domain/admissions/packets/v1",
"method": "POST",
"rel": "packet__add"
},
"packets__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"profile": [
"basic",
"academics",
"bio",
"religion"
],
"scoring_elements": [
"basic",
"scores",
"evaluations"
]
},
"default_page_size": 50,
"field_sets_available": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"field_sets_returned": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"academics": {
"act_composite": {
"api_type": "read-only",
"display_label": "ACT Composite",
"value": "34"
},
"ap_ib_count": {
"api_type": "read-only",
"display_label": "AP/IB Class Count",
"value": "3"
},
"date_time_updated": {
"api_type": "system",
"display_label": "date_time_updated",
"value": "2014-05-11T13:45:53.200Z"
},
"egpa": {
"api_type": "modifiable",
"display_label": "Freshman EGPA",
"value": "3.875"
},
"gpa_byu": {
"api_type": "read-only",
"display_label": "BYU GPA",
"value": "3.875"
},
"gpa_college": {
"api_type": "read-only",
"display_label": "College GPA",
"value": "3.875"
},
"gpa_hs": {
"api_type": "read-only",
"display_label": "High School GPA",
"value": "3.875"
},
"id_updated_by": {
"api_type": "system",
"display_label": "id_updated_by",
"value": "123456789"
},
"links": {
"academics__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "GET",
"rel": "self"
},
"academics__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "PUT",
"rel": "academics__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
},
"basic": {
"admit_period": {
"api_type": "system",
"display_label": "Admit Period",
"value": "2018 Fall"
},
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"value": "123456789"
},
"applicant_major": {
"api_type": "system",
"display_label": "Applicant Major",
"value": "English"
},
"applicant_name": {
"api_type": "system",
"display_label": "Applicant Name",
"value": "John Smith"
},
"applicant_type": {
"api_type": "system",
"display_label": "Applicant Type",
"value": "Freshman"
},
"application_uuid": {
"api_type": "system",
"display_label": "application_uuid",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"institution": {
"api_type": "system",
"display_label": "Institution",
"value": "BYUP"
},
"links": {
"basic__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
},
"biographical": {
"age": {
"api_type": "read-only",
"display_label": "Age",
"value": "M"
},
"birthdate": {
"api_type": "read-only",
"display_label": "Birth Date",
"value": "2000-05-11"
},
"citizenship": {
"api_type": "read-only",
"display_label": "Citizenship",
"value": "N"
},
"city": {
"api_type": "read-only",
"display_label": "City",
"value": "Springfield"
},
"country": {
"api_type": "read-only",
"display_label": "Country",
"value": "USA"
},
"fathers_education": {
"api_type": "read-only",
"display_label": "Fathers Education",
"value": "N"
},
"language": {
"api_type": "read-only",
"display_label": "Language",
"value": [
"English"
]
},
"links": {
"biographical__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/biographical",
"method": "GET",
"rel": "self"
}
},
"marital_status": {
"api_type": "read-only",
"display_label": "Marital Status",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mothers_education": {
"api_type": "read-only",
"display_label": "Mothers Education",
"value": "N"
},
"race": {
"api_type": "read-only",
"display_label": "Race",
"value": [
"White"
]
},
"sex": {
"api_type": "read-only",
"display_label": "Sex",
"value": "M"
},
"state": {
"api_type": "read-only",
"display_label": "State",
"value": "IL"
},
"visa_type": {
"api_type": "read-only",
"display_label": "Visa Type",
"value": "N"
}
},
"decision": {
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2017-05-11T13:45:53.200Z"
},
"id_updated_by": {
"api_type": "system",
"display_label": "Updated By",
"value": "123456789"
},
"links": {
"decision__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "GET",
"rel": "self"
},
"decision__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "PUT",
"rel": "decision__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model": {
"api_type": "modifiable",
"display_label": "Model",
"value": ""
},
"reason": {
"api_type": "modifiable",
"display_label": "Reason",
"value": ""
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "None"
}
},
"evaluations": {
"links": {
"evaluations__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/ea9a774-dfe8-4dfd-8a2a-bb2edc984407/evaluations",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"comments": [
{
"by_id": "123456789",
"date_time": "2017-05-11T13:45:53.200Z",
"value": "This is a comment"
}
],
"composite_score": {
"api_type": "modifiable",
"display_label": "Composite Score",
"value": "93.25"
},
"date_time_created": {
"api_type": "system",
"display_label": "Assigned",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Scored",
"value": "2017-05-11T13:45:53.200Z"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"reader_id": {
"api_type": "modifiable",
"display_label": "Reader ID",
"value": "123456789"
},
"subscores": [
{
"key": "2017F-02",
"value": 4
}
]
}
]
},
"flags": {
"links": {
"flag__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "PUT",
"rel": "flag__modify"
},
"flags__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Short Mission"
},
"type": {
"api_type": "modifiable",
"display_label": "Type",
"value": "Warning"
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "SM"
}
}
]
},
"links": {
"packet__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"contexts_available": {
"all": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"profile": [
"basic",
"academics",
"bio",
"religion"
],
"scoring_elements": [
"basic",
"scores",
"evaluations"
]
},
"field_sets_available": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"field_sets_returned": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model_results": {
"links": {
"model_results__add": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results",
"method": "POST",
"rel": "model_results__add"
},
"model_results__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"links": {
"model_result__remove": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "DELETE",
"rel": "model_result__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model_id": {
"api_type": "system",
"display_label": "Model ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"model_name": {
"api_type": "modifiable",
"display_label": "Model Name",
"value": "IntlFreshmen2018"
},
"rank": {
"api_type": "modifiable",
"display_label": "Rank",
"pool": "4639",
"value": "3785"
},
"score": {
"api_type": "modifiable",
"display_label": "Score",
"value": "87.75"
}
}
]
},
"packet": {
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"value": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
},
"links": {
"packet_metadata__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "GET",
"rel": "self"
},
"packet_metadata__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "PUT",
"rel": "packet_metadata__modify"
}
},
"log": {
"api_type": "read-only",
"display_label": "Log",
"value": [
{
"action": "score",
"by_id": "123456789",
"date_time": "1970-01-01T00:00:00.000Z"
}
]
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"process_refs": {
"api_type": "modifiable",
"display_label": "Packet Metadata Process References",
"value": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
},
"type": {
"api_type": "system",
"display_label": "Packet Type",
"value": "Decision Processing"
},
"uuid": {
"api_type": "system",
"display_label": "Packet ID",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
},
"processes": {
"links": {
"processes__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes",
"method": "GET",
"rel": "self"
},
"processes__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes",
"method": "PUT",
"rel": "processes__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "GET",
"rel": "self"
},
"process__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "PUT",
"rel": "process__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "read-only",
"display_label": "Name",
"value": "endorsement"
},
"notes": {
"api_type": "modifiable",
"display_label": "notes",
"values": [
{
"date_time_created": {
"api_type": "system",
"display_label": "Created",
"value": "2017-05-11T13:45:53.200Z"
},
"id_created_by": {
"api_type": "system",
"display_label": "Created By",
"value": "123456789"
},
"note": {
"api_type": "read-only",
"display_label": "Note",
"value": "blah blah blah"
}
}
]
},
"status": {
"api_type": "modifiable",
"display_label": "Status",
"value": "Open"
}
}
]
},
"religion": {
"code": {
"api_type": "read-only",
"display_label": "Code",
"value": "LDS"
},
"lds_tenure": {
"api_type": "read-only",
"display_label": "LDS Tenure",
"value": "3.5"
},
"links": {
"religion__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/religion",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mission_end": {
"api_type": "read-only",
"display_label": "Mission End",
"value": "2017-05-18"
},
"mission_name": {
"api_type": "read-only",
"display_label": "Mission Name",
"value": "Utah South Mission"
},
"mission_start": {
"api_type": "read-only",
"display_label": "Mission Start",
"value": "2015-05-18"
}
},
"scoring": {
"enumerated_attributes": {
"api_type": "read-only",
"display_label": "Enumerated Attributes",
"values": [
{
"key": "location",
"value": "CA"
},
{
"key": "sex",
"value": "M"
},
{
"key": "religion",
"value": "LDS"
},
{
"key": "father_school",
"value": "SHS"
},
{
"key": "mother_school",
"value": "SC"
}
]
},
"links": {
"scoring__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/scoring",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"metric_attributes": {
"api_type": "read-only",
"display_label": "metric_attributes",
"values": [
{
"key": "act",
"value": 30
},
{
"key": "ap_ib",
"value": 6
},
{
"key": "hsgpa",
"value": 3.875
},
{
"key": "cgpa",
"value": 0
},
{
"key": "cscale",
"value": 0.75
}
]
}
}
}
]
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Get the specified admission packet
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
| context | Select a predefined set of subresources | query | string | #/parameters/context |
| field_sets | select which subresources are to be returned | query | string | #/parameters/field_sets |
Uses default content-types: application/json
- 200 OK
-
Retrieved an admissions packet
Example for application/json{
"academics": {
"act_composite": {
"api_type": "read-only",
"display_label": "ACT Composite",
"value": "34"
},
"ap_ib_count": {
"api_type": "read-only",
"display_label": "AP/IB Class Count",
"value": "3"
},
"date_time_updated": {
"api_type": "system",
"display_label": "date_time_updated",
"value": "2014-05-11T13:45:53.200Z"
},
"egpa": {
"api_type": "modifiable",
"display_label": "Freshman EGPA",
"value": "3.875"
},
"gpa_byu": {
"api_type": "read-only",
"display_label": "BYU GPA",
"value": "3.875"
},
"gpa_college": {
"api_type": "read-only",
"display_label": "College GPA",
"value": "3.875"
},
"gpa_hs": {
"api_type": "read-only",
"display_label": "High School GPA",
"value": "3.875"
},
"id_updated_by": {
"api_type": "system",
"display_label": "id_updated_by",
"value": "123456789"
},
"links": {
"academics__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "GET",
"rel": "self"
},
"academics__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "PUT",
"rel": "academics__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
},
"basic": {
"admit_period": {
"api_type": "system",
"display_label": "Admit Period",
"value": "2018 Fall"
},
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"value": "123456789"
},
"applicant_major": {
"api_type": "system",
"display_label": "Applicant Major",
"value": "English"
},
"applicant_name": {
"api_type": "system",
"display_label": "Applicant Name",
"value": "John Smith"
},
"applicant_type": {
"api_type": "system",
"display_label": "Applicant Type",
"value": "Freshman"
},
"application_uuid": {
"api_type": "system",
"display_label": "application_uuid",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"institution": {
"api_type": "system",
"display_label": "Institution",
"value": "BYUP"
},
"links": {
"basic__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
},
"biographical": {
"age": {
"api_type": "read-only",
"display_label": "Age",
"value": "M"
},
"birthdate": {
"api_type": "read-only",
"display_label": "Birth Date",
"value": "2000-05-11"
},
"citizenship": {
"api_type": "read-only",
"display_label": "Citizenship",
"value": "N"
},
"city": {
"api_type": "read-only",
"display_label": "City",
"value": "Springfield"
},
"country": {
"api_type": "read-only",
"display_label": "Country",
"value": "USA"
},
"fathers_education": {
"api_type": "read-only",
"display_label": "Fathers Education",
"value": "N"
},
"language": {
"api_type": "read-only",
"display_label": "Language",
"value": [
"English"
]
},
"links": {
"biographical__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/biographical",
"method": "GET",
"rel": "self"
}
},
"marital_status": {
"api_type": "read-only",
"display_label": "Marital Status",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mothers_education": {
"api_type": "read-only",
"display_label": "Mothers Education",
"value": "N"
},
"race": {
"api_type": "read-only",
"display_label": "Race",
"value": [
"White"
]
},
"sex": {
"api_type": "read-only",
"display_label": "Sex",
"value": "M"
},
"state": {
"api_type": "read-only",
"display_label": "State",
"value": "IL"
},
"visa_type": {
"api_type": "read-only",
"display_label": "Visa Type",
"value": "N"
}
},
"decision": {
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2017-05-11T13:45:53.200Z"
},
"id_updated_by": {
"api_type": "system",
"display_label": "Updated By",
"value": "123456789"
},
"links": {
"decision__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "GET",
"rel": "self"
},
"decision__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "PUT",
"rel": "decision__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model": {
"api_type": "modifiable",
"display_label": "Model",
"value": ""
},
"reason": {
"api_type": "modifiable",
"display_label": "Reason",
"value": ""
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "None"
}
},
"evaluations": {
"links": {
"evaluations__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/ea9a774-dfe8-4dfd-8a2a-bb2edc984407/evaluations",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"comments": [
{
"by_id": "123456789",
"date_time": "2017-05-11T13:45:53.200Z",
"value": "This is a comment"
}
],
"composite_score": {
"api_type": "modifiable",
"display_label": "Composite Score",
"value": "93.25"
},
"date_time_created": {
"api_type": "system",
"display_label": "Assigned",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Scored",
"value": "2017-05-11T13:45:53.200Z"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"reader_id": {
"api_type": "modifiable",
"display_label": "Reader ID",
"value": "123456789"
},
"subscores": [
{
"key": "2017F-02",
"value": 4
}
]
}
]
},
"flags": {
"links": {
"flag__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "PUT",
"rel": "flag__modify"
},
"flags__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Short Mission"
},
"type": {
"api_type": "modifiable",
"display_label": "Type",
"value": "Warning"
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "SM"
}
}
]
},
"links": {
"packet__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"contexts_available": {
"all": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"profile": [
"basic",
"academics",
"bio",
"religion"
],
"scoring_elements": [
"basic",
"scores",
"evaluations"
]
},
"field_sets_available": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"field_sets_returned": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model_results": {
"links": {
"model_results__add": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results",
"method": "POST",
"rel": "model_results__add"
},
"model_results__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"links": {
"model_result__remove": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "DELETE",
"rel": "model_result__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model_id": {
"api_type": "system",
"display_label": "Model ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"model_name": {
"api_type": "modifiable",
"display_label": "Model Name",
"value": "IntlFreshmen2018"
},
"rank": {
"api_type": "modifiable",
"display_label": "Rank",
"pool": "4639",
"value": "3785"
},
"score": {
"api_type": "modifiable",
"display_label": "Score",
"value": "87.75"
}
}
]
},
"packet": {
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"value": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
},
"links": {
"packet_metadata__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "GET",
"rel": "self"
},
"packet_metadata__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "PUT",
"rel": "packet_metadata__modify"
}
},
"log": {
"api_type": "read-only",
"display_label": "Log",
"value": [
{
"action": "score",
"by_id": "123456789",
"date_time": "1970-01-01T00:00:00.000Z"
}
]
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"process_refs": {
"api_type": "modifiable",
"display_label": "Packet Metadata Process References",
"value": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
},
"type": {
"api_type": "system",
"display_label": "Packet Type",
"value": "Decision Processing"
},
"uuid": {
"api_type": "system",
"display_label": "Packet ID",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
},
"processes": {
"links": {
"processes__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes",
"method": "GET",
"rel": "self"
},
"processes__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes",
"method": "PUT",
"rel": "processes__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "GET",
"rel": "self"
},
"process__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "PUT",
"rel": "process__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "read-only",
"display_label": "Name",
"value": "endorsement"
},
"notes": {
"api_type": "modifiable",
"display_label": "notes",
"values": [
{
"date_time_created": {
"api_type": "system",
"display_label": "Created",
"value": "2017-05-11T13:45:53.200Z"
},
"id_created_by": {
"api_type": "system",
"display_label": "Created By",
"value": "123456789"
},
"note": {
"api_type": "read-only",
"display_label": "Note",
"value": "blah blah blah"
}
}
]
},
"status": {
"api_type": "modifiable",
"display_label": "Status",
"value": "Open"
}
}
]
},
"religion": {
"code": {
"api_type": "read-only",
"display_label": "Code",
"value": "LDS"
},
"lds_tenure": {
"api_type": "read-only",
"display_label": "LDS Tenure",
"value": "3.5"
},
"links": {
"religion__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/religion",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mission_end": {
"api_type": "read-only",
"display_label": "Mission End",
"value": "2017-05-18"
},
"mission_name": {
"api_type": "read-only",
"display_label": "Mission Name",
"value": "Utah South Mission"
},
"mission_start": {
"api_type": "read-only",
"display_label": "Mission Start",
"value": "2015-05-18"
}
},
"scoring": {
"enumerated_attributes": {
"api_type": "read-only",
"display_label": "Enumerated Attributes",
"values": [
{
"key": "location",
"value": "CA"
},
{
"key": "sex",
"value": "M"
},
{
"key": "religion",
"value": "LDS"
},
{
"key": "father_school",
"value": "SHS"
},
{
"key": "mother_school",
"value": "SC"
}
]
},
"links": {
"scoring__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/scoring",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"metric_attributes": {
"api_type": "read-only",
"display_label": "metric_attributes",
"values": [
{
"key": "act",
"value": 30
},
{
"key": "ap_ib",
"value": 6
},
{
"key": "hsgpa",
"value": 3.875
},
{
"key": "cgpa",
"value": 0
},
{
"key": "cscale",
"value": 0.75
}
]
}
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Creates a new admissions packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 201 Created
-
Admissions packet successfully created
Example for application/json{
"academics": {
"act_composite": {
"api_type": "read-only",
"display_label": "ACT Composite",
"value": "34"
},
"ap_ib_count": {
"api_type": "read-only",
"display_label": "AP/IB Class Count",
"value": "3"
},
"date_time_updated": {
"api_type": "system",
"display_label": "date_time_updated",
"value": "2014-05-11T13:45:53.200Z"
},
"egpa": {
"api_type": "modifiable",
"display_label": "Freshman EGPA",
"value": "3.875"
},
"gpa_byu": {
"api_type": "read-only",
"display_label": "BYU GPA",
"value": "3.875"
},
"gpa_college": {
"api_type": "read-only",
"display_label": "College GPA",
"value": "3.875"
},
"gpa_hs": {
"api_type": "read-only",
"display_label": "High School GPA",
"value": "3.875"
},
"id_updated_by": {
"api_type": "system",
"display_label": "id_updated_by",
"value": "123456789"
},
"links": {
"academics__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "GET",
"rel": "self"
},
"academics__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "PUT",
"rel": "academics__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
},
"basic": {
"admit_period": {
"api_type": "system",
"display_label": "Admit Period",
"value": "2018 Fall"
},
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"value": "123456789"
},
"applicant_major": {
"api_type": "system",
"display_label": "Applicant Major",
"value": "English"
},
"applicant_name": {
"api_type": "system",
"display_label": "Applicant Name",
"value": "John Smith"
},
"applicant_type": {
"api_type": "system",
"display_label": "Applicant Type",
"value": "Freshman"
},
"application_uuid": {
"api_type": "system",
"display_label": "application_uuid",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"institution": {
"api_type": "system",
"display_label": "Institution",
"value": "BYUP"
},
"links": {
"basic__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
},
"biographical": {
"age": {
"api_type": "read-only",
"display_label": "Age",
"value": "M"
},
"birthdate": {
"api_type": "read-only",
"display_label": "Birth Date",
"value": "2000-05-11"
},
"citizenship": {
"api_type": "read-only",
"display_label": "Citizenship",
"value": "N"
},
"city": {
"api_type": "read-only",
"display_label": "City",
"value": "Springfield"
},
"country": {
"api_type": "read-only",
"display_label": "Country",
"value": "USA"
},
"fathers_education": {
"api_type": "read-only",
"display_label": "Fathers Education",
"value": "N"
},
"language": {
"api_type": "read-only",
"display_label": "Language",
"value": [
"English"
]
},
"links": {
"biographical__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/biographical",
"method": "GET",
"rel": "self"
}
},
"marital_status": {
"api_type": "read-only",
"display_label": "Marital Status",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mothers_education": {
"api_type": "read-only",
"display_label": "Mothers Education",
"value": "N"
},
"race": {
"api_type": "read-only",
"display_label": "Race",
"value": [
"White"
]
},
"sex": {
"api_type": "read-only",
"display_label": "Sex",
"value": "M"
},
"state": {
"api_type": "read-only",
"display_label": "State",
"value": "IL"
},
"visa_type": {
"api_type": "read-only",
"display_label": "Visa Type",
"value": "N"
}
},
"decision": {
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2017-05-11T13:45:53.200Z"
},
"id_updated_by": {
"api_type": "system",
"display_label": "Updated By",
"value": "123456789"
},
"links": {
"decision__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "GET",
"rel": "self"
},
"decision__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "PUT",
"rel": "decision__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model": {
"api_type": "modifiable",
"display_label": "Model",
"value": ""
},
"reason": {
"api_type": "modifiable",
"display_label": "Reason",
"value": ""
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "None"
}
},
"evaluations": {
"links": {
"evaluations__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/ea9a774-dfe8-4dfd-8a2a-bb2edc984407/evaluations",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"comments": [
{
"by_id": "123456789",
"date_time": "2017-05-11T13:45:53.200Z",
"value": "This is a comment"
}
],
"composite_score": {
"api_type": "modifiable",
"display_label": "Composite Score",
"value": "93.25"
},
"date_time_created": {
"api_type": "system",
"display_label": "Assigned",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Scored",
"value": "2017-05-11T13:45:53.200Z"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"reader_id": {
"api_type": "modifiable",
"display_label": "Reader ID",
"value": "123456789"
},
"subscores": [
{
"key": "2017F-02",
"value": 4
}
]
}
]
},
"flags": {
"links": {
"flag__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "PUT",
"rel": "flag__modify"
},
"flags__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Short Mission"
},
"type": {
"api_type": "modifiable",
"display_label": "Type",
"value": "Warning"
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "SM"
}
}
]
},
"links": {
"packet__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"contexts_available": {
"all": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"profile": [
"basic",
"academics",
"bio",
"religion"
],
"scoring_elements": [
"basic",
"scores",
"evaluations"
]
},
"field_sets_available": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"field_sets_returned": [
"packet_metadata",
"basic",
"academics",
"bio",
"decision",
"religion",
"processes",
"flags",
"scores",
"evaluations",
"model_results"
],
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model_results": {
"links": {
"model_results__add": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results",
"method": "POST",
"rel": "model_results__add"
},
"model_results__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"links": {
"model_result__remove": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "DELETE",
"rel": "model_result__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model_id": {
"api_type": "system",
"display_label": "Model ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"model_name": {
"api_type": "modifiable",
"display_label": "Model Name",
"value": "IntlFreshmen2018"
},
"rank": {
"api_type": "modifiable",
"display_label": "Rank",
"pool": "4639",
"value": "3785"
},
"score": {
"api_type": "modifiable",
"display_label": "Score",
"value": "87.75"
}
}
]
},
"packet": {
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"value": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
},
"links": {
"packet_metadata__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "GET",
"rel": "self"
},
"packet_metadata__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "PUT",
"rel": "packet_metadata__modify"
}
},
"log": {
"api_type": "read-only",
"display_label": "Log",
"value": [
{
"action": "score",
"by_id": "123456789",
"date_time": "1970-01-01T00:00:00.000Z"
}
]
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"process_refs": {
"api_type": "modifiable",
"display_label": "Packet Metadata Process References",
"value": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
},
"type": {
"api_type": "system",
"display_label": "Packet Type",
"value": "Decision Processing"
},
"uuid": {
"api_type": "system",
"display_label": "Packet ID",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
},
"processes": {
"links": {
"processes__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes",
"method": "GET",
"rel": "self"
},
"processes__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes",
"method": "PUT",
"rel": "processes__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "GET",
"rel": "self"
},
"process__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "PUT",
"rel": "process__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "read-only",
"display_label": "Name",
"value": "endorsement"
},
"notes": {
"api_type": "modifiable",
"display_label": "notes",
"values": [
{
"date_time_created": {
"api_type": "system",
"display_label": "Created",
"value": "2017-05-11T13:45:53.200Z"
},
"id_created_by": {
"api_type": "system",
"display_label": "Created By",
"value": "123456789"
},
"note": {
"api_type": "read-only",
"display_label": "Note",
"value": "blah blah blah"
}
}
]
},
"status": {
"api_type": "modifiable",
"display_label": "Status",
"value": "Open"
}
}
]
},
"religion": {
"code": {
"api_type": "read-only",
"display_label": "Code",
"value": "LDS"
},
"lds_tenure": {
"api_type": "read-only",
"display_label": "LDS Tenure",
"value": "3.5"
},
"links": {
"religion__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/religion",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mission_end": {
"api_type": "read-only",
"display_label": "Mission End",
"value": "2017-05-18"
},
"mission_name": {
"api_type": "read-only",
"display_label": "Mission Name",
"value": "Utah South Mission"
},
"mission_start": {
"api_type": "read-only",
"display_label": "Mission Start",
"value": "2015-05-18"
}
},
"scoring": {
"enumerated_attributes": {
"api_type": "read-only",
"display_label": "Enumerated Attributes",
"values": [
{
"key": "location",
"value": "CA"
},
{
"key": "sex",
"value": "M"
},
{
"key": "religion",
"value": "LDS"
},
{
"key": "father_school",
"value": "SHS"
},
{
"key": "mother_school",
"value": "SC"
}
]
},
"links": {
"scoring__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/scoring",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"metric_attributes": {
"api_type": "read-only",
"display_label": "metric_attributes",
"values": [
{
"key": "act",
"value": 30
},
{
"key": "ap_ib",
"value": 6
},
{
"key": "hsgpa",
"value": 3.875
},
{
"key": "cgpa",
"value": 0
},
{
"key": "cscale",
"value": 0.75
}
]
}
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the academic field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet academic information
Example for application/json{
"act_composite": {
"api_type": "read-only",
"display_label": "ACT Composite",
"value": "34"
},
"ap_ib_count": {
"api_type": "read-only",
"display_label": "AP/IB Class Count",
"value": "3"
},
"date_time_updated": {
"api_type": "system",
"display_label": "date_time_updated",
"value": "2014-05-11T13:45:53.200Z"
},
"egpa": {
"api_type": "modifiable",
"display_label": "Freshman EGPA",
"value": "3.875"
},
"gpa_byu": {
"api_type": "read-only",
"display_label": "BYU GPA",
"value": "3.875"
},
"gpa_college": {
"api_type": "read-only",
"display_label": "College GPA",
"value": "3.875"
},
"gpa_hs": {
"api_type": "read-only",
"display_label": "High School GPA",
"value": "3.875"
},
"id_updated_by": {
"api_type": "system",
"display_label": "id_updated_by",
"value": "123456789"
},
"links": {
"academics__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "GET",
"rel": "self"
},
"academics__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "PUT",
"rel": "academics__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify the EGPA fields in an admissions packet
Modify admissions packet academics
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Modified packet academics
Example for application/json{
"act_composite": {
"api_type": "read-only",
"display_label": "ACT Composite",
"value": "34"
},
"ap_ib_count": {
"api_type": "read-only",
"display_label": "AP/IB Class Count",
"value": "3"
},
"date_time_updated": {
"api_type": "system",
"display_label": "date_time_updated",
"value": "2014-05-11T13:45:53.200Z"
},
"egpa": {
"api_type": "modifiable",
"display_label": "Freshman EGPA",
"value": "3.875"
},
"gpa_byu": {
"api_type": "read-only",
"display_label": "BYU GPA",
"value": "3.875"
},
"gpa_college": {
"api_type": "read-only",
"display_label": "College GPA",
"value": "3.875"
},
"gpa_hs": {
"api_type": "read-only",
"display_label": "High School GPA",
"value": "3.875"
},
"id_updated_by": {
"api_type": "system",
"display_label": "id_updated_by",
"value": "123456789"
},
"links": {
"academics__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "GET",
"rel": "self"
},
"academics__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "PUT",
"rel": "academics__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the biographical field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet biographical information
Example for application/json{
"age": {
"api_type": "read-only",
"display_label": "Age",
"value": "M"
},
"birthdate": {
"api_type": "read-only",
"display_label": "Birth Date",
"value": "2000-05-11"
},
"citizenship": {
"api_type": "read-only",
"display_label": "Citizenship",
"value": "N"
},
"city": {
"api_type": "read-only",
"display_label": "City",
"value": "Springfield"
},
"country": {
"api_type": "read-only",
"display_label": "Country",
"value": "USA"
},
"fathers_education": {
"api_type": "read-only",
"display_label": "Fathers Education",
"value": "N"
},
"language": {
"api_type": "read-only",
"display_label": "Language",
"value": [
"English"
]
},
"links": {
"biographical__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/biographical",
"method": "GET",
"rel": "self"
}
},
"marital_status": {
"api_type": "read-only",
"display_label": "Marital Status",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mothers_education": {
"api_type": "read-only",
"display_label": "Mothers Education",
"value": "N"
},
"race": {
"api_type": "read-only",
"display_label": "Race",
"value": [
"White"
]
},
"sex": {
"api_type": "read-only",
"display_label": "Sex",
"value": "M"
},
"state": {
"api_type": "read-only",
"display_label": "State",
"value": "IL"
},
"visa_type": {
"api_type": "read-only",
"display_label": "Visa Type",
"value": "N"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the decision field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet decision information
Example for application/json{
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2017-05-11T13:45:53.200Z"
},
"id_updated_by": {
"api_type": "system",
"display_label": "Updated By",
"value": "123456789"
},
"links": {
"decision__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "GET",
"rel": "self"
},
"decision__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "PUT",
"rel": "decision__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model": {
"api_type": "modifiable",
"display_label": "Model",
"value": ""
},
"reason": {
"api_type": "modifiable",
"display_label": "Reason",
"value": ""
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "None"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify the decision information in an admissions packet
Modify admissions packet decision information
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Packet decision information modified
Example for application/json{
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2017-05-11T13:45:53.200Z"
},
"id_updated_by": {
"api_type": "system",
"display_label": "Updated By",
"value": "123456789"
},
"links": {
"decision__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "GET",
"rel": "self"
},
"decision__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "PUT",
"rel": "decision__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model": {
"api_type": "modifiable",
"display_label": "Model",
"value": ""
},
"reason": {
"api_type": "modifiable",
"display_label": "Reason",
"value": ""
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "None"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the evaluations field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet evaluation information
Example for application/json{
"links": {
"evaluations__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/ea9a774-dfe8-4dfd-8a2a-bb2edc984407/evaluations",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"comments": [
{
"by_id": "123456789",
"date_time": "2017-05-11T13:45:53.200Z",
"value": "This is a comment"
}
],
"composite_score": {
"api_type": "modifiable",
"display_label": "Composite Score",
"value": "93.25"
},
"date_time_created": {
"api_type": "system",
"display_label": "Assigned",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Scored",
"value": "2017-05-11T13:45:53.200Z"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"reader_id": {
"api_type": "modifiable",
"display_label": "Reader ID",
"value": "123456789"
},
"subscores": [
{
"key": "2017F-02",
"value": 4
}
]
}
]
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify the evaluation information in an admissions packet
Modify admissions packet evaluation
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Packet evaluation modified
Example for application/json{
"comments": [
{
"by_id": "123456789",
"date_time": "2017-05-11T13:45:53.200Z",
"value": "This is a comment"
}
],
"composite_score": {
"api_type": "modifiable",
"display_label": "Composite Score",
"value": "93.25"
},
"date_time_created": {
"api_type": "system",
"display_label": "Assigned",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Scored",
"value": "2017-05-11T13:45:53.200Z"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"reader_id": {
"api_type": "modifiable",
"display_label": "Reader ID",
"value": "123456789"
},
"subscores": [
{
"key": "2017F-02",
"value": 4
}
]
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the flags field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet flag information
Example for application/json{
"links": {
"flag__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "PUT",
"rel": "flag__modify"
},
"flags__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Short Mission"
},
"type": {
"api_type": "modifiable",
"display_label": "Type",
"value": "Warning"
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "SM"
}
}
]
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify a flag in an admissions packet
Modify admissions packet flag
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Packet flag modified
Example for application/json{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Short Mission"
},
"type": {
"api_type": "modifiable",
"display_label": "Type",
"value": "Warning"
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "SM"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the model scores field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet model score information
Example for application/json{
"links": {
"model_results__add": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results",
"method": "POST",
"rel": "model_results__add"
},
"model_results__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"links": {
"model_result__remove": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "DELETE",
"rel": "model_result__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model_id": {
"api_type": "system",
"display_label": "Model ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"model_name": {
"api_type": "modifiable",
"display_label": "Model Name",
"value": "IntlFreshmen2018"
},
"rank": {
"api_type": "modifiable",
"display_label": "Rank",
"pool": "4639",
"value": "3785"
},
"score": {
"api_type": "modifiable",
"display_label": "Score",
"value": "87.75"
}
}
]
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Add model score data to an admissions packet
Add admissions packet model score information
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 201 Created
-
Packet model score modified
Example for application/json{
"links": {
"model_result__remove": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/model_results/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "DELETE",
"rel": "model_result__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model_id": {
"api_type": "system",
"display_label": "Model ID",
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"model_name": {
"api_type": "modifiable",
"display_label": "Model Name",
"value": "IntlFreshmen2018"
},
"rank": {
"api_type": "modifiable",
"display_label": "Rank",
"pool": "4639",
"value": "3785"
},
"score": {
"api_type": "modifiable",
"display_label": "Score",
"value": "87.75"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Get the packet model scores field set
DELETE /{packet_id}/model_results/{model_id}
Tags: Model ScoresRemove a model score from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
| model_id | Model UUID | path | string | #/parameters/model_id |
Uses default content-types: application/json
- 204 No Content
-
Removed packet model score information
- 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the packet metadata field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet metadata
Example for application/json{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"value": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
},
"links": {
"packet_metadata__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "GET",
"rel": "self"
},
"packet_metadata__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "PUT",
"rel": "packet_metadata__modify"
}
},
"log": {
"api_type": "read-only",
"display_label": "Log",
"value": [
{
"action": "score",
"by_id": "123456789",
"date_time": "1970-01-01T00:00:00.000Z"
}
]
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"process_refs": {
"api_type": "modifiable",
"display_label": "Packet Metadata Process References",
"value": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
},
"type": {
"api_type": "system",
"display_label": "Packet Type",
"value": "Decision Processing"
},
"uuid": {
"api_type": "system",
"display_label": "Packet ID",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify packet metadata
Modify admissions packet metadata
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Packet metadata modified
Example for application/json{
"attributes": {
"api_type": "modifiable",
"display_label": "Attributes",
"value": [
{
"key": "admit_period",
"value": "2018F"
},
{
"key": "name",
"value": "IntF"
},
{
"key": "description",
"value": "International Freshmen"
},
{
"key": "type",
"value": "SCREEN"
}
]
},
"links": {
"packet_metadata__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "GET",
"rel": "self"
},
"packet_metadata__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/packet",
"method": "PUT",
"rel": "packet_metadata__modify"
}
},
"log": {
"api_type": "read-only",
"display_label": "Log",
"value": [
{
"action": "score",
"by_id": "123456789",
"date_time": "1970-01-01T00:00:00.000Z"
}
]
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"process_refs": {
"api_type": "modifiable",
"display_label": "Packet Metadata Process References",
"value": [
"cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
]
},
"type": {
"api_type": "system",
"display_label": "Packet Type",
"value": "Decision Processing"
},
"uuid": {
"api_type": "system",
"display_label": "Packet ID",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the processes field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet process information
Example for application/json{
"links": {
"processes__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes",
"method": "GET",
"rel": "self"
},
"processes__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/processes",
"method": "PUT",
"rel": "processes__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "GET",
"rel": "self"
},
"process__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "PUT",
"rel": "process__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "read-only",
"display_label": "Name",
"value": "endorsement"
},
"notes": {
"api_type": "modifiable",
"display_label": "notes",
"values": [
{
"date_time_created": {
"api_type": "system",
"display_label": "Created",
"value": "2017-05-11T13:45:53.200Z"
},
"id_created_by": {
"api_type": "system",
"display_label": "Created By",
"value": "123456789"
},
"note": {
"api_type": "read-only",
"display_label": "Note",
"value": "blah blah blah"
}
}
]
},
"status": {
"api_type": "modifiable",
"display_label": "Status",
"value": "Open"
}
}
]
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify process information in an admissions packet
Modify admissions packet process information
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Packet process information modified
Example for application/json{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"links": {
"process__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "GET",
"rel": "self"
},
"process__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/:packet_id/processes/:process_name",
"method": "PUT",
"rel": "process__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "read-only",
"display_label": "Name",
"value": "endorsement"
},
"notes": {
"api_type": "modifiable",
"display_label": "notes",
"values": [
{
"date_time_created": {
"api_type": "system",
"display_label": "Created",
"value": "2017-05-11T13:45:53.200Z"
},
"id_created_by": {
"api_type": "system",
"display_label": "Created By",
"value": "123456789"
},
"note": {
"api_type": "read-only",
"display_label": "Note",
"value": "blah blah blah"
}
}
]
},
"status": {
"api_type": "modifiable",
"display_label": "Status",
"value": "Open"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the religion field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet religion information
Example for application/json{
"code": {
"api_type": "read-only",
"display_label": "Code",
"value": "LDS"
},
"lds_tenure": {
"api_type": "read-only",
"display_label": "LDS Tenure",
"value": "3.5"
},
"links": {
"religion__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/religion",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mission_end": {
"api_type": "read-only",
"display_label": "Mission End",
"value": "2017-05-18"
},
"mission_name": {
"api_type": "read-only",
"display_label": "Mission Name",
"value": "Utah South Mission"
},
"mission_start": {
"api_type": "read-only",
"display_label": "Mission Start",
"value": "2015-05-18"
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Returns the scoring field set from the specified packet.
| packet_id | Packet UUID | path | string | #/parameters/packet_id |
Uses default content-types: application/json
- 200 OK
-
Retrieved packet scoring information
Example for application/json{
"enumerated_attributes": {
"api_type": "read-only",
"display_label": "Enumerated Attributes",
"values": [
{
"key": "location",
"value": "CA"
},
{
"key": "sex",
"value": "M"
},
{
"key": "religion",
"value": "LDS"
},
{
"key": "father_school",
"value": "SHS"
},
{
"key": "mother_school",
"value": "SC"
}
]
},
"links": {
"scoring__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/scoring",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"metric_attributes": {
"api_type": "read-only",
"display_label": "metric_attributes",
"values": [
{
"key": "act",
"value": 30
},
{
"key": "ap_ib",
"value": 6
},
{
"key": "hsgpa",
"value": 3.875
},
{
"key": "cgpa",
"value": 0
},
{
"key": "cscale",
"value": 0.75
}
]
}
} - 400 Bad Request #/responses/400
-
Invalid Request - unable to interpret request
- 401 Unauthorized #/responses/401
-
Authentication required to access data
- 403 Forbidden #/responses/403
-
Access denied to protected data
- 404 Not Found #/responses/404
-
Application not found
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Parameter definitions
Response definitions
- 400
-
Invalid Request - unable to interpret request
- 401
-
Authentication required to access data
- 403
-
Access denied to protected data
- 404
-
Application not found
- 409
-
Query parameters conflict or are malformed
- default
-
Unexpected error
Schema definitions
{
"act_composite": {
"api_type": "read-only",
"display_label": "ACT Composite",
"value": "34"
},
"ap_ib_count": {
"api_type": "read-only",
"display_label": "AP/IB Class Count",
"value": "3"
},
"date_time_updated": {
"api_type": "system",
"display_label": "date_time_updated",
"value": "2014-05-11T13:45:53.200Z"
},
"egpa": {
"api_type": "modifiable",
"display_label": "Freshman EGPA",
"value": "3.875"
},
"gpa_byu": {
"api_type": "read-only",
"display_label": "BYU GPA",
"value": "3.875"
},
"gpa_college": {
"api_type": "read-only",
"display_label": "College GPA",
"value": "3.875"
},
"gpa_hs": {
"api_type": "read-only",
"display_label": "High School GPA",
"value": "3.875"
},
"id_updated_by": {
"api_type": "system",
"display_label": "id_updated_by",
"value": "123456789"
},
"links": {
"academics__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "GET",
"rel": "self"
},
"academics__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/academics",
"method": "PUT",
"rel": "academics__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
} - links: object
-
Hypermedia links that operate on academic information
- academics__info: object
-
Hypermedia link to retrieve academic information
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/:packet_id/academics
-
- method: string , x ∈ { GET (default) }
-
- academics__modify: object
-
Hypermedia link to modify academic information
- rel: string , x ∈ { academics__modify (default) }
-
- href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/:packet_id/academics
-
- method: string , x ∈ { PUT (default) }
-
- metadata: metadata_simple
-
- act_composite: academics_act_composite
-
- ap_ib_count: academics_ap_ib_count
-
- egpa: academics_egpa
-
- gpa_byu: academics_gpa_byu
-
- gpa_hs: academics_gpa_hs
-
- gpa_college: academics_gpa_college
-
- id_updated_by: std_id_updated_by
-
- date_time_updated: std_date_time_updated
-
Academics: ACT Composite
{
"api_type": "read-only",
"display_label": "ACT Composite",
"value": "34"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string academics_act_composite
-
Academics: AP/IB Class Count
{
"api_type": "modifiable",
"display_label": "AP/IB Class Count",
"value": "3"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string AP/IB Class Count
-
Academics: Freshman EGPA
{
"api_type": "modifiable",
"display_label": "Freshman EGPA",
"value": "3.875"
} - value: string
-
- api_type: string , x ∈ { modifiable (default) }
-
- display_label: string Freshman EGPA
-
Academics: BYU GPA
{
"api_type": "read-only",
"display_label": "BYU GPA",
"value": "3.875"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string BYU GPA
-
Academics: College GPA
{
"api_type": "read-only",
"display_label": "College GPA",
"value": "3.875"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string College GPA
-
Academics: High School GPA
{
"api_type": "read-only",
"display_label": "High School GPA",
"value": "3.875"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string High School GPA
-
Modifiable academic information.
{
"egpa": "3.875",
"id_updated_by": "123456789"
} - egpa: string
-
- id_updated_by: string
-
{
"admit_period": {
"api_type": "system",
"display_label": "Admit Period",
"value": "2018 Fall"
},
"applicant_id": {
"api_type": "system",
"display_label": "Applicant ID",
"value": "123456789"
},
"applicant_major": {
"api_type": "system",
"display_label": "Applicant Major",
"value": "English"
},
"applicant_name": {
"api_type": "system",
"display_label": "Applicant Name",
"value": "John Smith"
},
"applicant_type": {
"api_type": "system",
"display_label": "Applicant Type",
"value": "Freshman"
},
"application_uuid": {
"api_type": "system",
"display_label": "application_uuid",
"key": true,
"value": "cea9a774-dfe8-4dfd-8a2a-bb2edc984407"
},
"institution": {
"api_type": "system",
"display_label": "Institution",
"value": "BYUP"
},
"links": {
"basic__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
}
} - links: object
-
Hypermedia links that operate on basic packet information
- basic__info: object
-
Hypermedia link to retrieve a specific packet
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/:packet_id
-
- method: string , x ∈ { GET (default) }
-
- metadata: metadata_simple
-
- institution: std_institution
-
- admit_period: std_admit_period
-
- application_uuid: uuid
-
- applicant_type: std_applicant_type
-
- applicant_id: std_applicant_id
-
- applicant_name: std_applicant_name
-
- applicant_major: std_applicant_major
-
{
"age": {
"api_type": "read-only",
"display_label": "Age",
"value": "M"
},
"birthdate": {
"api_type": "read-only",
"display_label": "Birth Date",
"value": "2000-05-11"
},
"citizenship": {
"api_type": "read-only",
"display_label": "Citizenship",
"value": "N"
},
"city": {
"api_type": "read-only",
"display_label": "City",
"value": "Springfield"
},
"country": {
"api_type": "read-only",
"display_label": "Country",
"value": "USA"
},
"fathers_education": {
"api_type": "read-only",
"display_label": "Fathers Education",
"value": "N"
},
"language": {
"api_type": "read-only",
"display_label": "Language",
"value": [
"English"
]
},
"links": {
"biographical__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/biographical",
"method": "GET",
"rel": "self"
}
},
"marital_status": {
"api_type": "read-only",
"display_label": "Marital Status",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"mothers_education": {
"api_type": "read-only",
"display_label": "Mothers Education",
"value": "N"
},
"race": {
"api_type": "read-only",
"display_label": "Race",
"value": [
"White"
]
},
"sex": {
"api_type": "read-only",
"display_label": "Sex",
"value": "M"
},
"state": {
"api_type": "read-only",
"display_label": "State",
"value": "IL"
},
"visa_type": {
"api_type": "read-only",
"display_label": "Visa Type",
"value": "N"
}
} - links: object
-
Hypermedia links that operate on Biographical Information
- biographical__info: object
-
Hypermedia link to retrieve biographical information
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/:packet_id/biographical
-
- method: string , x ∈ { GET (default) }
-
- metadata: metadata_simple
-
- age: biographical_age
-
- sex: biographical_sex
-
- birthdate: biographical_birthdate
-
- marital_status: biographical_marital_status
-
- fathers_education: biographical_fathers_education
-
- mothers_education: biographical_mothers_education
-
- citizenship: biographical_citizenship
-
- visa_type: biographical_visa_type
-
- city: biographical_city
-
- state: biographical_state
-
- country: biographical_country
-
- race: biographical_race
-
- language: biographical_language
-
Biographical Information: Age
{
"api_type": "read-only",
"display_label": "Age",
"value": "M"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Age
-
Biographical Information: Birth Date
{
"api_type": "read-only",
"display_label": "Birth Date",
"value": "2000-05-11"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Birth Date
-
Biographical Information: Citizenship
{
"api_type": "read-only",
"display_label": "Citizenship",
"value": "N"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Ccitizenship
-
Biographical Information: City
{
"api_type": "read-only",
"display_label": "City",
"value": "Springfield"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string City
-
Biographical Information: Country
{
"api_type": "read-only",
"display_label": "Country",
"value": "USA"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Country
-
Biographical Information: Fathers Education
{
"api_type": "read-only",
"display_label": "Fathers Education",
"value": "N"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Fathers Education
-
Biographical Information: Language
{
"api_type": "read-only",
"display_label": "Language",
"value": [
"English"
]
} - value: string[]
-
string - api_type: string , x ∈ { read-only (default) }
-
- display_label: string Language
-
Biographical Information: Marital Status
{
"api_type": "read-only",
"display_label": "Marital Status",
"value": "N"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Marital Status
-
Biographical Information: Mothers Education
{
"api_type": "read-only",
"display_label": "Mothers Education",
"value": "N"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Mmothers Education
-
Biographical Information: Race
{
"api_type": "read-only",
"display_label": "Race",
"value": [
"White"
]
} - value: string[]
-
string - api_type: string , x ∈ { read-only (default) }
-
- display_label: string Race
-
Biographical Information: Sex
{
"api_type": "read-only",
"display_label": "Sex",
"value": "M"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Sex
-
Biographical Information: State
{
"api_type": "read-only",
"display_label": "State",
"value": "IL"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string State
-
Biographical Information: Visa Type
{
"api_type": "read-only",
"display_label": "Visa Type",
"value": "N"
} - value: string
-
- api_type: string , x ∈ { read-only (default) }
-
- display_label: string Visa Type
-
{
"date_time_updated": {
"api_type": "system",
"display_label": "Updated",
"value": "2017-05-11T13:45:53.200Z"
},
"id_updated_by": {
"api_type": "system",
"display_label": "Updated By",
"value": "123456789"
},
"links": {
"decision__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "GET",
"rel": "self"
},
"decision__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/decision",
"method": "PUT",
"rel": "decision__modify"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"model": {
"api_type": "modifiable",
"display_label": "Model",
"value": ""
},
"reason": {
"api_type": "modifiable",
"display_label": "Reason",
"value": ""
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "None"
}
} - links: object
-
Hypermedia links that operate on Decision Information
- decision__info: object
-
Hypermedia link to retrieve decision information
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/:packet_id/decision
-
- method: string , x ∈ { GET (default) }
-
- decision__modify: object
-
Hypermedia link to modify decision information
- rel: string , x ∈ { decision__modify (default) }
-
- href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/:packet_id/decision
-
- method: string , x ∈ { PUT (default) }
-
- metadata: metadata_simple
-
- value: decision_value
-
- reason: decision_reason
-
- model: decision_model
-
- id_updated_by: std_id_updated_by
-
- date_time_updated: std_date_time_updated
-
Decision Information: Model
{
"api_type": "modifiable",
"display_label": "Model",
"value": ""
} - value: string
-
- api_type: string , x ∈ { modifiable (default) }
-
- display_label: string Model
-
Modifiable decision information.
{
"model": "",
"reason": "",
"value": "None"
} - value: string
-
- reason: string
-
- model: string
-
Decision Information: Reason
{
"api_type": "modifiable",
"display_label": "Reason",
"value": ""
} - value: string
-
- api_type: string , x ∈ { modifiable (default) }
-
- display_label: string Reason
-
Decision Information: Value
{
"api_type": "modifiable",
"display_label": "Value",
"value": "None"
} - value: string
-
- api_type: string , x ∈ { modifiable (default) }
-
- display_label: string Value
-
- metadata: metadata_simple
-
{
"comments": [
{
"by_id": "123456789",
"date_time": "2017-05-11T13:45:53.200Z",
"value": "This is a comment"
}
],
"composite_score": {
"api_type": "modifiable",
"display_label": "Composite Score",
"value": "93.25"
},
"date_time_created": {
"api_type": "system",
"display_label": "Assigned",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Scored",
"value": "2017-05-11T13:45:53.200Z"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"reader_id": {
"api_type": "modifiable",
"display_label": "Reader ID",
"value": "123456789"
},
"subscores": [
{
"key": "2017F-02",
"value": 4
}
]
} - metadata: metadata_simple
-
- reader_id: evaluation_reader_id
-
- date_time_created: std_date_time_created
-
- date_time_updated: std_date_time_updated
-
- composite_score: evaluation_composite_score
-
- subscores: object[]
- comments: object[]
-
object - value: string
-
- by_id: string
-
- date_time: string (date-time)
-
Evaluation: Composite Score
{
"api_type": "modifiable",
"display_label": "Composite Score",
"value": "93.25"
} - value: string
-
- api_type: string , x ∈ { modifiable (default) , read-only }
-
- display_label: string Composite Score
-
Modifiable evaluation information.
{
"comments": [
{
"by_id": "123456789",
"date_time": "2017-05-11T13:45:53.200Z",
"value": "This is another comment"
}
],
"composite_score": "93.25",
"reader_id": "123456789",
"subscores": [
{
"key": "2017F-02",
"value": 4
}
]
} - reader_id: string
-
- composite_score: string
-
- subscores: object[]
-
object - key: string
-
- value: number
-
- comments: object[]
-
object - value: string
-
- by_id: string
-
- date_time: string (date-time)
-
Evaluation: Reader ID
{
"api_type": "modifiable",
"display_label": "Reader ID",
"value": "123456789"
} - value: string
-
- api_type: string , x ∈ { modifiable (default) , read-only }
-
- display_label: string Reader ID
-
A set of admission packet evaluations
{
"links": {
"evaluations__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/ea9a774-dfe8-4dfd-8a2a-bb2edc984407/evaluations",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"comments": [
{
"by_id": "123456789",
"date_time": "2017-05-11T13:45:53.200Z",
"value": "This is a comment"
}
],
"composite_score": {
"api_type": "modifiable",
"display_label": "Composite Score",
"value": "93.25"
},
"date_time_created": {
"api_type": "system",
"display_label": "Assigned",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Scored",
"value": "2017-05-11T13:45:53.200Z"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"reader_id": {
"api_type": "modifiable",
"display_label": "Reader ID",
"value": "123456789"
},
"subscores": [
{
"key": "2017F-02",
"value": 4
}
]
}
]
} - links: object
-
Hypermedia Links that operate on a set of admission packet evaluations
- evaluations__info: object
-
Hypermedia link to retrieve a set of admission packet evaluations
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/:packet_id/evaluations
-
- method: string , x ∈ { GET (default) }
-
- metadata: metadata_simple
-
- values: object[]
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Short Mission"
},
"type": {
"api_type": "modifiable",
"display_label": "Type",
"value": "Warning"
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "SM"
}
} - metadata: metadata_simple
-
- name: flag_name
-
- type: flag_type
-
- value: flag_value
-
- id_set_by: std_id_set_by
-
- date_time_set: std_date_time_set
-
- id_cleared_by: std_id_cleared_by
-
- date_time_cleared: std_date_time_cleared
-
Modifiable flag information.
{
"name": "Short Mission",
"state": "set",
"type": "Warning",
"value": "SM"
} - name: string
-
- type: string
-
- value: string
-
- state: string
-
Flag: name
{
"api_type": "modifiable",
"display_label": "Name",
"value": "Short Mission"
} - value: string
-
- api_type: string , x ∈ { modifiable (default) }
-
- display_label: string Name
-
Flag: type
{
"api_type": "modifiable",
"display_label": "Type",
"value": "Warning"
} - value: string
-
- api_type: string , x ∈ { modifiable (default) }
-
- display_label: string Type
-
Flag: value
{
"api_type": "modifiable",
"display_label": "Value",
"value": "SM"
} - value: string
-
- api_type: string , x ∈ { modifiable (default) }
-
- display_label: string Value
-
A set of admission packet flags
{
"links": {
"flag__modify": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "PUT",
"rel": "flag__modify"
},
"flags__info": {
"href": "https://api.byu.edu/domain/admissions/packets/v1/cea9a774-dfe8-4dfd-8a2a-bb2edc984407/flags",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"values": [
{
"date_time_cleared": {
"api_type": "system",
"display_label": "Cleared",
"value": "2017-05-11T13:45:53.200Z"
},
"date_time_set": {
"api_type": "system",
"display_label": "Set",
"value": "2017-05-11T13:45:53.200Z"
},
"id_cleared_by": {
"api_type": "system",
"display_label": "Cleared By",
"value": "123456789"
},
"id_set_by": {
"api_type": "system",
"display_label": "Set By",
"value": "123456789"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Success"
}
},
"name": {
"api_type": "modifiable",
"display_label": "Name",
"value": "Short Mission"
},
"type": {
"api_type": "modifiable",
"display_label": "Type",
"value": "Warning"
},
"value": {
"api_type": "modifiable",
"display_label": "Value",
"value": "SM"
}
}
]
} - links: object
-
Hypermedia Links that operate on a set of admission packet flags
- flags__info: object
-
Hypermedia link to retrieve a set of admission packet flags
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domain/admissions/packets/v1/:packet_id/flags
-
- method: string , x ∈ { GET (default) }
-