RingCentral Automatic Location Updates API

openapi: 3.0.3
info:
  title: RingCentral Adaptive Cards Automatic Location Updates API
  description: RingCentral API specification
  version: 1.0.58-20240529-47eda8bd
  contact:
    name: RingCentral Developers Support
    url: https://developers.ringcentral.com/support
  termsOfService: https://www.ringcentral.com/legal/apilitos.html
  license:
    name: RingCentral API License Agreement
    url: https://www.ringcentral.com/legal/apilitos.html
servers:
- url: https://platform.ringcentral.com
  description: Production API entry point
- url: https://media.ringcentral.com
  description: Production Media entry point
- url: https://platform.devtest.ringcentral.com
  description: Developer sandbox API entry point
- url: https://platform.devtest.ringcentral.com
  description: Developer sandbox Media entry point
security:
- OAuth2: []
tags:
- name: Automatic Location Updates
paths:
  /restapi/v1.0/account/{accountId}/emergency-locations:
    get:
      tags:
      - Automatic Location Updates
      summary: List Emergency Locations
      description: Returns emergency response locations for the current account.
      operationId: listEmergencyLocations
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/SiteIdQuery'
      - name: searchString
        in: query
        description: 'Filters entries containing the specified substring in ''address''

          and ''name'' fields. The character range is 0-64; not case-sensitive.

          If empty then the filter is ignored

          '
        schema:
          type: string
          maxLength: 64
      - name: addressStatus
        in: query
        schema:
          $ref: '#/components/schemas/EmergencyAddressStatus'
      - name: usageStatus
        in: query
        schema:
          $ref: '#/components/schemas/EmergencyLocationUsageStatus'
      - name: domesticCountryId
        in: query
        schema:
          type: string
      - name: orderBy
        in: query
        description: 'Comma-separated list of fields to order results, prefixed by

          plus sign ''+'' (ascending order) or minus sign ''-'' (descending order)

          '
        schema:
          type: string
          enum:
          - +name
          - +siteName
          - +address
          - +addressStatus
          - +usageStatus
          - -name
          - -siteName
          - -address
          - -addressStatus
          - -usageStatus
          default: +address
      - name: perPage
        in: query
        description: 'Indicates a page size (number of items). The values

          supported: `Max` or numeric value. If not specified,

          100 records are returned per one page

          '
        schema:
          type: integer
          format: int32
          default: 100
      - name: page
        in: query
        description: 'Indicates the page number to retrieve. Only positive number values

          are supported

          '
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: Emergency locations list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmergencyLocationsResource'
      x-feature: ReadCompanyInfo
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
      x-user-permission: ConfigureEmergencyMaps
    post:
      tags:
      - Automatic Location Updates
      summary: Add Emergency Location
      operationId: createEmergencyLocation
      description: Creates a new emergency response location for a company.
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        description: JSON body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmergencyLocationRequestResource'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmergencyLocationResponseResource'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: Limited
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-locations/{locationId}:
    get:
      tags:
      - Automatic Location Updates
      summary: Get Emergency Location
      description: Returns emergency response location by ID. Available for Admin users only.
      operationId: readEmergencyLocation
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/EmergencyLocationId'
      - name: syncEmergencyAddress
        in: query
        schema:
          type: boolean
      responses:
        '200':
          description: Emergency location information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonEmergencyLocationResource'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate OR ReadEmergencyLocations
      x-availability: Limited
      x-throttling-group: Light
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
    put:
      tags:
      - Automatic Location Updates
      summary: Update Emergency Location
      description: Updates the specified emergency response location.
      operationId: updateEmergencyLocation
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/EmergencyLocationId'
      requestBody:
        description: JSON body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmergencyLocationRequestResource'
        required: true
      responses:
        '200':
          description: Updated emergency location information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmergencyLocationResponseResource'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate OR EditEmergencyLocations
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
    delete:
      tags:
      - Automatic Location Updates
      operationId: deleteEmergencyLocation
      summary: Delete Emergency Location
      description: Deletes the specified emergency response location.
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/EmergencyLocationId'
      - name: validateOnly
        in: query
        description: 'Flag indicating that validation of emergency location(s) is required

          before deletion

          '
        required: false
        schema:
          type: boolean
      - name: newLocationId
        in: query
        description: 'Internal identifier of an emergency response location

          that should be used instead of a deleted one.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Successful validation
        '204':
          description: No content
        '207':
          description: Multi-status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLocationDeletionMultiResponse'
      x-feature: EditEmergencyLocations
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/emergency-locations:
    get:
      tags:
      - Automatic Location Updates
      summary: List User Emergency Locations
      description: Returns a list of emergency response locations available for the particular extension.
      operationId: getExtensionEmergencyLocations
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      - $ref: '#/components/parameters/SiteIdQuery'
      - name: searchString
        in: query
        description: 'Filters entries by the specified substring (search by chassis

          ID, switch name or address) The characters range is 0-64 (if

          empty the filter is ignored)

          '
        schema:
          type: string
      - name: domesticCountryId
        in: query
        schema:
          type: string
      - name: orderBy
        in: query
        description: 'Comma-separated list of fields to order results prefixed by ''+''

          sign (ascending order) or ''-'' sign (descending order). The default

          sorting is by `name`

          '
        schema:
          type: string
          default: +visibility
          enum:
          - +name
          - +siteName
          - +address
          - +addressStatus
          - +usageStatus
          - +visibility
          - -name
          - -siteName
          - -address
          - -addressStatus
          - -usageStatus
          - -visibility
      - name: perPage
        in: query
        description: 'Indicates a page size (number of items). The values supported:

          `Max` or numeric value. If not specified, 100 records are returned

          per one page

          '
        schema:
          format: int32
          type: integer
      - name: page
        in: query
        description: 'Indicates a page number to retrieve. Only positive

          number values are supported

          '
        schema:
          type: integer
          default: 1
          format: int32
      - name: visibility
        in: query
        schema:
          type: string
      responses:
        '200':
          description: User emergency location list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmergencyLocationsResource'
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
    post:
      tags:
      - Automatic Location Updates
      summary: Create User Emergency Location
      description: Creates a personal emergency response location for the current user.
      operationId: createExtensionEmergencyLocation
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserEmergencyLocationRequest'
        required: true
      responses:
        '200':
          description: Emergency location information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmergencyLocationResponseResource'
      x-feature: EmergencyFramework or NewEmergencyCallingFramework
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: EmergencyFramework
  /restapi/v1.0/account/{accountId}/extension/{extensionId}/emergency-locations/{locationId}:
    put:
      tags:
      - Automatic Location Updates
      summary: Update User Emergency Location
      description: 'Updates a personal emergency response location by the current user or admin.

        '
      operationId: updateExtensionEmergencyLocation
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      - $ref: '#/components/parameters/EmergencyLocationId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmergencyLocationRequestResource'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmergencyLocationResponseResource'
      x-feature: EmergencyFramework or NewEmergencyCallingFramework
      x-availability: Limited
      x-throttling-group: Light
      x-app-permission: EditAccounts
      x-user-permission: EmergencyFramework
    delete:
      tags:
      - Automatic Location Updates
      summary: Delete User Emergency Location
      description: 'Deletes a personal emergency response location by ID by

        the current user or admin. Multiple personal emergency response

        locations can be deleted by single API call.

        '
      operationId: deleteExtensionEmergencyLocation
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      - $ref: '#/components/parameters/EmergencyLocationId'
      - name: validateOnly
        in: query
        description: 'Flag indicating that only validation of Emergency Response Locations

          to be deleted is required

          '
        required: false
        schema:
          type: boolean
      responses:
        '204':
          description: No content
      x-feature: EmergencyFramework or NewEmergencyCallingFramework
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: EmergencyFramework
    get:
      tags:
      - Automatic Location Updates
      summary: Get User Emergency Location
      description: Returns a personal emergency response location for the current user.
      operationId: getExtensionEmergencyLocation
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ExtensionId'
      - $ref: '#/components/parameters/EmergencyLocationId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonEmergencyLocationResource'
      x-availability: High
      x-throttling-group: Light
      x-app-permission: ReadAccounts
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/tasks/{taskId}:
    get:
      tags:
      - Automatic Location Updates
      summary: Get Emergency Map Configuration Task
      description: 'Returns results of the task created within the frame of Automatic

        Location Updates feature. Currently four task types are supported: ''Wireless

        Points Bulk Create'', ''Wireless Points Bulk Update'', ''Switches Bulk Create'',

        ''Switches Bulk Update''.

        '
      operationId: readAutomaticLocationUpdatesTask
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: taskId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Task information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomaticLocationUpdatesTaskInfo'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: High
      x-throttling-group: Light
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/users:
    get:
      tags:
      - Automatic Location Updates
      summary: List Users
      description: 'Returns a list of users with their status of Automatic Location

        Updates feature.

        '
      operationId: listAutomaticLocationUpdatesUsers
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: type
        in: query
        description: Extension type. Multiple values are supported
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - User
            - Limited
      - name: searchString
        in: query
        description: 'Filters entries containing the specified substring in user name,

          extension or department. The characters range is 0-64; not case-sensitive.

          If empty then the filter is ignored

          '
        schema:
          type: string
      - name: department
        in: query
        description: 'Department name to filter the users. The value range is 0-64;

          not case-sensitive. If not specified then the parameter is ignored. Multiple

          values are supported

          '
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - $ref: '#/components/parameters/SiteIdQuery'
      - name: featureEnabled
        in: query
        description: 'Filters entries by their status of Automatic Location Updates

          feature

          '
        schema:
          type: boolean
      - name: orderBy
        in: query
        description: 'Comma-separated list of fields to order results prefixed by

          plus sign ''+'' (ascending order) or minus sign ''-'' (descending order).

          Supported values: ''name'', ''modelName'', ''siteName'', ''featureEnabled''.

          The default sorting is by `name`

          '
        schema:
          type: string
      - name: perPage
        in: query
        description: 'Indicates a page size (number of items). The values supported:

          `Max` or numeric value. If not specified, 100 records are returned per one

          page

          '
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        description: 'Indicates a page number to retrieve. Only positive number values

          are supported

          '
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: User list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomaticLocationUpdatesUserList'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: High
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/users/bulk-assign:
    post:
      tags:
      - Automatic Location Updates
      summary: Enable Automatic Location Updates for Users
      description: 'Enables or disables Automatic Location Updates feature for multiple

        account users.

        '
      operationId: assignMultipleAutomaticLocationUpdatesUsers
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmergencyAddressAutoUpdateUsersBulkAssignResource'
        required: false
      responses:
        '204':
          description: No content
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create:
    post:
      tags:
      - Automatic Location Updates
      summary: Create Multiple Wireless Points
      description: 'Creates multiple wireless points in a corporate map. The maximum

        number of wireless points per request is 10 000; limitation for account is

        70 000.

        '
      operationId: createMultipleWirelessPoints
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMultipleWirelessPointsRequest'
        required: true
      responses:
        '202':
          description: Multiple Wireless Points Creation Task
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMultipleWirelessPointsResponse'
      x-feature: EditSoftPhoneAutoLocationUpdate
      x-request-max-body-size: 100m
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks:
    get:
      tags:
      - Automatic Location Updates
      summary: Get Network Map
      description: 'Returns a corporate network map with emergency addresses assigned

        to the current account.

        '
      operationId: listNetworks
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/SiteIdQuery'
      - name: searchString
        in: query
        description: 'Filters entries by the specified substring (search by chassis

          ID, switch name or address) The characters range is 0-64 (if empty the filter

          is ignored)

          '
        schema:
          type: string
      - name: orderBy
        in: query
        description: 'Comma-separated list of fields to order results prefixed by ''+''

          sign (ascending order) or ''-'' sign (descending order). The default

          sorting is by `name`

          '
        schema:
          type: string
      - name: perPage
        in: query
        description: 'Indicates a page size (number of items). The values supported:

          `Max` or numeric value. If not specified, 100 records are returned per one

          page''

          '
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        description: 'Indicates a page number to retrieve. Only positive number values

          are supported

          '
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: Network map
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworksList'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: High
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
    post:
      tags:
      - Automatic Location Updates
      summary: Create Network
      description: 'Creates a new network in a corporate ethernet map for assignment

        of emergency addresses to network access points.

        '
      operationId: createNetwork
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateNetworkRequest'
        required: true
      responses:
        '200':
          description: Created network
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInfo'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/networks/{networkId}:
    get:
      tags:
      - Automatic Location Updates
      summary: Get Network
      description: 'Returns the specified network with emergency addresses assigned

        to the current account.

        '
      operationId: readNetwork
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: networkId
        in: path
        required: true
        description: Internal identifier of a network
        schema:
          type: string
      responses:
        '200':
          description: Network information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInfo'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: High
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
    put:
      tags:
      - Automatic Location Updates
      summary: Update Network
      description: 'Updates a network in a corporate ethernet map for assignment of emergency

        addresses to network access points.

        '
      operationId: updateNetwork
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: networkId
        in: path
        required: true
        description: Internal identifier of a network
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNetworkRequest'
        required: true
      responses:
        '200':
          description: Updated network information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInfo'
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
    delete:
      tags:
      - Automatic Location Updates
      summary: Delete Network
      description: 'Deletes network(s) in a corporate ethernet map for Automatic Location

        Updates feature.

        '
      operationId: deleteNetwork
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: networkId
        in: path
        required: true
        description: Internal identifier of a network
        style: simple
        schema:
          type: array
          items:
            type: string
      responses:
        '204':
          description: No content
      x-feature: EditSoftPhoneAutoLocationUpdate OR EditHardPhoneAutoLocationUpdate
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches-bulk-validate:
    post:
      tags:
      - Automatic Location Updates
      summary: Validate Multiple Switches
      description: 'Validates switches before creation or update. The maximum number

        of switches per request is 10 000.

        '
      operationId: validateMultipleSwitches
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateMultipleSwitchesRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateMultipleSwitchesResponse'
      x-feature: EditHardPhoneAutoLocationUpdate
      x-request-max-body-size: 100m
      x-availability: High
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches:
    get:
      tags:
      - Automatic Location Updates
      summary: List Account Switches
      description: 'Returns a corporate map of configured network switches with the assigned

        emergency addresses for the logged-in account.

        '
      operationId: listAccountSwitches
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/SiteIdQuery'
      - name: searchString
        in: query
        description: 'Filters entries by the specified substring (search by chassis

          ID, switch name or address) The characters range is 0-64 (if empty the filter

          is ignored)

          '
        schema:
          type: string
      - name: orderBy
        in: query
        description: 'Comma-separated list of fields to order results prefixed by ''+''

          sign (ascending order) or ''-'' sign (descending order). The default

          sorting is by `name`

          '
        schema:
          type: string
      - name: perPage
        in: query
        description: 'Indicates a page size (number of items). The values supported:

          `Max` or numeric value. If not specified, 100 records are returned per one

          page''

          '
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        description: 'Indicates a page number to retrieve. Only positive number values

          are supported

          '
        schema:
          type: integer
          format: int32
          default: 1
      responses:
        '200':
          description: Switches Map
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwitchesList'
      x-feature: EditHardPhoneAutoLocationUpdate
      x-availability: High
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
    post:
      tags:
      - Automatic Location Updates
      summary: Create Switch
      description: 'Creates a new switch in corporate map based on chassis ID and used

        for Automatic Locations Update feature.

        '
      operationId: createSwitch
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSwitchInfo'
        required: true
      responses:
        '200':
          description: Switch information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwitchInfo'
      x-feature: EditHardPhoneAutoLocationUpdate
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
  /restapi/v1.0/account/{accountId}/emergency-address-auto-update/switches/{switchId}:
    get:
      tags:
      - Automatic Location Updates
      summary: Get Switch
      description: Returns the specified switch with the assigned emergency address.
      operationId: readSwitch
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: switchId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Switch information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwitchInfo'
      x-feature: EditHardPhoneAutoLocationUpdate
      x-availability: High
      x-throttling-group: Medium
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
    put:
      tags:
      - Automatic Location Updates
      summary: Update Switch
      description: 'Updates switch. Partial update is not supported, all switch parameters

        should be specified. If null value is received or parameter is missing, its

        value is removed.

        '
      operationId: updateSwitch
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: switchId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSwitchInfo'
        required: true
      responses:
        '200':
          description: Updated switch information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SwitchInfo'
      x-feature: EditHardPhoneAutoLocationUpdate
      x-availability: Limited
      x-throttling-group: Heavy
      x-app-permission: EditAccounts
      x-user-permission: ConfigureEmergencyMaps
    delete:
      tags:
      - Automatic Location Updates
      summary: Delete Switch
      description: 'Deletes wireless switch(es) in a network configuration for Automatic

        Location Updates feature.

        '
      operationId: deleteSwitch
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: switchId
        in: path
        required: true
        style: simple
        schema:
          type: array
        

# --- truncated at 32 KB (90 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ringcentral/refs/heads/main/openapi/ringcentral-automatic-location-updates-api-openapi.yml