Microsoft Azure Timezone API

openapi: 3.2.0
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Timezone API
tags:
- name: Timezone
paths:
  /timezone/byId/{format}:
    get:
      x-publish: true
      description: '__Time Zone by Id__<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>This API returns current, historical, and future time zone information for the specified IANA time zone ID.'
      operationId: microsoftAzureTimezoneGettimezonebyid
      x-ms-examples:
        GetTimezoneByID:
          $ref: ./examples/GetTimezoneByID.json
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/TimezoneAcceptLanguage'
      - $ref: '#/components/parameters/TimezoneOptions'
      - $ref: '#/components/parameters/TimezoneTimeStamp'
      - $ref: '#/components/parameters/TimezoneTransitionsFrom'
      - $ref: '#/components/parameters/TimezoneTransitionsYears'
      - $ref: '#/components/parameters/JsonFormat'
      - name: query
        in: query
        description: The IANA time zone ID.
        required: true
        x-ms-parameter-location: method
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimezoneByIdResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Get Timezone Byid Format
      tags:
      - Timezone
  /timezone/byCoordinates/{format}:
    get:
      x-publish: true
      description: '__Time Zone by Coordinates__<br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>This API returns current, historical, and future time zone information for a specified latitude-longitude pair. In addition, the API provides sunset and sunrise times for a given location.'
      operationId: microsoftAzureTimezoneGettimezonebycoordinates
      x-ms-examples:
        GetTimezoneByCoordinates:
          $ref: ./examples/GetTimezoneByCoordinates.json
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/TimezoneAcceptLanguage'
      - $ref: '#/components/parameters/TimezoneOptions'
      - $ref: '#/components/parameters/TimezoneTimeStamp'
      - $ref: '#/components/parameters/TimezoneTransitionsFrom'
      - $ref: '#/components/parameters/TimezoneTransitionsYears'
      - $ref: '#/components/parameters/JsonFormat'
      - name: query
        in: query
        description: Coordinates of the point for which time zone information is requested. The applicable query is specified as a comma separated string composed by latitude followed by longitude e.g. "47.641268,-122.125679".
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimezoneByCoordinatesResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Get Timezone Bycoordinates Format
      tags:
      - Timezone
  /timezone/enumWindows/{format}:
    get:
      x-publish: true
      description: '__Enumerate Windows Time Zones__<br><br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>This API returns a full list of Windows Time Zone IDs.'
      operationId: microsoftAzureTimezoneGettimezoneenumwindows
      x-ms-examples:
        GetTimezoneEnumWindows:
          $ref: ./examples/GetTimezoneEnumWindows.json
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/JsonFormat'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimezoneEnumWindowsResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Get Timezone Enumwindows Format
      tags:
      - Timezone
  /timezone/enumIana/{format}:
    get:
      x-publish: true
      description: '__Enumerate IANA Time Zones__<br><br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>This API returns a full list of IANA time zone IDs. Updates to the IANA service will be reflected in the system within one day.'
      operationId: microsoftAzureTimezoneGettimezoneenumiana
      x-ms-examples:
        GetTimezoneEnumIANA:
          $ref: ./examples/GetTimezoneEnumIANA.json
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/JsonFormat'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimezoneEnumIanaResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Get Timezone Enumiana Format
      tags:
      - Timezone
  /timezone/ianaVersion/{format}:
    get:
      x-publish: true
      description: '__Time Zone IANA Version__<br><br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>This API returns the current IANA version number.'
      operationId: microsoftAzureTimezoneGettimezoneianaversion
      x-ms-examples:
        GetTimezoneIANAVersion:
          $ref: ./examples/GetTimezoneIANAVersion.json
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/JsonFormat'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimezoneIanaVersionResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Get Timezone Ianaversion Format
      tags:
      - Timezone
  /timezone/windowsToIana/{format}:
    get:
      x-publish: true
      description: '__Windows to IANA Time Zone__<br><br><br>**Applies to**: S0 and S1 pricing tiers.<br><br><br>This API returns a corresponding IANA ID, given a valid Windows Time Zone ID. Multiple IANA IDs may be returned for a single Windows ID. It is possible to narrow these results by adding an optional territory parameter.'
      operationId: microsoftAzureTimezoneGettimezonewindowstoiana
      x-ms-examples:
        GetTimezoneWindowsToIANA:
          $ref: ./examples/GetTimezoneWindowsToIANA.json
      parameters:
      - $ref: '#/components/parameters/ClientId'
      - $ref: '#/components/parameters/SubscriptionKey'
      - $ref: '#/components/parameters/ApiVersion'
      - $ref: '#/components/parameters/JsonFormat'
      - name: query
        in: query
        description: The Windows time zone ID.
        required: true
        schema:
          type: string
      - name: territory
        in: query
        description: Windows Time Zone territory code.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TimezoneWindowToIanaResult'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Microsoft Azure Get Timezone Windowstoiana Format
      tags:
      - Timezone
components:
  schemas:
    TimeZonesById:
      description: TimeZoneById array
      type: array
      readOnly: true
      items:
        $ref: '#/components/schemas/TimezoneById'
    ReferenceTimeByCoordinates:
      description: Details in effect at the local time.
      type: object
      readOnly: true
      properties:
        Tag:
          description: Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect).
          type: string
          readOnly: true
        StandardOffset:
          description: UTC offset in effect at the `ReferenceUTCTimestamp`.
          type: string
          readOnly: true
        DaylightSavings:
          description: Time saving in minutes in effect at the `ReferenceUTCTimestamp`.
          type: string
          readOnly: true
        WallTime:
          description: Current wall time at the given time zone as shown in the `Tag` property.
          type: string
          readOnly: true
        PosixTzValidYear:
          description: 'The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year.'
          type: integer
          readOnly: true
        PosixTz:
          description: POSIX string used to set the time zone environment variable.
          type: string
          readOnly: true
        Sunrise:
          description: Sunrise at the given time zone as shown in the `Tag` property.
          type: string
          readOnly: true
        Sunset:
          description: Sunset at the given time zone as shown in the `Tag` property.
          type: string
          readOnly: true
    TimezoneEnumWindowsResult:
      description: This object is returned from a successful Timezone Enum Windows call
      type: array
      items:
        $ref: '#/components/schemas/TimezoneEnumWindow'
    TimezoneByCoordinatesResult:
      description: This object is returned from a successful Timezone By Coordinates call
      type: object
      properties:
        Version:
          description: Version property
          type: string
          readOnly: true
        ReferenceUtcTimestamp:
          description: Reference Utc Timestamp property
          type: string
          readOnly: true
          format: date-time
        TimeZones:
          $ref: '#/components/schemas/TimeZonesByCoordinates'
    TimezoneByIdResult:
      description: This object is returned from a successful Timezone By ID call
      type: object
      properties:
        Version:
          description: Version property
          type: string
          readOnly: true
        ReferenceUtcTimestamp:
          description: Reference Utc Timestamp property
          type: string
          readOnly: true
          format: date-time
        TimeZones:
          $ref: '#/components/schemas/TimeZonesById'
    Country:
      type: object
      description: A country/region  record.
      properties:
        Name:
          description: country/region  Name
          type: string
          readOnly: true
        Code:
          description: ISO-3166 2-letter country/region  code for the country/region .
          type: string
          readOnly: true
    Names:
      type: object
      description: Timezone names object.
      properties:
        ISO6391LanguageCode:
          description: The ISO 639-1 language code of the Names
          type: string
          readOnly: true
        Generic:
          description: Generic Name
          type: string
          readOnly: true
        Standard:
          description: Standard Name
          type: string
          readOnly: true
        Daylight:
          description: Daylight Name
          type: string
          readOnly: true
    TimeTransition:
      type: object
      readOnly: true
      properties:
        Tag:
          description: Tag property
          type: string
          readOnly: true
        StandardOffset:
          description: StandardOffset property
          type: string
          readOnly: true
        DaylightSavings:
          description: DaylightSavings property
          type: string
          readOnly: true
        UtcStart:
          description: Start date, start time for this transition period
          type: string
          readOnly: true
          format: date-time
        UtcEnd:
          description: End date, end time for this transition period
          type: string
          readOnly: true
          format: date-time
    ODataErrorResponse:
      type: object
      description: This response object is returned when an error occurs in the Azure Maps API.
      properties:
        error:
          $ref: '#/components/schemas/ODataError'
    ReferenceTimeById:
      description: Details in effect at the local time.
      type: object
      readOnly: true
      properties:
        Tag:
          description: Time zone name in effect at the reference timestamp (i.e. PST or PDT depending whether Daylight Savings Time is in effect).
          type: string
          readOnly: true
        StandardOffset:
          description: UTC offset in effect at the `ReferenceUTCTimestamp`.
          type: string
          readOnly: true
        DaylightSavings:
          description: Time saving in minutes in effect at the `ReferenceUTCTimestamp`.
          type: string
          readOnly: true
        WallTime:
          description: Current wall time at the given time zone as shown in the `Tag` property.
          type: string
          readOnly: true
        PosixTzValidYear:
          description: 'The year this POSIX string is valid for. Note: A POSIX string will only be valid in the given year.'
          type: integer
          readOnly: true
        PosixTz:
          description: POSIX string used to set the time zone environment variable.
          type: string
          readOnly: true
    TimeZoneByCoordinates:
      type: object
      properties:
        Id:
          description: Id property
          type: string
          readOnly: true
        Aliases:
          description: 'An array of time zone ID aliases.  Only returned when [options]=*zoneinfo* or *all*.


            Note: may be null.'
          type: array
          readOnly: true
          items:
            type: string
            readOnly: true
        Countries:
          description: An array of country/region records. Only returned when [options]=*zoneinfo* or *all*.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Country'
        Names:
          $ref: '#/components/schemas/Names'
        ReferenceTime:
          $ref: '#/components/schemas/ReferenceTimeByCoordinates'
        RepresentativePoint:
          $ref: '#/components/schemas/RepresentativePoint'
        TimeTransitions:
          description: Time zone DST transitions from [transitionsFrom] until timestamp + 1 year.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/TimeTransition'
    RepresentativePoint:
      description: Representative point property
      type: object
      readOnly: true
      properties:
        Latitude:
          description: Latitude property
          type: number
          readOnly: true
        Longitude:
          description: Longitude property
          type: number
          readOnly: true
    TimezoneIanaVersionResult:
      description: This object is returned from a successful Timezone IANA Version call
      type: object
      properties:
        version:
          description: Version property
          type: string
          readOnly: true
    TimezoneWindowToIanaResult:
      description: This object is returned from a successful Timezone Windows To IANA call
      type: array
      items:
        $ref: '#/components/schemas/IanaId'
    IanaId:
      type: object
      properties:
        id:
          description: Id property
          type: string
          readOnly: true
        isAlias:
          description: IsAlias property
          type: boolean
          readOnly: true
        aliasOf:
          description: AliasOf property
          type: string
          readOnly: true
        hasZone1970Location:
          description: HasZone1970Location property
          type: boolean
          readOnly: true
    TimezoneById:
      type: object
      properties:
        Id:
          description: Id property
          type: string
          readOnly: true
        Aliases:
          description: 'An array of time zone ID aliases. Only returned when [options]=*zoneinfo* or *all*.


            Note: may be null.'
          type: array
          readOnly: true
          items:
            type: string
            readOnly: true
        Countries:
          description: An array of country/region records. Only returned when [options]=*zoneinfo* or *all*.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/Country'
        Names:
          $ref: '#/components/schemas/Names'
        ReferenceTime:
          $ref: '#/components/schemas/ReferenceTimeById'
        RepresentativePoint:
          $ref: '#/components/schemas/RepresentativePoint'
        TimeTransitions:
          description: Time zone DST transitions from [transitionsFrom] until timestamp + 1 year.
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/TimeTransition'
    TimeZonesByCoordinates:
      description: TimeZoneByCoordinates array
      type: array
      readOnly: true
      items:
        $ref: '#/components/schemas/TimeZoneByCoordinates'
    ODataError:
      type: object
      description: This object is returned when an error occurs in the Azure Maps API.
      properties:
        code:
          type: string
          readOnly: true
          description: The ODataError code.
        message:
          type: string
          readOnly: true
          description: If available, a human-readable description of the error.
        details:
          type: array
          items:
            $ref: '#/components/schemas/ODataError'
        target:
          type: string
          readOnly: true
          description: If available, the target causing the error.
    TimezoneEnumIanaResult:
      description: This object is returned from a successful Timezone Enum IANA call
      type: array
      items:
        $ref: '#/components/schemas/IanaId'
    TimezoneEnumWindow:
      type: object
      properties:
        WindowsId:
          description: Windows Id property
          type: string
          readOnly: true
        Territory:
          description: Territory property
          type: string
          readOnly: true
        IanaIds:
          description: IanaIds array
          type: array
          items:
            type: string
            readOnly: true
  parameters:
    TimezoneAcceptLanguage:
      name: Accept-Language
      in: header
      description: Specifies the language code in which the timezone names should be returned. If no language code is provided, the response will be in "EN". Please refer to [Supported Languages](https://docs.microsoft.com/en-us/azure/azure-maps/supported-languages) for details.
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
    TimezoneOptions:
      name: options
      in: query
      description: Alternatively, use alias "o". Options available for types of information returned in the result.
      required: false
      x-ms-enum:
        name: TimezoneOptions
        modelAsString: true
        values:
        - value: none
          description: Do not include zoneinfo or transitions in the result.
        - value: zoneInfo
          description: Include additional time zone info in the result.
        - value: transitions
          description: Include transition information in the result (The number of transitions is currently capped at 250).
        - value: all
          description: Include both zoneinfo and transitions in the result.
      x-ms-parameter-location: method
      schema:
        type: string
        enum:
        - none
        - zoneInfo
        - transitions
        - all
    TimezoneTransitionsYears:
      name: transitionsYears
      in: query
      description: Alternatively, use alias "ty". The number of years from "transitionsFrom" for which DST transitions are requested, only applies when "options" = all or "options" = transitions.
      required: false
      x-ms-parameter-location: method
      schema:
        type: integer
    TimezoneTransitionsFrom:
      name: transitionsFrom
      in: query
      description: Alternatively, use alias "tf". The start date from which daylight savings time (DST) transitions are requested, only applies when "options" = all or "options" = transitions.
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
        format: date-time
    SubscriptionKey:
      name: subscription-key
      description: One of the Azure Maps keys provided from an Azure Map Account. Please refer to this [article](https://docs.microsoft.com/azure/azure-maps/how-to-manage-authentication) for details on how to manage authentication.
      in: query
      required: false
      x-ms-parameter-location: client
      schema:
        type: string
    JsonFormat:
      name: format
      description: Desired format of the response. Only `json` format is supported.
      in: path
      required: true
      x-ms-enum:
        name: JsonFormat
        modelAsString: true
        values:
        - value: json
          description: '[The JavaScript Object Notation Data Interchange Format](https://tools.ietf.org/html/rfc8259)'
      x-ms-parameter-location: method
      schema:
        type: string
        enum:
        - json
    ClientId:
      name: x-ms-client-id
      description: Specifies which account is intended for usage in conjunction with the Microsoft Entra ID security model.  It represents a unique ID for the Azure Maps account and can be retrieved from the Azure Maps management  plane Account API. To use Microsoft Entra ID security in Azure Maps see the following [articles](https://aka.ms/amauthdetails) for guidance.
      in: header
      required: false
      x-ms-parameter-location: client
      schema:
        type: string
    ApiVersion:
      name: api-version
      description: Version number of Azure Maps API. Current version is 1.0
      in: query
      required: true
      x-ms-parameter-location: client
      schema:
        type: string
        default: '1.0'
    TimezoneTimeStamp:
      name: timeStamp
      in: query
      description: Alternatively, use alias "stamp", or "s". Reference time, if omitted, the API will use the machine time serving the request.
      required: false
      x-ms-parameter-location: method
      schema:
        type: string
        format: date-time
  responses:
    '404':
      description: 'Not Found: the requested resource could not be found, but it may be available again in the future.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
    '400':
      description: 'Bad request: one or more parameters were incorrectly specified or are mutually exclusive.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
    '403':
      description: Permission, capacity, or authentication issues.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
    '401':
      description: Access denied due to invalid subscription key or invalid Microsoft Entra ID bearer token.  Make sure to provide a valid key for an active Azure subscription and Maps resource.  Otherwise, verify the [WWW-Authenticate](https://tools.ietf.org/html/rfc6750#section-3.1) header for error code and description of the provided Microsoft Entra ID bearer token.
      headers:
        WWW-Authenticate:
          description: Bearer realm="https://atlas.microsoft.com/", error="invalid_token", error_description="The access token expired"
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
    '500':
      description: An error occurred while processing the request. Please try again later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ODataErrorResponse'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'