From b0e3b56e5047b54e498e4674b76c8373761803b4 Mon Sep 17 00:00:00 2001 From: Jon Esparaz <48423418+JonEsparaz@users.noreply.github.com> Date: Sat, 29 Jul 2023 20:42:04 -0400 Subject: [PATCH 1/3] Add Location to root object --- specification.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/specification.md b/specification.md index 90e522b..109663d 100644 --- a/specification.md +++ b/specification.md @@ -24,6 +24,7 @@ The specification defines the following types: - [DateTime](#DateTime) - [Event](#Event) - [Extension](#Extension) +- [Location](#Location) - [Percent](#Percent) - [Person](#Person) - [PersonalBest](#PersonalBest) @@ -55,6 +56,7 @@ Represents the root object and is usually referred to as a WCIF. | `persons` | [`[Person]`](#person) | List of all the people related to the competition. | | `events` | [`[Event]`](#event) | List of all events held at the competition. | | `schedule` | [`Schedule`](#schedule) | All the data related to time and scheduling. | +| `location` | [`Location`](#location) | Data related to the competition's assigned location. | | `competitorLimit` | `Integer\|null` | The maximal number of competitors that can register for the competition. | | `extensions` | [`[Extension]`](#extension) | List of custom competition extensions. | @@ -556,6 +558,32 @@ Represents the competition data related to time and scheduling. } ``` +### Location + +Represents the main location assigned to a competition. The `Location` may contain some data that overlaps with a competition [`Venue`](#Venue), but it is possible that no competition `Venue` contains the exact same data as the `Location` (e.g., for 3x3x3 Fewest Moves simultaneous competitions). Only the `Location` contains the `city` and `address`. + +| Attribute | Type | Description | +| --- | --- | --- | +| `name` | `String` | The name of the competition venue. | +| `address` | `String` | The address of the competition venue. | +| `city` | `String` | The city where the competition is located. | +| `countryIso2` | [`CountryCode`](#countrycode) | The country where the competition is located. | +| `latitudeMicrodegrees` | `Integer` | The geographic latitude of the competition in microdegrees (degrees times 10^6). | +| `longitudeMicrodegrees` | `Integer` | The geographic longitude of the competition in microdegrees (degrees times 10^6). | + +#### Example + +```json +{ + "name": "Westin Harbour Castle Conference Centre", + "address": "11 Bay Street, Toronto, Ontario", + "cityName": "Toronto, Ontario", + "countryIso2": "CA", + "latitudeMicrodegrees": 43641740, + "longitudeMicrodegrees": 79376902 +} +``` + ### Venue Represents a physical location where the competition takes place. From 395483e59252971493a16008aecbb878238779ad Mon Sep 17 00:00:00 2001 From: Jon Esparaz <48423418+JonEsparaz@users.noreply.github.com> Date: Sat, 29 Jul 2023 21:01:41 -0400 Subject: [PATCH 2/3] Add RegistrationInfo to root object, introduce CurrencyCode object --- specification.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/specification.md b/specification.md index 109663d..0bc646d 100644 --- a/specification.md +++ b/specification.md @@ -19,6 +19,7 @@ The specification defines the following types: - [Avatar](#Avatar) - [Competition](#Competition) - [CountryCode](#CountryCode) +- [CurrencyCode](#CurrencyCode) - [Cutoff](#Cutoff) - [Date](#Date) - [DateTime](#DateTime) @@ -31,6 +32,7 @@ The specification defines the following types: - [Qualification](#Qualification) - [Ranking](#Ranking) - [Registration](#Registration) +- [RegistrationInfo](#RegistrationInfo) - [Result](#Result) - [Role](#Role) - [Room](#Room) @@ -57,6 +59,7 @@ Represents the root object and is usually referred to as a WCIF. | `events` | [`[Event]`](#event) | List of all events held at the competition. | | `schedule` | [`Schedule`](#schedule) | All the data related to time and scheduling. | | `location` | [`Location`](#location) | Data related to the competition's assigned location. | +| `registrationInfo` | [`RegistrationInfo`](#registrationinfo) | Data related to when and how competitors can register for the competition. | | `competitorLimit` | `Integer\|null` | The maximal number of competitors that can register for the competition. | | `extensions` | [`[Extension]`](#extension) | List of custom competition extensions. | @@ -153,6 +156,16 @@ A `String` representing the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/I US ``` +### CurrencyCode + +A `String` representing the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the given currency. + +#### Example + +```json +CAD +``` + ### Role A `String` representing a role at the competition. @@ -198,6 +211,28 @@ Represents person registration data. } ``` +### RegistrationInfo + +Represents information related to when and how to register for the competition. + +| Attribute | Type | Description | +| --- | --- | --- | +| `registrationOpen` | [`DateTime`](#datetime) | The point in time when online registration opens. | +| `registrationClose` | [`DateTime`](#datetime) | The point in time when online registration closes. | +| `baseEntryFee` | `Integer` | The competition's base fee for online registration. | +| `currencyCode` | [`CurrencyCode`](#currencycode) | The currency of the `baseEntryFee`. | + +#### Example + +```json +{ + "registrationOpen": "2023-08-29T05:00:00Z", + "registrationClose": "2023-10-13T06:00:00Z", + "baseEntryFee": 20, + "currencyCode": "USD" +} +``` + ### Avatar Represents an avatar image. From 9f7267ddd9c777b045120ec3bc526a926ed2e627 Mon Sep 17 00:00:00 2001 From: Jon Esparaz <48423418+JonEsparaz@users.noreply.github.com> Date: Sat, 7 Oct 2023 12:36:02 -0400 Subject: [PATCH 3/3] Make country and currency code examples strings --- specification.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification.md b/specification.md index 0bc646d..898b3e6 100644 --- a/specification.md +++ b/specification.md @@ -153,7 +153,7 @@ A `String` representing the [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/I #### Example ```json -US +"US" ``` ### CurrencyCode @@ -163,7 +163,7 @@ A `String` representing the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) c #### Example ```json -CAD +"CAD" ``` ### Role