Operations of the Parlay X Terminal Status over Parlay Web
service operation map to Parlay Mobility Service Capability Feature
(SCF) API methods.
Call flows
The following steps show an example
of the call flow for Parlay X getStatus () Web service request:
- The application invokes a getStatus request.
- The Parlay X Terminal Status over Parlay Web
service implementation sends the request over the Parlay API to the
Parlay Connector.
- The Parlay Connector sends the request to the appropriate server
and waits for a response.
- The server sends a GetStatusResponse to the Parlay Connector.
- The Parlay Connector sends the GetStatusResponse to Parlay X Terminal Status over Parlay.
- Parlay X Terminal Status over Parlay sends
the response to the application.
Interfaces
- Terminal Status
- getStatus
- Retrieves the status for a single terminal. It is mapped to the
IpUserStatus.statusReportReq Parlay Mobility SCF API function. It
is also used by applications that are interested in determining the
status of one or more terminal devices. When status information is
available, the IpAppUserStatus.statusReportRes callback is invoked.
If an error occurs, the IpAppUserStatus.statusReportErr callback is
invoked.
- getStatusForGroup
- Initiates a retrieval activity, where one or more terminals or
groups of terminals, may have their statuses determined. The Web service
may return a result set that does not include complete information,
allowing the Web service implementation to choose to deliver a partial
set of results that accommodate other conditions. This includes avoiding
timeouts. In this case, the addresses for which no attempt
has been made to provide data, will be marked NotRetrieved in the
result for each applied address.
- Terminal Status Notification Manager
- startNotification
- Applications can be notified of status changes, and the number
and duration of notifications can be requested as part of the notification
setup. The notification may also be governed by service policies,
or a combination of both. The StartNotification will be mapped to
the IpUserStatus.triggeredStatusReportingStartReq Parlay Mobility
SCF API function.
- endNotification
- The application may end a notification using this operation, which
the service will map to IpUserStatus.triggeredStatusReportingStop.
However until this operation returns, the notifications may continue
to be received by the application. There is not an end of notification
(statusEnd) message delivered to the application for a notification
ending using this operation.
- Terminal Notification
- statusNotification
- When the status of monitored devices change, a notification will
be delivered to the application with the new status information for
each of the devices. If a group identifier was used the terminal device
URI will be provided, and not the group URI. The sending of this notification
occurs when a service callback is invoked by the following Parlay
API functions.
- statusError
- The status changed error message will be sent to the application
to indicate that the notification is being cancelled by the Web service.
The sending of this notification occurs when a service callback is
invoked by the following Parlay API functions:
- IpAppUserStatus.triggeredStatusReportErr
- IpAppUserStatus.StatusReportErr (Valid only when checkImmediate
is indicated).
- statusEnd
- This message will be delivered when the duration or count for
notifications have completed. The message will not be delivered in
the case of an error ending notification or deliberate ending of the
notification. This is indicated when the application invokes the TerminalStatusNotificationManager.endNotification
operation.