ApplicationsApplicationPeriods
Defines the relationship between school selections and application deliverables
More information: https://it.byu.edu
Contact Info: api@byu.edu
Base URL: /domains/applications/application_periods
Version: v1
Default response content-types: application/json
Schemes: https
Summary
| Path | Operation | Description |
|---|---|---|
| / | GET | Retrieve Application Periods |
| POST | Create Application Period | |
| /* | GET | Retrieve Application Periods |
| /{ces_school},{admit_period},{applicant_type} | DELETE | Remove Application Period |
| GET | Retrieve Application Period | |
| POST | Clone Application Period | |
| PUT | Modify Application Period | |
| /{ces_school},{admit_period},{applicant_type}/application_deliverables | GET | Retrieve Application Deliverables |
| POST | Create Application Deliverable | |
| /{ces_school},{admit_period},{applicant_type}/application_deliverables/{deliverable_type},{deliverable_qualifier} | DELETE | Remove Application Deliverable |
| GET | Retrieve Application Deliverable | |
| PUT | Modify Application Deliverable | |
| /{ces_school},{admit_period},{applicant_type}/application_deliverables_logs | GET | Retrieve Application Deliverables Logs |
| /{ces_school},{admit_period},{applicant_type}/logs | GET | Retrieve Application Period Logs |
Paths
Retrieve a Collection of Application Periods
| admit_period_query | Admit Period query parameter. | query | string | |
| applicant_type_query | Applicant Type query parameter. | query | string | |
| ces_school_query | CES School query parameter. | query | string | |
| status_query | Filter by status: select=available for selection, read=reads in process | query | string , x ∈ { select , read } | |
| context | Indicates a set of subresources | query | string , x ∈ { all } | #/parameters/context |
| field_sets | List which subresources are to be returned | query | string | #/parameters/field_sets |
| page_start | Skip into a large collection to this item | query | string , must match ^[1-9][0-9]*$ | #/parameters/page_start |
| page_size | Return this many items of a large collection | query | string , must match ^([1-9][0-9]{0,2}|1000)$ | #/parameters/page_size |
Uses default content-types: application/json
- 200 OK
-
A collection of application_periods
Example for application/json{
"links": {
"application_periods__clone": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type?new_admit_period=:admit_period",
"method": "POST",
"rel": "application_periods__clone"
},
"application_periods__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1",
"method": "POST",
"rel": "application_periods__create"
},
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"application_periods__next": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "application_periods__next"
},
"application_periods__prev": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "application_periods__prev"
}
},
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"application_deliverables"
]
},
"default_page_size": 50,
"field_sets_available": [
"basic",
"application_deliverables"
],
"field_sets_default": [
"basic"
],
"field_sets_returned": [
"basic",
"application_deliverables"
],
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Retrieve Successful"
}
},
"values": [
{
"application_deliverables": {
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
},
"basic": {
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
}
]
} - 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
Create an Application Period
New Application Period values
Uses default content-types: application/json
- 201 Created
-
Application Period successfully created
Example for application/json{
"application_deliverables": {
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
},
"basic": {
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
} - 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
Retrieve a Collection of Application Periods
| admit_period_query | Admit Period query parameter. | query | string | |
| applicant_type_query | Applicant Type query parameter. | query | string | |
| ces_school_query | CES School query parameter. | query | string | |
| status_query | Filter by status: select=available for selection, read=reads in process | query | string , x ∈ { select , read } | |
| context | Indicates a set of subresources | query | string , x ∈ { all } | #/parameters/context |
| field_sets | List which subresources are to be returned | query | string | #/parameters/field_sets |
| page_start | Skip into a large collection to this item | query | string , must match ^[1-9][0-9]*$ | #/parameters/page_start |
| page_size | Return this many items of a large collection | query | string , must match ^([1-9][0-9]{0,2}|1000)$ | #/parameters/page_size |
Uses default content-types: application/json
- 200 OK
-
A collection of application_periods
Example for application/json{
"links": {
"application_periods__clone": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type?new_admit_period=:admit_period",
"method": "POST",
"rel": "application_periods__clone"
},
"application_periods__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1",
"method": "POST",
"rel": "application_periods__create"
},
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"application_periods__next": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "application_periods__next"
},
"application_periods__prev": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "application_periods__prev"
}
},
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"application_deliverables"
]
},
"default_page_size": 50,
"field_sets_available": [
"basic",
"application_deliverables"
],
"field_sets_default": [
"basic"
],
"field_sets_returned": [
"basic",
"application_deliverables"
],
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Retrieve Successful"
}
},
"values": [
{
"application_deliverables": {
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
},
"basic": {
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
}
]
} - 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
Remove Application Period
DELETE /{ces_school},{admit_period},{applicant_type}
Tags: Application PeriodsRemoves an Application Period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| context | Indicates a set of subresources | query | string , x ∈ { all } | #/parameters/context |
| field_sets | List which subresources are to be returned | query | string | #/parameters/field_sets |
Uses default content-types: application/json
- 204 No Content
-
Application Period successfully Removed
- 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
- default #/responses/default
-
Unexpected error
Retrieve Application Period
GET /{ces_school},{admit_period},{applicant_type}
Tags: Application PeriodsRetrieve a specific Application Period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| context | Indicates a set of subresources | query | string , x ∈ { all } | #/parameters/context |
| field_sets | List which subresources are to be returned | query | string | #/parameters/field_sets |
Uses default content-types: application/json
- 200 OK
-
A specific Application Period
Example for application/json{
"application_deliverables": {
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
},
"basic": {
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
} - 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
-
There is no matching Application Period
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Clone Application Period
POST /{ces_school},{admit_period},{applicant_type}
Tags: Application PeriodsClone Application Periods from one Admit Period to a new Admit Period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| new_admit_period | New Admit Period resulting from the clone operation | query | string |
Uses default content-types: application/json
- 201 Created
-
Application Period successfully cloned
Example for application/json{
"application_deliverables": {
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
},
"basic": {
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
} - 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
-
There is no matching Application Period
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify Application Period
PUT /{ces_school},{admit_period},{applicant_type}
Tags: Application PeriodsModify an Application Period
Values required to modify an application_period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| context | Indicates a set of subresources | query | string , x ∈ { all } | #/parameters/context |
| field_sets | List which subresources are to be returned | query | string | #/parameters/field_sets |
Uses default content-types: application/json
- 200 OK
-
Application Period successfully Modified
Example for application/json{
"application_deliverables": {
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
},
"basic": {
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
} - 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
-
There is no matching Application Period
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Retrieve Application Deliverables
GET /{ces_school},{admit_period},{applicant_type}/application_deliverables
Tags: Application PeriodsRetrieve the collection of Application Deliverables for an Application Period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
Uses default content-types: application/json
- 200 OK
-
A collection of Application Deliverables for an Application Period
Example for application/json{
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
} - 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
-
There is no matching Application Period
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Create Application Deliverable
POST /{ces_school},{admit_period},{applicant_type}/application_deliverables
Tags: Application PeriodsCreate an Application Deliverable
New Application Deliverable values
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
Uses default content-types: application/json
- 201 Created
-
Application Deliverable successfully created
Example for application/json{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
} - 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
-
There is no matching Application Period
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Remove Application Deliverable
DELETE /{ces_school},{admit_period},{applicant_type}/application_deliverables/{deliverable_type},{deliverable_qualifier}
Tags: Application PeriodsRemoves a specific Application Deliverable for an Application Period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| deliverable_type | Deliverable Type path parameter | path | string | #/parameters/deliverable_type |
| deliverable_qualifier | Deliverable Qualifier path parameter | path | string | #/parameters/deliverable_qualifier |
Uses default content-types: application/json
- 204 No Content
-
Application Deliverable successfully Removed
- 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
- default #/responses/default
-
Unexpected error
Retrieve Application Deliverable
GET /{ces_school},{admit_period},{applicant_type}/application_deliverables/{deliverable_type},{deliverable_qualifier}
Tags: Application PeriodsRetrieve a specific Application Deliverable for an Application Period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| deliverable_type | Deliverable Type path parameter | path | string | #/parameters/deliverable_type |
| deliverable_qualifier | Deliverable Qualifier path parameter | path | string | #/parameters/deliverable_qualifier |
Uses default content-types: application/json
- 200 OK
-
A specific Application Deliverable
Example for application/json{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
} - 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
-
There is no matching Application Deliverable
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Modify Application Deliverable
PUT /{ces_school},{admit_period},{applicant_type}/application_deliverables/{deliverable_type},{deliverable_qualifier}
Tags: Application PeriodsModify a specific Application Deliverable for an Application Period
Values required to modify an application_deliverable
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| deliverable_type | Deliverable Type path parameter | path | string | #/parameters/deliverable_type |
| deliverable_qualifier | Deliverable Qualifier path parameter | path | string | #/parameters/deliverable_qualifier |
Uses default content-types: application/json
- 200 OK
-
Application Deliverable successfully Modified
Example for application/json{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
} - 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
-
There is no matching Application Deliverable
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Retrieve Application Deliverables Logs
GET /{ces_school},{admit_period},{applicant_type}/application_deliverables_logs
Tags: Application Period LogsRetrieve the collection of Application Deliverables Logs for an Application Period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| page_start | Skip into a large collection to this item | query | string , must match ^[1-9][0-9]*$ | #/parameters/page_start |
| page_size | Return this many items of a large collection | query | string , must match ^([1-9][0-9]{0,2}|1000)$ | #/parameters/page_size |
Uses default content-types: application/json
- 200 OK
-
A collection of Application Deliverables Logs for an Application Period
Example for application/json{
"links": {
"application_deliverables_logs__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables_logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"application_deliverables_logs__next": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables_logs?page_start=101&page_size=50",
"method": "GET",
"rel": "application_deliverables_logs__next"
},
"application_deliverables_logs__prev": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables_logs?page_start=1&page_size=50",
"method": "GET",
"rel": "application_deliverables_logs__prev"
}
},
"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": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "system",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "system",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"value": "NewFreshman"
},
"ces_school": {
"api_type": "system",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "system",
"display_label": "Application Deliverable Qualifier",
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "system",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "system",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/cesapi/meta/application_deliverable_types/v1",
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"log_action": {
"api_type": "system",
"display_label": "Log Action",
"value": "application_deliverables__create"
},
"max_allowed": {
"api_type": "system",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "system",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"min_required": {
"api_type": "system",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "system",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
} - 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
-
There is no matching Application Period
- 409 Conflict #/responses/409
-
Query parameters conflict or are malformed
- default #/responses/default
-
Unexpected error
Retrieve Application Period Logs
GET /{ces_school},{admit_period},{applicant_type}/logs
Tags: Application Period LogsRetrieve the collection of logs for an Application Period
| ces_school | CES School path parameter | path | string | #/parameters/ces_school |
| admit_period | Admit Period path parameter | path | string | #/parameters/admit_period |
| applicant_type | Applicant Type path parameter | path | string | #/parameters/applicant_type |
| page_start | Skip into a large collection to this item | query | string , must match ^[1-9][0-9]*$ | #/parameters/page_start |
| page_size | Return this many items of a large collection | query | string , must match ^([1-9][0-9]{0,2}|1000)$ | #/parameters/page_size |
Uses default content-types: application/json
- 200 OK
-
A collection of Application Period Logs
Example for application/json{
"links": {
"application_period_logs__info": {
"href": "https://api.byu.edu/domains/applications/application_period/v1/BYUI,Fall2017,NewFreshman/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"application_period_logs__next": {
"href": "https://api.byu.edu/domains/applications/application_period/v1/BYUI,Fall2017,NewFreshman/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "application_period_logs__next"
},
"application_period_logs__prev": {
"href": "https://api.byu.edu/domains/applications/application_period/v1/BYUI,Fall2017,NewFreshman/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "application_period_logs__prev"
}
},
"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": "Successful"
}
},
"values": [
{
"additional_materials_required": {
"api_type": "system",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "system",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "system",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"value": "NewFreshman"
},
"ces_school": {
"api_type": "system",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "system",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "system",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "system",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"log_action": {
"api_type": "system",
"display_label": "Log Action",
"value": "application_periods__create"
},
"priority_deadline_date": {
"api_type": "system",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "system",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "system",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
} - 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
-
There is no matching Application Period
- 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
- 409
-
Query parameters conflict or are malformed
- default
-
Unexpected error
Schema definitions
Additional Materials are required by the CES School
{
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
} - value: string
-
- api_type: string , x ∈ { modifiable , read-only (default) , system }
-
- display_label: string Additional Materials Status
-
Academic Period for which the Applicant is requesting admittance
{
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
} - value: string
-
- api_type: string , x ∈ { modifiable , read-only (default) , system }
-
- key: boolean true
-
- description: string
-
- long_description: string
-
- domain: string (uri) https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=:ces_school
-
- display_label: string Admit Period
-
Type of Applicant, for example: New Freshman, Transfer
{
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
} - value: string
-
- api_type: string , x ∈ { modifiable , read-only (default) , system }
-
- key: boolean true
-
- description: string
-
- domain: string (uri) https://api.byu.edu/cesapi/meta/applicant_types/v1?ces_school=:ces_school
-
- display_label: string Applicant Type
-
An Application Deliverable for the Application Period
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
} - links: object
-
Hypermedia Links that impact this Application Deliverable for the Application Period
- application_deliverables__info: object
-
Hypermedia link to retrieve this Application Deliverable
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/application_deliverables/:deliverable_type,:deliverable_qualifier
-
- method: string , x ∈ { GET (default) }
-
- application_deliverables__modify: object
-
Hypermedia link to modify this Application Deliverable
- rel: string , x ∈ { application_deliverables__modify (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/application_deliverables/:deliverable_type,:deliverable_qualifier
-
- method: string , x ∈ { PUT (default) }
-
- application_deliverables__remove: object
-
Hypermedia link to remove this Application Deliverable
- rel: string , x ∈ { application_deliverables__remove (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/application_deliverables/:deliverable_type,:deliverable_qualifier
-
- method: string , x ∈ { DELETE (default) }
-
- metadata: simple_metadata
-
- ces_school: ces_school
-
- admit_period: admit_period
-
- applicant_type: applicant_type
-
- deliverable_type: deliverable_type
-
- deliverable_qualifier: deliverable_qualifier
-
- deliverable_qualifier_type: deliverable_qualifier_type
-
- min_required: min_required
-
- max_allowed: max_allowed
-
- optional: optional
-
- may_be_waived: may_be_waived
-
- updated_by_id: updated_by_id
-
- date_time_updated: date_time_updated
-
Elements required to modify an existing application_deliverable
{
"deliverable_qualifier_type": "URL Path Generated",
"deliverable_type_description": "High School Teacher Recommendation",
"deliverable_type_long_description": "Recommendation by High School Teacher",
"max_allowed": "2",
"may_be_waived": "N",
"min_required": "2",
"optional": "Y"
} - deliverable_type_description: string
-
- deliverable_type_long_description: string
-
- deliverable_qualifier_type: string
-
- min_required: string
-
- max_allowed: string
-
- optional: string
-
- may_be_waived: string
-
Elements required to add a new application_deliverable
{
"deliverable_qualifier": "1",
"deliverable_qualifier_type": "URL Path Generated",
"deliverable_type": "HS-Rec",
"deliverable_type_description": "High School Teacher Recommendation",
"deliverable_type_long_description": "Recommendation by High School Teacher",
"max_allowed": "2",
"may_be_waived": "N",
"min_required": "2",
"optional": "Y"
} - deliverable_type: string
-
- deliverable_type_description: string
-
- deliverable_type_long_description: string
-
- deliverable_qualifier: string
-
- deliverable_qualifier_type: string
-
- min_required: string
-
- max_allowed: string
-
- optional: string
-
- may_be_waived: string
-
The Application Deliverables collection for an Application Period
{
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
} - links: object
-
Hypermedia Links that impact the Application Deliverable collection for the Application Period
- application_deliverables__info: object
-
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/application_deliverables
-
- method: string , x ∈ { GET (default) }
-
- application_deliverables__create: object
-
- rel: string , x ∈ { application_deliverables__create (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/application_deliverables
-
- method: string , x ∈ { POST (default) }
-
- metadata: sub_level_metadata
-
- values: object[]
Application Deliverable Change Log for CES School/Admit Period/Applicant Type combination
{
"admit_period": {
"api_type": "system",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "system",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"value": "NewFreshman"
},
"ces_school": {
"api_type": "system",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "system",
"display_label": "Application Deliverable Qualifier",
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "system",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "system",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/cesapi/meta/application_deliverable_types/v1",
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"log_action": {
"api_type": "system",
"display_label": "Log Action",
"value": "application_deliverables__create"
},
"max_allowed": {
"api_type": "system",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "system",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"min_required": {
"api_type": "system",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "system",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
} - log_action: log_action
-
- ces_school: ces_school
-
- admit_period: admit_period
-
- applicant_type: applicant_type
-
- deliverable_type: deliverable_type
-
- deliverable_qualifier: deliverable_qualifier
-
- deliverable_qualifier_type: deliverable_qualifier_type
-
- min_required: min_required
-
- max_allowed: max_allowed
-
- optional: optional
-
- may_be_waived: may_be_waived
-
- updated_by_id: updated_by_id
-
- date_time_updated: date_time_updated
-
Change Logs for Application Deliverables for a CES School/Admit Period/Applicant Type combination
{
"links": {
"application_deliverables_logs__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables_logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"application_deliverables_logs__next": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables_logs?page_start=101&page_size=50",
"method": "GET",
"rel": "application_deliverables_logs__next"
},
"application_deliverables_logs__prev": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables_logs?page_start=1&page_size=50",
"method": "GET",
"rel": "application_deliverables_logs__prev"
}
},
"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": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "system",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "system",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"value": "NewFreshman"
},
"ces_school": {
"api_type": "system",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "system",
"display_label": "Application Deliverable Qualifier",
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "system",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "system",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/cesapi/meta/application_deliverable_types/v1",
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"log_action": {
"api_type": "system",
"display_label": "Log Action",
"value": "application_deliverables__create"
},
"max_allowed": {
"api_type": "system",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "system",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"min_required": {
"api_type": "system",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "system",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
} - links: object
-
Hypermedia Links that impact the deliverables log collection for application_period
- application_deliverables_logs__info: object
-
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/application_deliverables_logs?page_start=:page_start&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- application_deliverables_logs__prev: object
-
- rel: string , x ∈ { application_deliverables_logs__prev (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/application_deliverables_logs?page_start=:page_start&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- application_deliverables_logs__next: object
-
- rel: string , x ∈ { application_deliverables_logs__next (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/application_deliverables_logs?page_start=:page_start1&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- metadata: sub_level_metadata
-
- values: object[]
An Application Period
{
"application_deliverables": {
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
},
"basic": {
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
} - basic: basic
-
- application_deliverables: application_deliverables
-
Change Log for Application Period API
{
"additional_materials_required": {
"api_type": "system",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "system",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "system",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"value": "NewFreshman"
},
"ces_school": {
"api_type": "system",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "system",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "system",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "system",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"log_action": {
"api_type": "system",
"display_label": "Log Action",
"value": "application_periods__create"
},
"priority_deadline_date": {
"api_type": "system",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "system",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "system",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
} - log_action: log_action
-
- ces_school: ces_school
-
- admit_period: admit_period
-
- applicant_type: applicant_type
-
- start_selection_date: start_selection_date
-
- end_selection_date: end_selection_date
-
- priority_deadline_date: priority_deadline_date
-
- deadline_date: deadline_date
-
- additional_materials_required: additional_materials_required
-
- scoring_start_date: scoring_start_date
-
- decision_by_date: decision_by_date
-
- updated_by_id: updated_by_id
-
- date_time_updated: date_time_updated
-
Change Logs for Application Pperiod API
{
"links": {
"application_period_logs__info": {
"href": "https://api.byu.edu/domains/applications/application_period/v1/BYUI,Fall2017,NewFreshman/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"application_period_logs__next": {
"href": "https://api.byu.edu/domains/applications/application_period/v1/BYUI,Fall2017,NewFreshman/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "application_period_logs__next"
},
"application_period_logs__prev": {
"href": "https://api.byu.edu/domains/applications/application_period/v1/BYUI,Fall2017,NewFreshman/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "application_period_logs__prev"
}
},
"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": "Successful"
}
},
"values": [
{
"additional_materials_required": {
"api_type": "system",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "system",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "system",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"value": "NewFreshman"
},
"ces_school": {
"api_type": "system",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "system",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "system",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "system",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"log_action": {
"api_type": "system",
"display_label": "Log Action",
"value": "application_periods__create"
},
"priority_deadline_date": {
"api_type": "system",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "system",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "system",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
} - links: object
-
Hypermedia Links that impact the log collection for application_period
- application_period_logs__info: object
-
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/logs?page_start=:page_start&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- application_period_logs__prev: object
-
- rel: string , x ∈ { application_period_logs__prev (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/logs?page_start=:page_start&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- application_period_logs__next: object
-
- rel: string , x ∈ { application_period_logs__next (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type/logs?page_start=:page_start1&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- metadata: sub_level_metadata
-
- values: object[]
Elements required to modify an existing application_period
{
"additional_materials_required": "N",
"admit_period": "Fall2017",
"admit_period_description": "Fall 2017",
"admit_period_long_description": "Fall Semester 2017",
"applicant_type": "NewFreshman",
"applicant_type_description": "New Freshman",
"ces_school": "BYUI",
"ces_school_description": "BYU Idaho",
"deadline_date": "2015-05-02T07:00:00.000Z",
"decision_by_date": "2015-05-02T07:00:00.000Z",
"end_selection_date": "2015-05-02T07:00:00.000Z",
"priority_deadline_date": "2015-05-02T07:00:00.000Z",
"scoring_start_date": "2015-05-02T07:00:00.000Z",
"start_selection_date": "2015-05-02T07:00:00.000Z"
} - ces_school: string
-
- ces_school_description: string
-
- admit_period: string
-
- admit_period_description: string
-
- admit_period_long_description: string
-
- applicant_type: string
-
- applicant_type_description: string
-
- start_selection_date: string
-
- end_selection_date: string
-
- priority_deadline_date: string
-
- deadline_date: string
-
- additional_materials_required: string
-
- scoring_start_date: string
-
- decision_by_date: string
-
Elements required to add a new application_period
{
"additional_materials_required": "N",
"admit_period": "Fall2017",
"admit_period_description": "Fall 2017",
"admit_period_long_description": "Fall Semester 2017",
"applicant_type": "NewFreshman",
"applicant_type_description": "New Freshman",
"ces_school": "BYUI",
"ces_school_description": "BYU Idaho",
"deadline_date": "2015-05-02T07:00:00.000Z",
"decision_by_date": "2015-05-02T07:00:00.000Z",
"end_selection_date": "2015-05-02T07:00:00.000Z",
"priority_deadline_date": "2015-05-02T07:00:00.000Z",
"scoring_start_date": "2015-05-02T07:00:00.000Z",
"start_selection_date": "2015-05-02T07:00:00.000Z"
} - ces_school: string
-
- ces_school_description: string
-
- admit_period: string
-
- admit_period_description: string
-
- admit_period_long_description: string
-
- applicant_type: string
-
- applicant_type_description: string
-
- start_selection_date: string
-
- end_selection_date: string
-
- priority_deadline_date: string
-
- deadline_date: string
-
- additional_materials_required: string
-
- scoring_start_date: string
-
- decision_by_date: string
-
The Application Period collection
{
"links": {
"application_periods__clone": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type?new_admit_period=:admit_period",
"method": "POST",
"rel": "application_periods__clone"
},
"application_periods__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1",
"method": "POST",
"rel": "application_periods__create"
},
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
},
"application_periods__next": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "application_periods__next"
},
"application_periods__prev": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "application_periods__prev"
}
},
"metadata": {
"collection_size": 1,
"contexts_available": {
"all": [
"basic",
"application_deliverables"
]
},
"default_page_size": 50,
"field_sets_available": [
"basic",
"application_deliverables"
],
"field_sets_default": [
"basic"
],
"field_sets_returned": [
"basic",
"application_deliverables"
],
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Retrieve Successful"
}
},
"values": [
{
"application_deliverables": {
"links": {
"application_deliverables__create": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "POST",
"rel": "application_deliverables__create"
},
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables",
"method": "GET",
"rel": "self"
}
},
"metadata": {
"collection_size": 4,
"default_page_size": 10,
"max_page_size": 10,
"page_end": 4,
"page_size": 4,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"values": [
{
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deliverable_qualifier": {
"api_type": "modifiable",
"display_label": "Application Deliverable Qualifier",
"key": true,
"value": "1"
},
"deliverable_qualifier_type": {
"api_type": "modifiable",
"display_label": "How is the deliverable qualifier used?",
"value": "URL Path Generated"
},
"deliverable_type": {
"api_type": "modifiable",
"description": "High School Teacher Recommendation",
"display_label": "Application Deliverable Type",
"domain": "https://api.byu.edu/domains/applications/application_deliverable_types/v1",
"key": true,
"long_description": "Recommendation by High School Teacher",
"value": "HS-Rec"
},
"links": {
"application_deliverables__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "GET",
"rel": "self"
},
"application_deliverables__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "PUT",
"rel": "application_deliverables__modify"
},
"application_deliverables__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman/application_deliverables/HS-Rec,1",
"method": "DELETE",
"rel": "application_deliverables__remove"
}
},
"max_allowed": {
"api_type": "modifiable",
"display_label": "What is the maximum number of this deliverable that is allowed?",
"value": "2"
},
"may_be_waived": {
"api_type": "modifiable",
"display_label": "May this deliverable be waived?",
"value": "N"
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"min_required": {
"api_type": "modifiable",
"display_label": "How many instances of this deliverable are required?",
"value": "2"
},
"optional": {
"api_type": "modifiable",
"display_label": "Is this deliverable optional?",
"value": "Y"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
]
},
"basic": {
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
}
}
]
} - links: object
-
Hypermedia Links that impact the Application Period collection
- application_periods__info: object
-
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1?page_start=51&page_size=50
-
- method: string , x ∈ { GET (default) }
-
- application_periods__prev: object
-
- rel: string , x ∈ { application_periods__prev (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1?page_start=:page_start&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- application_periods__next: object
-
- rel: string , x ∈ { application_periods__next (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1?page_start=:page_start1&page_size=:page_size
-
- method: string , x ∈ { GET (default) }
-
- application_periods__create: object
-
- rel: string , x ∈ { application_periods__create (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1
-
- method: string , x ∈ { POST (default) }
-
- metadata: top_level_metadata
-
- values: object[]
Basic field-set for Application Period
{
"additional_materials_required": {
"api_type": "modifiable",
"display_label": "Are Additional Materials required for the CES School/Admit Period/Applicant Type combination",
"value": "N"
},
"admit_period": {
"api_type": "modifiable",
"description": "Fall 2017",
"display_label": "Admit Period",
"domain": "https://api.byu.edu/domains/applications/admit_periods/v1?ces_school=BYUI",
"key": true,
"long_description": "Fall Semester 2017",
"value": "Fall2017"
},
"applicant_type": {
"api_type": "modifiable",
"description": "New Freshman",
"display_label": "Applicant Type",
"domain": "https://api.byu.edu/domains/applications/applicant_types/v1?ces_school=BYUI",
"key": true,
"value": "NewFreshman"
},
"ces_school": {
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
},
"date_time_updated": {
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
},
"deadline_date": {
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"decision_by_date": {
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"end_selection_date": {
"api_type": "modifiable",
"display_label": "End of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"links": {
"application_periods__info": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "GET",
"rel": "self"
},
"application_periods__modify": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "PUT",
"rel": "application_periods__modify"
},
"application_periods__remove": {
"href": "https://api.byu.edu/domains/applications/application_periods/v1/BYUI,Fall2017,NewFreshman",
"method": "DELETE",
"rel": "application_periods__remove"
}
},
"metadata": {
"validation_response": {
"code": 200,
"message": "Successful"
}
},
"priority_deadline_date": {
"api_type": "modifiable",
"display_label": "Priority Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"scoring_start_date": {
"api_type": "modifiable",
"display_label": "Start of Scoring for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"start_selection_date": {
"api_type": "modifiable",
"display_label": "Start of Selection Period for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
},
"updated_by_id": {
"api_type": "system",
"description": "Bugs Bunny Ithaca",
"display_label": "Application Period definition last updated by?",
"value": "764634873"
}
} - links: object
-
Hypermedia Links that impact this Application Period
- application_periods__info: object
-
Hypermedia link to retrieve this Application Period
- rel: string , x ∈ { self (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type
-
- method: string , x ∈ { GET (default) }
-
- application_periods__clone: object
-
Hypermedia link to clone this Application Period
- rel: string , x ∈ { application_periods__clone (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type?new_admit_period=:admit_period
-
- method: string , x ∈ { POST (default) }
-
- application_periods__modify: object
-
Hypermedia link to modify this Application Period
- rel: string , x ∈ { application_periods__modify (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type
-
- method: string , x ∈ { PUT (default) }
-
- application_periods__remove: object
-
Hypermedia link to remove this application_period
- rel: string , x ∈ { application_periods__remove (default) }
-
- href: string (uri) https://api.byu.edu/domains/applications/application_periods/v1/:ces_school,:admit_period,:applicant_type
-
- method: string , x ∈ { DELETE (default) }
-
- metadata: simple_metadata
-
- ces_school: ces_school
-
- admit_period: admit_period
-
- applicant_type: applicant_type
-
- start_selection_date: start_selection_date
-
- end_selection_date: end_selection_date
-
- priority_deadline_date: priority_deadline_date
-
- deadline_date: deadline_date
-
- additional_materials_required: additional_materials_required
-
- scoring_start_date: scoring_start_date
-
- decision_by_date: decision_by_date
-
- updated_by_id: updated_by_id
-
- date_time_updated: date_time_updated
-
CES School designator
{
"api_type": "modifiable",
"description": "BYU Idaho",
"display_label": "CES School",
"domain": "https://api.byu.edu/domains/applications/ces_schools/v1",
"key": true,
"value": "BYUI"
} - value: string
-
- description: string
-
- domain: string (uri) https://api.byu.edu/domains/applications/ces_schools/v1
-
- key: boolean true
-
- api_type: string , x ∈ { read-only (default) , modifiable , system }
-
- display_label: string CES School
-
When was the Application Period's data last updated?
{
"api_type": "system",
"display_label": "Application Period definition last updated when?",
"value": "2014-05-11T13:45:53.200Z"
} - value: string (date-time)
-
- api_type: string , x ∈ { system (default) }
-
- display_label: string Application Period last updated when?
-
Deadline Date for an Application based on the CES School/Admit Period/Applicant Type
{
"api_type": "modifiable",
"display_label": "Application Deadline for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
} - value: string
-
- api_type: string , x ∈ { derived , read-only (default) , modifiable , system }
-
- display_label: string Application Deadline
-
Decisions expected by date for CES School/Admit Period/Applicant Type combination
{
"api_type": "modifiable",
"display_label": "Decisions expected by date for CES School/Admit Period/Applicant Type combination",
"value": "2015-05-02T07:00:00.000Z"
} - value: string
-
- api_type: string , x ∈ { read-only (default) , modifiable , system }
-
- display_label: string Decisions expected by date for CES School/Admit Period/Applicant Type combination
-