58 lines
1.5 KiB
YAML
58 lines
1.5 KiB
YAML
title: Country
|
|
description: Country details
|
|
type: object
|
|
required:
|
|
- display_name
|
|
- id
|
|
- iso_2
|
|
- iso_3
|
|
- name
|
|
- num_code
|
|
- region_id
|
|
properties:
|
|
id:
|
|
description: The country's ID
|
|
type: string
|
|
example: 109
|
|
iso_2:
|
|
description: The 2 character ISO code of the country in lower case
|
|
type: string
|
|
example: it
|
|
externalDocs:
|
|
url: >-
|
|
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
|
description: See a list of codes.
|
|
iso_3:
|
|
description: The 2 character ISO code of the country in lower case
|
|
type: string
|
|
example: ita
|
|
externalDocs:
|
|
url: >-
|
|
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements
|
|
description: See a list of codes.
|
|
num_code:
|
|
description: The numerical ISO code for the country.
|
|
type: string
|
|
example: 380
|
|
externalDocs:
|
|
url: >-
|
|
https://en.wikipedia.org/wiki/ISO_3166-1_numeric#Officially_assigned_code_elements
|
|
description: See a list of codes.
|
|
name:
|
|
description: The normalized country name in upper case.
|
|
type: string
|
|
example: ITALY
|
|
display_name:
|
|
description: The country name appropriate for display.
|
|
type: string
|
|
example: Italy
|
|
region_id:
|
|
description: The region ID this country is associated with.
|
|
nullable: true
|
|
type: string
|
|
example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
|
|
region:
|
|
description: A region object. Available if the relation `region` is expanded.
|
|
nullable: true
|
|
type: object
|