openapi: 3.2.0
info:
  title: Nokia Network As Code Location Retrieval v0.2.0 API
  version: 1.0.0
  termsOfService: https://developer.networkascode.nokia.io/legal/terms-of-service
  x-refined-note:
  - x-badges differs across the merged source definitions and was not carried
  - x-camara-commonalities differs across the merged source definitions and was not carried
  - x-category differs across the merged source definitions and was not carried
  - x-collections differs across the merged source definitions and was not carried
  - x-long-description differs across the merged source definitions and was not carried
  - x-public differs across the merged source definitions and was not carried
  - x-thumbnail differs across the merged source definitions and was not carried
  - x-version-lifecycle differs across the merged source definitions and was not carried
  - x-website differs across the merged source definitions and was not carried
  description: 'Operations tagged Location Retrieval v0.2.0 across 2 of this provider''s published API definitions: nokia-network-as-code-camara-openapi.yml, nokia-network-as-code-platform-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: '{apiRoot}/geofencing-subscriptions/v0.3'
  variables:
    apiRoot:
      default: http://localhost:9091
      description: API root
- url: '{apiRoot}/geofencing-subscriptions/v0.4'
  variables:
    apiRoot:
      default: http://localhost:9091
      description: API root
- url: https://network-as-code.p-eu.rapidapi.com
tags:
- name: Location Retrieval v0.2.0
paths:
  /location-retrieval/v0/retrieve:
    post:
      tags:
      - Location Retrieval v0.2.0
      summary: Execute location retrieval for a user equipment
      description: Retrieve the area where a certain user device is localized.
      operationId: retrieveLocation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrievalLocationRequest-LocR-V0'
            examples:
              LOCATION_RETRIEVAL_PHONE_NUMBER:
                value:
                  device:
                    phoneNumber: '+99999991000'
                  maxAge: 60
        required: true
      responses:
        '200':
          description: Location retrieval result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Location-LocR-V0'
              examples:
                LOCATION_CIRCLE:
                  $ref: '#/components/examples/RETRIEVAL_CIRCLE-LocR-V0'
                LOCATION_POLYGON:
                  $ref: '#/components/examples/RETRIEVAL_POLYGON-LocR-V0'
        '400':
          $ref: '#/components/responses/RetrieveLocationBadRequest400-LocR-V0'
        '401':
          $ref: '#/components/responses/Generic401-LocR-V0'
        '403':
          $ref: '#/components/responses/Generic403-LocR-V0'
        '404':
          $ref: '#/components/responses/Generic404-LocR-V0'
        '500':
          $ref: '#/components/responses/Generic500-LocR-V0'
        '503':
          $ref: '#/components/responses/Generic503-LocR-V0'
      security:
      - openId:
        - location-retrieval:read
    servers:
    - url: '{apiRoot}/geofencing-subscriptions/v0.3'
      variables:
        apiRoot:
          default: http://localhost:9091
          description: API root
    - url: '{apiRoot}/geofencing-subscriptions/v0.4'
      variables:
        apiRoot:
          default: http://localhost:9091
          description: API root
components:
  schemas:
    ErrorInfo-LocR-V0:
      type: object
      required:
      - status
      - code
      - message
      properties:
        status:
          type: integer
          description: HTTP status code returned along with this error response
        code:
          type: string
          description: Code given to this error
        message:
          type: string
          description: Detailed error description
    Location-LocR-V0:
      type: object
      description: Device location
      required:
      - lastLocationTime
      - area
      properties:
        lastLocationTime:
          description: Last date and time when the device was localized. It must follow RFC 3339 and must have time zone. Recommended format is yyyy-MM-dd'T'HH:mm:ss.SSSZ (i.e. which allows 2023-07-03T14:27:08.312+02:00 or 2023-07-03T12:27:08.312Z)
          type: string
          format: date-time
        area:
          $ref: '#/components/schemas/Area-LocR-V0'
    DeviceIpv4Addr-LocR-V0:
      type: object
      description: 'The device should be identified by either the public (observed) IP address and port as seen by the application server, or the private (local) and any public (observed) IP addresses in use by the device (this information can be obtained by various means, for example from some DNS servers).


        If the allocated and observed IP addresses are the same (i.e. NAT is not in use) then  the same address should be specified for both publicAddress and privateAddress.


        If NAT64 is in use, the device should be identified by its publicAddress and publicPort, or separately by its allocated IPv6 address (field ipv6Address of the Device object)


        In all cases, publicAddress must be specified, along with at least one of either privateAddress or publicPort, dependent upon which is known. In general, mobile devices cannot be identified by their public IPv4 address alone.

        '
      properties:
        publicAddress:
          $ref: '#/components/schemas/SingleIpv4Addr-LocR-V0'
        privateAddress:
          $ref: '#/components/schemas/SingleIpv4Addr-LocR-V0'
        publicPort:
          $ref: '#/components/schemas/Port-LocR-V0'
      anyOf:
      - required:
        - publicAddress
        - privateAddress
      - required:
        - publicAddress
        - publicPort
      example:
        publicAddress: 84.125.93.10
        publicPort: 59765
    DeviceIpv6Address-LocR-V0:
      description: 'The device should be identified by the observed IPv6 address, or by any single IPv6 address from within the subnet allocated to the device (e.g. adding ::0 to the /64 prefix).

        '
      type: string
      format: ipv6
      example: 2001:db8:85a3:8d3:1319:8a2e:370:7344
    Device-LocR-V0:
      description: 'End-user equipment able to connect to a mobile network. Examples of devices include smartphones or IoT sensors/actuators.


        The developer can choose to provide the below specified device identifiers:


        * `ipv4Address`

        * `ipv6Address`

        * `phoneNumber`

        * `networkAccessIdentifier`


        NOTE: the MNO might support only a subset of these options. The API invoker can provide multiple identifiers to be compatible across different MNOs. In this case the identifiers MUST belong to the same device.

        '
      type: object
      properties:
        phoneNumber:
          $ref: '#/components/schemas/PhoneNumber-LocR-V0'
        networkAccessIdentifier:
          $ref: '#/components/schemas/NetworkAccessIdentifier-LocR-V0'
        ipv4Address:
          $ref: '#/components/schemas/DeviceIpv4Addr-LocR-V0'
        ipv6Address:
          $ref: '#/components/schemas/DeviceIpv6Address-LocR-V0'
      minProperties: 1
    Area-LocR-V0:
      type: object
      properties:
        areaType:
          $ref: '#/components/schemas/AreaType-LocR-V0'
      required:
      - areaType
      discriminator:
        propertyName: areaType
        mapping:
          CIRCLE: '#/components/schemas/Circle'
          POLYGON: '#/components/schemas/Polygon'
    NetworkAccessIdentifier-LocR-V0:
      description: A public identifier addressing a subscription in a mobile network. In 3GPP terminology, it corresponds to the GPSI formatted with the External Identifier ({Local Identifier}@{Domain Identifier}). Unlike the telephone number, the network access identifier is not subjected to portability ruling in force, and is individually managed by each operator.
      type: string
      example: 123456789@domain.com
    AreaType-LocR-V0:
      type: string
      description: 'Type of this area.

        CIRCLE - The area is defined as a circle.

        POLYGON - The area is defined as a polygon.

        '
      enum:
      - CIRCLE
      - POLYGON
    RetrievalLocationRequest-LocR-V0:
      type: object
      properties:
        device:
          $ref: '#/components/schemas/Device-LocR-V0'
        maxAge:
          type: integer
          description: Maximum age of the location information which is accepted for the location retrieval (in seconds)
          minimum: 60
      required:
      - device
    Port-LocR-V0:
      description: TCP or UDP port number
      type: integer
      minimum: 0
      maximum: 65535
    PhoneNumber-LocR-V0:
      description: A public identifier addressing a telephone subscription. In mobile networks it corresponds to the MSISDN (Mobile Station International Subscriber Directory Number). In order to be globally unique it has to be formatted in international format, according to E.164 standard, optionally prefixed with '+'.
      type: string
      pattern: ^\+?[0-9]{5,15}$
      example: '123456789'
    SingleIpv4Addr-LocR-V0:
      description: A single IPv4 address with no subnet mask
      type: string
      format: ipv4
      example: 84.125.93.10
  examples:
    RETRIEVAL_POLYGON-LocR-V0:
      value:
        lastLocationTime: '2023-10-17T13:18:23.682Z'
        area:
          areaType: POLYGON
          boundary:
          - latitude: 45.754114
            longitude: 4.860374
          - latitude: 45.753845
            longitude: 4.863185
          - latitude: 45.75249
            longitude: 4.861876
          - latitude: 45.751224
            longitude: 4.861125
          - latitude: 45.751442
            longitude: 4.859827
    RETRIEVAL_CIRCLE-LocR-V0:
      value:
        lastLocationTime: '2023-10-17T13:18:23.682Z'
        area:
          areaType: CIRCLE
          center:
            latitude: 45.754114
            longitude: 4.860374
          radius: 800
  responses:
    Generic401-LocR-V0:
      description: Unauthenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo-LocR-V0'
          example:
            status: 401
            code: UNAUTHENTICATED
            message: 'Authorization failed: ...'
    Generic503-LocR-V0:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo-LocR-V0'
          example:
            status: 503
            code: UNAVAILABLE
            message: Service unavailable
    RetrieveLocationBadRequest400-LocR-V0:
      description: "Problem with the client request. In addition to regular scenario of `INVALID_ARGUMENT`, another scenarios may exist:\n\n\n\n\n  - maxAge threshold cannot be satisfied"
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo-LocR-V0'
          examples:
            InvalidArgument:
              value:
                status: 400
                code: INVALID_ARGUMENT
                message: Invalid argument
            MaxAgeIssue:
              value:
                status: 400
                code: LOCATION_RETRIEVAL.MAXAGE_INVALID_ARGUMENT
                message: maxAge threshold cannot be satisfied
    Generic403-LocR-V0:
      description: Permission denied
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo-LocR-V0'
          example:
            status: 403
            code: PERMISSION_DENIED
            message: 'Operation not allowed: ...'
    Generic404-LocR-V0:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo-LocR-V0'
          example:
            status: 404
            code: NOT_FOUND
            message: The specified resource is not found
    Generic500-LocR-V0:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorInfo-LocR-V0'
          example:
            status: 500
            code: INTERNAL
            message: Internal server error
  parameters:
    x-rapidapi-host:
      name: x-rapidapi-host
      in: header
      required: true
      description: The API's Host value as defined in the RapidAPI Hub.
      schema:
        type: string
        example: network-as-code.p-eu.rapidapi.com
  securitySchemes:
    openId:
      description: OpenID Connect authentication
      type: openIdConnect
      openIdConnectUrl: https://example.com/.well-known/openid-configuration
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-rapidapi-key
      description: Your RapidAPI key
externalDocs:
  description: Project documentation at Camara
  url: https://github.com/camaraproject/DeviceLocation
x-refined-from:
- nokia-network-as-code-camara-openapi.yml
- nokia-network-as-code-platform-openapi.json