API docs by Redocly

Namf_Location (1.3.1)

Download OpenAPI specification:

AMF Location Service.
© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.518 V18.9.0; 5G System; Access and Mobility Management Services

Individual UE context (Document)

Namf_Location ProvidePositioningInfo service Operation

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-...

UE Context Identifier

Request Body schema: application/json
required
required
string or string (ExternalClientType)

Indicates types of External Clients.

required
string or string (LocationType)

Type of location measurement requested

supi
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
gpsi
string (Gpsi) ^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$

String identifying a Gpsi shall contain either an External Id or an MSISDN. It shall be formatted as follows -External Identifier= "extid-'extid', where 'extid' shall be formatted according to clause 19.7.2 of 3GPP TS 23.003 that describes an External Identifier.

Array of strings or strings (RangingSlResult) non-empty
Array of objects (RelatedUe) non-empty
lmfId
string (LMFIdentification)

LMF identification.

string or string (LcsPriority)

Indicates priority of the LCS client.

object (LocationQoS)

QoS of Location request.

string or string (VelocityRequested)

Indicates velocity requirement.

string or string (SupportedGADShapes)

Indicates supported GAD shapes.

Array of strings or strings (SupportedGADShapes) non-empty
locationNotificationUri
string (Uri)

String providing an URI formatted according to RFC 3986.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

object (Guami)

Globally Unique AMF Identifier constructed out of PLMN, Network and AMF identity.

pei
string (Pei) ^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a...

String representing a Permanent Equipment Identifier that may contain - an IMEI or IMEISV, as specified in clause 6.2 of 3GPP TS 23.003; a MAC address for a 5G-RG or FN-RG via wireline access, with an indication that this address cannot be trusted for regulatory purpose if this address cannot be used as an Equipment Identifier of the FN-RG, as specified in clause 4.7.7 of 3GPP TS23.316. Examples are imei-012345678901234 or imeisv-0123456789012345.

lcsServiceType
integer (LcsServiceType) [ 0 .. 127 ]

LCS service type.

string or string (LdrType)

Indicates LDR types.

hgmlcCallBackURI
string (Uri)

String providing an URI formatted according to RFC 3986.

lirGmlcCallBackUri
string (Uri)

String providing an URI formatted according to RFC 3986.

ldrReference
string (LdrReference) [ 2 .. 510 ] characters

LDR Reference.

lirReference
string (LirReference) [ 2 .. 510 ] characters

LIR Reference.

object (PeriodicEventInfo)

Indicates the information of periodic event reporting.

object (AreaEventInfo)

Indicates the information of area based event reporting.

object (MotionEventInfo)

Indicates the information of motion based event reporting.

externalClientIdentification
string (ExternalClientIdentification)

Contains the external client identification

afID
string <uuid> (NfInstanceId)

String uniquely identifying a NF instance. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122.

codeWord
string (CodeWord)

Contains the codeword

object (UePrivacyRequirements)

UE privacy requirements from (H)GMLC to the serving AMF or VGMLC(in the roaming case) for the target UE

scheduledLocTime
string <date-time> (DateTime)

string with format 'date-time' as defined in OpenAPI.

reliableLocReq
boolean
Default: false
intermediateLocationInd
boolean
Default: false
maxRespTime
integer (DurationSec)

indicating a time in seconds.

ueUnawareInd
boolean
Value: true
string or string (LpHapType)

Type of Low Power and/or High Accuracy Positioning

Array of objects (ReportingArea) [ 1 .. 250 ] items
string or string
Default: "INSIDE_REPORTING"

Indicates whether the UE is allowed to generate and send the event report inside or outside the event report allowed(expected) area

object (IntegrityRequirements)

integrity requirements.

object (UpLocRepInfoAf)

Information for the location reporting over user plane

object (MappedLocationQoSEps)

Mapped Location QoS for EPS.

coordinateID
integer

Responses

Callbacks

Request samples

Content type
application/json
{
  • "lcsClientType": "EMERGENCY_SERVICES",
  • "lcsLocation": "CURRENT_LOCATION",
  • "supi": "string",
  • "gpsi": "string",
  • "requestedRangingSlResult": [
    ],
  • "relatedUes": [
    ],
  • "lmfId": "string",
  • "priority": "HIGHEST_PRIORITY",
  • "lcsQoS": {
    },
  • "velocityRequested": "VELOCITY_IS_NOT_REQUESTED",
  • "lcsSupportedGADShapes": "POINT",
  • "additionalLcsSuppGADShapes": [
    ],
  • "locationNotificationUri": "string",
  • "supportedFeatures": "string",
  • "oldGuami": {
    },
  • "pei": "string",
  • "lcsServiceType": 127,
  • "ldrType": "UE_AVAILABLE",
  • "hgmlcCallBackURI": "string",
  • "lirGmlcCallBackUri": "string",
  • "ldrReference": "string",
  • "lirReference": "string",
  • "periodicEventInfo": {
    },
  • "areaEventInfo": {
    },
  • "motionEventInfo": {
    },
  • "externalClientIdentification": "string",
  • "afID": "4e48e86c-8eb6-4017-bf4f-96fda159d2c6",
  • "codeWord": "string",
  • "uePrivacyRequirements": {
    },
  • "scheduledLocTime": "2019-08-24T14:15:22Z",
  • "reliableLocReq": false,
  • "intermediateLocationInd": false,
  • "maxRespTime": 0,
  • "ueUnawareInd": true,
  • "lpHapType": "LOW_POW_HIGH_ACCU_POS",
  • "evtRptAllowedAreas": [
    ],
  • "reportingInd": "INSIDE_REPORTING",
  • "integrityRequirements": {
    },
  • "upLocRepInfoAf": {
    },
  • "mappedQoSEps": {
    },
  • "coordinateID": 0
}

Response samples

Content type
application/json
{
  • "locationEstimate": {
    },
  • "localLocationEstimate": {
    },
  • "accuracyFulfilmentIndicator": "REQUESTED_ACCURACY_FULFILLED",
  • "ageOfLocationEstimate": 32767,
  • "timestampOfLocationEstimate": "2019-08-24T14:15:22Z",
  • "velocityEstimate": {
    },
  • "positioningDataList": [
    ],
  • "gnssPositioningDataList": [
    ],
  • "ecgi": {
    },
  • "ncgi": {
    },
  • "remoteUeInd": true,
  • "targetServingNode": "9db5d2ce-8862-4777-8cd5-c5bddb43d04b",
  • "targetMmeName": "string",
  • "targetMmeRealm": "string",
  • "utranSrvccInd": true,
  • "civicAddress": {
    },
  • "barometricPressure": 30000,
  • "altitude": -32767,
  • "supportedFeatures": "string",
  • "servingLMFIdentification": "string",
  • "locationPrivacyVerResult": "LOCATION_ALLOWED",
  • "achievedQos": {
    },
  • "directReportInd": false,
  • "acceptedPeriodicEventInfo": {
    },
  • "haGnssMetrics": {
    },
  • "indoorOutdoorInd": "INDOOR",
  • "losNlosMeasureInd": "LOS",
  • "relatedApplicationlayerId": "string",
  • "distanceDirection": {
    },
  • "2dRelativeLocation": {
    },
  • "3dRelativeLocation": {
    },
  • "relativeVelocity": {
    },
  • "integrityResult": {
    },
  • "addProvidePosInfos": [
    ]
}

Callback payload samples

Callback
POST: {$request.body#/locationNotificationUri}
Content type
application/json
{
  • "locationEvent": "EMERGENCY_CALL_ORIGINATION",
  • "supi": "string",
  • "gpsi": "string",
  • "pei": "string",
  • "locationEstimate": {
    },
  • "localLocationEstimate": {
    },
  • "ageOfLocationEstimate": 32767,
  • "timestampOfLocationEstimate": "2019-08-24T14:15:22Z",
  • "velocityEstimate": {
    },
  • "positioningDataList": [
    ],
  • "gnssPositioningDataList": [
    ],
  • "ecgi": {
    },
  • "ncgi": {
    },
  • "remoteUeInd": true,
  • "servingNode": "cc121660-fe3e-4178-9c61-8964bda538de",
  • "targetMmeName": "string",
  • "targetMmeRealm": "string",
  • "utranSrvccInd": true,
  • "civicAddress": {
    },
  • "barometricPressure": 30000,
  • "altitude": -32767,
  • "hgmlcCallBackURI": "string",
  • "ldrReference": "string",
  • "servingLMFIdentification": "string",
  • "terminationCause": "TERMINATION_BY_UE",
  • "achievedQos": {
    },
  • "mscServerId": "string",
  • "haGnssMetrics": {
    },
  • "indoorOutdoorInd": "INDOOR",
  • "losNlosMeasureInd": "LOS",
  • "relatedApplicationlayerId": "string",
  • "distanceDirection": {
    },
  • "2dRelativeLocation": {
    },
  • "3dRelativeLocation": {
    },
  • "relativeVelocity": {
    },
  • "integrityResult": {
    },
  • "addProvidePosInfos": [
    ]
}

Namf_Location ProvideLocationInfo service Operation

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-...

UE Context Identifier

Request Body schema: application/json
required
req5gsLoc
boolean
Default: false
reqCurrentLoc
boolean
Default: false
reqRatType
boolean
Default: false
reqTimeZone
boolean
Default: false
supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Responses

Request samples

Content type
application/json
{
  • "req5gsLoc": false,
  • "reqCurrentLoc": false,
  • "reqRatType": false,
  • "reqTimeZone": false,
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "currentLoc": true,
  • "location": {
    },
  • "additionalLocation": {
    },
  • "geoInfo": {
    },
  • "locationAge": 32767,
  • "ratType": "NR",
  • "timezone": "-08:00+1",
  • "supportedFeatures": "string",
  • "oldGuami": {
    }
}

Namf_Location CancelLocation service operation

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
ueContextId
required
string^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|imei-...

UE Context Identifier

Request Body schema: application/json
required
supi
required
string (Supi) ^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$

String identifying a Supi that shall contain either an IMSI, a network specific identifier, a Global Cable Identifier (GCI) or a Global Line Identifier (GLI) as specified in clause 2.2A of 3GPP TS 23.003. It shall be formatted as follows

  • for an IMSI "imsi-", where shall be formatted according to clause 2.2 of 3GPP TS 23.003 that describes an IMSI.
  • for a network specific identifier "nai-, where shall be formatted according to clause 28.7.2 of 3GPP TS 23.003 that describes an NAI.
  • for a GCI "gci-", where shall be formatted according to clause 28.15.2 of 3GPP TS 23.003.
  • for a GLI "gli-", where shall be formatted according to clause 28.16.2 of 3GPP TS 23.003.To enable that the value is used as part of an URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501.
hgmlcCallBackURI
required
string (Uri)

String providing an URI formatted according to RFC 3986.

ldrReference
required
string (LdrReference) [ 2 .. 510 ] characters

LDR Reference.

servingLMFIdentification
string (LMFIdentification)

LMF identification.

supportedFeatures
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Responses

Request samples

Content type
application/json
{
  • "supi": "string",
  • "hgmlcCallBackURI": "string",
  • "ldrReference": "string",
  • "servingLMFIdentification": "string",
  • "supportedFeatures": "string"
}

Response samples

Content type
application/json
{
  • "cause": "string",
  • "targetScp": "string",
  • "targetSepp": "string"
}