Skip to content

Schema Docs
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/recordGeoJSON
Property Pattern Type Deprecated Definition Title/Description
+ id No string No - A unique identifier of the catalog record.
+ type No enum (of string) No - -
- time No Combination No - -
+ geometry No Combination No - -
- conformsTo No array of string No - The extensions/conformance classes used in this record.
+ properties No Combination No - -
- links No array No - -
- linkTemplates No array No - -

1. Property root > id
Type string
Required Yes

Description: A unique identifier of the catalog record.

2. Property root > type
Type enum (of string)
Required Yes

Must be one of: * "Feature"

3. Property root > time
Type combining
Required No
Additional properties Any type allowed
One of(Option)
item 0
time

3.1. Property root > time > oneOf > item 0
Type enum (of null)
Required No

Must be one of: * null

3.2. Property root > time > oneOf > time
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/time
Property Pattern Type Deprecated Definition Title/Description
- date No string No - -
- timestamp No string No - -
- interval No array No - -
- resolution No string No - Minimum time period resolvable in the dataset, as an ISO 8601 duration.

3.2.1. Property root > time > oneOf > item 1 > date
Type string
Required No
Restrictions
Must match regular expression ^\d{4}-\d{2}-\d{2}$ Test

3.2.2. Property root > time > oneOf > item 1 > timestamp
Type string
Required No
Restrictions
Must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z$ Test

3.2.3. Property root > time > oneOf > item 1 > interval
Type array
Required No
Array restrictions
Min items 2
Max items 2
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
interval items -
3.2.3.1. root > time > oneOf > item 1 > interval > interval items
Type combining
Required No
Additional properties Any type allowed
One of(Option)
item 0
item 1
item 2
3.2.3.1.1. Property root > time > oneOf > item 1 > interval > interval items > oneOf > item 0
Type string
Required No
Restrictions
Must match regular expression ^\d{4}-\d{2}-\d{2}$ Test
3.2.3.1.2. Property root > time > oneOf > item 1 > interval > interval items > oneOf > item 1
Type string
Required No
Restrictions
Must match regular expression ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d+)?Z$ Test
3.2.3.1.3. Property root > time > oneOf > item 1 > interval > interval items > oneOf > item 2
Type enum (of string)
Required No

Must be one of: * ".."

3.2.4. Property root > time > oneOf > item 1 > resolution
Type string
Required No

Description: Minimum time period resolvable in the dataset, as an ISO 8601 duration.

4. Property root > geometry
Type combining
Required Yes
Additional properties Any type allowed
One of(Option)
item 0
geometryGeoJSON

4.1. Property root > geometry > oneOf > item 0
Type enum (of null)
Required No

Must be one of: * null

4.2. Property root > geometry > oneOf > geometryGeoJSON
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/geometryGeoJSON
One of(Option)
pointGeoJSON
multipointGeoJSON
linestringGeoJSON
multilinestringGeoJSON
polygonGeoJSON
multipolygonGeoJSON
geometrycollectionGeoJSON

4.2.1. Property root > geometry > oneOf > item 1 > oneOf > pointGeoJSON
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/pointGeoJSON
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - -
+ coordinates No array of number No - -
4.2.1.1. Property root > geometry > oneOf > item 1 > oneOf > item 0 > type
Type enum (of string)
Required Yes

Must be one of: * "Point"

4.2.1.2. Property root > geometry > oneOf > item 1 > oneOf > item 0 > coordinates
Type array of number
Required Yes
Array restrictions
Min items 2
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items -
4.2.1.2.1. root > geometry > oneOf > item 1 > oneOf > item 0 > coordinates > coordinates items
Type number
Required No

4.2.2. Property root > geometry > oneOf > item 1 > oneOf > multipointGeoJSON
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/multipointGeoJSON
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - -
+ coordinates No array of array No - -
4.2.2.1. Property root > geometry > oneOf > item 1 > oneOf > item 1 > type
Type enum (of string)
Required Yes

Must be one of: * "MultiPoint"

4.2.2.2. Property root > geometry > oneOf > item 1 > oneOf > item 1 > coordinates
Type array of array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items -
4.2.2.2.1. root > geometry > oneOf > item 1 > oneOf > item 1 > coordinates > coordinates items
Type array of number
Required No
Array restrictions
Min items 2
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items items -
4.2.2.2.1.1. root > geometry > oneOf > item 1 > oneOf > item 1 > coordinates > coordinates items > coordinates items items
Type number
Required No

4.2.3. Property root > geometry > oneOf > item 1 > oneOf > linestringGeoJSON
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/linestringGeoJSON
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - -
+ coordinates No array of array No - -
4.2.3.1. Property root > geometry > oneOf > item 1 > oneOf > item 2 > type
Type enum (of string)
Required Yes

Must be one of: * "LineString"

4.2.3.2. Property root > geometry > oneOf > item 1 > oneOf > item 2 > coordinates
Type array of array
Required Yes
Array restrictions
Min items 2
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items -
4.2.3.2.1. root > geometry > oneOf > item 1 > oneOf > item 2 > coordinates > coordinates items
Type array of number
Required No
Array restrictions
Min items 2
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items items -
4.2.3.2.1.1. root > geometry > oneOf > item 1 > oneOf > item 2 > coordinates > coordinates items > coordinates items items
Type number
Required No

4.2.4. Property root > geometry > oneOf > item 1 > oneOf > multilinestringGeoJSON
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/multilinestringGeoJSON
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - -
+ coordinates No array of array No - -
4.2.4.1. Property root > geometry > oneOf > item 1 > oneOf > item 3 > type
Type enum (of string)
Required Yes

Must be one of: * "MultiLineString"

4.2.4.2. Property root > geometry > oneOf > item 1 > oneOf > item 3 > coordinates
Type array of array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items -
4.2.4.2.1. root > geometry > oneOf > item 1 > oneOf > item 3 > coordinates > coordinates items
Type array of array
Required No
Array restrictions
Min items 2
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items items -
4.2.4.2.1.1. root > geometry > oneOf > item 1 > oneOf > item 3 > coordinates > coordinates items > coordinates items items
Type array of number
Required No
Array restrictions
Min items 2
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items items items -
4.2.4.2.1.1.1. root > geometry > oneOf > item 1 > oneOf > item 3 > coordinates > coordinates items > coordinates items items > coordinates items items items
Type number
Required No

4.2.5. Property root > geometry > oneOf > item 1 > oneOf > polygonGeoJSON
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/polygonGeoJSON
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - -
+ coordinates No array of array No - -
4.2.5.1. Property root > geometry > oneOf > item 1 > oneOf > item 4 > type
Type enum (of string)
Required Yes

Must be one of: * "Polygon"

4.2.5.2. Property root > geometry > oneOf > item 1 > oneOf > item 4 > coordinates
Type array of array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items -
4.2.5.2.1. root > geometry > oneOf > item 1 > oneOf > item 4 > coordinates > coordinates items
Type array of array
Required No
Array restrictions
Min items 4
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items items -
4.2.5.2.1.1. root > geometry > oneOf > item 1 > oneOf > item 4 > coordinates > coordinates items > coordinates items items
Type array of number
Required No
Array restrictions
Min items 2
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items items items -
4.2.5.2.1.1.1. root > geometry > oneOf > item 1 > oneOf > item 4 > coordinates > coordinates items > coordinates items items > coordinates items items items
Type number
Required No

4.2.6. Property root > geometry > oneOf > item 1 > oneOf > multipolygonGeoJSON
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/multipolygonGeoJSON
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - -
+ coordinates No array of array No - -
4.2.6.1. Property root > geometry > oneOf > item 1 > oneOf > item 5 > type
Type enum (of string)
Required Yes

Must be one of: * "MultiPoint"

4.2.6.2. Property root > geometry > oneOf > item 1 > oneOf > item 5 > coordinates
Type array of array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items -
4.2.6.2.1. root > geometry > oneOf > item 1 > oneOf > item 5 > coordinates > coordinates items
Type array of number
Required No
Array restrictions
Min items 2
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
coordinates items items -
4.2.6.2.1.1. root > geometry > oneOf > item 1 > oneOf > item 5 > coordinates > coordinates items > coordinates items items
Type number
Required No

4.2.7. Property root > geometry > oneOf > item 1 > oneOf > geometrycollectionGeoJSON
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/geometrycollectionGeoJSON
Property Pattern Type Deprecated Definition Title/Description
+ type No enum (of string) No - -
+ geometries No array No - -
4.2.7.1. Property root > geometry > oneOf > item 1 > oneOf > item 6 > type
Type enum (of string)
Required Yes

Must be one of: * "GeometryCollection"

4.2.7.2. Property root > geometry > oneOf > item 1 > oneOf > item 6 > geometries
Type array
Required Yes
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
geometryGeoJSON -
4.2.7.2.1. root > geometry > oneOf > item 1 > oneOf > item 6 > geometries > geometryGeoJSON
Type combining
Required No
Additional properties Any type allowed
Same definition as geometry_oneOf_i1

5. Property root > conformsTo
Type array of string
Required No

Description: The extensions/conformance classes used in this record.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
conformsTo items -

5.1. root > conformsTo > conformsTo items
Type string
Required No

6. Property root > properties
Type combining
Required Yes
Additional properties Any type allowed
All of(Requirement)
recordCommonProperties
item 1

6.1. Property root > properties > allOf > recordCommonProperties
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/recordCommonProperties
Property Pattern Type Deprecated Definition Title/Description
- created No string No - The date this record was created in the server.
- updated No string No - The most recent date on which the record was changed.
- type No string No - The nature or genre of the resource. The value should be a code, convenient for filtering records. Where available, a link to the canonical URI of the record type resource will be added to the 'links' property.
- title No string No - A human-readable name given to the resource.
- description No string No - A free-text account of the resource.
- keywords No array of string No - The topic or topics of the resource. Typically represented using free-form keywords, tags, key phrases, or classification codes.
- themes No array No - A knowledge organization system used to classify the resource.
- language No object No In #/$defs/language The language used for textual values in this record representation.
- languages No array No - This list of languages in which this record is available.
- resourceLanguages No array No - The list of languages in which the resource described by this record is available.
- externalIds No array of object No - An identifier for the resource assigned by an external (to the catalog) entity.
- formats No array No - A list of available distributions of the resource.
- contacts No array No - A list of contacts qualified by their role(s) in association to the record or the resource described by the record.
- license No string No In #/$defs/license A legal document under which the resource is made available. If the resource is being made available under a common license then use an SPDX license id (https://spdx.org/licenses/). If the resource is being made available under multiple common licenses then use an SPDX license expression v2.3 string (https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/) If the resource is being made available under one or more licenses that haven't been assigned an SPDX identifier or one or more custom licenses then use a string value of 'other' and include one or more links (rel="license") in the `link` section of the record to the file(s) that contains the text of the license(s). There is also the case of a resource that is private or unpublished and is thus unlicensed; in this case do not register such a resource in the catalog in the first place since there is no point in making such a resource discoverable.
- rights No string No - A statement that concerns all rights not addressed by the license such as a copyright statement.

6.1.1. Property root > properties > allOf > item 0 > created
Type string
Required No
Format date-time

Description: The date this record was created in the server.

6.1.2. Property root > properties > allOf > item 0 > updated
Type string
Required No
Format date-time

Description: The most recent date on which the record was changed.

6.1.3. Property root > properties > allOf > item 0 > type
Type string
Required No

Description: The nature or genre of the resource. The value should be a code, convenient for filtering records. Where available, a link to the canonical URI of the record type resource will be added to the 'links' property.

6.1.4. Property root > properties > allOf > item 0 > title
Type string
Required No

Description: A human-readable name given to the resource.

6.1.5. Property root > properties > allOf > item 0 > description
Type string
Required No

Description: A free-text account of the resource.

6.1.6. Property root > properties > allOf > item 0 > keywords
Type array of string
Required No

Description: The topic or topics of the resource. Typically represented using free-form keywords, tags, key phrases, or classification codes.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
keywords items -
6.1.6.1. root > properties > allOf > item 0 > keywords > keywords items
Type string
Required No

6.1.7. Property root > properties > allOf > item 0 > themes
Type array
Required No

Description: A knowledge organization system used to classify the resource.

Array restrictions
Min items 1
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
theme -
6.1.7.1. root > properties > allOf > item 0 > themes > theme
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/theme
Property Pattern Type Deprecated Definition Title/Description
+ concepts No array of object No - One or more entity/concept identifiers from this knowledge system. it is recommended that a resolvable URI be used for each entity/concept identifier.
+ scheme No string No - An identifier for the knowledge organization system used to classify the resource. It is recommended that the identifier be a resolvable URI. The list of schemes used in a searchable catalog can be determined by inspecting the server's OpenAPI document or, if the server implements CQL2, by exposing a queryable (e.g. named `scheme`) and enumerating the list of schemes in the queryable's schema definition.
6.1.7.1.1. Property root > properties > allOf > item 0 > themes > themes items > concepts
Type array of object
Required Yes

Description: One or more entity/concept identifiers from this knowledge system. it is recommended that a resolvable URI be used for each entity/concept identifier.

Array restrictions
Min items 1
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
concepts items -
6.1.7.1.1.1. root > properties > allOf > item 0 > themes > themes items > concepts > concepts items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
+ id No string No - An identifier for the concept.
- title No string No - A human readable title for the concept.
- description No string No - A human readable description for the concept.
- url No string No - A URI providing further description of the concept.
6.1.7.1.1.1.1. Property root > properties > allOf > item 0 > themes > themes items > concepts > concepts items > id
Type string
Required Yes

Description: An identifier for the concept.

6.1.7.1.1.1.2. Property root > properties > allOf > item 0 > themes > themes items > concepts > concepts items > title
Type string
Required No

Description: A human readable title for the concept.

6.1.7.1.1.1.3. Property root > properties > allOf > item 0 > themes > themes items > concepts > concepts items > description
Type string
Required No

Description: A human readable description for the concept.

6.1.7.1.1.1.4. Property root > properties > allOf > item 0 > themes > themes items > concepts > concepts items > url
Type string
Required No
Format uri

Description: A URI providing further description of the concept.

6.1.7.1.2. Property root > properties > allOf > item 0 > themes > themes items > scheme
Type string
Required Yes

Description: An identifier for the knowledge organization system used to classify the resource. It is recommended that the identifier be a resolvable URI. The list of schemes used in a searchable catalog can be determined by inspecting the server's OpenAPI document or, if the server implements CQL2, by exposing a queryable (e.g. named scheme) and enumerating the list of schemes in the queryable's schema definition.

6.1.8. Property root > properties > allOf > item 0 > language
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/language

Description: The language used for textual values in this record representation.

Property Pattern Type Deprecated Definition Title/Description
+ code No string No - The language tag as per RFC-5646.
- name No string No - The untranslated name of the language.
- alternate No string No - The name of the language in another well-understood language, usually English.
- dir No enum (of string) No - The direction for text in this language. The default, `ltr` (left-to-right), represents the most common situation. However, care should be taken to set the value of `dir` appropriately if the language direction is not `ltr`. Other values supported are `rtl` (right-to-left), `ttb` (top-to-bottom), and `btt` (bottom-to-top).
6.1.8.1. Property root > properties > allOf > item 0 > language > code
Type string
Required Yes

Description: The language tag as per RFC-5646.

6.1.8.2. Property root > properties > allOf > item 0 > language > name
Type string
Required No

Description: The untranslated name of the language.

Restrictions
Min length 1
6.1.8.3. Property root > properties > allOf > item 0 > language > alternate
Type string
Required No

Description: The name of the language in another well-understood language, usually English.

6.1.8.4. Property root > properties > allOf > item 0 > language > dir
Type enum (of string)
Required No
Default "ltr"

Description: The direction for text in this language. The default, ltr (left-to-right), represents the most common situation. However, care should be taken to set the value of dir appropriately if the language direction is not ltr. Other values supported are rtl (right-to-left), ttb (top-to-bottom), and btt (bottom-to-top).

Must be one of: * "ltr" * "rtl" * "ttb" * "btt"

6.1.9. Property root > properties > allOf > item 0 > languages
Type array
Required No

Description: This list of languages in which this record is available.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
language The language used for textual values in this record.
6.1.9.1. root > properties > allOf > item 0 > languages > language
Type object
Required No
Additional properties Any type allowed
Same definition as language

Description: The language used for textual values in this record.

6.1.10. Property root > properties > allOf > item 0 > resourceLanguages
Type array
Required No

Description: The list of languages in which the resource described by this record is available.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
language The language used for textual values in this record.
6.1.10.1. root > properties > allOf > item 0 > resourceLanguages > language
Type object
Required No
Additional properties Any type allowed
Same definition as language

Description: The language used for textual values in this record.

6.1.11. Property root > properties > allOf > item 0 > externalIds
Type array of object
Required No

Description: An identifier for the resource assigned by an external (to the catalog) entity.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
externalIds items -
6.1.11.1. root > properties > allOf > item 0 > externalIds > externalIds items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- scheme No string No - A reference to an authority or identifier for a knowledge organization system from which the external identifier was obtained. It is recommended that the identifier be a resolvable URI.
+ value No string No - The value of the identifier.
6.1.11.1.1. Property root > properties > allOf > item 0 > externalIds > externalIds items > scheme
Type string
Required No

Description: A reference to an authority or identifier for a knowledge organization system from which the external identifier was obtained. It is recommended that the identifier be a resolvable URI.

6.1.11.1.2. Property root > properties > allOf > item 0 > externalIds > externalIds items > value
Type string
Required Yes

Description: The value of the identifier.

6.1.12. Property root > properties > allOf > item 0 > formats
Type array
Required No

Description: A list of available distributions of the resource.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
format -
6.1.12.1. root > properties > allOf > item 0 > formats > format
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/format
Property Pattern Type Deprecated Definition Title/Description
- name No string No - -
- mediaType No string No - -
Any of(Option)
item 0
item 1
6.1.12.1.1. Property root > properties > allOf > item 0 > formats > formats items > anyOf > item 0
Type object
Required No
Additional properties Any type allowed
6.1.12.1.1.1. The following properties are required
  • name
6.1.12.1.2. Property root > properties > allOf > item 0 > formats > formats items > anyOf > item 1
Type object
Required No
Additional properties Any type allowed
6.1.12.1.2.1. The following properties are required
  • mediaType
6.1.12.1.3. Property root > properties > allOf > item 0 > formats > formats items > name
Type string
Required No
6.1.12.1.4. Property root > properties > allOf > item 0 > formats > formats items > mediaType
Type string
Required No

6.1.13. Property root > properties > allOf > item 0 > contacts
Type array
Required No

Description: A list of contacts qualified by their role(s) in association to the record or the resource described by the record.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
contact Identification of, and means of communication with, person responsible ...
6.1.13.1. root > properties > allOf > item 0 > contacts > contact
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/contact

Description: Identification of, and means of communication with, person responsible for the resource.

Property Pattern Type Deprecated Definition Title/Description
- identifier No string No - A value uniquely identifying a contact.
- name No string No - The name of the responsible person.
- position No string No - The name of the role or position of the responsible person taken from the organization's formal organizational hierarchy or chart.
- organization No string No - Organization/affiliation of the contact.
- logo No Combination No - Graphic identifying a contact. The link relation should be `icon` and the media type should be an image media type.
- phones No array of object No - Telephone numbers at which contact can be made. The type of
phone number is indicated using the roles property.
- emails No array of object No - Email addresses at which contact can be made. The type of
email address is indicated using the roles property.
- addresses No array of object No - Physical location at which contact can be made. The type of
address is indicated using the roles property.
- links No array No - On-line information about the contact.
- hoursOfService No string No - Time period when the contact can be contacted.
- contactInstructions No string No - Supplemental instructions on how or when to contact the
responsible party. The roles property is used to associate
a set of named duties, job functions and/or permissions
associated with this contact. (e.g. developer,
administrator, etc.).
- roles No array of string No Same as roles The list of duties, job functions or permissions assigned by the system and associated with the context of this member.
Any of(Option)
item 0
item 1
6.1.13.1.1. Property root > properties > allOf > item 0 > contacts > contacts items > anyOf > item 0
Type object
Required No
Additional properties Any type allowed
6.1.13.1.1.1. The following properties are required
  • name
6.1.13.1.2. Property root > properties > allOf > item 0 > contacts > contacts items > anyOf > item 1
Type object
Required No
Additional properties Any type allowed
6.1.13.1.2.1. The following properties are required
  • organization
6.1.13.1.3. Property root > properties > allOf > item 0 > contacts > contacts items > identifier
Type string
Required No

Description: A value uniquely identifying a contact.

6.1.13.1.4. Property root > properties > allOf > item 0 > contacts > contacts items > name
Type string
Required No

Description: The name of the responsible person.

6.1.13.1.5. Property root > properties > allOf > item 0 > contacts > contacts items > position
Type string
Required No

Description: The name of the role or position of the responsible person taken from the organization's formal organizational hierarchy or chart.

6.1.13.1.6. Property root > properties > allOf > item 0 > contacts > contacts items > organization
Type string
Required No

Description: Organization/affiliation of the contact.
Type combining
Required No
Additional properties Any type allowed

Description: Graphic identifying a contact. The link relation should be icon and the media type should be an image media type.

All of(Requirement)
link
item 1
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/link
All of(Requirement)
linkBase
item 1
6.1.13.1.7.1.1. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > linkBase
Type object
Required No
Additional properties Any type allowed
Defined in #/$defs/linkBase
Property Pattern Type Deprecated Definition Title/Description
- rel No string No - The type or semantics of the relation.
- type No string No - A hint indicating what the media type of the result of dereferencing the link should be.
- hreflang No string No - A hint indicating what the language of the result of dereferencing the link should be.
- title No string No - Used to label the destination of a link such that it can be used as a human-readable identifier.
- length No integer No - -
- created No string No - Date of creation of the resource pointed to by the link.
- updated No string No - Most recent date on which the resource pointed to by the link was changed.
6.1.13.1.7.1.1.1. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 0 > rel
Type string
Required No

Description: The type or semantics of the relation.

6.1.13.1.7.1.1.2. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 0 > type
Type string
Required No

Description: A hint indicating what the media type of the result of dereferencing the link should be.

6.1.13.1.7.1.1.3. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 0 > hreflang
Type string
Required No

Description: A hint indicating what the language of the result of dereferencing the link should be.

6.1.13.1.7.1.1.4. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 0 > title
Type string
Required No

Description: Used to label the destination of a link such that it can be used as a human-readable identifier.

6.1.13.1.7.1.1.5. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 0 > length
Type integer
Required No
6.1.13.1.7.1.1.6. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 0 > created
Type string
Required No
Format date-time

Description: Date of creation of the resource pointed to by the link.

6.1.13.1.7.1.1.7. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 0 > updated
Type string
Required No
Format date-time

Description: Most recent date on which the resource pointed to by the link was changed.

6.1.13.1.7.1.2. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 1
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
+ href No string No - -
6.1.13.1.7.1.2.1. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 0 > allOf > item 1 > href
Type string
Required Yes
Format uri
6.1.13.1.7.2. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 1
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
+ rel No enum (of string) No - -
6.1.13.1.7.2.1. The following properties are required
  • type
6.1.13.1.7.2.2. Property root > properties > allOf > item 0 > contacts > contacts items > logo > allOf > item 1 > rel
Type enum (of string)
Required Yes

Must be one of: * "icon"

6.1.13.1.8. Property root > properties > allOf > item 0 > contacts > contacts items > phones
Type array of object
Required No

Description: Telephone numbers at which contact can be made. The type of phone number is indicated using the roles property.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
phones items -
6.1.13.1.8.1. root > properties > allOf > item 0 > contacts > contacts items > phones > phones items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
+ value No string No - The value is the phone number itself.
- roles No array of string No In #/$defs/roles The list of duties, job functions or permissions assigned by the system and associated with the context of this member.
6.1.13.1.8.1.1. Property root > properties > allOf > item 0 > contacts > contacts items > phones > phones items > value
Type string
Required Yes

Description: The value is the phone number itself.

Restrictions
Must match regular expression ^\+[1-9]{1}[0-9]{3,14}$ Test
6.1.13.1.8.1.2. Property root > properties > allOf > item 0 > contacts > contacts items > phones > phones items > roles
Type array of string
Required No
Defined in #/$defs/roles

Description: The list of duties, job functions or permissions assigned by the system and associated with the context of this member.

Array restrictions
Min items 1
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
roles items -
6.1.13.1.8.1.2.1. root > properties > allOf > item 0 > contacts > contacts items > phones > phones items > roles > roles items
Type string
Required No
6.1.13.1.9. Property root > properties > allOf > item 0 > contacts > contacts items > emails
Type array of object
Required No

Description: Email addresses at which contact can be made. The type of email address is indicated using the roles property.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
emails items -
6.1.13.1.9.1. root > properties > allOf > item 0 > contacts > contacts items > emails > emails items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
+ value No string No - The value is the email number itself.
- roles No array of string No Same as roles The list of duties, job functions or permissions assigned by the system and associated with the context of this member.
6.1.13.1.9.1.1. Property root > properties > allOf > item 0 > contacts > contacts items > emails > emails items > value
Type string
Required Yes
Format email

Description: The value is the email number itself.

6.1.13.1.9.1.2. Property root > properties > allOf > item 0 > contacts > contacts items > emails > emails items > roles
Type array of string
Required No
Same definition as roles

Description: The list of duties, job functions or permissions assigned by the system and associated with the context of this member.

6.1.13.1.10. Property root > properties > allOf > item 0 > contacts > contacts items > addresses
Type array of object
Required No

Description: Physical location at which contact can be made. The type of address is indicated using the roles property.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
addresses items -
6.1.13.1.10.1. root > properties > allOf > item 0 > contacts > contacts items > addresses > addresses items
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
- deliveryPoint No array of string No - Address lines for the location.
- city No string No - City for the location.
- administrativeArea No string No - State or province of the location.
- postalCode No string No - ZIP or other postal code.
- country No string No - Country of the physical address. ISO 3166-1 is recommended.
- roles No array of string No Same as roles The list of duties, job functions or permissions assigned by the system and associated with the context of this member.
6.1.13.1.10.1.1. Property root > properties > allOf > item 0 > contacts > contacts items > addresses > addresses items > deliveryPoint
Type array of string
Required No

Description: Address lines for the location.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
deliveryPoint items -
6.1.13.1.10.1.1.1. root > properties > allOf > item 0 > contacts > contacts items > addresses > addresses items > deliveryPoint > deliveryPoint items
Type string
Required No
6.1.13.1.10.1.2. Property root > properties > allOf > item 0 > contacts > contacts items > addresses > addresses items > city
Type string
Required No

Description: City for the location.

6.1.13.1.10.1.3. Property root > properties > allOf > item 0 > contacts > contacts items > addresses > addresses items > administrativeArea
Type string
Required No

Description: State or province of the location.

6.1.13.1.10.1.4. Property root > properties > allOf > item 0 > contacts > contacts items > addresses > addresses items > postalCode
Type string
Required No

Description: ZIP or other postal code.

6.1.13.1.10.1.5. Property root > properties > allOf > item 0 > contacts > contacts items > addresses > addresses items > country
Type string
Required No

Description: Country of the physical address. ISO 3166-1 is recommended.

6.1.13.1.10.1.6. Property root > properties > allOf > item 0 > contacts > contacts items > addresses > addresses items > roles
Type array of string
Required No
Same definition as roles

Description: The list of duties, job functions or permissions assigned by the system and associated with the context of this member.
Type array
Required No

Description: On-line information about the contact.

Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
links items -
Type combining
Required No
Additional properties Any type allowed
All of(Requirement)
link
item 1
Type combining
Required No
Additional properties Any type allowed
Same definition as properties_allOf_i0_contacts_items_logo_allOf_i0
Type object
Required No
Additional properties Any type allowed
6.1.13.1.11.1.2.1. The following properties are required
  • type
6.1.13.1.12. Property root > properties > allOf > item 0 > contacts > contacts items > hoursOfService
Type string
Required No

Description: Time period when the contact can be contacted.

6.1.13.1.13. Property root > properties > allOf > item 0 > contacts > contacts items > contactInstructions
Type string
Required No

Description: Supplemental instructions on how or when to contact the responsible party. The roles property is used to associate a set of named duties, job functions and/or permissions associated with this contact. (e.g. developer, administrator, etc.).

6.1.13.1.14. Property root > properties > allOf > item 0 > contacts > contacts items > roles
Type array of string
Required No
Same definition as roles

Description: The list of duties, job functions or permissions assigned by the system and associated with the context of this member.

6.1.14. Property root > properties > allOf > item 0 > license
Type string
Required No
Defined in #/$defs/license

Description: A legal document under which the resource is made available. If the resource is being made available under a common license then use an SPDX license id (https://spdx.org/licenses/). If the resource is being made available under multiple common licenses then use an SPDX license expression v2.3 string (https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions/) If the resource is being made available under one or more licenses that haven't been assigned an SPDX identifier or one or more custom licenses then use a string value of 'other' and include one or more links (rel="license") in the link section of the record to the file(s) that contains the text of the license(s). There is also the case of a resource that is private or unpublished and is thus unlicensed; in this case do not register such a resource in the catalog in the first place since there is no point in making such a resource discoverable.

6.1.15. Property root > properties > allOf > item 0 > rights
Type string
Required No

Description: A statement that concerns all rights not addressed by the license such as a copyright statement.

6.2. Property root > properties > allOf > item 1
Type object
Required No
Additional properties Any type allowed
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
link -
Type combining
Required No
Additional properties Any type allowed
Same definition as properties_allOf_i0_contacts_items_logo_allOf_i0

8. Property root > linkTemplates
Type array
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
linkTemplate -

8.1. root > linkTemplates > linkTemplate
Type combining
Required No
Additional properties Any type allowed
Defined in #/$defs/linkTemplate
All of(Requirement)
linkBase
item 1

8.1.1. Property root > linkTemplates > linkTemplates items > allOf > linkBase
Type object
Required No
Additional properties Any type allowed
Same definition as properties_allOf_i0_contacts_items_logo_allOf_i0_allOf_i0

8.1.2. Property root > linkTemplates > linkTemplates items > allOf > item 1
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated Definition Title/Description
+ uriTemplate No string No - Supplies a resolvable URI to a remote resource (or resource fragment).
- varBase No string No - The base URI to which the variable name can be appended to retrieve the definition of the variable as a JSON Schema fragment.
- variables No object No - This object contains one key per substitution variable in the templated URL. Each key defines the schema of one substitution variable using a JSON Schema fragment and can thus include things like the data type of the variable, enumerations, minimum values, maximum values, etc.
8.1.2.1. Property root > linkTemplates > linkTemplates items > allOf > item 1 > uriTemplate
Type string
Required Yes

Description: Supplies a resolvable URI to a remote resource (or resource fragment).

8.1.2.2. Property root > linkTemplates > linkTemplates items > allOf > item 1 > varBase
Type string
Required No
Format uri

Description: The base URI to which the variable name can be appended to retrieve the definition of the variable as a JSON Schema fragment.

8.1.2.3. Property root > linkTemplates > linkTemplates items > allOf > item 1 > variables
Type object
Required No
Additional properties Any type allowed

Description: This object contains one key per substitution variable in the templated URL. Each key defines the schema of one substitution variable using a JSON Schema fragment and can thus include things like the data type of the variable, enumerations, minimum values, maximum values, etc.

Generated using json-schema-for-humans on 2025-11-07 at 00:41:11 +0100