5.13 NpConfiguration API
29.1223GPPRelease 18T8 reference point for Northbound APIsTS
5.13.1 Overview
The NpConfiguration API is a RESTful API that allows the SCS/AS to send suggested network parameters to influence certain aspects of UE/network behaviour such as the UE’s PSM, extended idle mode DRX, and extended buffering configurations. The NpConfiguration API defines a set of data models, resources and the related procedures for the creation and management of the network parameter configuration. The corresponding JSON schema for the representation of the resources and operations defined by the NpConfiguration API is provided in its complete form in Annex A.13.
5.13.2 Data model
5.13.2.1 Resource data types
5.13.2.1.1 Introduction
This clause defines data structures to be used in resource representations.
Table 5.13.2.1.1-1 specifies data types re-used by the NetworkParameterConfiguration API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NetworkParameterConfiguration API.
Table 5.13.2.1.1-1: NetworkParameterConfiguration API re-used Data Types
Data type |
Reference |
Comments |
Dnn |
3GPP TS 29.571 [45] |
Identifies a DNN. |
IpAddr |
3GPP TS 29.571 [45] |
UE IP Address. |
MacAddr48 |
3GPP TS 29.571 [45] |
MAC Address. |
SupportedFeatures |
3GPP TS 29.571 [45] |
Used to negotiate the applicability of the optional features defined in table 5.13.4-1. |
Table 5.13.2.1.1-2 specifies the data types defined for the NpConfiguration API.
Table 5.13.2.1.1-2: NpConfiguration API specific Data Types
Data type |
Clause defined |
Description |
Applicability |
ConfigurationNotification |
5.13.2.1.4 |
Represents a configuration result notification. |
|
NpConfiguration |
5.13.2.1.2 |
Represents a network parameters configuration. |
|
NpConfigurationPatch |
5.13.2.1.3 |
Represents parameters used to request the modification of a network parameters configuration resource. |
5.13.2.1.2 Type: NpConfiguration
This type represents a configuration of network parameters. The same structure is used in the configuration request and response.
Table 5.13.2.1.2-1: Definition of type NpConfiguration
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE 2) |
self |
Link |
0..1 |
Link to the resource "Individual NP Configuration". This parameter shall be supplied by the SCEF in HTTP responses. |
|
supportedFeatures |
SupportedFeatures |
0..1 |
Used to negotiate the supported optional features of the API as described in clause 5.2.7. This attribute shall be provided in the POST request and in the response of successful resource creation. |
|
mtcProviderId |
string |
0..1 |
Identifies the MTC Service Provider and/or MTC Application. (NOTE 4) |
|
dnn |
Dnn |
0..1 |
Identifies a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. |
UEId_retrieval |
externalId |
ExternalId |
0..1 |
Identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2]. The attribute may also be present in the NP configuration response message, if the "UEId_retrieval" feature is supported and the corresponding request message includes the "ueIpAddr" attribute or the "ueMacAddr" attribute. (NOTE 1) |
|
msisdn |
Msisdn |
0..1 |
Identifies the MS internal PSTN/ISDN number allocated for a UE. (NOTE 1) |
|
externalGroupId |
ExternalGroupId |
0..1 |
Identifies a user group as defined in Clause 4.6.2 of 3GPP TS 23.682 [2]. (NOTE 1) |
|
maximumLatency |
DurationSec |
0..1 |
This parameter may be included to identify the maximum delay acceptable for downlink data transfers. |
|
maximumResponseTime |
DurationSec |
0..1 |
This parameter may be included to identify the length of time for which the UE stays reachable to allow the SCS/AS to reliably deliver the required downlink data. |
|
suggestedNumberOfDlPackets |
integer |
0..1 |
This parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable. |
|
groupReportingGuardTime |
DurationSec |
0..1 |
Identifies the time for which the SCEF can aggregate the reports detected by the UEs in a group and report them together to the SCS/AS, as specified in clause 5.6.0 of 3GPP TS 23.682 [2]. |
|
notificationDestination |
Link |
0..1 |
A URI indicating the notification destination where T8 notification requests shall be delivered. The attribute shall be provided if the attribute "externalGroupId" is provided. |
|
requestTestNotification |
boolean |
0..1 |
Set to true by the SCS/AS to request the SCEF to send a test notification as defined in clause 5.2.5.3. Set to false or omitted otherwise. The attribute may only be provided if the attribute "externalGroupId" is provided. |
Notification_test_event |
websockNotifConfig |
WebsockNotifConfig |
0..1 |
Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 5.2.5.4. The attribute may only be provided if the attribute "externalGroupId" is provided. |
Notification_websocket |
validityTime |
DateTime |
0..1 |
Identifies when the network parameter expires and shall be deleted locally if it expires. The attribute is only applicable in 5G. (NOTE 3) |
NpExpiry_5G |
snssai |
Snssai |
0..1 |
Indicate the S-NSSAI. |
UEId_retrieval |
ueIpAddr |
IpAddr |
0..1 |
UE IP address. |
UEId_retrieval |
ueMacAddr |
MacAddr48 |
0..1 |
UE MAC address. |
UEId_retrieval |
NOTE 1: Only one of the properties "externalId", "msisdn" or "externalGroupId" shall be included. NOTE 2: Properties marked with a feature as defined in clause 5.13.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. NOTE 3: If this attribute is omitted, no expiry for network parameter configuration applies. NOTE 4: The SCEF should check received MTC provider identifier and then the SCEF may: |
5.13.2.1.3 Type: NpConfigurationPatch
This type represents a configuration of network parameters provided by the SCS/AS to the SCEF. The structure is used for HTTP PATCH request.
Table 5.13.2.1.3-1: Definition of type NpConfigurationPatch
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE) |
maximumLatency |
DurationSecRm |
0..1 |
This parameter may be included to identify the maximum delay acceptable for downlink data transfers. |
|
maximumResponseTime |
DurationSecRm |
0..1 |
This parameter may be included to identify the length of time for which the UE stays reachable to allow the SCS/AS to reliably deliver the required downlink data. |
|
suggestedNumberOfDlPackets |
integer |
0..1 |
This parameter may be included to identify the number of packets that the serving gateway shall buffer in case that the UE is not reachable. |
|
groupReportGuardTime |
DurationSecRm |
0..1 |
Identifies the time for which the SCEF can aggregate the reports detected by the UEs in a group and report them together to the SCS/AS, as specified in clause 5.6.0 of 3GPP TS 23.682 [2]. |
|
validityTime |
DateTimeRm |
0..1 |
Identifies when the network parameter expires and shall be deleted locally if it expires. The attribute is only applicable in 5G. |
NpExpiry_5G |
notificationDestination |
Link |
0..1 |
A URI indicating the notification destination where T8 notification requests shall be delivered. |
|
NOTE: Properties marked with a feature as defined in clause 5.13.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features. |
5.13.2.1.4 Type: ConfigurationNotification
This type represents a configuration result notification.
Table 5.13.2.1.4-1: Definition of the ConfigurationNotification data type
Attribute name |
Data type |
Cardinality |
Description |
Applicability (NOTE) |
configuration |
Link |
1 |
Link to the configuration resource to which this notification is related. |
|
configResults |
array(ConfigResult) |
0..N |
Each element identifies a notification of grouping configuration result. |
|
appliedParam |
AppliedParameterConfiguration |
0..1 |
Indicates the applied parameter configuration in the network. The "maximumDetectionTime" attribute in AppliedParameterConfiguration data type is not applicable for Network Parameter configuration. |
Enhanced_param_config |
NOTE: Properties marked with a feature as defined in clause 5.13.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features. |
5.13.3 Resource structure
5.13.3.1 General
All resource URIs of this API should have the following root:
{apiRoot}/3gpp-network-parameter-configuration/v1
"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-network-parameter-configuration" and "apiVersion" shall be set to "v1" for the version defined in the present document. All resource URIs in the clauses below are defined relative to the above root URI.
The following resources and HTTP methods are supported for this API:
Table 5.13.3.1-1: Resources and methods overview
Resource name |
Resource URI |
HTTP method |
Meaning |
NP Configurations |
/{scsAsId}/configurations |
GET |
Read all NP configurations for a given SCS/AS |
POST |
Create a new NP configuration |
||
Individual NP Configuration |
/{scsAsId}/configurations/{configurationId} |
PUT |
Replace all of the properties in an existing NP configuration |
PATCH |
Modify some properties in an existing NP configuration |
||
GET |
Read an existing NP configuration |
||
DELETE |
Delete a NP configuration |
5.13.3.2 Resource: NP Configurations
5.13.3.2.1 Introduction
This resource allows an SCS/AS to read all active network parameter configurations or create a new configuration to configure network parameters.
5.13.3.2.2 Resource definition
Resource URI: {apiRoot}/3gpp-network-parameter-configuration/v1/{scsAsId}/configurations
This resource shall support the resource URI variables defined in table 5.13.3.2.2-1.
Table 5.13.3.2.2-1: Resource URI variables for resource "NP Configurations"
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.2.4. |
scsAsId |
string |
Identifier of the SCS/AS. |
5.13.3.2.3 Resource methods
5.13.3.2.3.1 GET
The GET method allows to read all active configurations indicated by the resource URI as defined in clause 5.13.3.2.2. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.2.3.1-1 and table 5.13.3.2.3.1-2.
Table 5.13.3.2.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.13.3.2.3.1-2: Data structures supported by the GET request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
array(NpConfiguration) |
0..N |
200 OK |
The NP configuration information related to the request URI is returned. |
|
none |
307 Temporary Redirect |
Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. |
Table 5.13.3.2.3.1-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 SCEF. |
Table 5.13.3.2.3.1-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 SCEF. |
5.13.3.2.3.2 PUT
This HTTP method is not supported for the resource.
5.13.3.2.3.3 PATCH
This HTTP method is not supported for the resource.
5.13.3.2.3.4 POST
The POST method creates a new configuration resource for a given SCS/AS. The SCS/AS shall initiate the HTTP POST request message and the SCEF shall respond to the message. The SCEF shall construct the URI of the created resource.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.2.3.4-1 and table 5.13.3.2.3.4-2.
Table 5.13.3.2.3.4-1: URI query parameters supported by the POST method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.13.3.2.3.4-2: Data structures supported by the POST request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
NpConfiguration |
1 |
Parameters to create a new configuration to configure network parameters with the SCEF. |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
NpConfiguration |
1 |
201 Created |
The configuration was created successfully. The URI of the created resource shall be returned in the "Location" HTTP header. |
|
ProblemDetails |
0..1 |
403 Forbidden |
(NOTE 2) |
|
ProblemDetails |
0..1 |
404 Not Found |
(NOTE 2) |
|
NOTE 1: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. NOTE 2: Failure cases are described in clause 5.13.5.3. |
Table 5.13.3.2.3.4-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-network-parameter-configuration/v1/{scsAsId}/configurations/{configurationId} |
5.13.3.2.3.5 DELETE
This HTTP method is not supported for the resource.
5.13.3.3 Resource: Individual NP Configuration
5.13.3.3.1 Introduction
This resource allows an SCS/AS to query, update and delete a network parameter configuration indicated by the resource URI as defined in clause 5.13.3.3.2.
5.13.3.3.2 Resource definition
Resource URI: {apiRoot}/3gpp-network-parameter-configuration/v1/{scsAsId}/configurations/{configurationId}
This resource shall support the resource URI variables defined in table 5.13.3.3.2-1.
Table 5.13.3.2.2-1: Resource URI variables for resource "Individual NP Configuration"
Name |
Data type |
Definition |
apiRoot |
string |
See clause 5.2.4. |
scsAsId |
string |
Identifier of the SCS/AS. |
configurationId |
string |
Identifier of the configuration resource. |
5.13.3.3.3 Resource methods
5.13.3.3.3.1 GET
The GET method allows to read an active configuration indicated by the resource URI as defined in subclause 5.13.3.3.2. The SCS/AS shall initiate the HTTP GET request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.3.3.1-1 and table 5.13.3.3.3.1-2.
Table 5.13.3.3.3.1-1: URI query parameters supported by the GET method on this resource
Name |
Data type |
Cardinality |
Remarks |
Table 5.13.3.3.3.1-2: Data structures supported by the GET request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
NpConfiguration |
1 |
200 OK |
The configuration information related to the request URI is returned. |
|
none |
307 Temporary Redirect |
Temporary redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during configuration retrieval. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.6-1 also apply. |
Table 5.13.3.3.3.1-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 SCEF. |
Table 5.13.3.3.3.1-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 SCEF. |
5.13.3.3.3.2 PUT
The PUT method modifies an existing configuration indicated by the resource URI as defined in clause 5.13.3.3.2. The SCS/AS shall initiate the HTTP PUT request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.3.3.2-1 and table 5.13.3.3.3.2-2.
Table 5.13.3.3.3.2-1: URI query parameters supported by the PUT method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.13.3.3.3.2-2: Data structures supported by the PUT request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
NpConfiguration |
1 |
Update of network parameter(s) for an existing Configuration. |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
NpConfiguration |
1 |
200 OK |
The resource was updated successfully. The SCEF shall return an updated Configuration information in the response. |
|
none |
204 No Content |
The resource was updated successfully. |
||
none |
307 Temporary Redirect |
Temporary redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
ProblemDetails |
0..1 |
403 Forbidden |
(NOTE 2) |
|
NOTE 1: The mandatory HTTP error status codes for the PUT method listed in table 5.2.6-1 also apply. NOTE 2: Failure cases are described in clause 5.13.5.3. |
Table 5.13.3.3.3.2-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 SCEF. |
Table 5.13.3.3.3.2-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 SCEF. |
5.13.3.3.3.3 PATCH
The PATCH method shall be used to update some properties in an existing configuration indicated by the Resource URI as defined in clause 5.13.3.3.2. The SCS/AS shall initiate the HTTP PATCH request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.3.3.3-1 and table 5.13.3.3.3.3-2.
Table 5.13.3.3.3.3-1: URI query parameters supported by the PATCH method on this resource
Name |
Data type |
Cardinality |
Remarks |
none specified |
Table 5.13.3.3.3.3-2: Data structures supported by the PATCH request/response by the resource
Request body |
Data type |
Cardinality |
Remarks |
|
NpConfigurationPatch |
1 |
Partial update an existing network parameter configuration. |
||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
NpConfiguration |
1 |
200 OK |
The configuration was updated successfully. The SCEF shall return an updated configuration information in the response. |
|
none |
204 No Content |
The configuration was updated successfully. |
||
none |
307 Temporary Redirect |
Temporary redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during configuration modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
ProblemDetails |
0..1 |
403 Forbidden |
(NOTE 2) |
|
NOTE 1: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply. NOTE 2: Failure cases are described in clause 5.13.5.3. |
Table 5.13.3.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 SCEF. |
Table 5.13.3.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 SCEF. |
5.13.3.3.3.4 POST
This HTTP method is not supported for the resource.
5.13.3.3.3.5 DELETE
The DELETE method deletes an existing configuration resource "Individual NP Configuration". The SCS/AS shall initiate the HTTP DELETE request message and the SCEF shall respond to the message.
This method shall support the URI query parameters, request and response data structures, and response codes, as specified in the table 5.13.3.3.3.5-1 and table 5.13.3.3.3.5-2.
Table 5.13.3.3.3.5-1: URI query parameters supported by the DELETE method on this resource
Name |
Data type |
Cardinality |
Remarks |
N/A |
Table 5.13.3.3.3.5-2: Data structures supported by the DELETE request/response on the resource
Request body |
Data type |
Cardinality |
Remarks |
|
none |
||||
Response body |
Data type |
Cardinality |
Response codes |
Remarks |
array(ConfigResult) |
1..N |
200 OK |
The configuration was terminated successfully, the configuration failure information for group members shall be included if received. |
|
none |
204 No Content |
The configuration was terminated successfully. The response body shall be empty. |
||
none |
307 Temporary Redirect |
Temporary redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
none |
308 Permanent Redirect |
Permanent redirection, during configuration termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative SCEF. Redirection handling is described in clause 5.2.10. |
||
NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply. |
Table 5.13.3.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 SCEF. |
Table 5.13.3.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 SCEF. |
5.13.3.4 Void
5.13.3A Notifications
5.13.3A.1 General
The notifications provided by the NpConfiguration API are specified in this clause.
Table 5.13.3A-1: Notifications overview
Notification |
Callback URI |
HTTP method or custom operation |
Description (service operation) |
Configuration Notification |
{notificationDestination} |
POST |
Report a grouping configuration result from the SCEF to the SCS/AS |
5.13.3A.2 Configuration Notification
5.13.3A.2.1 Description
The Configuration Notification allows the SCEF to send notifications about grouping configuration result to the SCS/AS.
5.13.3A.2.2 Target URI
The Callback URI "{notificationDestination}" shall be used with the callback URI variables defined in table 5.13.3a.2.2-1.
Table 5.13.3A.2.2-1: Callback URI variables
Name |
Data type |
Definition |
notificationDestination |
Link |
Callback reference provided by the SCS/AS during creation or modification of the NP configuration subscription. |
5.13.3A.2.3 Standard Methods
5.13.3A.2.3.1 Notification via POST
The HTTP POST method reports the grouping configuration results for a NP configuration subscription. The SCEF shall initiate the HTTP POST request message and the SCS/AS shall respond to the message.
This method shall support the request data structures specified in table 5.13.3A.2.3.1-1 and the response data structures and response codes specified in table 5.13.3A.2.3.1-2.
Table 5.13.3A.2.3.1-1: Data structures supported by the POST Request Body
Data type |
Cardinality |
Description |
ConfigurationNotification |
1 |
The grouping configuration result notification provided by the SCEF. |
Table 5.13.3A.2.3.1-2: Data structures supported by the POST Response Body
Data type |
Cardinality |
Response codes |
Description |
none |
204 No Content |
The notification is received successfully. |
|
none |
307 Temporary Redirect |
Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10. |
|
none |
308 Permanent Redirect |
Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative SCS/AS where the notification should be sent. Redirection handling is described in clause 5.2.10. |
|
NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 also apply. |
Table 5.13.3A.2.3.1-3: Headers supported by the 307 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. |
Table 5.13.3A.2.3.1-4: Headers supported by the 308 Response Code on this resource
Name |
Data type |
P |
Cardinality |
Description |
Location |
string |
M |
1 |
An alternative URI representing the end point of an alternative SCS/AS towards which the notification should be redirected. |
5.13.3a.2.3.2 Notification via Websocket
If supported by both SCS/AS and SCEF and successfully negotiated, the ConfigurationNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4.
5.13.4 Used Features
The table below defines the features applicable to the NpConfiguration API. Those features are negotiated as described in clause 5.2.7.
Table 5.13.4-1: Features used by NpConfiguration API
Feature Number |
Feature |
Description |
1 |
Notification_websocket |
The delivery of notifications over Websocket is supported according to clause 5.2.5.4. This feature requires that the Notification_test_event featute is also supported. |
2 |
Notification_test_event |
The testing of notification connection is supported according to clause 5.2.5.3. |
3 |
NpExpiry_5G |
The network parameter expiry is supported. This feature may only be supported in 5G. |
4 |
Enhanced_param_config |
This feature supports the co-existence of multiple event configurations for target UE(s) if there are parameters affecting periodic RAU/TAU timer and/or Active Time. |
5 |
UEId_retrieval |
This feature supports AF specific UE ID retrieval. The feature is not applicable to pre-5G (e.g. 4G). |
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "Notification". Description: A clear textual description of the feature. |
5.13.5 Error handling
5.13.5.1 General
HTTP error handling shall be supported as specified in clause 5.2.6.
In addition, the requirements in the following clauses shall apply.
5.13.5.2 Protocol Errors
In this release of the specification, there are no additional protocol errors applicable for the NpConfiguration API.
5.13.5.3 Application Errors
The application errors defined for the NpConfiguration API are listed in table 5.13.5.3-1.
Table 5.13.5.3-1: Application errors
Application Error |
HTTP status code |
Description |
Applicability |
PARAMETER_OUT_OF_RANGE |
403 Forbidden |
Indicates that the resource is not allowed to be created since one or more of the received parameters are out of range defined by operator policies. |
|
REQUEST_NOT_AUTHORIZED |
403 Forbidden |
Indicates that the AF specific UE ID retrieval request is not authorized. |
UEId_retrieval |
UE_ID_NOT_AVAILABLE |
404 Not Found |
Indicates that the AF specific UE ID is not available. |
UEId_retrieval |
UE_NOT_FOUND |
404 Not Found |
Indicates that the requested UE address is not found. |
UEId_retrieval |