Service Provisioning Subscriptions

/subscriptions

POST

Creates a new subscription in ECS in order to be notified of provisioning data changes of interest.

Individual Service Provisioning Subscription

/subscriptions/{subscriptionId}

PUT

Updates an existing individual service provisioning subscription identified by the subscriptionId

DELETE

Deletes an existing individual service provisioning subscription identified by the subscriptionId.

PATCH

Partial update an existing individual service provisioning subscription identified by the subscriptionId.

apiRoot

String

See clause 7.5 of 3GPP TS 29.558 [4]

n/a

ECSServProvSubscription

M

1

Create a new service provisioning subscription.

ECSServProvSubscription

M

1

201 Created

Individual ECS Service Provisioning Subscription resource created successfully.

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

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

Location

String

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/eecs-serviceprovisioning/<apiVersion>/subscriptions/{subscriptionId}

apiRoot

string

See clause 7.5 of 3GPP TS 29.558 [4]

subscriptionId

string

Identifies an individual service provisioning subscription.

n/a

ECSServProvSubscription

M

1

Details of individual service provisioning subscription matching the subscriptionId to be updated at the ECS.

ECSServProvSubscription

M

1

200 OK

The individual service provisioning subscription matching the subscriptionId was modified successfully and the updated information is returned in the response.

n/a

204 No Content

The individual service provisioning subscription matching the subscriptionId was modified successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status code for the PUT method listed in Table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative ECS.

Location

string

M

1

An alternative URI of the resource located in an alternative ECS.

n/a

n/a

n/a

M

1

204 No Content

The individual service provisioning subscription matching the subscriptionId is deleted.

n/a

307 Temporary Redirect

Temporary redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource termination. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative ECS.

Location

string

M

1

An alternative URI of the resource located in an alternative ECS.

n/a

ECSServProvSubscriptionPatch

M

1

Details of individual service provisioning subscription matching the subscriptionId to be updated at the ECS.

ECSServProvSubscription

M

1

200 OK

The individual service provisioning subscription matching the subscriptionId was modified successfully and the updated information is returned in the response.

n/a

204 No Content

The individual service provisioning subscription matching the subscriptionId was modified successfully.

n/a

307 Temporary Redirect

Temporary redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection, during resource modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative ECS. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

NOTE: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative URI of the resource located in an alternative ECS.

Location

string

M

1

An alternative URI of the resource located in an alternative ECS.

Request

/request

POST

Enables an EEC to request service provisioning information to the ECS.

ECSServProvReq

M

1

Contains the parameters to request service provisioning information.

ECSServProvResp

M

1

200 OK

The requested service provisioning information is returned successfully.

n/a

204 No Content

The requested service provisioning information does not exist.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative ECS.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3]

NOTE: The manadatory HTTP error status code for the HTTP POST method listed in Table 5.2.6-1 of 3GPP TS 29.122 [3] also apply.

Location

string

M

1

An alternative target URI located in an alternative ECS.

Location

string

M

1

An alternative target URI located in an alternative ECS.

Service Provisioning Notification

{notificationDestination}

POST

Notifies EEC of the service provisioning information of interest.

n/a

ServProvNotification

M

1

Notification of service provisioning information.

n/a

204 No Content

The receipt of the Notification is acknowledged.

n/a

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EEC where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

n/a

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing an alternative URI representing the end point of an alternative EEC where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [3].

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

Location

string

M

1

An alternative URI representing the end point of an alternative EEC towards which the notification should be redirected.

Location

string

M

1

An alternative URI representing the end point of an alternative EEC towards which the notification should be redirected.

ECSServProvReq

8.1.5.2.2

ECSServProvResp

8.1.5.2.3

ECSServProvSubscription

8.1.5.2.4

Represents the service provisioning subscription.

ConnectivityInfo

8.1.5.2.5

ServProvNotification

8.1.5.2.6

Service provisioning information notification from ECS to EEC.

EDNConfigInfo

8.1.5.2.7

EDNConInfo

8.1.5.2.8

EESInfo

8.1.5.2.9

PlmnId

3GPP TS 29.571 [5]

ACProfile

clause 6.2.5.2.3

DateTime

3GPP TS 29.122 [3]

Uri

3GPP TS 29.122 [3]

SupportedFeatures

3GPP TS 29.571 [5]

Used to negotiate the applicability of optional features.

Snssai

3GPP TS 29.571 [5]

LocationArea5G

3GPP TS 29.122 [3]

EndPoint

3GPP TS 29.558 [4]

Dnai

3GPP TS 29.571 [5]

LocationInfo

3GPP TS 29.122 [3]

The location information related to the UE.

Dnn

3GPP TS 29.571 [5]

Gpsi

3GPP TS 29.571 [5]

Used to identify the UE.

ACRScenario

3GPP TS 29.558 [4]

eecId

string

M

0..1

Represents a unique identifier of the EEC.

ueId

Gpsi

O

0..1

Represents the identifier of the UE.

acProfs

array(ACProfile)

O

1..N

Information about services the EEC wants to connect to.

eecSvcContSupp

array(ACRScenario)

O

0..1

The ACR scenarios supported by the EEC for service continuity. If this attribute is not present, then the EEC does not support service continuity.

connInfo

array(ConnectivityInfo)

O

0..N

List of connectivity information for the UE.

locInf

LocationInfo

O

0..1

Represents location information of the UE.

ednCnfgInfo

array(EDNConfigInfo)

M

1..N

List of EDN configuration information.

eecId

string

M

0..1

Represents a unique identifier of the EEC.

ueId

Gpsi

O

0..1

Represents the identifier of the UE.

acProfs

array(ACProfile)

O

1..N

Information about services the EEC wants to connect to.

expTime

DateTime

O

0..1

Indicates the expiration time of the subscription. If the expiration time is not present, then it indicates that the EEC subscription never expires.

eecSvcContSupp

array(ACRScenario)

O

0..1

The ACR scenarios supported by the EEC for service continuity. If this attribute is not present, then the EEC does not support service continuity.

connInfo

array(ConnectivityInfo)

O

0..N

List of connectivity information for the UE.

notificationDestination

Uri

O

1

The notification target address containing the URI where the service provisioning notification should be delivered to. This attribute shall be present in HTTP POST message to ECS. (NOTE 1)

requestTestNotification

boolean

O

0..1

Set to true by Subscriber to request the ECS to send a test notification as defined in clause 7.6 of 3GPP TS 29.558 [4]. Set to false or omitted otherwise.

Notification_test_event

websockNotifConfig

WebsockNotifConfig

O

0..1

Configuration parameters to set up notification delivery over Websocket protocol as defined in clause 7.6 of 3GPP TS 29.558 [4].

Notification_websocket

suppFeat

SupportedFeatures

O

0..1

Used to negotiate the supported optional features of the API as described in clause 7.8 of 3GPP TS 29.558 [4].

This attribute shall be provided in the HTTP POST request and in the response of successful resource creation.

This attribute also shall be provided in the HTTP PUT request and in the response of successful resource modification.

NOTE 1: The notification target address can terminate at the EEC (e.g. in an IoT device) if the deployment supports EEC reachability, or it can terminate at a push notification service. Details of the push notification service are out of scope of this release.

plmnId

PlmnId

O

0..1

Represents PLMN identity

ssId

string

O

0..1

This IE shall be present if the UE is accessing the 5GC via a trusted WLAN access network.

When present, it shall contain the SSID of the access point to which the UE is attached.

subId

string

M

1

String identifying the individual service provisioning subscription for which the service provisioning notification is delivered.

ednCnfgInfo

array(EDNConfigInfo)

M

1..N

List of EDN configuration information.

ednConInfo

EDNConInfo

M

1

Contains EDN connection information required by the UE to establish connection with the EDN

eess

array(EESInfo)

M

1..N

Contains the list of EESs of the EDN

lifeTime

DateTime

O

0..1

Indicates the time duration for which the EDN configuration information is valid and supposed to be cached in the EEC.

dnn

Dnn

O

0..1

String representing a Data Network or an APN

snssai

Snssai

O

0..1

Represents network slice information

ednTopoSrvArea

LocationArea5G

O

0..1

The list of geographical and topological areas that the ECS serves. ACs in the UE that are outside the area shall not be served.

eesId

string

M

1

The identifier of the EES

endPt

EndPoint

M

1

Endpoint information (e.g. URI, FQDN, IP address) used to communicate with the EES. This information is provided to the EEC to connect to the EES.

easIds

array(string)

O

1..N

The list of application identifiers of the Edge Application Servers registered with the EES, e.g. FQDN, URI.

ecspInfo

string

O

0..1

String representing the EES Provider (such as ECSP Information)

svcArea

LocationArea5G

O

0..1

The list of geographical and topological areas that the EES serves. EECs in the UE that are outside the area shall not be served.

dnais

array(Dnai)

O

0..1

Represents list of Data network access identifier

eesSvcContSupp

array(ACRScenario)

O

0..1

The ACR scenarios supported by the EES for service continuity. If this attribute is not present, then the EEC does not support service continuity.

eecRegConf

boolean

M

1

Indicates whether the EEC is required to register on the EES to use edge services or not

acProfs

array(ACProfile)

O

1..N

Information about services the EEC wants to connect to.

expTime

DateTime

O

0..1

Indicates the expiration time of the subscription. If the expiration time is not present, then it indicates that the EEC subscription never expires.

eecSvcContSupp

array(ACRScenario)

O

0..1

The ACR scenarios supported by the EEC for service continuity. If this attribute is not present, then the EEC does not support service continuity.

connInfo

array(ConnectivityInfo)

O

0..N

List of connectivity information for the UE.

1

Notification_test_event

Testing of notification connection is supported according to clause 7.6 of 3GPP TS 29.558 [4].

2

Notification_websocket

The delivery of notifications over Websocket is supported according to clause 7.6 of 3GPP TS 29.558 [4]. This feature requires that the Notification_test_event feature is also supported.