eedm.region-iso-codes.v1.0.0.region-iso-codes.json Maven / Gradle / Ivy

Go to download
{
  "title" : "Region ISO Codes",
  "description" : "The valid list of ISO 3166-2 region (subdivision) codes.",
  "version" : "1.0.0",
  "type" : "object",
  "properties" : {
    "metadata" : {
      "$ref" : "resource:/eedm/metadata.json"
    },
    "id" : {
      "title" : "ID",
      "description" : "The global identifier of the region ISO code.",
      "type" : "string",
      "format" : "guid",
      "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
    },
    "title" : {
      "title" : "Title",
      "description" : "The full name of the region represented by the ISO code.",
      "type" : "string",
      "minLength" : 1
    },
    "isoCode" : {
      "title" : "Iso Code",
      "description" : "The ISO 3166-2 code associated with the region.",
      "type" : "string",
      "minLength" : 1
    },
    "country" : {
      "title" : "Country",
      "description" : "The country associated with the region.",
      "oneOf" : [ {
        "type" : "object",
        "properties" : {
          "id" : {
            "title" : "ID",
            "description" : "The global identifier for the Country.",
            "type" : "string",
            "format" : "guid",
            "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
          }
        },
        "links" : [ {
          "rel" : "self",
          "href" : "/country-iso-codes/{id}",
          "targetSchema" : {
            "$ref" : "country-iso-codes.json#"
          }
        } ],
        "additionalProperties" : false,
        "required" : [ "id" ]
      }, {
        "type" : "object",
        "maxProperties" : 0
      } ]
    },
    "status" : {
      "title" : "Status",
      "description" : "An indicator as to whether the ISO code is currently in use or was previously used to represent a region.",
      "enum" : [ "active", "inactive" ],
      "type" : "string"
    }
  },
  "required" : [ "id", "title", "isoCode", "status" ],
  "additionalProperties" : false,
  "links" : [ {
    "rel" : "filter",
    "encType" : "application/x-www-form-urlencoded",
    "method" : "GET",
    "href" : "/region-iso-codes?criteria={\"country\": {\"id\": $id}}",
    "title" : "Country",
    "description" : "The country associated with the region.",
    "schema" : {
      "type" : "object",
      "properties" : {
        "country" : {
          "type" : "object",
          "properties" : {
            "id" : {
              "type" : "string",
              "format" : "guid",
              "pattern" : "^[a-f0-9]{8}(?:-[a-f0-9]{4}){3}-[a-f0-9]{12}$"
            }
          }
        }
      }
    },
    "targetSchema" : {
      "$ref" : "region-iso-codes.json#"
    }
  } ]
}