Merge pull request #179 from icpc/add-subdivisions

Add country subdivisions to organizations

Author: niemela

Contest_API.md

@@ -1247,19 +1247,21 @@ organizations (i.e. return any organization\_ids).
 
 Properties of organization objects:
 
-| Name               | Type            | Description
-| :----------------- | :-------------- | :----------
-| id                 | ID              | Identifier of the organization.
-| icpc\_id           | string ?        | External identifier from ICPC CMS.
-| name               | string          | Short display name of the organization.
-| formal\_name       | string ?        | Full organization name if too long for normal display purposes.
-| country            | string ?        | [ISO 3166-1 alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the organization's country.
-| country\_flag      | array of FILE ? | Flag of the country. A server is recommended to provide flags of size around 56x56 and 160x160. Only allowed mime types are image/\*.
-| url                | string ?        | URL to organization's website.
-| twitter\_hashtag   | string ?        | Organization Twitter hashtag.
-| twitter\_account   | string ?        | Organization Twitter account.
-| location           | LOCATION ?      | Location where this organization is based.
-| logo               | array of FILE ? | Logo of the organization. A server must provide logos of size 56x56 and 160x160 but may provide other sizes as well. Only allowed mime types are image/\*.
+| Name                       | Type            | Description
+| :------------------------- | :-------------- | :----------
+| id                         | ID              | Identifier of the organization.
+| icpc\_id                   | string ?        | External identifier from ICPC CMS.
+| name                       | string          | Short display name of the organization.
+| formal\_name               | string ?        | Full organization name if too long for normal display purposes.
+| country                    | string ?        | [ISO 3166-1 alpha-3 code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the organization's country.
+| country\_flag              | array of FILE ? | Flag of the country. A server is recommended to provide flags of size around 56x56 and 160x160. Only allowed mime types are image/\*.
+| country\_subdivision       | string ?        | [ISO 3166-2 code](https://en.wikipedia.org/wiki/ISO_3166-2) of the organization's country subdivision (e.g. province or state).
+| country\_subdivision\_flag | array of FILE ? | Flag of the country subdivision. A server is recommended to provide flags of size around 56x56 and 160x160. Only allowed mime types are image/\*.
+| url                        | string ?        | URL to organization's website.
+| twitter\_hashtag           | string ?        | Organization Twitter hashtag.
+| twitter\_account           | string ?        | Organization Twitter account.
+| location                   | LOCATION ?      | Location where this organization is based.
+| logo                       | array of FILE ? | Logo of the organization. A server must provide logos of size 56x56 and 160x160 but may provide other sizes as well. Only allowed mime types are image/\*.
 
 #### Examples
 
@@ -1271,7 +1273,11 @@ Returned data:
 
 ```json
 [{"id":"inst123","icpc_id":"433","name":"Shanghai Jiao Tong U.","formal_name":"Shanghai Jiao Tong University"},
- {"id":"inst105","name":"Carnegie Mellon University","country":"USA",
+ {"id":"inst105","name":"Carnegie Mellon University","country":"USA","country_subdivision":"US-PA",
+  "country_flag":[{"href":"http://example.com/api/contests/wf14/flags/USA/56px","filename":"56px.png","mime":"image/png","width":56,"height":56},
+          {"href":"http://example.com/api/contests/wf14/flags/USA/160px","filename":"160px.png","mime":"image/png","width":160,"height":160}],
+  "country_subdivision_flag":[{"href":"http://example.com/api/contests/wf14/flags/US-PA/56px","filename":"56px.png","mime":"image/png","width":56,"height":56},
+          {"href":"http://example.com/api/contests/wf14/flags/US-PA/160px","filename":"160px.png","mime":"image/png","width":160,"height":160}],
   "logo":[{"href":"http://example.com/api/contests/wf14/organizations/inst105/logo/56px","filename":"56px.png","mime":"image/png","width":56,"height":56},
           {"href":"http://example.com/api/contests/wf14/organizations/inst105/logo/160px","filename":"160px.png","mime":"image/png","width":160,"height":160}]
  }

readme.md

@@ -30,6 +30,7 @@ These are the main changes made since the `2023-06` version:
 
 - Changed type of `penalty_time` in contest enpoint from `integer` to `RELTIME`.
 - Changed type of time related properties in scoreboard endpoint from `integer` to `RELTIME`.
+- Added `country_subdivision` and `country_subdivision_flag` to organizations endpoint.
 
 ## References