Namf_Location

The Namf_Location service enables NF service consumers to request the AMF for initiating positioning requests and providing location information. Additionally, it notifies location change events to the NF service consumers. The key functionalities of this NF service include:

  • Allow NFs to request the current geodetic and optionally local and/or civic location of a target UE.

  • Allow NFs to be notified of event information related to emergency sessions.

  • Allow NFs to request Network Provided Location Information (NPLI) and/or local time zone corresponding to the location of a target UE.

OpenAPI

OpenAPI Version: 3.0.0

Info


Version: 1.1.0
 
Title: Namf_Location
 
Description: |
 
  AMF Location Service
 
  © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
 
  All rights reserved.

Servers


  URL: '{apiRoot}/namf-loc/v1'
 
  Variables:
 
    API Root:
 
      Default: https://example.com
 
      Description: apiRoot as defined in clause clause 4.4 of 3GPP TS 29.501

Security


- {}
 
- oAuth2ClientCredentials:
 
    - namf-loc

Paths

/{ueContextId}/provide-pos-info: 


  Method: Post
 
    Summary: Namf_Location ProvidePositioningInfo service Operation
 
    Tags:
 
      - Individual UE context (Document)
 
    Operation ID: ProvidePositioningInfo
 
    Parameters:
 
      - Name: ueContextId
 
        In: path
 
        Description: UE Context Identifier
 
        Required/Optional: true
 
        Schema:
 
          Type: string
 
          pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-[0-9]{15}|imeisv-[0-9]{16}|.+)$'
 
    Request Body:
 
      Content:
 
        Application/JSON:
 
          Schema:
 
            Reference: '#/components/schemas/RequestPosInfo'
 
      Required/Optional: true
 
    Responses:
 
      '200':
 
        Description: Expected response to a valid request
 
        Content:
 
          Application/JSON:
 
            Schema:
 
              Reference: '#/components/schemas/ProvidePosInfo'
 
      '400':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/400'
 
      '403':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/403'
 
      '411':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/411'
 
      '413':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/413'
 
      '415':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/415'
 
      '429':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/429'
 
      '500':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/500'
 
      '503':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/503'
 
      '504':
 
        Reference: 'TS29571_CommonData.yaml#/components/responses/504'
 
      Default:
 
        Description: Unexpected error
 
    Callbacks:
 
      onUELocationNotification:
 
        '{$request.body#/locationNotificationUri}':
 
          Method: Post
 
            Request Body:
 
              Description: UE Location Event Notification
 
              Content:
 
                Application/JSON:
 
                  Schema:
 
                    Reference: '#/components/schemas/NotifiedPosInfo'
 
            Responses:
 
              '204':
 
                Description: Expected response to a successful callback processing
 
              '400':
 
                Reference: 'TS29571_CommonData.yaml#/components/responses/400'
 
              '403':
 
                Reference: 'TS29571_CommonData.yaml#/components/responses/403'
 
              '411':
 
                Reference: 'TS29571_CommonData.yaml#/components/responses/411'
 
              '413':
 
                Reference: 'TS29571_CommonData.yaml#/components/responses/413'
 
              '415':
 
                Reference: 'TS29571_CommonData.yaml#/components/responses/415'
 
              '429':
 
                Reference: 'TS29571_CommonData.yaml#/components/responses/429'
 
              '500':
 
                Reference: 'TS29571_CommonData.yaml#/components/responses/500'
 
              '503':
 
                Reference: 'TS29571_CommonData.yaml#/components/responses/503'

Components


securitySchemes:
 
  oAuth2ClientCredentials:
 
    Type: oauth2
 
    Flows:
 
      clientCredentials:
 
        tokenUrl: '{nrfApiRoot}/oauth2/token'
 
        scopes:
 
          namf-loc: Access to the Namf_Location API
 
schemas:
 
  RequestPosInfo:
 
    Type: object
 
    Properties:
 
      lcsClientType:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType'
 
      lcsLocation:
 
        Reference: '#/components/schemas/LocationType'
 
      supi:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Supi'
 
      gpsi:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Gpsi'
 
      priority:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsPriority'
 
      lcsQoS:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS'
 
      velocityRequested:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityRequested'
 
      lcsSupportedGADShapes:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes'
 
      additionalLcsSuppGADShapes:
 
        Type: array
 
        Items:
 
          Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes'
 
        minItems: 1
 
      locationNotificationUri:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
 
      supportedFeatures:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
 
      oldGuami:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Guami'
 
      pei:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Pei'
 
      lcsServiceType:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/LcsServiceType'
 
      ldrType:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrType'
 
      hgmlcCallBackURI:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Uri'
 
      ldrReference:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference'
 
      periodicEventInfo:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/PeriodicEventInfo'
 
      areaEventInfo:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/AreaEventInfo'
 
      motionEventInfo:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/MotionEventInfo'
 
      externalClientIdentification:
 
        Reference: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ExternalClientIdentification'
 
      afID:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
 
      codeWord:
 
        Reference: 'TS29515_Ngmlc_Location.yaml#/components/schemas/CodeWord'
 
      uePrivacyRequirements:
 
        Reference: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UePrivacyRequirements'
 
    Required:
 
      - lcsClientType
 
      - lcsLocation
 
  ProvidePosInfo:
 
    Type: object
 
    Properties:
 
      locationEstimate:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea'
 
      accuracyFulfilmentIndicator:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator'
 
      ageOfLocationEstimate:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate'
 
      velocityEstimate:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate'
 
      positioningDataList:
 
        Type: array
 
        Items:
 
          Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage'
 
        minItems: 0
 
        maxItems: 9
 
      gnssPositioningDataList:
 
        Type: array
 
        Items:
 
          Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/GnssPositioningMethodAndUsage'
 
        minItems: 0
 
        maxItems: 9
 
      ecgi:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
 
      ncgi:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
 
      targetServingNode:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId'
 
      civicAddress:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress'
 
      barometricPressure:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/BarometricPressure'
 
      altitude:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
 
      supportedFeatures:
 
        Reference: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
 
      servingLMFIdentification:
 
        Reference: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification'
 
      locationPrivacyVerResult:
 
        Reference: '#/components/schemas/LocationPrivacyVerResult'

External Docs


Description: 3GPP TS 29.518 V16.4.0; 5G System; Access and Mobility Management Services
 
URL: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.518/'