Application Client Information Subscriptions

/subscriptions

POST

Creates a subscription for reporting of AC information to the EAS.

Individual Application Client Information Subscription

/subscriptions/{subscriptionId}

GET

Retrieves the Individual AC information subscription information identified by subscriptionId.

PATCH

Partially updates the Individual AC information subscription identified by subscriptionId.

PUT

Fully replaces the Individual AC information subscription identified by subscriptionId.

DELETE

Removes the Individual AC information subscription identified by subscriptionId.

apiRoot

string

See clause 7.5

n/a

ACInfoSubscription

M

1

Create a new AC information subscription.

ACInfoSubscription

M

1

201 Created

The individual AC information subscription resource created successfully. The information about the confirmed subscription at the EES is provided in the response body.

The URI of the created resource shall be retruned 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 [6] also apply.

Location

string

M

1

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

apiRoot

string

See clause 7.5

subscriptionId

string

Identifies an individual AC information subscription.

n/a

n/a

ACInfoSubscription

M

1

200 OK

The AC information subscription information is returned by the EES.

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 EES.

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

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 EES.

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

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

Location

string

M

1

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

Location

string

M

1

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

n/a

ACInfoSubscriptionPatch

M

1

Request to partially update the individual AC information subscription matching the subscriptionId at the EES.

ACInfoSubscription

M

1

200 OK

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

n/a

204 No Content

The individual AC information subscription matching the subscriptionId was modified successfully.

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 EES.

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

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 EES.

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

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

Location

string

M

1

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

Location

string

M

1

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

n/a

ACInfoSubscription

M

1

Details of individual AC information subscription matching the subscriptionId to be updated at the EES.

ACInfoSubscription

M

1

200 OK

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

n/a

204 No Content

The individual AC information subscription matching the subscriptionId was modified successfully.

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 EES.

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

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 EES.

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

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

Location

string

M

1

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

Location

string

M

1

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

n/a

n/a

n/a

M

1

204 No Content

The individual AC information subscription matching the subscriptionId is deleted.

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 EES.

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

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 EES.

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

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

Location

string

M

1

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

Location

string

M

1

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

AC Information Notification

{notificationDestination}

POST

Notifies the subscriber EAS the AC information.

notificationDestination

Uri

Callback reference provided by the EAS during AC information subscription creation/update/modification procedure.

ACInfoNotification

M

1

Notification of AC(s) 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 EAS where the notification should be sent.

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

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 EAS where the notification should be sent.

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

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

Location

string

M

1

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

Location

string

M

1

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

ACInfoSubscription

8.4.5.2.2

Represents the AC information subscription.

ACInfoSubscriptionPatch

8.4.5.2.3

Used to request the partial update of AC information subscription.

ACFilters

8.4.5.2.4

Used to list the set of characteristics to discover the ACs.

ACInfoNotification

8.4.5.2.5

AC information notification matching the filter criteria.

ACInformation

8.4.5.2.6

Used to represent the AC information in the AC information notification.

DateTime

3GPP TS 29.122 [6]

Used to capture the expiration time of EAS subscription for application client information reporting.

ReportingInformation

3GPP TS 29.523 [13]

Used to indicate the reporting requirement, only the following information are applicable:

– immRep

– notifMethod

– maxReportNbr

– monDur

– repPeriod

Uri

3GPP TS 29.122 [6]

WebsockNotifConfig

3GPP TS 29.122 [6]

Following differences apply:

– The SCEF is the EES; and

– The SCS/AS is the subscribing EAS.

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of optional features.

TestNotification

3GPP TS 29.122 [6]

Following differences apply:

– The SCEF is the EES; and

– The SCS/AS is the subscribing EAS.

LocationArea5G

3GPP TS 29.122 [6]

Used to define the geographic and topological area.

ScheduledCommunicationTime

3GPP TS 29.122 [6]

Used to define the operation schedule of AC.

Gpsi

3GPP TS 29.571 [8]

Used to identify the UE in the query parameter, for which location information is queried.

ACProfile

3GPP TS 24.558 [14]

Used to represent the profile the information of the Application Client.

ServiceArea

Clause 9.1.5.2.5

Used to represent the EAS service area in ACFilters data type.

ACServiceKPIs

3GPP TS 24.558 [14]

Used to represent the minimum and maximum AC service KPI information of the Application Client.

easId

string

M

1

The application identifier of the EAS, e.g. URI, FQDN, subscribing for AC information report.

acFltrs

array(ACFilters)

O

1..N

Filters to retrieve the information about particular ACs.

expTime

DateTime

O

0..1

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

eventReq

ReportingInformation

O

0..1

Represents the reporting requirements of the AC information subscription. (NOTE)

notificationDestination

Uri

C

0..1

URI where the notification on information about particular ACs should be delivered to. This attribute shall be present in HTTP POST message to EES and maybe present in HTTP PUT request.

requestTestNotification

boolean

O

0..1

Set to true by Subscriber to request the EES to send a test notification as defined in clause 7.6. 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.

Notification_websocket

suppFeat

SupportedFeatures

O

0..1

Used to negotiate the supported optional features of the API as described in clause 7.8.

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

NOTE: The applicable values of the ReportingInformation data type are, "immRep", "notifMethod", "maxReportNbr", "monDur", "repPeriod".

eventReq

ReportingInformation

O

0..1

The reporting requirements of the AC information event subscription to be updated.

expTime

DateTime

O

0..1

Indicates the proposed expiration time of the subscription.

notificationDestination

Uri

O

0..1

Updated URI where the AC information notification should be delivered to.

acFltrs

array(ACFilters)

O

1..N

Filters to retrieve the information about particular ACs.

acTypes

array(string)

O

1..N

List of AC types or categories to be matched.

ecspIds

array(string)

O

1..N

The list of identifiers of the ECSPs associated with the EEC.

acIds

array(string)

O

1..N

List of the identifiers of the AC(s) to be matched.

svcArea

ServiceArea

O

0..1

EAS service area for identifying the UEs with matching expected geographical and topological location(s).

maxAcKpi

ACServiceKPIs

O

0..1

Maximum value of the AC service KPIs to identify the matched ACs. The service KPI values in this attribute need to be higher than the service KPIs information of the AC profiles provided during registrations and/or discovery need to be lower.

minAcKpi

ACServiceKPIs

O

0..1

Minimum value of the AC service KPIs to identify the matched ACs. The service KPI values in this attribute need to be lower than the service KPIs information of the AC profiles provided during registrations and/or discovery need to be lower.

opSchds

array(ScheduledCommunicationTime)

O

1..N

The operation schedule of the EAS to be matched with operation schedule of the AC.

ueIds

array(Gpsi)

O

1..N

List of UE identifiers hosting the AC.

locInfs

LocationArea5G

O

0..1

List of location(s) of the UE(s) hosting the AC.

subId

string

M

1

String identifying the individual AC information subscription for which the AC information notification is delivered.

acInfs

array(ACInformation)

M

1..N

List of notifications that include the information of the ACs matching the filter criteria.

acProfs

array(ACProfile)

M

1

List of ACs profile information.

ueIds

array(Gpsi)

O

1..N

List of UE identifiers hosting the ACs.

ueLocInfs

LocationArea5G

O

0..1

Location information of the UEs hosting the AC.

REGISTRATION_REQUIRED

403 Forbidden

Indicates that registration at the EES is required for the EAS to be authorized to perform the operation.

1

Notification_test_event

Testing of notification connection is supported according to clause 7.6.

2

Notification_websocket

The delivery of notifications over Websocket is supported according to clause 7.6. This feature requires that the Notification_test_event feature is also supported.