Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

cmti CA  Oleg Berzin Suzy Gu

  1. Location API
    1. UE Location Lookup

GET<>

(

Used to get a list of identifiers for zones authorized for use by the application.

) zonelist

GET<zoneId>

(

Used to get the status of a zone

)status

GET <interestRealm>

(

Used to retrieve a set of access points matching specific realm in the request

)zoneId, accessPointList

GET<zoneId, accessPointId>

(

Used to get the status of a Access point status

)status

GET<zoneId, accessPointId>

(

Users currently using a zone may be retrieved for a specific accessPoint in the request

)userIdList

GET<zoneId>

(

Users currently useing a zone may be retrieved

)userIdList

b. subscription API

      GETSUB<zonalTrafficSubscription>

(

This operation is used for retrieving all active subscriptions to zonal traffic change notifications

notificationSubscriptionList

...

cmti CA  Oleg Berzin Suzy Gu

Table of Contents

Introduction

The PCEI API Document includes a list of APIs which are included in the PCEI Enabler interfaces with telco side and public cloud/third party cloud sides. As the architecture page is shown, all APIs from P1 to P8 interfaces will be eventually included. Currently, in this release, we first focus on the P2' interfaces, the MNO core network function APIs. We transplant some of the ETSI MEC APIs and re-encapsulates thems. The following example is a location service related API. It is RESTFUL and all interactions are fulfilled through HTTP/HTTPS request and reply.

In the future, we will add more MNO function APIs into it. Also for other interfaces from P1 to P8. 

Location API

  1. UE Location Lookup

GET<>

(

Used to get a list of identifiers for zones authorized for use by the application.

) zonelist

GET<zoneId>

(

Used to get the status of a zone

)status

GET <interestRealm>

(

Used to retrieve a set of access points matching specific realm in the request

)zoneId, accessPointList

GET<zoneId, accessPointId>

(

Used to get the status of an Access point status

)status

GET<zoneId, accessPointId>

(

Users currently using a zone may be retrieved for a specific access point in the request

)userIdList

GET<zoneId>

(

Users currently using a zone may be retrieved

)userIdList


2. subscription API

      GETSUB<zonalTrafficSubscription>

(

This operation is used for retrieving all active subscriptions to zonal traffic change notifications

notificationSubscriptionList

POSTSUB<zonalTrafficSubscription>

                       (

                       This operation is used for creating a new subscription to zonal traffic change notification

                        )

                       GETSUB<subscriptionId, zonalTrafficSubscription>

                       (

                       This operation is used to retrieve an individual subscription to zonal traffic change notification

                       )

                      PUTSUB<zonalTrafficSubscription, subscriptionId>

                       (

                       This operation is used for updating an individual subscription to zonal traffic change notification

                       )

                       DELETESUB<subscriptionId>

                       (

                       This  This operation is used for creating canceling a new subscription to zonal traffic change notificationsubscription and stopping corresponding notifications

                        )

                       GETSUB<subscriptionId, zonalTrafficSubscription> GETSUB<userTrackingSubscription>

                        (

                       This  This operation is used for retrieve an individual subscription to zonal traffic change notificationretrieving all active subscriptions to user tracking change notifications

                       )notificationSubscriptionList

                      PUTSUB<POSTSUB<zonalTrafficSubscription, subscriptionId> userTrackingSubscription>

                       (

                       This operation is used for updating an individual creating a new subscription to zonal traffic user tracking change notification

                       )

                       DELETESUB<subscriptionId>GETSUB<userTrackingSubscription, subscriptionId>

                        (

                       This   This operation is used for cancelling a subscription and stopping corresponding notificationsretrieving an individual subscription to user tracking change notification

                       )

                       GETSUB<userTrackingSubscription> PUTSUB<subscriptionId, userTrackingSubscription>

                     (

                       This operation is used for retrieving all active subscriptions updating an individual subscription to user tracking change notificationsnotification

                        )notificationSubscriptionList

                      POSTSUB<zonalTrafficSubscriptionDELETESUB<subscriptionId,   userTrackingSubscription>

                     (

                       This operation is used for creating a new retrieving an individual subscription to user tracking change notification

                        )

                      GETSUB<userTrackingSubscription, subscriptionId> GETSUB<zoneStatusSubscription>

                     (

                      This operation is used for retrieving an individual subscription to user tracking retrieve all subscriptions to zone status change notification

                       )notificationSubscriptionList

                     PUTSUB<subscriptionId, userTrackingSubscription>POSTSUB<zoneStatusSubscription>

                     (

                       This operation is used for updating an individual creating a new subscription to user tracking zone status change notification

                     )

                      DELETESUB<subscriptionId GETSUB<zoneStatusSubscription, userTrackingSubscription>subscriptionId>

                     (

                       This This operation is used for retrieving an individual subscription to user tracking zone status change notification

                      )

                       GETSUB<zoneStatusSubscription>PUTSUB<zoneStatusSubscription, subscriptionId>

                       (

                        This  This operation is used for retrieve all subscriptions updating an individual subscription to zone status change notification

                       )notificationSubscriptionList

                      POSTSUB<DELETESUB<subscriptionId, zoneStatusSubscription>

                      (

                       This   This operation is used for creating canceling a new subscription to zone status change notificationsubscription and stopping corresponding notifications

                      )

                     GETSUB<zoneStatusSubscription, subscriptionId>

                     (

                      This operation is used for retrieving an individual subscription to zone status change notification

                      )

                     PUTSUB<zoneStatusSubscription, subscriptionId>

                       (

                       This operation is used for updating an individual subscription to zone status change notification

                       )

                      DELETESUB<subscriptionId, zoneStatusSubscription>

                      (

                      This operation is used for cancelling a subscription and stopping corresponding notifications

...

Example Call Flow

PCEI Facilitated Location Service using OMA Zonal Presence API or ETSI MEC Location API

Assumptions:

  • MNO provides a Location Service (LS) compliant with OMA Zonal Presence API (OMA-TS-REST_NetAPI_ZonalPresence)
  • A Public Cloud Edge (PCE) instance is associated with a Zone (collection of Access Points such as small cells) provided by an MNO
  • A 3rd-Party Edge (3PE) instance is associated with a Zone (collection of Access Points such as small cells) provided by an MNO
  • An application/workload in the PCE requires Location Information (e.g. coordinates of the Access Point) for the UE/subscriber
  • An application/workload in the 3PE requires Location Information (e.g. coordinates of the Access Point) for the UE/subscriber
  • PCEI Enabler facilitates Zonal Presence API Request/Response routing between PCE and the MNO LS and between the 3PE and the MNO LS


The example use case diagram is shown below:

Image Added

The example call flow sequence is shown below:

Image Added