Religion Codes

Religion Codes in the Identity Domain

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

Base URL: /domains/identity/religion_codes

Version: v1

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

Summary

Path Operation Description
/ GET

Identity Codes

POST

Identity Codes

/{religion_code} DELETE

Identity Codes

GET

Identity Codes

PUT

Identity Codes

/{religion_code}/logs GET

Identity Codes Archive

Paths

Identity Codes

GET /

Retrieve a Collection of Religion Codes

religion_code

religion_codes query parameter.

query string
active_status

active query parameter.

query string

Uses default content-types: application/json

200 OK

A Collection of Religion Codes

Example for application/json
{
"links": {
"religion_codes__create": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1",
"method": "POST",
"rel": "religion_codes__create"
}
,
"religion_codes__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_codes__next": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_codes__next"
}
,
"religion_codes__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_codes__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"collection_size": 1,
"contexts_available": {
"all": [
"links",
"metadata",
"religion_code",
"description",
"active_status",
"updated_by_id",
"date_time_updated",
"religion_code_logs"
]
}
,
"default_page_size": 50,
"field_sets_available": [
"links",
"metadata",
"religion_code",
"description",
"active_status",
"updated_by_id",
"date_time_updated",
"religion_code_logs"
]
,
"field_sets_returned": [
"links",
"metadata",
"religion_code",
"description",
"active_status",
"updated_by_id",
"date_time_updated"
]
,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Retrieve Successful"
}
}
,
"values": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
"religion_codes__info": {
"href": "https://api.byu/edu/domains/identity/religion_codes/v1/LDS",
"method": "GET",
"rel": "self"
}
,
"religion_codes__modify": {
"href": "https://api.byu.edu/domains/identity/religion_code_codes/v1/LDS",
"method": "PUT",
"rel": "religion_codes__modify"
}
,
"religion_codes__remove": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS",
"method": "DELETE",
"rel": "religion_codes__remove"
}
}
,
"long_description": "Latter-Day Saint",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"religion_code_logs": {
"links": {
"religion_code_logs__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_code_logs__next": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_code_logs__next"
}
,
"religion_code_logs__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_code_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"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": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
}
,
"log_action": "religion_codes__create",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"updated_by_id": "111111111"
}
]
}
,
"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 are no matching Religion Codes

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Identity Codes

POST /

Creates a Religion Code

New religion_codes values

Uses default content-types: application/json

201 Created

Religion Codes successfully created

Example for application/json
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
"religion_codes__info": {
"href": "https://api.byu/edu/domains/identity/religion_codes/v1/LDS",
"method": "GET",
"rel": "self"
}
,
"religion_codes__modify": {
"href": "https://api.byu.edu/domains/identity/religion_code_codes/v1/LDS",
"method": "PUT",
"rel": "religion_codes__modify"
}
,
"religion_codes__remove": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS",
"method": "DELETE",
"rel": "religion_codes__remove"
}
}
,
"long_description": "Latter-Day Saint",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"religion_code_logs": {
"links": {
"religion_code_logs__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_code_logs__next": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_code_logs__next"
}
,
"religion_code_logs__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_code_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"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": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
}
,
"log_action": "religion_codes__create",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"updated_by_id": "111111111"
}
]
}
,
"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

Identity Codes

DELETE /{religion_code}

Tags: Identity, Codes

Removes a Religion Code

religion_code

religion_code path parameter

path string #/parameters/religion_code

Uses default content-types: application/json

204 No Content

Religion Code 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

Identity Codes

GET /{religion_code}

Tags: Identity, Codes

Retrieve a specific Religion Code

religion_code

religion_code path parameter

path string #/parameters/religion_code

Uses default content-types: application/json

200 OK

A specific Religion Code

Example for application/json
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
"religion_codes__info": {
"href": "https://api.byu/edu/domains/identity/religion_codes/v1/LDS",
"method": "GET",
"rel": "self"
}
,
"religion_codes__modify": {
"href": "https://api.byu.edu/domains/identity/religion_code_codes/v1/LDS",
"method": "PUT",
"rel": "religion_codes__modify"
}
,
"religion_codes__remove": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS",
"method": "DELETE",
"rel": "religion_codes__remove"
}
}
,
"long_description": "Latter-Day Saint",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"religion_code_logs": {
"links": {
"religion_code_logs__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_code_logs__next": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_code_logs__next"
}
,
"religion_code_logs__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_code_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"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": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
}
,
"log_action": "religion_codes__create",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"updated_by_id": "111111111"
}
]
}
,
"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 Religion Code

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Identity Codes

PUT /{religion_code}

Tags: Identity, Codes

Modify a Religion Code

Values required to modify a new Religion Code

religion_code

religion_code path parameter

path string #/parameters/religion_code

Uses default content-types: application/json

200 OK

Religion Code successfully Modified

Example for application/json
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
"religion_codes__info": {
"href": "https://api.byu/edu/domains/identity/religion_codes/v1/LDS",
"method": "GET",
"rel": "self"
}
,
"religion_codes__modify": {
"href": "https://api.byu.edu/domains/identity/religion_code_codes/v1/LDS",
"method": "PUT",
"rel": "religion_codes__modify"
}
,
"religion_codes__remove": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS",
"method": "DELETE",
"rel": "religion_codes__remove"
}
}
,
"long_description": "Latter-Day Saint",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"religion_code_logs": {
"links": {
"religion_code_logs__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_code_logs__next": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_code_logs__next"
}
,
"religion_code_logs__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_code_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"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": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
}
,
"log_action": "religion_codes__create",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"updated_by_id": "111111111"
}
]
}
,
"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 Religion Code

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Identity Codes Archive

GET /{religion_code}/logs

Tags: Identity, Codes

Retrieve the collection of logs for a Religion Code

religion_code

religion_code path parameter

path string #/parameters/religion_code

Uses default content-types: application/json

200 OK

A collection of Religion Code Logs

Example for application/json
{
"links": {
"religion_code_logs__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs",
"method": "GET",
"rel": "self"
}
}
,
"metadata": {
"collection_size": 1,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"values": [
{
"active_status": "Y",
"date_time_updated": "2017-08-31T15:30:53.200Z",
"description": "Latter-Day Saint",
"log_action": "religion_code__create",
"long_description": "Latter-Day Saint",
"religion_code": "LDS",
"updated_by_id": "INIT"
}
]
}
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 Religion Code

409 Conflict #/responses/409

Query parameters conflict or are malformed

default #/responses/default

Unexpected error

Parameter definitions

religion_code religion_code

religion_code path parameter

path 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 , must match ^(?:Y|N)$

active status

"Y"                            

date_time_updated: string (date-time)

When was the Religion Code updated?

"2017-09-20T10:39:53.200Z"                            

description: string (up to 30 chars)

description

"Latter-Day Saint"                            

error_response: object

metadata: simple_metadata

log_action: string , x ∈ { religion_code__create , religion_code__modify , religion_code__remove }

What function was performed on the religion_code

"religion_codes__create"                            

long_description: string

long_description of the Religion Code

"Latter-Day Saint"                            

religion_code: string

Religion Code

"LDS"                            

religion_code_data: object

A Religion Codes Data

{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
"religion_codes__info": {
"href": "https://api.byu/edu/domains/identity/religion_codes/v1/LDS",
"method": "GET",
"rel": "self"
}
,
"religion_codes__modify": {
"href": "https://api.byu.edu/domains/identity/religion_code_codes/v1/LDS",
"method": "PUT",
"rel": "religion_codes__modify"
}
,
"religion_codes__remove": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS",
"method": "DELETE",
"rel": "religion_codes__remove"
}
}
,
"long_description": "Latter-Day Saint",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"religion_code_logs": {
"links": {
"religion_code_logs__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_code_logs__next": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_code_logs__next"
}
,
"religion_code_logs__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_code_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"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": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
}
,
"log_action": "religion_codes__create",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"updated_by_id": "111111111"
}
]
}
,
"updated_by_id": "111111111"
}
links: object

Hypermedia Links that Impact a specific Religion Code

religion_codes__info: object

Hypermedia link to retrieve a specific Religion Code

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1/:religion_code
method: string , x ∈ { GET (default) }
religion_codes__modify: object

Hypermedia link to modify a Religion Code

rel: string , x ∈ { religion_codes__modify (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1/:religion_code
method: string , x ∈ { PUT (default) }
religion_codes__remove: object

Hypermedia link to remove a Religion Code

rel: string , x ∈ { religion_codes__remove (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1/:religion_code
method: string , x ∈ { DELETE (default) }
metadata: simple_metadata
religion_code: religion_code
description: description
long_description: long_description
active_status: active_status
updated_by_id: updated_by_id
date_time_updated: date_time_updated
religion_code_logs: religion_code_logs

religion_code_log: object

Change Log for religion_codes API

{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
}
,
"log_action": "religion_codes__create",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"updated_by_id": "111111111"
}
links: object

Hypermedia Links for this Religion Code

metadata: simple_metadata
log_action: log_action
religion_code: religion_code
description: description
long_description: long_description
active_status: active_status
updated_by_id: updated_by_id
date_time_updated: date_time_updated

religion_code_logs: object

Change Logs for religion_codes API

{
"links": {
"religion_code_logs__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_code_logs__next": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_code_logs__next"
}
,
"religion_code_logs__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_code_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"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": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
}
,
"log_action": "religion_codes__create",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"updated_by_id": "111111111"
}
]
}
links: object

Hypermedia Links for the Collection of Logs for this Religion Code

religion_code_logs__info: object

Hypermedia link to retrieve the change logs for this Religion Code

rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1/:religion_code/logs?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }
religion_code_logs__prev: object

Hypermedia link to retrieve the previous page of change logs for this Religion Code

rel: string , x ∈ { religion_code_logs__prev (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1/:religion_code/logs?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }
religion_code_logs__next: object

Hypermedia link to retrieve the next page of change logs for this Religion Code

rel: string , x ∈ { religion_code_logs__next (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1/:religion_code/logs?page_start=:page_start1&page_size=:page_size
method: string , x ∈ { GET (default) }
metadata: sub_level_metadata
values: object[]

religion_code_new: object

Elements required to add a new Religion Code

{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"long_description": "Latter-Day Saint",
"religion_code": "LDS",
"updated_by_id": "111111111"
}
religion_code: religion_code
description: description
long_description: long_description
active_status: active_status
updated_by_id: updated_by_id
date_time_updated: date_time_updated

religion_codes: object

A Religion Code collection

{
"links": {
"religion_codes__create": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1",
"method": "POST",
"rel": "religion_codes__create"
}
,
"religion_codes__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_codes__next": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_codes__next"
}
,
"religion_codes__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_codes__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"collection_size": 1,
"contexts_available": {
"all": [
"links",
"metadata",
"religion_code",
"description",
"active_status",
"updated_by_id",
"date_time_updated",
"religion_code_logs"
]
}
,
"default_page_size": 50,
"field_sets_available": [
"links",
"metadata",
"religion_code",
"description",
"active_status",
"updated_by_id",
"date_time_updated",
"religion_code_logs"
]
,
"field_sets_returned": [
"links",
"metadata",
"religion_code",
"description",
"active_status",
"updated_by_id",
"date_time_updated"
]
,
"max_page_size": 1000,
"page_end": 1,
"page_size": 1,
"page_start": 1,
"validation_response": {
"code": 200,
"message": "Retrieve Successful"
}
}
,
"values": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
"religion_codes__info": {
"href": "https://api.byu/edu/domains/identity/religion_codes/v1/LDS",
"method": "GET",
"rel": "self"
}
,
"religion_codes__modify": {
"href": "https://api.byu.edu/domains/identity/religion_code_codes/v1/LDS",
"method": "PUT",
"rel": "religion_codes__modify"
}
,
"religion_codes__remove": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS",
"method": "DELETE",
"rel": "religion_codes__remove"
}
}
,
"long_description": "Latter-Day Saint",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"religion_code_logs": {
"links": {
"religion_code_logs__info": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=51&page_size=50",
"method": "GET",
"rel": "self"
}
,
"religion_code_logs__next": {
"href": "https://api.byu.edu/domain/identity/religion_codes/v1/LDS/logs?page_start=101&page_size=50",
"method": "GET",
"rel": "religion_code_logs__next"
}
,
"religion_code_logs__prev": {
"href": "https://api.byu.edu/domains/identity/religion_codes/v1/LDS/logs?page_start=1&page_size=50",
"method": "GET",
"rel": "religion_code_logs__prev"
}
}
,
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"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": [
{
"active_status": "Y",
"date_time_updated": "2017-09-20T10:39:53.200Z",
"description": "Latter-Day Saint",
"links": {
}
,
"log_action": "religion_codes__create",
"metadata": {
"cache": {
"date_time": "2017-09-20T10:39:53.200Z"
}
,
"validation_response": {
"code": 200,
"message": "Successful"
}
}
,
"religion_code": "LDS",
"updated_by_id": "111111111"
}
]
}
,
"updated_by_id": "111111111"
}
]
}
links: object

Hypermedia Links that impact the Religion Codes collection

religion_codes__info: object
rel: string , x ∈ { self (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1?page_start=51&page_size=50
method: string , x ∈ { GET (default) }
religion_codes__prev: object
rel: string , x ∈ { religion_codes__prev (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }
religion_codes__next: object
rel: string , x ∈ { religion_codes__next (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1?page_start=:page_start1&page_size=:page_size
method: string , x ∈ { GET (default) }
religion_codes__create: object
rel: string , x ∈ { religion_codes__create (default) }
href: string (uri) https://api.byu.edu/domains/identity/religion_codes/v1
method: string , x ∈ { POST (default) }
metadata: top_level_metadata
values: object[]

simple_metadata: object

validation_response: object
code: integer
message: string
validation_information: string[]
string
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)

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

top_level_metadata:

field_sets_returned: string[]
string , x ∈ { links , metadata , religion_code , description , active_status , updated_by_id , date_time_updated , religion_code_logs }
field_sets_available: string[]
string , x ∈ { links , metadata , religion_code , description , active_status , updated_by_id , date_time_updated , religion_code_logs }
field_sets_default: string[]
string , x ∈ { links , metadata , religion_code , description , active_status , updated_by_id , date_time_updated }
contexts_available: object

Contexts available for the domain-identity-religion_codes resource

all: string[]
string , x ∈ { links , metadata , religion_code , description , active_status , updated_by_id , date_time_updated , religion_code_logs }

updated_by_id: string (up to 9 chars)

Who (byu_id) updated the Religion Code?

"111111111"                            

validation_response: object

code: integer
message: string
Service Path: 
/domains/identity/religion_codes
Domain or University API: 
/domains/identity/religion_codes

Community

 

Don't see your question listed here? Ask!