CountryCodes

Country Codes of the Identity Domain

Base URL: /domains/identity/country_codes

Version: v1

Default response content-types: application/json

Schemes: https

Summary

Path	Operation	Description
/	GET	Identity Codes
/	POST	Identity Codes
/{country_code}	DELETE	Identity Codes
	GET	Identity Codes
	PUT	Identity Codes
/{country_code}/logs	GET	Identity Codes Archive

Paths

Identity Codes

GET /

Tags: Identity, Codes

Retrieve the Collection of Country Codes


country_description_search	Wild Card look-up on country descriptions	query	string
valid_for_address_filter	Filter based on valid_for_address flag	query	string
valid_for_birth_country_filter	Filter based on valid_for_birth_country flag	query	string
valid_for_citizenship_filter	Filter based on valid_for_citizenship flag	query	string
valid_for_home_country_filter	Filter based on valid_for_home_country flag	query	string
country_phone_prefix_reverse_lookup	Look-up a country_code based on the country_phone_prefix	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 Country Codes

country_codes

Example for application/json

{
    "links": {
        "country_codes__create": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1",
            "method": "POST",
            "rel": "country_codes__create"
        },
        "country_codes__first": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=1&page_size=50",
            "method": "GET",
            "rel": "country_codes__first"
        },
        "country_codes__info": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=51&page_size=50",
            "method": "GET",
            "rel": "self"
        },
        "country_codes__last": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=151&page_size=50",
            "method": "GET",
            "rel": "country_codes__last"
        },
        "country_codes__next": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=101&page_size=50",
            "method": "GET",
            "rel": "country_codes__next"
        },
        "country_codes__prev": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=1&page_size=50",
            "method": "GET",
            "rel": "country_codes__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": "Retrieve Successful"
        }
    },
    "values": [
        {
            "active_status": "Y",
            "continent_code": "NA",
            "country_code": "USA",
            "country_phone_prefix": "001",
            "date_time_updated": "2014-05-11T13:45:53.200Z",
            "description": "United States",
            "iso_code": "US",
            "iso_code_3": "USA",
            "links": {
                "country_codes__info": {
                    "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
                    "method": "GET",
                    "rel": "self"
                },
                "country_codes__modify": {
                    "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
                    "method": "PUT",
                    "rel": "country_codes__modify"
                },
                "country_codes__remove": {
                    "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
                    "method": "DELETE",
                    "rel": "country_codes__remove"
                }
            },
            "long_description": "United States of America",
            "metadata": {
                "validation_response": {
                    "code": 200,
                    "message": "Successful"
                }
            },
            "updated_by_id": "111111111",
            "valid_for_address": "Y",
            "valid_for_birth_country": "Y",
            "valid_for_citizenship": "Y",
            "valid_for_home_country": "Y"
        }
    ]
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

401 Unauthorized #/responses/401

Authentication required to access data

error_response

403 Forbidden #/responses/403

Access denied to protected data

error_response

409 Conflict #/responses/409

Query parameters conflict or are malformed

error_response

default #/responses/default

Unexpected error

error_response

Identity Codes

POST /

Tags: Identity, Codes

Creates a Country Code

New country_code values

country_code_new

Uses default content-types: application/json

201 Created

Country Code successfully Created

country_code_data

Example for application/json

{
    "active_status": "Y",
    "continent_code": "NA",
    "country_code": "USA",
    "country_phone_prefix": "001",
    "date_time_updated": "2014-05-11T13:45:53.200Z",
    "description": "United States",
    "iso_code": "US",
    "iso_code_3": "USA",
    "links": {
        "country_codes__info": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "GET",
            "rel": "self"
        },
        "country_codes__modify": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "PUT",
            "rel": "country_codes__modify"
        },
        "country_codes__remove": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "DELETE",
            "rel": "country_codes__remove"
        }
    },
    "long_description": "United States of America",
    "metadata": {
        "validation_response": {
            "code": 200,
            "message": "Successful"
        }
    },
    "updated_by_id": "111111111",
    "valid_for_address": "Y",
    "valid_for_birth_country": "Y",
    "valid_for_citizenship": "Y",
    "valid_for_home_country": "Y"
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

401 Unauthorized #/responses/401

Authentication required to access data

error_response

403 Forbidden #/responses/403

Access denied to protected data

error_response

409 Conflict #/responses/409

Query parameters conflict or are malformed

error_response

default #/responses/default

Unexpected error

error_response

Identity Codes

DELETE /{country_code}

Tags: Identity, Codes

Removes a Country Code


country_code	country_code path parameter	path	string	#/parameters/country_code

Uses default content-types: application/json

204 No Content: Country Code successfully Removed
400 Bad Request #/responses/400: Invalid Request - unable to interpret request

error_response
401 Unauthorized #/responses/401: Authentication required to access data

error_response
403 Forbidden #/responses/403: Access denied to protected data

error_response
default #/responses/default: Unexpected error

error_response

Identity Codes

GET /{country_code}

Tags: Identity, Codes

Retrieve a specific Country Code


country_code	country_code path parameter	path	string	#/parameters/country_code

Uses default content-types: application/json

200 OK

A specific Country Code

country_code_data

Example for application/json

{
    "active_status": "Y",
    "continent_code": "NA",
    "country_code": "USA",
    "country_phone_prefix": "001",
    "date_time_updated": "2014-05-11T13:45:53.200Z",
    "description": "United States",
    "iso_code": "US",
    "iso_code_3": "USA",
    "links": {
        "country_codes__info": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "GET",
            "rel": "self"
        },
        "country_codes__modify": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "PUT",
            "rel": "country_codes__modify"
        },
        "country_codes__remove": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "DELETE",
            "rel": "country_codes__remove"
        }
    },
    "long_description": "United States of America",
    "metadata": {
        "validation_response": {
            "code": 200,
            "message": "Successful"
        }
    },
    "updated_by_id": "111111111",
    "valid_for_address": "Y",
    "valid_for_birth_country": "Y",
    "valid_for_citizenship": "Y",
    "valid_for_home_country": "Y"
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

401 Unauthorized #/responses/401

Authentication required to access data

error_response

403 Forbidden #/responses/403

Access denied to protected data

error_response

404 Not Found

There is no matching Country Code

error_response

409 Conflict #/responses/409

Query parameters conflict or are malformed

error_response

default #/responses/default

Unexpected error

error_response

Identity Codes

PUT /{country_code}

Tags: Identity, Codes

Modify a Country Code

Values required to modify a new Country Code

country_code_new


country_code	country_code path parameter	path	string	#/parameters/country_code

Uses default content-types: application/json

200 OK

Country Code successfully Modified

country_code_data

Example for application/json

{
    "active_status": "Y",
    "continent_code": "NA",
    "country_code": "USA",
    "country_phone_prefix": "001",
    "date_time_updated": "2014-05-11T13:45:53.200Z",
    "description": "United States",
    "iso_code": "US",
    "iso_code_3": "USA",
    "links": {
        "country_codes__info": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "GET",
            "rel": "self"
        },
        "country_codes__modify": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "PUT",
            "rel": "country_codes__modify"
        },
        "country_codes__remove": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "DELETE",
            "rel": "country_codes__remove"
        }
    },
    "long_description": "United States of America",
    "metadata": {
        "validation_response": {
            "code": 200,
            "message": "Successful"
        }
    },
    "updated_by_id": "111111111",
    "valid_for_address": "Y",
    "valid_for_birth_country": "Y",
    "valid_for_citizenship": "Y",
    "valid_for_home_country": "Y"
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

401 Unauthorized #/responses/401

Authentication required to access data

error_response

403 Forbidden #/responses/403

Access denied to protected data

error_response

404 Not Found

There is no matching Country Code

error_response

409 Conflict #/responses/409

Query parameters conflict or are malformed

error_response

default #/responses/default

Unexpected error

error_response

Identity Codes Archive

GET /{country_code}/logs

Tags: Identity, Codes

Retrieve the collection of logs for a Country Code


country_code	country_code path parameter	path	string	#/parameters/country_code
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 Country Codes Logs

country_code_logs

Example for application/json

{
    "links": {
        "country_code_logs__first": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=1&page_size=50",
            "method": "GET",
            "rel": "country_code_logs__first"
        },
        "country_code_logs__info": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=51&page_size=50",
            "method": "GET",
            "rel": "self"
        },
        "country_code_logs__last": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=151&page_size=50",
            "method": "GET",
            "rel": "country_code_logs__last"
        },
        "country_code_logs__next": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=101&page_size=50",
            "method": "GET",
            "rel": "country_code_logs__next"
        },
        "country_code_logs__prev": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=1&page_size=50",
            "method": "GET",
            "rel": "country_code_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": [
        {
            "active_status": "Y",
            "continent_code": "NA",
            "country_code": "USA",
            "country_phone_prefix": "001",
            "date_time_updated": "2014-05-11T13:45:53.200Z",
            "description": "United States",
            "iso_code": "US",
            "iso_code_3": "USA",
            "links": {
            },
            "log_action": "country_codes__create",
            "long_description": "United States of America",
            "metadata": {
                "validation_response": {
                    "code": 200,
                    "message": "Successful"
                }
            },
            "updated_by_id": "111111111",
            "valid_for_address": "Y",
            "valid_for_birth_country": "Y",
            "valid_for_citizenship": "Y",
            "valid_for_home_country": "Y"
        }
    ]
}

400 Bad Request #/responses/400

Invalid Request - unable to interpret request

error_response

401 Unauthorized #/responses/401

Authentication required to access data

error_response

403 Forbidden #/responses/403

Access denied to protected data

error_response

404 Not Found

There is no matching Country Code

error_response

409 Conflict #/responses/409

Query parameters conflict or are malformed

error_response

default #/responses/default

Unexpected error

error_response

Parameter definitions


country_code	country_code	country_code 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

error_response
401: Authentication required to access data

error_response
403: Access denied to protected data

error_response
409: Query parameters conflict or are malformed

error_response
default: Unexpected error

error_response

Schema definitions

active_status: string , x ∈ { N , Y (default) } , { x | x ≤ 3 }

Is this country currently active and available for use?

"Y"

continent_code: string , x ∈ { AF , AS , AT , AU , EU , NA , SA } , { x | x ≤ 2 }

In which continent is this country located?

"NA"

country_code: string

BYU's Country Code

"USA"

country_code_data: object

A country_code

{
    "active_status": "Y",
    "continent_code": "NA",
    "country_code": "USA",
    "country_phone_prefix": "001",
    "date_time_updated": "2014-05-11T13:45:53.200Z",
    "description": "United States",
    "iso_code": "US",
    "iso_code_3": "USA",
    "links": {
        "country_codes__info": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "GET",
            "rel": "self"
        },
        "country_codes__modify": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "PUT",
            "rel": "country_codes__modify"
        },
        "country_codes__remove": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
            "method": "DELETE",
            "rel": "country_codes__remove"
        }
    },
    "long_description": "United States of America",
    "metadata": {
        "validation_response": {
            "code": 200,
            "message": "Successful"
        }
    },
    "updated_by_id": "111111111",
    "valid_for_address": "Y",
    "valid_for_birth_country": "Y",
    "valid_for_citizenship": "Y",
    "valid_for_home_country": "Y"
}

links: object

Hypermedia Links for this Country Code

country_codes__info: object

Hypermedia link to retrieve this byuapi-meta-country_codes

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

country_codes__modify: object

Hypermedia link to modify some byuapi-meta-country_codes

rel: string , x ∈ { country_codes__modify (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1/USA
method: string , x ∈ { PUT (default) }

country_codes__remove: object

Hypermedia link to remove an byuapi-meta-country_codes

rel: string , x ∈ { country_codes__remove (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1/USA
method: string , x ∈ { DELETE (default) }

metadata: simple_metadata

country_code: country_code

description: description

long_description: long_description

active_status: active_status

iso_code: iso_code

iso_code_3: iso_code_3

country_phone_prefix: country_phone_prefix

valid_for_address: valid_for_address

valid_for_birth_country: valid_for_birth_country

valid_for_citizenship: valid_for_citizenship

valid_for_home_country: valid_for_home_country

continent_code: continent_code

updated_by_id: updated_by_id

date_time_updated: date_time_updated

country_code_log: object

Change Log for country_codes API

{
    "active_status": "Y",
    "continent_code": "NA",
    "country_code": "USA",
    "country_phone_prefix": "001",
    "date_time_updated": "2014-05-11T13:45:53.200Z",
    "description": "United States",
    "iso_code": "US",
    "iso_code_3": "USA",
    "links": {
    },
    "log_action": "country_codes__create",
    "long_description": "United States of America",
    "metadata": {
        "validation_response": {
            "code": 200,
            "message": "Successful"
        }
    },
    "updated_by_id": "111111111",
    "valid_for_address": "Y",
    "valid_for_birth_country": "Y",
    "valid_for_citizenship": "Y",
    "valid_for_home_country": "Y"
}

links: object

Hypermedia Links for this Country Code

metadata: simple_metadata

log_action: log_action

country_code: country_code

description: description

long_description: long_description

active_status: active_status

iso_code: iso_code

iso_code_3: iso_code_3

country_phone_prefix: country_phone_prefix

valid_for_address: valid_for_address

valid_for_birth_country: valid_for_birth_country

valid_for_citizenship: valid_for_citizenship

valid_for_home_country: valid_for_home_country

continent_code: continent_code

updated_by_id: updated_by_id

date_time_updated: date_time_updated

country_code_logs: object

Change Logs for country_codes API

{
    "links": {
        "country_code_logs__first": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=1&page_size=50",
            "method": "GET",
            "rel": "country_code_logs__first"
        },
        "country_code_logs__info": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=51&page_size=50",
            "method": "GET",
            "rel": "self"
        },
        "country_code_logs__last": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=151&page_size=50",
            "method": "GET",
            "rel": "country_code_logs__last"
        },
        "country_code_logs__next": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=101&page_size=50",
            "method": "GET",
            "rel": "country_code_logs__next"
        },
        "country_code_logs__prev": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA/logs?page_start=1&page_size=50",
            "method": "GET",
            "rel": "country_code_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": [
        {
            "active_status": "Y",
            "continent_code": "NA",
            "country_code": "USA",
            "country_phone_prefix": "001",
            "date_time_updated": "2014-05-11T13:45:53.200Z",
            "description": "United States",
            "iso_code": "US",
            "iso_code_3": "USA",
            "links": {
            },
            "log_action": "country_codes__create",
            "long_description": "United States of America",
            "metadata": {
                "validation_response": {
                    "code": 200,
                    "message": "Successful"
                }
            },
            "updated_by_id": "111111111",
            "valid_for_address": "Y",
            "valid_for_birth_country": "Y",
            "valid_for_citizenship": "Y",
            "valid_for_home_country": "Y"
        }
    ]
}

links: object

Hypermedia Links for the Collection of Logs for this Country Code

country_code_logs__info: object

Hypermedia link to retrieve the change logs for this Country Code

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

country_code_logs__prev: object

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

rel: string , x ∈ { country_code_logs__prev (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1/:country_code/logs?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }

country_code_logs__last: object

Hypermedia link to retrieve the last page of change logs for this Country Code

rel: string , x ∈ { country_code_logs__last (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1/:country_code/logs?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }

country_code_logs__first: object

Hypermedia link to retrieve the first page of change logs for this Country Code

rel: string , x ∈ { country_code_logs__first (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1/:country_code/logs?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }

country_code_logs__next: object

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

rel: string , x ∈ { country_code_logs__next (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1/:country_code/logs?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }

metadata: sub_level_metadata

values: object[]

country_code_log

country_code_new: object

Elements required to add a new country_code

{
    "active_status": "Y",
    "continent_code": "NA",
    "country_code": "USA",
    "country_phone_prefix": "001",
    "date_time_updated": "2014-05-11T13:45:53.200Z",
    "description": "United States",
    "iso_code": "US",
    "iso_code_3": "USA",
    "long_description": "United States of America",
    "updated_by_id": "111111111",
    "valid_for_address": "Y",
    "valid_for_birth_country": "Y",
    "valid_for_citizenship": "Y",
    "valid_for_home_country": "Y"
}

country_code: country_code
description: description
long_description: long_description
active_status: active_status
iso_code: iso_code
iso_code_3: iso_code_3
country_phone_prefix: country_phone_prefix
valid_for_address: valid_for_address
valid_for_birth_country: valid_for_birth_country
valid_for_citizenship: valid_for_citizenship
valid_for_home_country: valid_for_home_country
continent_code: continent_code
updated_by_id: updated_by_id
date_time_updated: date_time_updated

country_codes: object

The country_code collection

{
    "links": {
        "country_codes__create": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1",
            "method": "POST",
            "rel": "country_codes__create"
        },
        "country_codes__first": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=1&page_size=50",
            "method": "GET",
            "rel": "country_codes__first"
        },
        "country_codes__info": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=51&page_size=50",
            "method": "GET",
            "rel": "self"
        },
        "country_codes__last": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=151&page_size=50",
            "method": "GET",
            "rel": "country_codes__last"
        },
        "country_codes__next": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=101&page_size=50",
            "method": "GET",
            "rel": "country_codes__next"
        },
        "country_codes__prev": {
            "href": "https://api.byu.edu/domains/identity/country_codes/v1?page_start=1&page_size=50",
            "method": "GET",
            "rel": "country_codes__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": "Retrieve Successful"
        }
    },
    "values": [
        {
            "active_status": "Y",
            "continent_code": "NA",
            "country_code": "USA",
            "country_phone_prefix": "001",
            "date_time_updated": "2014-05-11T13:45:53.200Z",
            "description": "United States",
            "iso_code": "US",
            "iso_code_3": "USA",
            "links": {
                "country_codes__info": {
                    "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
                    "method": "GET",
                    "rel": "self"
                },
                "country_codes__modify": {
                    "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
                    "method": "PUT",
                    "rel": "country_codes__modify"
                },
                "country_codes__remove": {
                    "href": "https://api.byu.edu/domains/identity/country_codes/v1/USA",
                    "method": "DELETE",
                    "rel": "country_codes__remove"
                }
            },
            "long_description": "United States of America",
            "metadata": {
                "validation_response": {
                    "code": 200,
                    "message": "Successful"
                }
            },
            "updated_by_id": "111111111",
            "valid_for_address": "Y",
            "valid_for_birth_country": "Y",
            "valid_for_citizenship": "Y",
            "valid_for_home_country": "Y"
        }
    ]
}

links: object

Hypermedia Links that impact the country_code collection

country_codes__info: object

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

country_codes__prev: object

rel: string , x ∈ { country_codes__prev (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1?page_start=:page_start&page_size=:page_size
method: string , x ∈ { GET (default) }

country_codes__next: object

rel: string , x ∈ { country_codes__next (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1?page_start=:page_start1&page_size=:page_size
method: string , x ∈ { GET (default) }

country_codes__first: object

rel: string , x ∈ { country_codes__first (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1?page_start=:page_start1&page_size=:page_size
method: string , x ∈ { GET (default) }

country_codes__last: object

rel: string , x ∈ { country_codes__last (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1?page_start=:page_start1&page_size=:page_size
method: string , x ∈ { GET (default) }

country_codes__create: object

rel: string , x ∈ { country_codes__create (default) }
href: string (uri) https://api.byu.edu/domains/identity/country_codes/v1
method: string , x ∈ { POST (default) }

metadata: sub_level_metadata

values: object[]

country_code_data

country_phone_prefix: string , { x | x ≤ 3 }

3-character phone prefix for the Country

"001"

date_time_updated: string (date-time)

When was the Country Code updated?

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

description: string , { x | x ≤ 15 }

BYU's 15-character name for the Country

"United States"

error_response: object

metadata: simple_metadata

iso_code: string , { x | x ≤ 2 }

ISO's 2-character abbreviation for the Country

"US"

iso_code_3: string , { x | x ≤ 3 }

ISO's 3-character abbreviation for the Country

"USA"

log_action: string , x ∈ { country_code__create , country_code__modify , country_code__remove }

What function was performed on the country_code

"country_codes__create"

long_description: string

BYU's full name for the Country

"United States of America"

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:

simple_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 , { x | x ≤ 9 }

Who (byu_id) updated the Country Code?

"111111111"

valid_for_address: string , x ∈ { N (default) , Y } , { x | x ≤ 1 }

May this country be used in an Address?

"Y"

valid_for_birth_country: string , x ∈ { N (default) , Y } , { x | x ≤ 1 }

May this country be used as a Birth Country?

"Y"

valid_for_citizenship: string , x ∈ { N (default) , Y } , { x | x ≤ 1 }

May this country be used for Citizenship?

"Y"

valid_for_home_country: string , x ∈ { N (default) , Y } , { x | x ≤ 1 }

May this country be used as a Home Country?

"Y"

Service Path:

/domains/identity/country_codes

Domain or University API:

/domains/identity/country_codes

Tags:

domains

Identity

country_codes

CountryCodes

CountryCodes

Summary

Paths

GET /

POST /

DELETE /{country_code}

GET /{country_code}

PUT /{country_code}

GET /{country_code}/logs

Parameter definitions

Response definitions

Schema definitions

active_status: string , x ∈ { N , Y (default) } , { x | x ≤ 3 }

continent_code: string , x ∈ { AF , AS , AT , AU , EU , NA , SA } , { x | x ≤ 2 }

country_code: string

country_code_data: object

country_code_log: object

country_code_logs: object

country_code_new: object

country_codes: object

country_phone_prefix: string , { x | x ≤ 3 }

date_time_updated: string (date-time)

description: string , { x | x ≤ 15 }

error_response: object

iso_code: string , { x | x ≤ 2 }

iso_code_3: string , { x | x ≤ 3 }

log_action: string , x ∈ { country_code__create , country_code__modify , country_code__remove }

long_description: string

simple_metadata: object

sub_level_metadata:

updated_by_id: string , { x | x ≤ 9 }

valid_for_address: string , x ∈ { N (default) , Y } , { x | x ≤ 1 }

valid_for_birth_country: string , x ∈ { N (default) , Y } , { x | x ≤ 1 }

valid_for_citizenship: string , x ∈ { N (default) , Y } , { x | x ≤ 1 }

valid_for_home_country: string , x ∈ { N (default) , Y } , { x | x ≤ 1 }

Community

View This API in the API Store

Get Elevated Access

Tags