5.6 NIDD API

29.1223GPPRelease 18T8 reference point for Northbound APIsTS

5.6.1 Overview

The NIDD API is a RESTful API that allows the SCS/AS to send non-IP data to the UE or receive non-IP data from the UE. The NIDD API defines a set of data models, resources and the related procedures for the non-IP data transfer. The corresponding JSON schema for the representation of the resources and operations defined by the NIDD API is provided in its complete form in Annex A.6.

5.6.2 Data model

5.6.2.1 Resource data types

5.6.2.1.1 Introduction

This clause defines data structures to be used in resource representations, including subscription resources.

Table 5.6.2.1.1-1 specifies data types re-used by the NIDD API from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NIDD API.

Table 5.5.2.1.1-1: NIDD API re-used Data Types

Data type

Reference

Comments

NullValue

3GPP TS 29.571 [45]

JSON’s null value, used as an explicit value of an enumeration.

SupportedFeatures

3GPP TS 29.571 [45]

Used to negotiate the applicability of the optional features defined in table 5.6.4-1.

Table 5.6.2.1.1-2 specifies the data types defined for the NIDD API.

Table 5.6.2.1.1-2: NIDD API specific Data Types

Data type

Clause defined

Description

Applicability

DeliveryStatus

5.6.2.3.4

Represents the status of a downlink NIDD data delivery.

GmdNiddDownlinkDataDeliveryNotification

5.6.2.1.8

Represents the delivery status of a specific group NIDD downlink data delivery.

GmdResult

5.6.2.2.3

Represents the group message delivery result.

GroupMessageDelivery

ManageEntity

5.6.2.3.7

Represents the origin that manages the RDS port.

ManagePort

5.6.2.1.9

Represents the configuration of a RDS dynamic port management.

Rds_dynamic_port

ManagePortNotification

5.6.2.1.10

Represents a ManagePort notification of port numbers that are reserved.

NiddConfiguration

5.6.2.1.2

Represents the configuration for NIDD.

NiddConfigurationPatch

5.6.2.1.7

Represents the parameters to update a NIDD configuration.

NiddConfigurationStatusNotification

5.6.2.1.6

Represents an NIDD configuration status notification.

NiddDownlinkDataDeliveryFailure

5.6.2.2.4

Represents information related to a failure delivery result.

NiddDownlinkDataDeliveryStatusNotification

5.6.2.1.5

Represents the delivery status of a specific NIDD downlink data delivery.

NiddDownlinkDataTransfer

5.6.2.1.3

Represents the received NIDD downlink data from the SCS/AS.

NiddDownlinkDataTransferPatch

5.6.2.1.11

Represents the parameters to request the modification of an Individual NIDD Downlink Data Delivery resource.

PatchUpdate

NiddStatus

5.6.2.3.5

Represents the status of a NIDD configuration.

NiddUplinkDataNotification

5.6.2.1.4

Represents NIDD uplink data to be notified to the SCS/AS.

PdnEstablishmentOptions

5.6.2.3.3

Represents PDN establishment options that describe the network behaviour when there is no PDN connection towards the addressed UE.

PdnEstablishmentOptionsRm

5.6.2.3.6

Represents the same information as the PdnEstablishmentOptions but with the "nullable: true" property.

RdsDownlinkDataDeliveryFailure

5.6.2.2.5

Represents the failure delivery result for RDS.

RdsPort

5.6.2.2.2

Represents the port configuration for Reliable Data Transfer.

SerializationFormat

5.6.2.3.8

Represents a serialization format associated with an RDS port.

Rds_serialization_format

5.6.2.1.2 Type: NiddConfiguration

This type represents the configuration for NIDD. The same structure is used in the configuration request and configuration response.

Table 5.6.2.1.2-1: Definition of type NiddConfiguration

Attribute name

Data type

Cardinality

Description

Applicability (NOTE 1)

self

Link

0..1

Link to the resource "Individual NIDD 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 3)

externalId

ExternalId

0..1

Each element uniquely identifies a user as defined in clause 4.6.2 of 3GPP TS 23.682 [2].

(NOTE 2)

msisdn

Msisdn

0..1

Each element identifies the MS internal PSTN/ISDN number allocated for a UE.

(NOTE 2)

externalGroupId

ExternalGroupId

0..1

Identifies a user group as defined in clause 4.6.3 of 3GPP TS 23.682 [2].

(NOTE 2)

GroupMessageDelivery

duration

DateTime

0..1

Identifies the absolute time at which the related NIDD Configuration request is considered to expire, as specified in clause 5.13.2 of 3GPP TS 23.682 [2]. When omitted in the request, it indicates the configuration is requested to be valid forever by the SCS/AS. When omitted in the response, it indicates the configuration is set to valid forever by the SCEF.

reliableDataService

boolean

0..1

Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682 [2]) acknowledgement is requested.

– true: reliable data service acknowledgement is requested;

– false (default): reliable data service acknowledgement is not requested.

rdsPorts

array(RdsPort)

0..N

Indicates the static port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]).

pdnEstablishmentOption

PdnEstablishmentOptions

0..1

Indicate what the SCEF should do if the UE has not established the PDN connection and MT non-IP data needs to be sent. (wait for the UE to establish the PDN connection, respond with an error cause, or send a device trigger; see step 2 of the MT NIDD Procedure in clause 5.13.3 of 3GPP TS 23.682 [2])

The SCEF will use the value as the default preference from the SCS/AS when handling all MT non-IP packets associated with the NIDD connection.

notificationDestination

Link

1

An URI of a notification destination that T8 message shall be delivered to.

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.

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.

Notification_websocket

maximumPacketSize

integer

0..1

The Maximum Packet Size is the maximum NIDD packet size that was transferred to the UE by the SCEF in the PCO, see clause 4.5.14.1 of 3GPP TS 23.682 [2]. If no maximum packet size was provided to the UE by the SCEF, the SCEF sends a default configured max packet size to SCS/AS.

Unit: bit.

niddDownlinkDataTransfers

array(NiddDownlinkDataTransfer)

0..N

The downlink data deliveries that needed to be executed by the SCEF. The cardinality of the property shall be 0..1 in the request and 0..N in the response (i.e. response may contain multiple buffered MT NIDD).

For GroupMessageDelivery feature, this property is only applicable for the configuration response to GET request.

status

NiddStatus

0..1

May be supplied by the SCEF

NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features unless stated otherwise.

NOTE 2: One of the properties "externalId", "msisdn" or "externalGroupId" shall be included.

NOTE 3: The SCEF should check received MTC provider identifier and then the SCEF may:
– override it with local configured value and send it to HSS;
– send it directly to the HSS; or
– reject the NIDD configuration request.

5.6.2.1.3 Type: NiddDownlinkDataTransfer

This type represents received NIDD downlink data from the SCS/AS.

Table 5.6.2.1.3-1: Definition of type NiddDownlinkDataTransfer

Attribute name

Data type

Cardinality

Description

Applicability (NOTE 1)

externalId

ExternalId

0..1

Each element uniquely identifies a user as defined in clause 4.6.2 of 3GPP TS 23.682 [2].

(NOTE 2)

externalGroupId

ExternalGroupId

0..1

Identifies a user group as defined in clause 4.6.3 of 3GPP TS 23.682 [2].

(NOTE 2)

GroupMessageDelivery

msisdn

Msisdn

0..1

Each element identifies the MS internal PSTN/ISDN number allocated for a UE.

(NOTE 2)

self

Link

0..1

Link to the resource "Individual NIDD downlink data delivery". This parameter shall be supplied by the SCEF in HTTP responses.

data

Bytes

1

The non-IP data that needed to be delivered to UE from the SCS/AS.

reliableDataService

boolean

0..1

Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682 [2]) acknowledgement is requested.

– true: reliable data service acknowledgement is requested;

– false (default): reliable data service acknowledgement is not requested.

rdsPort

RdsPort

0..1

Indicates the port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]).

maximumLatency

DurationSec

0..1

It is used to indicate maximum delay acceptable for downlink data and may be used to configure the buffer duration; a Maximum Latency of 0 indicates that buffering is not allowed. If not provided, the SCEF determines the acceptable delay based on local polices.

priority

integer

0..1

It is used to indicate the priority of the non-IP data packet relative to other non-IP data packets.

For GroupMessageDelivery feature, this property is not applicable.

pdnEstablishmentOption

PdnEstablishmentOptions

0..1

Indicate what the SCEF should do if the UE has not established the PDN connection and MT non-IP data needs to be sent (wait for the UE to establish the PDN connection, respond with an error cause, or send a device trigger; see step 2 of the MT NIDD Procedure in clause 5.13.3 of 3GPP TS 23.682 [2])

If PDN Connection Establishment Option is not provided with the non-IP packet, the SCEF uses the PDN Connection Establishment Option that was provided during NIDD Configuration to decide how to handle the absence of a PDN connection.

deliveryStatus

DeliveryStatus

0..1

Indicates the MT NIDD delivery status.

requestedRetransmissionTime

DateTime

0..1

Identifies the absolute time at which the SCEF is expected to retransmit the non-IP data when the deliveryStatus indicates that the non-IP data is buffered in the SCEF. This parameter may be supplied by the SCEF for delivery status "BUFFERING_TEMPORARILY_NOT_REACHABLE"

NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features unless stated otherwise.

NOTE 2: One of the properties "externalId", "msisdn" or "externalGroupId" shall be included.

5.6.2.1.4 Type: NiddUplinkDataNotification

This type represents NIDD uplink data to be notified to the SCS/AS.

Table 5.6.2.1.4-1: Definition of type NiddUplinkDataNotification

Attribute name

Data type

Cardinality

Description

Applicability (NOTE 1)

niddConfiguration

Link

1

Link to the NIDD configuration resource to which this notification is related.

externalId

ExternalId

0..1

Each element uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].

(NOTE 2)

msisdn

Msisdn

0..1

Each element identifies the MS internal PSTN/ISDN number allocated for a UE.

(NOTE 2)

data

Bytes

1

The non IP data that needed to be delivered from the UE to the SCS/AS.

reliableDataService

boolean

0..1

Indicates whether the reliable data service acknowledgement is requested.

– true: reliable data service acknowledgement is requested;

– false: reliable data service acknowledgement is not requested.

rdsPort

RdsPort

0..1

Indicates the port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]).

NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

NOTE 2: One of the properties "externalId" or "msisdn" shall be included.

5.6.2.1.5 Type: NiddDownlinkDataDeliveryStatusNotification

This type represents the delivery status for a specific NIDD downlink data delivery.

Table 5.6.2.1.5-1: Definition of type NiddDownlinkDataDeliveryStatusNotification

Attribute name

Data type

Cardinality

Description

Applicability (NOTE)

niddDownlinkDataTransfer

Link

1

Link to the NIDD downlink data transfer resource to which this notification is related.

deliveryStatus

DeliveryStatus

1

Indicates the MT NIDD delivery status.

requestedRetransmissionTime

DateTime

0..1

Identifies the absolute time at which the UE will be reachable.

This parameter may be supplied by the SCEF for delivery status "FAILURE_TEMPORARILY_NOT_REACHABLE"

NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.6.2.1.6 Type: NiddConfigurationStatusNotifiation

This type represents an NIDD configuration status notification.

Table 5.6.2.1.6-1: Definition of type NiddConfigurationStatusNotification

Attribute name

Data type

Cardinality

Description

Applicability (NOTE 1)

niddConfiguration

Link

1

Link to the NIDD configuration resource to which this notification is related.

externalId

ExternalId

0..1

Each element uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].

(NOTE 2)

msisdn

Msisdn

0..1

Each element identifies the MS internal PSTN/ISDN number allocated for a UE.

(NOTE 2)

status

NiddStatus

1

Indicates the NIDD configuration status.

rdsCapIndication

boolean

0..1

It indicates whether the network capability for the reliable data service is enabled or not.

rdsPort

RdsPort

0..1

Indicates the port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]).

Rds_port_verification

NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

NOTE 2: One of the properties "externalId" or "msisdn" shall be included.

5.6.2.1.7 Type: NiddConfigurationPatch

This type represents an NIDD configuration used in PATCH.

Table 5.6.2.1.7-1: Definition of type NiddConfigurationPatch

Attribute name

Data type

Cardinality

Description

Applicability (NOTE)

duration

DateTimeRm

0..1

Identifies the absolute time at which the related NIDD Configuration request is considered to expire, as specified in clause 5.13.2 of 3GPP TS 23.682 [2]. When set to null in the PATCH request, it indicates the configuration is requested to be valid forever by the SCS/AS. When omitted in the response, it indicates the configuration is set to valid forever by the SCEF.

reliableDataService

boolean

0..1

Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682 [2]) acknowledgement is requested.

– true: reliable data service acknowledgement is requested;

– false: reliable data service acknowledgement is not requested.

rdsPorts

array(RdsPort)

0..N

Indicates the static port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]).

pdnEstablishmentOption

PdnEstablishmentOptionsRm

0..1

Indicate what the SCEF should do if the UE has not established the PDN connection and MT non-IP data needs to be sent. (wait for the UE to establish the PDN connection, respond with an error cause, or send a device trigger; see step 2 of the MT NIDD Procedure in clause 5.13.3 of 3GPP TS 23.682 [2])

The SCEF will use the value as the default preference from the SCS/AS when handling all MT non-IP packets associated with the NIDD connection.

notificationDestination

Link

0..1

An URI of a notification destination that the message shall be delivered to.

NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.6.2.1.8 Type: GmdNiddDownlinkDataDeliveryNotification

This type represents the delivery status for a specific group NIDD downlink data delivery.

Table 5.6.2.1.8-1: Definition of type GmdNiddDownlinkDataDeliveryNotification

Attribute name

Data type

Cardinality

Description

Applicability (NOTE)

niddDownlinkDataTransfer

Link

1

Link to the NIDD downlink data transfer resource to which this notification is related.

gmdResults

array(GmdResult)

1..N

Indicates the group message delivery result.

GroupMessageDelivery

NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.6.2.1.9 Type: ManagePort

This type represents the configuration for RDS dynamic port management which is applicable for Rds_dynamic_port feature.

Table 5.6.2.1.9-1: Definition of type ManagePort

Attribute name

Data type

Cardinality

Description

Applicability

self

Link

0..1

Link to the resource "Individual ManagePort Configuration". This parameter shall be supplied by the SCEF in HTTP PUT/GET responses and in the notification POST request.

applicationId

string

1

Indicates the application that is associated with port configuration specified above (as defined in clause 5.4.2.6 of 3GPP TS 24.250 [31]).

manageEntity

ManageEntity

0..1

Indicates the "Individual ManagePort Configuration" resource is created by which function entity (UE or the AS). This attribute is supplied by the SCEF.

skipUeInquiry

boolean

0..1

Indicate whether to skip UE inquiry. Set to "true" if the SCS/AS decides to reserve port on the SCEF without confirming with the UE; otherwise set to "false". Default value is "false" if omitted.

supportedFormats

array(SerializationFormat)

0..N

Indicates the serialization format(s) that are supported by the SCS/AS on the associated RDS port.

This attribute is supplied by the SCS/AS.

Rds_serialization_format

configuredFormat

SerializationFormat

0..1

Indicates the serialization format that has been configured/negotiated for the RDS port.

This attribute is supplied by the SCEF.

(NOTE)

Rds_serialization_format

NOTE: The same serialization format is used in the MO and MT directions.

5.6.2.1.10 Type: ManagePortNotification

This type represents a ManagePort notification of port numbers that are reserved.

Table 5.6.2.1.10-1: Definition of type ManagePortNotification

Attribute name

Data type

Cardinality

Description

Applicability

niddConfiguration

Link

1

Link to the NIDD configuration resource to which this notification is related.

externalId

ExternalId

0..1

Each element uniquely identifies a user as defined in Clause 4.6.2 of 3GPP TS 23.682 [2].

(NOTE)

msisdn

Msisdn

0..1

Each element identifies the MS internal PSTN/ISDN number allocated for a UE.

(NOTE)

managedPorts

array(ManagePort)

0..N

Indicates the reserved RDS port configuration information.

NOTE: One of the properties "externalId" or "msisdn" shall be included.

5.6.2.1.11 Type: NiddDownlinkDataTransferPatch

This data type represents the parameters to request the modification of an Individual NIDD Downlink Data Delivery resource.

Table 5.6.2.1.11-1: Definition of type NiddDownlinkDataTransferPatch

Attribute name

Data type

Cardinality

Description

Applicability (NOTE 1)

data

Bytes

1

The updated non-IP data that needs to be delivered to the UE from the SCS/AS.

reliableDataService

boolean

0..1

Indicates whether the reliable data service (as defined in clause 4.5.14.3 of 3GPP TS 23.682 [2]) acknowledgement is requested.

– true: reliable data service acknowledgement is requested;

– false: reliable data service acknowledgement is not requested.

rdsPort

RdsPort

0..1

Indicates the port configuration that is used for reliable data transfer between specific applications using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]).

maximumLatency

DurationSec

0..1

It is used to indicate the maximum delay acceptable for downlink data delivery. It may be used to configure the buffer duration. A Maximum Latency of 0 indicates that buffering is not allowed.

If not provided, the SCEF determines the acceptable delay based on local polices.

priority

integer

0..1

It is used to indicate the priority of these non-IP data packets relative to other non-IP data packets.

pdnEstablishmentOption

PdnEstablishmentOptions

0..1

Indicates what the SCEF should do if the UE has not established the PDN connection and MT non-IP data needs to be sent (wait for the UE to establish the PDN connection, respond with an error cause, or send a device trigger; see step 2 of the MT NIDD Procedure in clause 5.13.3 of 3GPP TS 23.682 [2])

If PDN Connection Establishment Option is not provided with the non-IP packets, the SCEF uses the PDN Connection Establishment Option that was provided during NIDD Configuration to decide how to handle the absence of a PDN connection.

NOTE 1: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features unless stated otherwise.

5.6.2.2 Referenced structured data types

5.6.2.2.1 Introduction

This clause defines structured data types that are referenced from data structures defined in the previous clauses.

5.6.2.2.2 Type: RdsPort

This type represents the port configuration for Reliable Data Transfer. It shall comply with the provisions defined in table 5.6.2.2.2-1.

Table 5.6.2.2.2-1: Definition of RdsPort data Type

Attribute name

Data type

Cardinality

Description

portUE

Port

1

Indicates the port number on UE that is used for reliable data transfer with a specific application on UE using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]).

portSCEF

Port

1

Indicates the port number on SCEF that is used for reliable data transfer with a specific application on SCEF using RDS (as defined in clause 5.2.4 and 5.2.5 of 3GPP TS 24.250 [31]).

5.6.2.2.3 Type: GmdResult

This type represents the group message delivery result. It shall comply with the provisions defined in table 5.6.2.2.3-1.

Table 5.6.2.2.3-1: Definition of GmdResult data Type

Attribute name

Data type

Cardinality

Description

externalId

ExternalId

0..1

Each element uniquely identifies a user as defined in sublause 4.6.2 of 3GPP TS 23.682 [2].

(NOTE)

msisdn

Msisdn

0..1

Each element identifies the MS internal PSTN/ISDN number allocated for a UE.

(NOTE)

deliveryStatus

DeliveryStatus

1

Indicates the MT NIDD delivery status.

requestedRetransmissionTime

DateTime

0..1

Identifies the absolute time at which the UE will be reachable.

This parameter may be supplied by the SCEF for delivery status "FAILURE_TEMPORARILY_NOT_REACHABLE"

NOTE: One of the properties "externalId" or "msisdn" shall be included.

5.6.2.2.4 Type: NiddDownlinkDataDeliveryFailure

This type represents the failure delivery result. It shall comply with the provisions defined in table 5.6.2.2.4-1.

Table 5.6.2.2.4-1: Definition of NiddDownlinkDataDeliveryFailure data Type

Attribute name

Data type

Cardinality

Description

problemDetail

ProblemDetails

1

Detailed problem as defined in clause 5.2.1.2.12.

requestedRetransmissionTime

DateTime

0..1

Identifies the absolute time at which the UE will be reachable.

This parameter may be supplied by the SCEF for error indicating "TEMPORARILY_NOT_REACHABLE"

5.6.2.2.5 Type: RdsDownlinkDataDeliveryFailure

This type represents the failure delivery result for RDS. It shall comply with the provisions defined in table 5.6.2.2.5-1.

Table 5.6.2.2.5-1: Definition of RdsDownlinkDataDeliveryFailure data Type

Attribute name

Data type

Cardinality

Description

requestedRetransmissionTime

DateTime

0..1

Identifies the absolute time at which the UE will be reachable.

This parameter may be supplied by the SCEF for error indicating "TEMPORARILY_NOT_REACHABLE"

supportedUeFormats

array(SerializationFormat)

0..N

Indicates the serialization format(s) that are supported by the UE on the associated RDS port.

This parameter may be supplied by the SCEF for error indicating " SERIALIZATION_FORMAT_NOT_SUPPORTED"

NOTE: This data type also contains all the properties defined for ProblemDetails data type in clause 5.2.1.2.12.

5.6.2.3 Referenced simple data types and enumerations

5.6.2.3.1 Introduction

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

5.6.2.3.2 Simple data types

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

Table 5.6.2.3.2-1: Simple data types

Type name

Description

5.6.2.3.3 Enumeration: PdnEstablishmentOptions

The enumeration PdnEstablishmentOptions represents PDN establishment options that describe the network behaviour when there is no PDN connection towards the addressed UE.

Table 5.6.2.3.3-1: Enumeration PdnEstablishmentOptions

Enumeration value

Description

Applicability (NOTE)

WAIT_FOR_UE

wait for the UE to establish the PDN connection

INDICATE_ERROR

respond with an error cause

SEND_TRIGGER

send a device trigger

NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.6.2.3.4 Enumeration: DeliveryStatus

The enumeration DeliveryStatus represents the status of a downlink NIDD data delivery resource.

Table 5.6.2.3.4-1: Enumeration DeliveryStatus

Enumeration value

Description

Applicability (NOTE)

SUCCESS

Success but details not provided

SUCCESS_NEXT_HOP_ACKNOWLEDGED

Successful delivery to the next hop with acknowledgment.

SUCCESS_NEXT_HOP_UNACKNOWLEDGED

Successful delivery to the next hop without acknowledgment

SUCCESS_ACKNOWLEDGED

Reliable delivery was acknowledged by the UE

SUCCESS_UNACKNOWLEDGED

Reliable delivery was not acknowledged by the UE

TRIGGERED

The SCEF triggered the device and is buffering the data.

BUFFERING

The SCEF is buffering the data due to no PDN connection established.

BUFFERING_TEMPORARILY_NOT_REACHABLE

The SCEF has been informed that the UE is temporarily not reachable but is buffering the data

SENDING

The SCEF has forwarded the data, but they may be stored elsewhere.

FAILURE

Delivery failure but details not provided

FAILURE_RDS_DISABLED

RDS was disabled.

FAILURE_NEXT_HOP

Unsuccessful delivery to the next hop.

FAILURE_TIMEOUT

Unsuccessful delivery due to timeout.

FAILURE_TEMPORARILY_NOT_REACHABLE

The SCEF has been informed that the UE is temporarily not reachable without buffering the data.

NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.6.2.3.5 Enumeration: NiddStatus

The enumeration NiddStatus represents the status of a NIDD configuration.

Table 5.6.2.3.5-1: Enumeration NiddStatus

Enumeration value

Description

Applicability (NOTE)

ACTIVE

The NIDD configuration is active.

TERMINATED_UE_NOT_AUTHORIZED

The NIDD configuration was terminated because the UE´s authorisation was revoked.

TERMINATED

The NIDD configuration was terminated.

RDS_PORT_UNKNOWN

The RDS port is unknown.

Rds_port_verification

NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no feature are indicated, the related property applies for all the features.

5.6.2.3.6 Enumeration: PdnEstablishmentOptionsRm

The enumeration PdnEstablishmentOptionsRm represents PDN establishment options that describe the network behaviour when there is no PDN connection towards the addressed UE. It is defined in clause 5.6.2.3.3 but also allows null value (specified as "NullValue" data type) so it can be removed in "JSON Merge Patch", as defined in IETF RFC 7396 [39].

Table 5.6.2.3.6-1: Enumeration PdnEstablishmentOptionsRm

Enumeration value

Description

Applicability (NOTE)

WAIT_FOR_UE

wait for the UE to establish the PDN connection

INDICATE_ERROR

respond with an error cause

SEND_TRIGGER

send a device trigger

NOTE: Properties marked with a feature as defined in clause 5.6.4 are applicable as described in clause 5.2.7. If no features are indicated, the related property applies for all the features.

5.6.2.3.7 Enumeration: ManageEntity

The enumeration ManageEntity represents the origin that manages the RDS port.

Table 5.6.2.3.7-1: Enumeration ManageEntity

Enumeration value

Description

Applicability

UE

Representing the UE.

AS

Representing the Application Server

5.6.2.3.8 Enumeration: SerializationFormat

The enumeration SerializationFormat represents a serialization format associated with an RDS port which is applicable for the Rds_serialization_format feature.

Table 5.6.2.3.8-1: Enumeration SerializationFormat

Enumeration value

Description

Applicability (NOTE)

CBOR

The CBOR Serialzition format

JSON

The JSON Serialzition format

XML

The XML Serialzition format

5.6.3 Resource structure

5.6.3.1 General

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

{apiRoot}/3gpp-nidd/v1

"apiRoot" is set as described in clause 5.2.4. "apiName" shall be set to "3gpp-nidd" 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.6.3.1-1: Resources and methods overview

Resource name

Resource URI

HTTP method

HTTP initiator

Meaning

NIDD configurations

/{scsAsId}/configurations

GET

SCS/AS

Read all NIDD configuration resources for a given SCS/AS.

POST

SCS/AS

Create a new NIDD configuration resource.

Individual NIDD configuration

/{scsAsId}/configurations/{configurationId}

PATCH

SCS/AS

Modify an existing NIDD configuration resource.

GET

SCS/AS

Read an NIDD configuration resource.

DELETE

SCS/AS

Delete an existing NIDD configuration resource.

NIDD downlink data deliveries

/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries

GET

SCS/AS

Read all pending NIDD downlink data delivery resources related to a particular NIDD configuration resource.

POST

SCS/AS

Create an NIDD downlink data delivery resource related to a particular NIDD configuration resource.

Individual NIDD downlink data delivery

/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries/{downlinkDataDeliveryId}

PUT

SCS/AS

Replace an Individual NIDD downlink data delivery resource.

PATCH

SCS/AS

Modify an Individual NIDD downlink data delivery resource.

DELETE

SCS/AS

Delete an NIDD downlink data delivery resource.

GET

SCS/AS

Read pending NIDD downlink data delivery resource.

ManagePort Configurations

/{scsAsId}/configurations/{configurationId}/rds-ports

GET

SCS/AS

Read all RDS ManagePort Configurations.

Individual ManagePort Configuration

/{scsAsId}/configurations/{configurationId}/rds-ports/{portId}

PUT

SCS/AS

Create a new Individual ManagePort Configuration resource to reserve port numbers.

DELETE

SCS/AS

Delete an Individual ManagePort Configuration resource to release port numbers.

GET

SCS/AS

Read an Individual ManagePort Configuration resource to query port numbers.

5.6.3.2 Resource: NIDD Configurations

5.6.3.2.1 Introduction

This resource allows the SCS/AS to create an NIDD configuration at the SCEF, and read all NIDD configurations in the SCEF.

5.6.3.2.2 Resource definition

Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations

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

Table 5.6.3.2.2-1: Resource URI variables for resource "NIDD Configurations"

Name

Data type

Definition

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

5.6.3.2.3 Resource methods
5.6.3.2.3.1 GET

The GET method allows to read all active NIDD configurations for a given SCS/AS. 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.6.3.2.3.1-1 and table 5.6.3.2.3.1-2.

Table 5.6.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.6.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(NiddConfiguration)

0..N

200 OK

The configuration information for the SCS/AS in the request URI are 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.6.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.6.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.6.3.2.3.2 PUT

This HTTP method is not supported for the resource.

5.6.3.2.3.3 PATCH

This HTTP method is not supported for the resource.

5.6.3.2.3.4 POST

To create a NIDD configuration, the SCS/AS shall use the HTTP POST method on the "configurations" collection resource as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.2-1.

The possible response messages from the SCEF, depending on whether the POST request is successful or unsuccessful, are shown in table 5.6.3.2.3.4-1.

Table 5.6.3.2.3.4-1: Data structures supported by the POST request/response by the resource

Request body

Data type

Cardinality

Remarks

NiddConfiguration

1

Parameters to create and authorize a NIDD configuration with the SCEF.

Response body

Data type

Cardinality

Response

codes

Remarks

NiddConfiguration

1

201 Created

The NIDD configuration was created successfully.

The SCEF shall return a data structure of type "NiddConfiguration" in the response payload body.

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 also apply.

Table 5.6.3.2.3.4-2: 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-nidd/v1/{scsAsId}/configurations/{configurationId}

5.6.3.2.3.5 DELETE

This HTTP method is not supported for the resource.

5.6.3.3 Resource: Individual NIDD Configuration

5.6.3.3.1 Introduction

This resource allows the SCS/AS to query/update/cancel the specific NIDD configuration at the SCEF.

5.6.3.3.2 Resource definition

Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}

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

Table 5.6.3.3.2-1: Resource URI variables for resource "Individual NIDD 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. The configurationId corresponds to the stage 2 TLTRI.

5.6.3.3.3 Resource methods
5.6.3.3.3.1 GET

The GET method allows to read a NIDD configuration resource to obtain details of an active configuration. 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.6.3.3.3.1-1 and table 5.6.3.3.3.1-2.

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

Name

Data type

Cardinality

Remarks

none specified

Table 5.6.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

NiddConfiguration

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.6.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.6.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.6.3.3.3.2 PUT

This HTTP method is not supported for the resource.

5.6.3.3.3.3 PATCH

Assuming that a NIDD configuration has been created using the HTTP POST method described in clause 5.6.3.2.3.4, partial updating of its properties can be performed by the SCS/AS by using the HTTP PATCH method on the "configuration" instance resource as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.2-1

The possible response messages from the SCEF, depending on whether the PATCH request is successful or unsuccessful, are shown in table 5.6.3.3.3.3-1.

Table 5.6.3.3.3.3-1: Data structures supported by the PATCH request/response by the resource

Request body

Data type

Cardinality

Remarks

NiddConfigurationPatch

1

Parameters to update a NIDD configuration with the SCEF.

Response body

Data type

Cardinality

Response

codes

Remarks

NiddConfiguration

1

200 OK

The NIDD configuration was modified successfully.

The SCEF shall return an updated data structure of type "NiddConfiguration" in the response payload body.

None

204 No Content

The NIDD configuration has been modified successfully and no content is to be sent in the response message body.

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.

NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.6-1 also apply.

Table 5.6.3.3.3.3-2: 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.6.3.3.3.3-3: 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.6.3.3.3.4 POST

This HTTP method is not supported for the resource.

5.6.3.3.3.5 DELETE

To cancel a NIDD configuration, the SCS/AS shall use the HTTP DELETE method on the individual "NIDD configuration" resource which is indicated by the URI in the Location header of the HTTP POST response:

The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.6.3.3.3.5-1.

Table 5.6.3.3.3.5-1.: Data structures supported by the DELETE request/response by the resource

Request body

Data type

Cardinality

Remarks

none

.

Response body

Data type

Cardinality

Response

codes

Remarks

NiddConfiguration

1

200 OK

The NIDD configuration was cancelled successfully.

The SCEF shall return a full representation of the deleted resource including a data structure of type "NiddConfiguration" with a "TERMINATE" status in the response body.

None

204 No Content

The NIDD configuration was cancelled 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.6.3.3.3.5-2: 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.6.3.3.3.5-3: 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.6.3.4 Resource: NIDD downlink data deliveries

5.6.3.4.1 Introduction

This resource allows the SCS/AS to read all pending NIDD downlink data delivery resources for a particular NIDD configuration resource.

This resource also allows the SCS/AS to create an NIDD downlink data delivery.

This resource is applicable for a single UE and a group of UEs NIDD MT delivery.

5.6.3.4.2 Resource definition

Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries

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

Table 5.6.3.4.2-1: Resource URI variables for resource "NIDD Downlink Data Deliveries"

Name

Data type

Definition

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

configurationId

string

Identifier of the configuration.

5.6.3.4.3 Resource methods
5.6.3.4.3.1 GET

The GET method allows to read all pending NIDD downlink data deliveries for a given SCS/AS and NIDD configuration. 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.6.3.4.3.1-1 and table 5.6.3.4.3.1-2.

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

Name

Data type

Cardinality

Remarks

none specified

Table 5.6.3.4.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(NiddDownlinkDataTransfer)

0..N

200 OK

All pending NIDD downlink data deliveries for the SCS/AS and NIDD configuration in the request URI are 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.6.3.4.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.6.3.4.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.6.3.4.3.2 PUT

This HTTP method is not supported for the resource.

5.6.3.4.3.3 PATCH

This HTTP method is not supported for the resource.

5.6.3.4.3.4 POST

To deliver the downlink non-IP data, the SCS/AS shall use the HTTP POST method on the "NIDD downlink data deliveries" resource with the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.3-1.

The possible response messages from the SCEF, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.6.3.4.3.4-1.

Table 5.6.3.4.3.4-1: Data structures supported by the POST request/response by the resource

Request body

Data type

Cardinality

Remarks

NiddDownlinkDataTransfer

1

The parameters and non-IP data for the MT delivery.

Response body

Data type

Cardinality

Response

codes

Remarks

NiddDownlinkDataTransfer

1

200 OK

The NIDD downlink data delivery was successful.

The SCEF shall return a data structure of type "NiddDownlinkDataTransfer" in the response payload body.

NiddDownlinkDataTransfer

1

201 Created

The NIDD downlink data delivery request was accepted by the SCEF, the NIDD will be performed later.

The SCEF shall return a data structure of type "NiddDownlinkDataTransfer" in the response payload body, and shall return the URI of the resource representing the downlink data transfer in the "Location" header.

None

307 Temporary Redirect

Temporary redirection, during NIDD downlink data delivery. 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 NIDD downlink data delivery. 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.

NiddDownlinkDataDeliveryFailure

0..1

500 Internal Server Error

(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.6.5.3.

Table 5.6.3.4.3.4-2: 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.6.3.4.3.4-3: 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.

Table 5.6.3.4.3.4-2: 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-nidd/v1/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries/{downlinkDataDeliveryId}

5.6.3.4.3.5 DELETE

This HTTP method is not supported for the resource.

5.6.3.5 Resource: Individual NIDD downlink data delivery

5.6.3.5.1 Introduction

For NIDD MT delivery for a single UE, this resource allows the SCS/AS to read a pending NIDD downlink delivery resource, or to replace or cancel an NIDD downlink data delivery resource related to an NIDD configuration resource.

For NIDD MT delivery for a group of UEs, this resource allows the SCS/AS to read a pending NIDD downlink delivery resource related to a NIDD configuration resource.

5.6.3.5.2 Resource definition

Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/downlink-data-deliveries/{downlinkDataDeliveryId}

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

Table 5.6.3.4.2-1: Resource URI variables for resource "Individual NIDD Downlink Data Delivery"

Name

Data type

Definition

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

configurationId

string

Identifier of the configuration.

downlinkDataDeliveryId

string

Identifier of the downlink data delivery.

5.6.3.5.3 Resource methods
5.6.3.5.3.1 GET

The GET method allows to read a NIDD downlink data delivery resource to obtain details. 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.6.3.5.3.1-1 and table 5.6.3.5.3.1-2.

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

Name

Data type

Cardinality

Remarks

none specified

Table 5.6.3.5.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

NiddDownlinkDataTransfer

1

200 OK

Individual NIDD downlink data delivery resource 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.6.3.5.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.6.3.5.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.6.3.5.3.2 PUT

To replace the buffered downlink non-IP data, the SCS/AS shall use the HTTP PUT method on the "Individual NIDD downlink data delivery" resource with the body of the message encoded in JSON format with the data structure defined in table 5.6.2.1.3-1.

The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.6.3.5.3.2-1.

Table 5.6.3.5.3.2-1: Data structures supported by the PUT request/response by the resource

Request body

Data type

Cardinality

Remarks

NiddDownlinkDataTransfer

1

The parameters and non-IP data for the MT delivery.

Response body

Data type

Cardinality

Response

codes

Remarks

NiddDownlinkDataTransfer

1

200 OK

The update of the Individual NIDD downlink data delivery resource was successful.

The SCEF shall return an updated representation of the resource within the NiddDownlinkDataTransfer data structure in the response message body.

None

204 No Content

The update of the Individual NIDD downlink data delivery was successful and no content is to be sent in the response message body.

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)

ProblemDetails

0..1

404 Not Found

(NOTE 2)

ProblemDetails

0..1

409 Conflict

(NOTE 2)

NiddDownlinkDataDeliveryFailure

0..1

500 Internal Server Error

(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.6.5.3.

Table 5.6.3.5.3.2-2: 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.6.3.5.3.2-3: 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.6.3.5.3.3 PATCH

If the "PatchUpdate" feature defined in clause 5.7.4 is supported, to partially modify the buffered downlink non-IP data, the SCS/AS shall use the HTTP PATCH method on the "Individual NIDD downlink data delivery" resource with the body of the message encoded in JSON format with the data structure defined in table 5.6.2.1.11-1.

The possible response messages from the SCEF, depending on whether the HTTP PATCH request is successful or unsuccessful, are shown in Table 5.6.3.5.3.3-1.

Table 5.6.3.5.3.3-1: Data structures supported by the PATCH request/response by the resource

Request body

Data type

Cardinality

Remarks

NiddDownlinkDataTransferPatch

1

The parameters to modify an existing Individual NIDD downlink data delivery resource.

Response body

Data type

Cardinality

Response

codes

Remarks

NiddDownlinkDataTransfer

1

200 OK

The modification of the Individual NIDD downlink data delivery resource was successful.

The SCEF shall return an updated representation of the resource within the NiddDownlinkDataTransfer data structure in the response message body.

n/a

204 No Content

The modification of the Individual NIDD downlink data delivery resource was successful and no content is to be sent in the response message body.

n/a

307 Temporary Redirect

Temporary redirection. 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.

n/a

308 Permanent Redirect

Permanent redirection. 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)

ProblemDetails

0..1

404 Not Found

(NOTE 2)

ProblemDetails

0..1

409 Conflict

(NOTE 2)

NiddDownlinkDataDeliveryFailure

0..1

500 Internal Server Error

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the HTTP PATCH method listed in table 5.2.6-1 also apply.

NOTE 2: Failure cases are described in clause 5.6.5.3.

Table 5.6.3.5.3.3-2: 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.6.3.5.3.3-3: 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.6.3.5.3.4 POST

This HTTP method is not supported for the resource.

5.6.3.5.3.5 DELETE

To cancel a NIDD downlink data delivery, the SCS/AS shall use the HTTP DELETE method on the "Individual NIDD downlink data delivery" resource which is indicated by the URI in the Location header of the HTTP POST response:

The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in table 5.6.3.3.3.5-1.

Table 5.6.3.5.3.5-1.: Data structures supported by the DELETE request/response by the resource

Request body

Data type

Cardinality

Remarks

none

.

Response body

Data type

Cardinality

Response

codes

Remarks

none

204 No Content

The NIDD downlink data delivery was cancelled 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.

ProblemDetails

0..1

403 Forbidden

(NOTE 2)

ProblemDetails

0..1

404 Not Found

(NOTE 2)

ProblemDetails

0..1

409 Conflict

(NOTE 2)

NiddDownlinkDataDeliveryFailure

0..1

500 Internal Server Error

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply.

NOTE 2: Failure cases are described in clause 5.6.5.3.

Table 5.6.3.5.3.5-2: 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.6.3.5.3.5-3: 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.6.3.6 Void

5.6.3.7 Void

5.6.3.8 Void

5.6.3.9 Resource: Individual ManagePort Configuration

5.6.3.9.1 Introduction

This resource allows the SCS/AS to create, delete or read the specific ManagePort configuration at the SCEF.

5.6.3.9.2 Resource definition

Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/rds-ports/{portId}

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

Table 5.6.3.9.2-1: Resource URI variables for resource "Individual ManagePort 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. The configurationId corresponds to the stage 2 TLTRI.

portId

string

UE port identifier including both UE port number and exposure function port number.

Pattern: "^(ue([0-9]|(1[0-5]))-ef([0-9]|(1[0-5])))$".

5.6.3.9.3 Resource methods
5.6.3.9.3.1 GET

The GET method allows to read a ManagePort configuration resource to query the ports reserved. 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.6.3.9.3.1-1 and table 5.6.3.9.3.1-2.

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

Name

Data type

Cardinality

Remarks

none specified

Table 5.6.3.9.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

ManagePort

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.6.3.9.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.6.3.9.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.6.3.9.3.2 PUT

To create a ManagePort configuration and reserve a port number, the SCS/AS shall use the HTTP PUT method on the "ManagePort" resource with the body of the message is encoded in JSON format with the data structure defined in table 5.6.3.9.3.2-1.

The possible response messages from the SCEF, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.6.3.9.3.2-1.

Table 5.6.3.9.3.2-1: Data structures supported by the PUT request/response by the resource

Request body

Data type

Cardinality

Remarks

ManagePort

1

The ManagePort configuration to be created which represents the information used for reserving the port configuration for an application.

Response body

Data type

Cardinality

Response

codes

Remarks

ManagePort

1

201 Created

This indicates the reservation of port configuration for specified application is successful.

None

202 Accepted

This indicates the request for reservation of port configuration for specified application is accepted and under processing.

ProblemDetails

0..1

403 Forbidden

(NOTE 2)

RdsDownlinkDataDeliveryFailure

0..1

500 Internal Server Error

(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.6.5.3.

5.6.3.9.3.3 PATCH

This HTTP method is not supported for the resource.

5.6.3.9.3.4 POST

This HTTP method is not supported for the resource.

5.6.3.9.3.5 DELETE

To cancel a ManagePort configuration and release port numbers, the SCS/AS shall use the HTTP DELETE method on the ManagePort resource which is indicated by the URI in the Location header of the HTTP POST response:

The possible response messages from the SCEF, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.6.3.9.3.5-1.

Table 5.6.3.9.3.5-1.: Data structures supported by the DELETE request/response by the resource

Request body

Data type

Cardinality

Remarks

ManagePort

1

The ManagePort configuration to be cancelled which represents the information used for releasing the port configuration for an application

Response body

Data type

Cardinality

Response

codes

Remarks

None

204 No Content

The ManagePort configuration was cancelled successfully and the port configuration was released.

None

202 Accepted

This indicates the request for cancellation of port configuration for specified application is accepted and under processing.

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.

ProblemDetails

0..1

404 Not Found

(NOTE 2)

RdsDownlinkDataDeliveryFailure

0..1

500 Internal Server Error

(NOTE 2)

NOTE 1: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.6-1 also apply.

NOTE 2: Failure cases are described in clause 5.6.5.3.

Table 5.6.3.9.3.5-2: 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.6.3.9.3.5-3: 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.6.3.10 Void

5.6.3.11 Resource: ManagePort Configurations

5.6.3.11.1 Introduction

This resource allows the SCS/AS to read all ManagePort configurations for a given NIDD configuration at the SCEF.

5.6.3.11.2 Resource definition

Resource URI: {apiRoot}/3gpp-nidd/v1/{scsAsId}/configurations/{configurationId}/rds-ports

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

Table 5.6.3.11.2-1: Resource URI variables for resource "ManagePort Configurations"

Name

Data type

Definition

apiRoot

string

See clause 5.2.4.

scsAsId

string

Identifier of the SCS/AS.

configurationId

string

Identifier of the configuration of type string. The configurationId corresponds to the stage 2 TLTRI.

5.6.3.11.3 Resource methods
5.6.3.11.3.1 GET

The GET method allows to read all ManagePort configurations on the SCEF. 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.6.3.11.3.1-1 and table 5.6.3.11.3.1-2.

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

Name

Data type

Cardinality

Remarks

none specified

Table 5.6.3.11.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(ManagePort)

0..N

200 OK

All RDS dynamic port configuration information related to the request URI are 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.6.3.11.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.6.3.11.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.6.3.11.3.2 PUT

This HTTP method is not supported for the resource.

5.6.3.11.3.3 PATCH

This HTTP method is not supported for the resource.

5.6.3.11.3.4 POST

This HTTP method is not supported for the resource.

5.6.3.11.3.5 DELETE

This HTTP method is not supported for the resource.

5.6.3A Notifications

5.6.3A.1 General

The notifications provided by the NIDD API are specified in this clause.

Table 5.6.3A-1: Notifications overview

Notification

Callback URI

HTTP method or custom operation

Description

(service operation)

NIDD Configuration Update Notification

{notification_uri}

POST

Send notifications about the status of an NIDD configuration to the SCS/AS.

NIDD Downlink Data Delivery Status Notification

{notification_uri}

POST

Report a specific NIDD downlink data delivery result to the SCS/AS.

NIDD Uplink Data Notification

{notification_uri}

POST

Send an uplink non-IP data notification from the SCEF to the SCS/AS.

ManagePort Notification

{notification_uri}

POST

Send notifications about the port numbers that are reserved.

5.6.3A.2 NIDD Configuration Update Notification

5.6.3A.2.1 Description

The NIDD Configuration Update Notification allows the SCEF to send notifications about the status of an NIDD configuration to the SCS/AS.

5.6.3A.2.2 Target URI

The Callback URI "{notification_uri}" shall be used with the callback URI variables defined in table 5.6.3A.2.2-1.

Table 5.6.3A.2.2-1: Callback URI variables

Name

Data type

Definition

notification_uri

Link

A URI indicating the notification destination where T8 notification requests shall be delivered.

This URI shall be provided within the "notificationDestination" attribute in the NiddConfiguration type.

5.6.3A.2.3 Standard Methods
5.6.3A.2.3.1 Notification via POST

To report the status of the NIDD configuration to the SCS/AS, the SCEF shall use the HTTP POST method on the notification point as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.6-1.

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

Table 5.6.3A.2.3.1-1: Data structures supported by the POST Request Body

Data type

Cardinality

Description

NiddConfigurationStatusNotification

1

The NIDD configuration status notification.

Table 5.6.3A.2.3.1-2: Data structures supported by the POST Response Body

Data type

Cardinality

Response codes

Description

Acknowledgement

1

200 OK

The successful acknowledgement of the notification with a body.

(None)

204 No Content

The successful acknowledgement of the notification without a body.

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.6.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.6.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.6.3A.2.3.2 Notification via Websocket

If supported by both SCS/AS and SCEF and successfully negotiated, the NiddConfigurationStatusNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4.

5.6.3A.3 NIDD Downlink Data Delivery Status Notification

5.6.3A.3.1 Description

The NIDD Downlink Data Delivery Status Notification allows the SCEF to send notifications about the status of downlink NIDD data delivery to the SCS/AS. This resource is applicable for a single UE and a group of UEs NIDD MT delivery.

5.6.3A.3.2 Target URI

The Callback URI "{notification_uri}" shall be used with the callback URI variables defined in table 5.6.3A.3.2-1.

Table 5.6.3A.3.2-1: Callback URI variables

Name

Data type

Definition

notification_uri

Link

A URI indicating the notification destination URI where T8 notification requests shall be delivered.

This URI shall be provided within the "notificationDestination" attribute in the NiddConfiguration type.

5.6.3A.3.3 Standard Methods
5.6.3A.3.3.1 Notification via POST

To report the delivery status of the downlink non-IP data delivery, the SCEF shall use the HTTP POST method on the notification endpoint with the body of the message encoded in JSON format with the data structure defined in table 5.6.2.1.5-1 for a single UE or table 5.6.2.1.8-1 for a group of UEs.

This method shall support the request and response data structures specified in table 5.6.3A.3.3.1-1 and table 5.6.3A.3.3.1-2 for a single UE, and support the request and response data structures specified in table 5.6.3A.3.3.1-3 and table 5.6.3A.3.3.1-4 for a group of UEs.

Table 5.6.3A.3.3.1-1: Data structures supported by the POST Request Body

Data type

Cardinality

Description

NiddDownlinkDataDeliveryStatusNotification

1

The Down link data delivery status notification for a single UE.

Table 5.6.3A.3.3.1-2: Data structures supported by the POST Response Body

Data type

Cardinality

Response codes

Description

Acknowledgement

1

200 OK

The successful acknowledgement of the notification.

(None)

204 No Content

The successful acknowledgement of the notification without a body.

None

307 Temporary Redirect

Temporary redirection, during event 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 event 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.6.3A.3.3.1-3: Data structures supported by the POST Request Body

Data type

Cardinality

Description

GmdNiddDownlinkDataDeliveryStatusNotification

1

The Down link data delivery status notification for a group of UEs.

Table 5.6.3A.3.3.1-4: Data structures supported by the POST Response Body

Data type

Cardinality

Response codes

Description

Acknowledgement

1

200 OK

The successful acknowledgement of the notification.

(None)

204 No Content

The successful acknowledgement of the notification without a body.

None

307 Temporary Redirect

Temporary redirection, during event 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 event 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.6.3A.3.3.1-5: 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.6.3A.3.3.1-6: 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.6.3A.3.3.2 Notification via Websocket

If supported by both SCS/AS and SCEF and successfully negotiated, the NiddDownlinkDataDeliveryStatusNotification or GmdNiddDownlinkDataDeliveryStatusNotification may alternatively be delivered for a single UE or a group of UEs through the Websocket mechanism as defined in clause 5.2.5.4.

5.6.3A.4 NIDD Uplink Data Notification

5.6.3A.4.1 Description

The NIDD Uplink Data Notification allows the SCEF to send notifications about received NIDD uplink data..

5.6.3A.4.2 Target URI

The Callback URI "{notification_uri}" shall be used with the callback URI variables defined in table 5.6.3A.4.2-1.

Table 5.6.3A.4.2-1: Callback URI variables

Name

Data type

Definition

notification_uri

Link

A URI indicating the notification destination URI where T8 notification requests shall be delivered.

This URI shall be provided within the "notificationDestination" attribute in the NiddConfiguration type.

5.6.3A.4.3 Standard Methods
5.6.3A.4.3.1 Notification via POST

To send the uplink non-IP data to the SCS/AS, the SCEF shall use the HTTP POST method on the notification endpoint in SCS/AS as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.4-1.

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

Table 5.6.3A.4.3.1-1: Data structures supported by the POST Request Body

Data type

Cardinality

Description

NiddUplinkDataNotification

1

The parameters and non-IP data for the NIDD uplink non-IP data notification.

Table 5.6.3A.4.3.1-2: Data structures supported by the POST Response Body

Data type

Cardinality

Response codes

Description

Acknowledgement

1

200 OK

The successful acknowledgement of the uplink data notification

(None)

204 No Content

The successful acknowledgement of the notification without a body.

None

307 Temporary Redirect

Temporary redirection, during event 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 event 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.6.3A.4.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.6.3A.4.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.6.3A.4.3.2 Notification via Websocket

If supported by both SCS/AS and SCEF and successfully negotiated, the NiddUplinkDataNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4.

5.6.3A.5 ManagePort Notification

5.6.3A.5.1 Description

The ManagePort Notification allows the SCEF to send notifications about the port numbers that are reserved.

5.6.3A.5.2 Target URI

The Callback URI "{notification_uri}" shall be used with the callback URI variables defined in table 5.6.3A.5.2-1.

Table 5.6.3A.5.2-1: Callback URI variables

Name

Data type

Definition

notification_uri

Link

A URI indicating the notification destination URI where T8 notification requests shall be delivered.

This URI shall be provided within the "notificationDestination" attribute in the NiddConfiguration type.

5.6.3A.5.3 Standard Methods
5.6.3A.5.3.1 Notification via POST

To send the information about reserved ports and their configuration to the SCS/AS, the SCEF shall use the HTTP POST method on the notification endpoint in SCS/AS as follows:

– the body of the message is encoded in JSON format with the data structure defined in table 5.6.2.1.10-1.

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

Table 5.6.3A.5.3.1-1: Data structures supported by the POST Request Body

Data type

Cardinality

Description

ManagePortNotification

1

The parameters that represents the information about port numbers that are reserved for use with an application.

Table 5.6.3A.5.3.1-2: Data structures supported by the POST Response Body

Data type

Cardinality

Response codes

Description

Acknowledgement

1

200 OK

The successful notification of reserved port configuration.

(None)

204 No Content

The successful acknowledgement of the reserved port configuration without a body.

None

307 Temporary Redirect

Temporary redirection, during event 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 event 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.6.3A.5.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.6.3A.5.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.6.3A.5.3.2 Notification via Websocket

If supported by both SCS/AS and SCEF and successfully negotiated, the ManagePortNotification may alternatively be delivered through the Websocket mechanism as defined in clause 5.2.5.4.

5.6.4 Used Features

The table below defines the features applicable to the NIDD API. Those features are negotiated as described in clause 5.2.7.

Table 5.6.4-1: Features used by NIDD API

Feature Number

Feature

Description

1

GroupMessageDelivery

This feature indicates the support of group message delivery via MT NIDD as defined in clause 5.5.3 of 3GPP TS 23.682 [2].

2

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.

3

Notification_test_event

The testing of notification connection is supported according to clause 5.2.5.3.

4

MT_NIDD_modification_cancellation

Modification and cancellation of an individual MT NIDD resource.

5

Rds_port_verification

This feature indicates the support of RDS port verification in the MO/MT NIDD delivery.

6

Rds_dynamic_port

This feature indicates the support of RDS dynamic port management.

7

Rds_serialization_format

This feature indicates the support of RDS Serialization Format reservation, notification, and query. This feature requires that the Rds_dynamic_port is also supported.

8

PatchUpdate

Indicates the support of enhancements to the northbound interfaces (e.g. support the partial modification of an existing subscription resource).

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.6.5 Error handling

5.6.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.6.5.2 Protocol Errors

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

5.6.5.3 Application Errors

The application errors defined for the NIDD API are listed in table 5.6.5.3-1.

Table 5.6.5.3-1: Application errors

Application Error

HTTP status code

Description

Applicability

QUOTA_EXCEEDED

403 Forbidden

Not enough quota for the MT NIDD

DATA_TOO_LARGE

403 Forbidden

The non-IP data size is larger than "maximumPacketSize" of the NIDD configuration.

RDS_PORT_UNKNOWN

403 Forbidden

The SCEF does not know the RDS port numbers in the MT NIDD, such port numbers does not match with the configured port numbers.

Rds_port_verification

OPERATION_PROHIBITED

403 Forbidden

Indicates the operation is prohibited.

PORT_NOT_FREE

403 Forbidden

Port is not free as it is already associated with an application

Rds_dynamic_port

ALREADY_DELIVERED

404 Not Found

The SCEF has already delivered the buffered data.

PORT_NOT_ASSOC_WITH_APP

404 Not Found

Port is free and is not associated with any application.

Rds_dynamic_port

SENDING

409 Conflict

The SCEF is already in sending the buffered non-IP data.

TRIGGERED

500 Internal Server Error

The SCEF triggered the device but did not buffer the data. The SCS AS may resubmit the data

TEMPORARILY_NOT_REACHABLE

500 Internal Server Error

The SCEF has aborted the delivery because the UE is temporarily not reachable. The SCEF may in addition indicate a requested re-submission time for the data.

NEXT_HOP

500 Internal Server Error

Unsuccessful delivery to the next hop.

TIMEOUT

500 Internal Server Error

Unsuccessful delivery due to timeout.

NO_PDN_CONNECTION

500 Internal Server Error

The SCEF cannot proceed since there is no PDN connection.

SERIALIZATION_FORMAT_NOT_SUPPORTED

500 Internal Server Error

The SCEF was not able to configure a Serialization Format for the port

Rds_serialization_format