Get a province or territory by abbreviation

v1.0.0

Returns a Canadian province or territory with its associated holidays. Returns a 404 response for invalid abbreviations.

Input

{
  "type": "object",
  "properties": {
    "optional": {
      "type": "string",
      "enum": [
        "1",
        "0",
        "true",
        "false"
      ]
    },
    "year": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "province": {
      "type": "object",
      "description": "A Canadian province or territory ",
      "required": [
        "id",
        "nameEn",
        "nameFr",
        "sourceEn",
        "sourceLink"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "Canadian province abbreviations",
          "enum": [
            "AB",
            "BC",
            "MB",
            "NB",
            "NL",
            "NS",
            "NT",
            "NU",
            "ON",
            "PE",
            "QC",
            "SK",
            "YT"
          ]
        },
        "nameEn": {
          "type": "string",
          "description": "English name"
        },
        "nameFr": {
          "type": "string",
          "description": "French name"
        },
        "nextHoliday": {
          "type": "object",
          "description": "A Canadian holiday. Includes a name, the literal date of the holiday, the observed date of the holiday (ie, accommodating for weekends), and a list of regions that observe this holiday.",
          "required": [
            "date",
            "federal",
            "id",
            "nameEn",
            "nameFr",
            "observedDate"
          ],
          "properties": {
            "date": {
              "type": "string",
              "format": "date",
              "description": "ISO date: the literal date of the holiday"
            },
            "federal": {
              "type": "integer",
              "description": "Whether this holiday is observed by federally-regulated industries.",
              "enum": [
                1,
                0
              ]
            },
            "id": {
              "type": "integer",
              "description": "Primary key for a holiday"
            },
            "nameEn": {
              "type": "string",
              "description": "English name"
            },
            "nameFr": {
              "type": "string",
              "description": "French name"
            },
            "observedDate": {
              "type": "string",
              "format": "date",
              "description": "ISO date: when this holiday is observed"
            },
            "optional": {
              "type": "integer",
              "description": "Whether this is a province-wide statutory holiday, or one that is optional for employers.",
              "enum": [
                1
              ]
            },
            "provinces": {
              "type": "array",
              "items": {
                "type": "object",
                "additionalProperties": true
              }
            }
          }
        },
        "optional": {
          "type": "integer",
          "description": "Whether this province optionally observes a given holiday.",
          "enum": [
            1
          ]
        },
        "provinces": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        },
        "sourceEn": {
          "type": "string",
          "description": "Name of reference page with public holidays for this region"
        },
        "sourceLink": {
          "type": "string",
          "format": "uri",
          "description": "URL to public holidays reference for this region"
        }
      }
    }
  }
}