//Template
The purpose of this Document is to enumerate the APIs which are exposed by Akraino Blue print project to the external projects Akraino/Non Akraino for interaction/integration.
This document should be used in conjunction with the architecture document to understand APIs at modular level and their interactions.
This document should function as a glossary of APIs with its functionality, interfaces, inputs and expected outcomes as the following example:
API1 < var 1, var 2, var 2>
(
functional description
) ret 1, ret2
- Location API
- 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
POSTSUB<zonalTrafficSubscription>
(
This operation is used for creating a new subscription to zonal traffic change notification
)
GETSUB<subscriptionId, zonalTrafficSubscription>
(
This operation is used for 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 operation is used for cancelling a subscription and stopping corresponding notifications
)
GETSUB<userTrackingSubscription>
(
This operation is used for retrieving all active subscriptions to user tracking change notifications
)notificationSubscriptionList
POSTSUB<zonalTrafficSubscription, userTrackingSubscription>
(
This operation is used for creating a new subscription to user tracking change notification
)
GETSUB<userTrackingSubscription, subscriptionId>
(
This operation is used for retrieving an individual subscription to user tracking change notification
)
PUTSUB<subscriptionId, userTrackingSubscription>
(
This operation is used for updating an individual subscription to user tracking change notification
)
DELETESUB<subscriptionId, userTrackingSubscription>
(
This operation is used for retrieving an individual subscription to user tracking change notification
)
GETSUB<zoneStatusSubscription>
(
This operation is used for retrieve all subscriptions to zone status change notification
)notificationSubscriptionList
POSTSUB<zoneStatusSubscription>
(
This operation is used for creating a new subscription to zone status change notification
)
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
)