5.7 5GLANParameterProvision API

29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

5.7.1 Resources

5.7.1.1 Overview

All resource URIs of this API should have the following root:

{apiRoot}/3gpp-5glan-pp/v1

"apiRoot" is set as described in clause 5.2.4 in 3GPP TS 29.122 [4]. "apiName" shall be set to "3gpp-5glan-pp" and "apiVersion" shall be set to "v1" for the current version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI.

This clause describes the structure for the Resource URIs as shown in figure 5.7.1.1-1 and the resources and HTTP methods used for the 5GLANParameterProvision API.

Figure 5.7.1.1-1: Resource URI structure of the 5GLANParameterProvision API

Table 5.7.1.1-1 provides an overview of the resources and HTTP methods applicable for the 5GLANParameterProvision API.

Table 5.7.1.1-1: Resources and methods overview

Resource name	Resource URI	HTTP method	Description
5GLAN Parameters Provision Subscriptions	/{afId}/subscriptions	GET	Read all subscriptions for a given AF
5GLAN Parameters Provision Subscriptions	/{afId}/subscriptions	POST	Create a new subscription to provision parameters
Individual 5GLAN Parameters Provision Subscription	/{afId}/subscriptions/{subscriptionId}	GET	Read an existing subscription identified by {subscriptionId}
		PUT	Modify all of the properties of an existing subscription identified by {subscriptionId}
		PATCH	Modify some properties of an existing subscription identified by {subscriptionId}
		DELETE	Delete a subscription identified by {subscriptionId}

5.7.1.2 Resource: 5GLAN Parameters Provision Subscriptions

5.7.1.2.1 Introduction

This resource allows a AF to read all active 5GLAN parameters provision subscribtions for the given AF, or create an new individual 5GLAN parameters provision subscription to provision parameters to the NEF.

5.7.1.2.2 Resource Definition

Resource URI: {apiRoot}/3gpp-5glan-pp/v1/{afId}/subscriptions

This resource shall support the resource URI variables defined in table 5.7.1.2.2-1.

Table 5.7.1.2.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	Clause 5.2.4 of 3GPP TS 29.122 [4].
afId	string	Identifier of the AF.

5.7.1.2.3 Resource Methods

5.7.1.2.3.1 General

The following clauses specify the resource methods supported by the resource as described in clause 5.7.1.2.2.

5.7.1.2.3.2 GET

The GET method allows to read all active subscriptions for a given AF. The AF shall initiate the HTTP GET request message and the NEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.7.1.2.3.2-1.

Table 5.7.1.2.3.2-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
N/A

This method shall support the request data structures specified in table 5.7.1.2.3.2-2 and the response data structures and response codes specified in table 5.7.1.2.3.2-3.

Table 5.7.1.2.3.2-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
N/A

Table 5.7.1.2.3.2-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
array(5GLanParametersProvision)	M	0..N	200 OK	All the subscription information for the AF in the request URI are returned.
N/A			307 Temporary Redirect	Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
N/A			308 Permanent Redirect	Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.7.1.2.3.2-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.7.1.2.3.2-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.7.1.2.3.3 POST

The POST method creates a new resource to individual 5GLAN parameters provision subscription for a given AF. The AF shall initiate the HTTP POST request message and the NEF shall respond to the message. The NEF shall construct the URI of the created resource.

This method shall support the request data structures specified in table 5.7.1.2.3.3-1 and the response data structures and response codes specified in table 5.7.1.2.3.3-2.

Table 5.7.1.2.3.3-1: Data structures supported by the POST Request Body on this resource

Data type	P	Cardinality	Description
5GLanParametersProvision	M	1	Parameters to create a subscription to provision parameters.

Table 5.7.1.2.3.3-2: Data structures supported by the POST Response Body on this resource

Data type

Cardinality

Response codes

Description

5GLanParametersProvision

201 Created

The subscription was created successfully.

The URI of the created resource shall be returned in the "Location" HTTP header.

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.7.1.2.3.3-3: Headers supported by the 201 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	Contains the URI of the newly created resource, according to the structure: {apiRoot}/3gpp-5glan-pp/v1/{afId}/subscriptions/{subscriptionId}

5.7.1.3 Resource: Individual 5GLAN Parameters Provision Subscription

5.7.1.3.1 Introduction

This resource allows a AF to read, update or delete an existing subscription to provision 5GLAN parameters.

5.7.1.3.2 Resource Definition

Resource URI: {apiRoot}/3gpp-5glan-pp/v1/{afId}/subscriptions/{subscriptionId}

This resource shall support the resource URI variables defined in table 5.7.1.3.2-1.

Table 5.7.1.3.2-1: Resource URI variables for this resource

Name	Data type	Definition
apiRoot	string	Clause 5.2.4 of 3GPP TS 29.122 [4].
afId	string	Identifier of the AF.
subscriptionId	string	Identifier of the subscription resource.

5.7.1.3.3 Resource Methods

5.7.1.3.3.1 General

The following clauses specify the resource methods supported by the resource as described in clause 5.7.1.3.2.

5.7.1.3.3.2 GET

The GET method allows to read the active subscription for a given AF and subscription Id. The AF shall initiate the HTTP GET request message and the NEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.7.1.3.3.2-1.

Table 5.7.1.3.3.2-1: URI query parameters supported by the GET method on this resource

Name	Data type	P	Cardinality	Description
N/A

This method shall support the request data structures specified in table 5.7.1.3.3.2-2 and the response data structures and response codes specified in table 5.7.1.3.3.2-3.

Table 5.7.1.3.3.2-2: Data structures supported by the GET Request Body on this resource

Data type	P	Cardinality	Description
N/A

Table 5.7.1.3.3.2-3: Data structures supported by the GET Response Body on this resource

Data type	P	Cardinality	Response codes	Description
5GLanParametersProvision	M	1	200 OK	The information for the subscription in the request URI are returned.
N/A			307 Temporary Redirect	Temporary redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
N/A			308 Permanent Redirect	Permanent redirection, during subscription retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.7.1.3.3.2-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.7.1.3.3.2-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.7.1.3.3.3 PUT

The PUT method modifies an existing resource to update a subscription. The AF shall initiate the HTTP PUT request message and the NEF shall respond to the message.

This method shall support the request data structures specified in table 5.7.1.3.3.3-1 and the response data structures and response codes specified in table 5.7.1.3.3.3-2.

Table 5.7.1.3.3.3-1: Data structures supported by the PUT Request Body on this resource

Data type	P	Cardinality	Description
5GLanParametersProvision	M	1	Modify an existing subscription to provision parameters.

Table 5.7.1.3.3.3-2: Data structures supported by the PUT Response Body on this resource

Data type	P	Cardinality	Response codes	Description
5GLanParametersProvision	M	1	200 OK	The subscription was updated successfully.
n/a			204 No Content	The subscription was updated successfully.
N/A			307 Temporary Redirect	Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
N/A			308 Permanent Redirect	Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.7.1.3.3.3-3: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.7.1.3.3.3-4: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.7.1.3.3.4 DELETE

The DELETE method deletes an existing individual 5GLAN parameters provision subscription for a given AF. The AF shall initiate the HTTP DELETE request message and the NEF shall respond to the message.

This method shall support the URI query parameters specified in table 5.7.1.3.3.4-1.

Table 5.7.1.3.3.4-1: URI query parameters supported by the DELETE method on this resource

Name	Data type	P	Cardinality	Description
N/A

This method shall support the request data structures specified in table 5.7.1.3.3.4-2 and the response data structures and response codes specified in table 5.7.1.3.3.4-3.

Table 5.7.1.3.3.4-2: Data structures supported by the DELETE Request Body on this resource

Data type	P	Cardinality	Description
N/A

Table 5.7.1.3.3.4-3: Data structures supported by the DELETE Response Body on this resource

Data type	P	Cardinality	Response codes	Description
N/A			204 No Content	The subscription was terminated successfully.
N/A			307 Temporary Redirect	Temporary redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
N/A			308 Permanent Redirect	Permanent redirection, during subscription termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.7.1.3.3.4-4: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.7.1.3.3.4-5: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.7.1.3.3.5 PATCH

The PATCH method allows to change some properties of an existing resource to update a subscription. The AF shall initiate the HTTP PATCH request message and the NEF shall respond to the message.

This method shall support the request data structures specified in table 5.7.1.3.3.5-1 and the response data structures and response codes specified in table 5.7.1.3.3.5-2.

Table 5.7.1.3.3.5-1: Data structures supported by the PATCH Request Body on this resource

Data type	P	Cardinality	Description
5GLanParametersProvisionPatch	M	1	Modify an existing subscription to provision parameters.

Table 5.7.1.3.3.5-2: Data structures supported by the PATCH Response Body on this resource

Data type	P	Cardinality	Response codes	Description
5GLanParametersProvision	M	1	200 OK	The subscription was updated successfully.
n/a			204 No Content	The subscription was updated successfully.
N/A			307 Temporary Redirect	Temporary redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
N/A			308 Permanent Redirect	Permanent redirection, during subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NEF. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].
NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.7.1.3.3.5-3: Headers supported by the 307 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

Table 5.7.1.3.3.5-4: Headers supported by the 308 Response Code on this resource

Name	Data type	P	Cardinality	Description
Location	string	M	1	An alternative URI of the resource located in an alternative NEF.

5.7.1A Notifications

Notifications are not applicable to this API.

5.7.2 Data Model

5.7.2.1 General

This clause specifies the application data model supported by the 5GLANParameterProvision API.

Table 5.7.2.1-1 specifies the data types defined for the 5GLANParameterProvision API.

Table 5.7.2.1-1: 5GLANParameterProvision API specific Data Types

Data type	Clause defined	Description	Applicability
5GLanParameters	5.7.2.3.3	Represents 5G LAN service related parameters that need to be provisioned.
5GLanParametersPatch	5.7.2.3.6	Represents 5G LAN service related parameters that need to be modified.
5GLanParametersProvision	5.7.2.3.2	Represents an individual 5G LAN parameters provision subscription resource.
5GLanParametersProvisionPatch	5.7.2.3.5	Represents the 5G LAN parameters to request the modification of a subscription to provision parameters.
AaaUsage	5.7.2.4.3	Represents the usage of the DN-AAA server.
AppDescriptor	5.7.2.3.4	Represents an operation system and the corresponding applications.
AppDescriptorRm	5.7.2.3.7	Represents the same as the AppDescriptor data type but with the "nullable: true" property.

5.7.2.2 Reused data types

The data types reused by the 5GLANParameterProvision API from other specifications are listed in table 5.7.2.2-1.

Table 5.7.2.2-1: Re-used Data Types

Data type	Reference	Comments
ApplicationId	3GPP TS 29.571 [8]
Dnn	3GPP TS 29.571 [8]	Identifies a DNN.
ExternalGroupId	3GPP TS 29.122 [4]	External Group Identifier for a user group.
Gpsi	3GPP TS 29.571 [8]	Identifies a GPSI.
Ipv4Addr	3GPP TS 29.571 [8]	Identifies an IPv4 address.
Ipv6Addr	3GPP TS 29.571 [8]	Identifies an IPv6 address.
Link	3GPP TS 29.122 [4]	Identifies a referenced resource.
MtcProviderInformation	3GPP TS 29.571 [8]	Indicates MTC provider information for 5G VN Group Configuration authorization.
OsId	3GPP TS 29.519 [23]	Operating System.
PduSessionType	3GPP TS 29.571 [8]	PDU session type.
Snssai	3GPP TS 29.571 [8]	Identifies the S-NSSAI.
SupportedFeatures	3GPP TS 29.571 [8]	Used to negotiate the applicability of the optional features defined in table 5.7.3-1.

5.7.2.3 Structured data types

5.7.2.3.1 Introduction

This clause defines the structured data types to be used in resource representations.

5.7.2.3.2 Type: 5GLanParametersProvision

Table 5.7.2.3.2-1: Definition of type 5GLanParametersProvision

Attribute name	Data type	P	Cardinality	Description	Applicability
self	Link	C	0..1	Identifies the individual parameters provision subscription resource. Shall be present in the HTTP GET response when reading all the subscriptions for an AF.
5gLanParams	5GLanParameters	M	1	Represents the 5G LAN service related parameters.
suppFeat	SupportedFeatures	M	1	Indicates the negotiated supported features.

5.7.2.3.3 Type: 5GLanParameters

This type represents the 5G LAN service related parameters need to be provisioned.

Table 5.7.2.3.3-1: Definition of type 5GLanParameters

Attribute name	Data type	P	Cardinality	Description	Applicability
exterGroupId	ExternalGroupId	M	1	Identifies an 5G Virtual Network Group.
gpsis	map(Gpsi)	M	1..N	Represents the list of 5G VN Group members, each member is identified by GPSI. Any string value can be used as a key of the map.
dnn	Dnn	M	1	DNN for the 5G VN group, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
aaaIpv4Addr	Ipv4Addr	O	1	Identifies the DN-AAA server IPv4 address provided by AF, for the secondary authentication/authorization and/or UE IP address allocation by DN-AAA server.
aaaIpv6Addr	Ipv6Addr	O	1	Identifies the DN-AAA server IPv6 address provided by AF, for the secondary authentication/authorization and/or UE IP address allocation by DN-AAA server.
aaaUsgs	array(AaaUsage)	O	1..2	Identifies the usage needs for secondary authentication/authorization and/or UE IP address allocation from the DN-AAA server.
mtcProviderId	MtcProviderInformation	O	0..1	Indicates MTC provider information for 5G VN Group Configuration authorization. (NOTE 1)
snssai	Snssai	M	1	S-NSSAI for the 5G VN group.
sessionType	PduSessionType	M	1	PDU Session Type allowed for 5G VN group.
sessionTypes	array(PduSessionType)	O	1..N	If further PDU Session Types (in addition to the PDU Session Type indicated in the "sessionType" attribute) are allowed for the 5G VN group, they are provided in this attribute. (NOTE 2)	multipleSessionTypes
appDesps	map(AppDescriptor)	M	1..N	Describes the operation systems and the corresponding applications for each operation systems. The key of map is osId.
NOTE 1: The NEF should check received MTC Provider information and then the NEF may: – override it with local configured value and send it to UDM; – send it directly to the UDM; or – reject the 5G VN Group Configuration request. NOTE 2: Only one PDU Session type is applied for a PDU Session of a VN group at a time.

5.7.2.3.4 Type: AppDescriptor

Table 5.7.2.3.4-1: Definition of type AppDescriptor

Attribute name

Data type

Cardinality

Description

Applicability

osId

OsId

Identifies an operating system supported by the UE.

appIds

map(ApplicationId)

1..N

Identifies applications that is running on the UE’s operating system.

Any string value can be used as a key of the map.

5.7.2.3.5 Type: 5GLanParametersProvisionPatch

Table 5.7.2.3.5-1: Definition of type 5GLanParametersProvisionPatch

Attribute name	Data type	P	Cardinality	Description	Applicability
5gLanParamsPatch	5GLanParametersPatch	O	0..1	Represents the 5G LAN servise related parameters.

5.7.2.3.6 Type: 5GLanParametersPatch

Table 5.7.2.3.6-1: Definition of type 5GLanParametersPatch

Attribute name

Data type

Cardinality

Description

Applicability

gpsis

map(GpsiRm)

1..N

Represents the list of 5G VN Group members, each member is identified by GPSI.

Any string value can be used as a key of the map.

appDesps

map(AppDescriptorRm)

1..N

Describes the operation systems and the corresponding applications for each operation system.

The key of map is osId.

5.7.2.3.7 Type: AppDescriptorRm

Table 5.7.2.3.7-1: Definition of type AppDescriptorRm

Attribute name

Data type

Cardinality

Description

Applicability

appIds

map(ApplicationIdRm)

1..N

Identifies application(s) on the UE’s operating system.

Any string value can be used as a key of the map.

5.7.2.3.8 Void

5.7.2.4 Simple data types and enumerations

5.7.2.4.1 Introduction

This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.

5.7.2.4.2 Simple data types

The simple data types defined in table 5.7.2.4.2-1 shall be supported.

Table 5.7.2.4.2-1: Simple data types

Type Name	Type Definition	Description	Applicability

5.7.2.4.3 Enumeration: AaaUsage

Table 5.7.2.4.3-1: Enumeration AaaUsage

The enumeration AaaUsage represents the usage of the DN-AAA server.

Enumeration value	Description
"AUTH"	Secondary authentication/authorization by DN-AAA server
"IP_ALLOC"	UE IP address allocation by DN-AAA server

5.7.3 Used Features

The table below defines the features applicable to the 5GLANParameterProvision API. Those features are negotiated as described in clause 5.2.7 of 3GPP TS 29.122 [4].

Table 5.7.3-1: Features used by 5GLANParameterProvision API

Feature number	Feature Name	Description
1	multipleSessionTypes	Indicates that multiple allowed PDU Session Types can be provided for a 5G VN group.

5.7.4 Error handling

5.7.4.1 General

HTTP error handling shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [4].

In addition, the requirements in the following clauses shall apply.

5.7.4.2 Protocol Errors

In this Release of the specification, there are no additional protocol errors applicable for the 5GLANParameterProvision API.

5.7.4.3 Application Errors

The application errors defined for 5GLANParameterProvision API are listed in table 5.7.4.3-1.

Table 5.7.4.3-1: Application errors

Application Error	HTTP status code	Description	Applicability