domain-identity-application_statuses

The Application Status Codes Server

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

Base URL: /domains/domain-identity/application_statuses

Version: v1

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

Summary

Path Operation Description
/ GET

domain-identity Codes

POST

domain-identity Codes

/{application_status} DELETE

domain-identity Codes

GET

domain-identity Codes

PUT

domain-identity Codes

/{application_status}/logs GET

domain-identity Codes Archive

Paths

domain-identity Codes

GET /

Tags: domain-identity, Codes

Retrieve a collection of application_status

active_status_query

active_status query parameter.

query string
page_start

Skip into a large collection to this item

query string #/parameters/page_start
page_size

Return this many items of a large collection

query string #/parameters/page_size

Uses default content-types: application/json

200 OK

A collection of application_statuses

Example for application/json
{
"links": {
"application_statuses__create": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1",
"method": "POST",
"rel": "application_statuses__create"
}
,
"application_statuses__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"application_statuses__next": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "application_statuses__next"
}
,
"application_statuses__prev": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "application_statuses__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Retrieve Successful",
"return_code": 200
}
}
,
"values": [
{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"links": {
"application_statuses__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "GET",
"rel": "self"
}
,
"application_statuses__modify": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "PUT",
"rel": "application_statuses__modify"
}
,
"application_statuses__remove": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "DELETE",
"rel": "application_statuses__remove"
}
}
,
"long_description": "Applicant has been admitted",
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"updated_by_id": "111111111"
}
]
}
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

domain-identity Codes

POST /

Tags: domain-identity, Codes

Creates a application_status

New application_status values

Uses default content-types: application/json

201 Created

application_status successfully created

Example for application/json
{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"links": {
"application_statuses__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "GET",
"rel": "self"
}
,
"application_statuses__modify": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "PUT",
"rel": "application_statuses__modify"
}
,
"application_statuses__remove": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "DELETE",
"rel": "application_statuses__remove"
}
}
,
"long_description": "Applicant has been admitted",
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"updated_by_id": "111111111"
}
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

domain-identity Codes

DELETE /{application_status}

Tags: domain-identity, Codes

Removes a application_status

application_status

application_status path parameter

path string #/parameters/application_status

Uses default content-types: application/json

204 No Content

application_status 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

domain-identity Codes

GET /{application_status}

Tags: domain-identity, Codes

Retrieve a specific application_status

application_status

application_status path parameter

path string #/parameters/application_status

Uses default content-types: application/json

200 OK

A specific application_status

Example for application/json
{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"links": {
"application_statuses__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "GET",
"rel": "self"
}
,
"application_statuses__modify": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "PUT",
"rel": "application_statuses__modify"
}
,
"application_statuses__remove": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "DELETE",
"rel": "application_statuses__remove"
}
}
,
"long_description": "Applicant has been admitted",
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"updated_by_id": "111111111"
}
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_status

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

domain-identity Codes

PUT /{application_status}

Tags: domain-identity, Codes

Modify a application_status

Values required to modify a application_status

application_status

application_status path parameter

path string #/parameters/application_status

Uses default content-types: application/json

200 OK

application_status successfully Modified

Example for application/json
{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"links": {
"application_statuses__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "GET",
"rel": "self"
}
,
"application_statuses__modify": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "PUT",
"rel": "application_statuses__modify"
}
,
"application_statuses__remove": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "DELETE",
"rel": "application_statuses__remove"
}
}
,
"long_description": "Applicant has been admitted",
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"updated_by_id": "111111111"
}
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_status

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

domain-identity Codes Archive

GET /{application_status}/logs

Tags: domain-identity, Codes

Retrieve the collection of logs for a application_status

application_status

application_status path parameter

path string #/parameters/application_status

Uses default content-types: application/json

200 OK

A collection of application_status Logs

Example for application/json
{
"links": {
"application_status_logs__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/application_status/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"application_status_logs__next": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/application_status/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "application_status_logs__next"
}
,
"application_status_logs__prev": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/application_status/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "application_status_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"values": [
{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"log_action": "application_statuses__create",
"long_description": "Applicant has been admitted",
"updated_by_id": "111111111"
}
]
}
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_status

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Parameter definitions

application_status application_status

application_status path parameter

path string
page_start page_start

Skip into a large collection to this item

query string
page_size page_size

Return this many items of a large collection

query string

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

active_status: string

Is the code currently active or only used for archive purposes?

"Y"                            

application_status: string

application_status

"A"                            

application_status_data: object

A application_status

{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"links": {
"application_statuses__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "GET",
"rel": "self"
}
,
"application_statuses__modify": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "PUT",
"rel": "application_statuses__modify"
}
,
"application_statuses__remove": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "DELETE",
"rel": "application_statuses__remove"
}
}
,
"long_description": "Applicant has been admitted",
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"updated_by_id": "111111111"
}
links: object

Hypermedia Links that impact this application_status

application_statuses__info: object

Hypermedia link to retrieve this application_status

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1/:application_status
method: string , x ∈ { GET (default) }
application_statuses__modify: object

Hypermedia link to modify this application_status

rel: string , x ∈ { application_statuses__modify (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1/:application_status
method: string , x ∈ { PUT (default) }
application_statuses__remove: object

Hypermedia link to remove this application_status

rel: string , x ∈ { application_statuses__remove (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1/:application_status
method: string , x ∈ { DELETE (default) }
metadata: simple_metadata
application_status: application_status
description: description
long_description: long_description
active_status: active_status
updated_by_id: updated_by_id
date_time_updated: date_time_updated

application_status_log: object

Change Log for application_status API

{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"log_action": "application_statuses__create",
"long_description": "Applicant has been admitted",
"updated_by_id": "111111111"
}
log_action: log_action
application_status: application_status
description: description
long_description: long_description
active_status: active_status
updated_by_id: updated_by_id
date_time_updated: date_time_updated

application_status_logs: object

Change Logs for application_status API

{
"links": {
"application_status_logs__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/application_status/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"application_status_logs__next": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/application_status/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "application_status_logs__next"
}
,
"application_status_logs__prev": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/application_status/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "application_status_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"values": [
{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"log_action": "application_statuses__create",
"long_description": "Applicant has been admitted",
"updated_by_id": "111111111"
}
]
}
links: object

Hypermedia Links that impact the log collection for application_status

application_status_logs__info: object
rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1/:application_status/logs?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }
application_status_logs__prev: object
rel: string , x ∈ { application_status_logs__prev (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1/:application_status/logs?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }
application_status_logs__next: object
rel: string , x ∈ { application_status_logs__next (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1/:application_status/logs?page_start=:page_start1&page_size=:page_size
method: string , x ∈ { GET (default) }
metadata: sub_level_metadata
values: object[]

application_status_new: object

Elements required to add a new application_status

{
"active_status": "Y",
"application_status": "E",
"description": "EXAMPLE",
"long_description": "An example application status"
}
application_status: application_status
description: description
long_description: long_description
active_status: active_status

application_statuses: object

The application_status collection

{
"links": {
"application_statuses__create": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1",
"method": "POST",
"rel": "application_statuses__create"
}
,
"application_statuses__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"application_statuses__next": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "application_statuses__next"
}
,
"application_statuses__prev": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "application_statuses__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"collection_size": 1,
"default_page_size": 50,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"response": "Retrieve Successful",
"return_code": 200
}
}
,
"values": [
{
"active_status": "Y",
"application_status": "A",
"date_time_updated": "2014-05-11T13:45:53.200Z",
"description": "ADMIT",
"links": {
"application_statuses__info": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "GET",
"rel": "self"
}
,
"application_statuses__modify": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "PUT",
"rel": "application_statuses__modify"
}
,
"application_statuses__remove": {
"href": "https://api.byu.edu/domains/domain-identity/application_statuses/v1/A",
"method": "DELETE",
"rel": "application_statuses__remove"
}
}
,
"long_description": "Applicant has been admitted",
"metadata": {
"cache": {
"date_time": "2014-05-11T13:45:53.200Z"
}
,
"validation_response": {
"response": "Successful",
"return_code": 200
}
}
,
"updated_by_id": "111111111"
}
]
}
links: object

Hypermedia Links that impact the application_status collection

application_statuses__info: object
rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=51&page_size=50
method: string , x ∈ { GET (default) }
application_statuses__prev: object
rel: string , x ∈ { application_statuses__prev (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }
application_statuses__next: object
rel: string , x ∈ { application_statuses__next (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1?page_start=:page_start1&page_size=:page_size
method: string , x ∈ { GET (default) }
application_statuses__create: object
rel: string , x ∈ { application_statuses__create (default) }
href: string (uri) https://api.byu.edu/domains/domain-identity/application_statuses/v1
method: string , x ∈ { POST (default) }
metadata: sub_level_metadata
values: object[]

date_time_updated: string

When was the application_status's data last updated?

"2014-05-11T13:45:53.200Z"                            

description: string

application_status Short Description

"ADMIT"                            

log_action: string , x ∈ { application_statuses__create , application_statuses__modify , application_statuses__remove }

What function was performed on the application_status

"application_statuses__create"                            

long_description: string

application_status Long Description

"Applicant has been admitted"                            

simple_metadata: object

cache: object

If data is from live source, value will be null, otherwise it will be date-time of cache

date_time: string (date-time)
validation_response: validation_response

sub_level_metadata:

collection_size: integer , { x ∈ ℤ | x ≥ 0 }
page_start: integer , { x ∈ ℤ | x ≥ 0 }
page_end: integer , { x ∈ ℤ | x ≥ 0 }
page_size: integer , { x ∈ ℤ | x ≥ 1 }
default_page_size: integer , { x ∈ ℤ | x ≥ 1 }
max_page_size: integer

updated_by_id: string

Who last updated the application_status's data?

"111111111"                            

validation_response: object

return_code: integer
response: string
Service Path: 
/domains/domain-identity/application_statuses
Domain or University API: 
/domains/domain-identity/application_statuses

Community

 

Don't see your question listed here? Ask!