swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Device Location API
schemes:
- https
tags:
- name: Device Location
paths:
  /device-location/location:verify:
    post:
      operationId: microsoftAzureDevicelocationVerify
      description: Verifies whether a device is within a specified location area, defined as an accuracy (radius) around a point, specified by longitude and latitude.
      parameters:
      - $ref: '#/parameters/Azure.Core.Foundations.ApiVersionParameter'
      - $ref: '#/parameters/Azure.Core.ClientRequestIdHeader'
      - $ref: '#/parameters/ApcGatewayIdHeader'
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/DeviceLocationVerificationContent'
      responses:
        '200':
          description: The request has succeeded.
          schema:
            $ref: '#/definitions/DeviceLocationVerificationResult'
          headers:
            x-ms-client-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, client-generated string identifier for the request.
            x-ms-request-id:
              type: string
              format: uuid
              description: An opaque, globally-unique, server-generated string identifier for the request.
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/Azure.Core.Foundations.ErrorResponse'
          headers:
            x-ms-error-code:
              type: string
              description: String error code indicating what went wrong.
      x-ms-examples:
        DeviceLocation_Verify:
          $ref: ./examples/DeviceLocation_Verify_MaximumSet_Gen.json
      summary: Microsoft Azure Post Device Location Location:verify
      tags:
      - Device Location
definitions:
  Azure.Core.Foundations.ErrorResponse:
    type: object
    description: A response containing error details.
    properties:
      error:
        $ref: '#/definitions/Azure.Core.Foundations.Error'
        description: The error object.
    required:
    - error
  DeviceLocationVerificationContent:
    type: object
    description: Request to verify Location
    properties:
      networkIdentifier:
        $ref: '#/definitions/NetworkIdentifier'
        description: Network to query for this device, or device information to enable network routing.
      latitude:
        type: number
        format: double
        description: Latitude of location to be verified
        minimum: -90
        maximum: 90
      longitude:
        type: number
        format: double
        description: Longitude of location to be verified
        minimum: -180
        maximum: 180
      accuracy:
        type: integer
        format: int32
        description: Accuracy expected for location verification in kilometers
        minimum: 2
        maximum: 100
      device:
        $ref: '#/definitions/LocationDevice'
        description: The device to find the location for. Exactly one of Network Access Code, Phone Number, IPv4 address, or IPv6 address
    required:
    - networkIdentifier
    - latitude
    - longitude
    - accuracy
    - device
  LocationDevice:
    type: object
    description: Device information needed by operator to provide location information. Include exactly one of these properties to identify your device.
    properties:
      networkAccessIdentifier:
        type: string
        description: External identifier or network access identifier of the device
      phoneNumber:
        type: string
        description: Phone number in E.164 format (starting with country code), and optionally prefixed with '+'
        pattern: ^\+?[0-9]{5,15}$
      ipv4Address:
        $ref: '#/definitions/Ipv4Address'
        description: The Ipv4 address
      ipv6Address:
        $ref: '#/definitions/Ipv6Address'
        description: The Ipv6 address
  Azure.Core.Foundations.InnerError:
    type: object
    description: An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: Inner error.
  DeviceLocationVerificationResult:
    type: object
    description: Response verifying location
    properties:
      verificationResult:
        type: boolean
        description: True if the location is in the specified area, False otherwise
    required:
    - verificationResult
  Ipv6Address:
    type: object
    description: IPv6 device indicator
    properties:
      ipv6:
        type: string
        description: An IPv6 address. This may be specified as an exact address, or as a subnet in CIDR notation.
      port:
        type: integer
        format: int32
        description: User equipment port.
    required:
    - ipv6
    - port
  NetworkIdentifier:
    type: object
    description: Identifier for the network to be queried
    properties:
      identifierType:
        type: string
        description: 'The type of identifier for the network. one of: ''IPv4'', ''IPv6'', ''NetworkCode'''
      identifier:
        type: string
        description: 'The network identifier, based on the identifierType: an IPv4 address, and IPv6 address, or a Network Code.

          A Network Code may be obtained from APC documentation or from the APC /Network:retrieve endpoint.'
    required:
    - identifierType
    - identifier
  Ipv4Address:
    type: object
    description: IPv4 device indicator
    properties:
      ipv4:
        type: string
        description: An IPv4 address. This may be specified as an exact address, or as a subnet in CIDR notation.
      port:
        type: integer
        format: int32
        description: User equipment port.
    required:
    - ipv4
    - port
  Azure.Core.Foundations.Error:
    type: object
    description: The error object.
    properties:
      code:
        type: string
        description: One of a server-defined set of error codes.
      message:
        type: string
        description: A human-readable representation of the error.
      target:
        type: string
        description: The target of the error.
      details:
        type: array
        description: An array of details about specific errors that led to this reported error.
        items:
          $ref: '#/definitions/Azure.Core.Foundations.Error'
        x-ms-identifiers: []
      innererror:
        $ref: '#/definitions/Azure.Core.Foundations.InnerError'
        description: An object containing more specific information than the current object about the error.
    required:
    - code
    - message
parameters:
  Azure.Core.ClientRequestIdHeader:
    name: x-ms-client-request-id
    in: header
    description: An opaque, globally-unique, client-generated string identifier for the request.
    required: false
    type: string
    format: uuid
    x-ms-parameter-location: method
    x-ms-client-name: clientRequestId
  ApcGatewayIdHeader:
    name: apc-gateway-id
    in: header
    description: The identifier of the APC Gateway resource which should handle this request.
    required: true
    type: string
    x-ms-parameter-location: method
    x-ms-client-name: apcGatewayId
  Azure.Core.Foundations.ApiVersionParameter:
    name: api-version
    in: query
    description: The API version to use for this operation.
    required: true
    type: string
    minLength: 1
    x-ms-parameter-location: method
    x-ms-client-name: apiVersion
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'