The service usage database is used by all services, including Parlay X Terminal Status over SIP/IMS, to record events related to a service request. The payment service invokes the Usage Record component Web service to write service usage records to the database
The following table lists part names and service attributes used for getStatus.
Attribute | Description |
---|---|
REQUESTER | Requester name requesting this operation - Identifies the application that issues the service request |
TARGETS | URI Addresses of the terminal (s) whose status have to be retrieved |
RESULT | Contains status information in case of successful operation, otherwise contains an exception type |
ROOT_CAUSE | Only present if an exception occurs due to an unrecoverable internal error |
The following table lists part names and service attributes used for getStatusForGroup.
Attribute | Description |
---|---|
REQUESTER | Requester name requesting this operation |
TARGETS | URI Addresses of the terminal(s) whose status have to be retrieved |
EXPANDED_TARGETS | Group List Management server - TARGETS can have group URIs, EXPANDED_TARGETS list contains a single entry for each user/terminal. |
EXPANDED_TARGETS_COUNT | Total number of targets for which status has to be queried |
RESULT | Contains status information in case of successful operation, otherwise, contains an exception type |
ROOT_CAUSE | Present only if an exception occurred because of an unrecoverable internal error |
The following table lists part names and service attributes used for startNotification.
Attribute | Description |
---|---|
REQUESTER | Identifies the application that issued the service request |
TARGETS | URI Addresses of the terminal(s) whose status have to be retrieved |
EXPANDED_TARGETS | Group List Management server - TARGETS can have group URIs, EXPANDED_TARGETS list contains a single entry for each user/terminal |
EXPANDED_TARGETS_COUNT | Total number of targets for which status has to be queried |
CORRELATOR | Endpoint used for callbacks |
NOTIFICATION_ENDPOINT | An endpoint URI used for notifications by the service |
NOTIFICATION_CRITERIA | When an application receives a notification |
CHECK_IMMEDIATE | Identifies if an immediate notification should
be returned. Has to be one of the following: Yes |
FREQUENCY | Duration between sending two separate asynchronous notifications |
NOTIFICATION_EXPIRES_AT | Expiration time for the notification |
NOTIFICATION_COUNT | Maximum number of notifications delivered - either this value does not exist or it is a value of zero |
The following table lists part names and service attributes used for endNotification.
Attribute | Description |
---|---|
REQUESTER | Identifies the application that issues the service request |
CORRELATOR | Used to communicate with endpoint for callbacks |
RESULT | Contains status information in case of successful operation, otherwise, contains an exception type |
ROOT_CAUSE | Present only if an Exception occurred because of unrecoverable internal error |
The following table lists part names and service attributes used for statusNotification_DeliveryAttempted.
Attribute | Description |
---|---|
CORRELATOR | Used to communicate with endpoint for callbacks |
TARGETS | Formatted target address |
DELIVERY_STATUS | One of the PresenceAttributeType enumeration status values or the returned Exception |
APP_CORRELATION_ID | DeliveryResult |
The following table lists part names and service attributes used for statusNotification_DeliveryResult.
Attribute | Description |
---|---|
FAILURE_REASON | Empty if the DeliveryStatus = Success |
FAILURE_DETAIL | Empty if the DeliveryStatus = Success |
APP_CORRELATION_ID | Used to match this DeliveryResult record with a DeliveryAttempted |
The following table lists part names and service attributes used for statusChanged_DeliveryAttempted.
Attribute | Description |
---|---|
CORRELATOR | Used to communicate with endpoint for callbacks |
TARGETS | Pulled from the notifySubscriptionRequest.Presentity part |
APP_CORRELATION_ID | Used to match this DeliveryAttempted record with a DeliveryResult |
PRESENCE_ACTIVITY | Not present if the Activity is not in the ChangedAttributes |
PRESENCE_PLACE | Not present if the Place is not in the ChangedAttributes |
PRESENCE_PRIVACY | Not present if the Privacy is not in the ChangedAttributes |
PRESENCE_SPHERE | Not present if the Sphere is not in the ChangedAttributes |
PRESENCE_CONTACTS | Not present if the Communication is not in the ChangedAttributes |
PRESENCE_CONTACT_PRIORITIES | Not present if the Communication is not in the ChangedAttributes - Corresponds to the values in PRESENCE_CONTACTS |
The following table lists part names and service attributes used for statusChanged_DeliveryResult.
Attribute | Description |
---|---|
FAILURE_REASON | Empty if the DeliveryStatus = Success |
FAILURE_DETAIL | Empty if the DeliveryStatus = Success |
APP_CORRELATION_ID | Used to match this DeliveryResult record with a DeliveryAttempted |
The following table lists part names and service attributes used for statusError_DeliveryAttempted.
Attribute | Description |
---|---|
CORRELATOR | Used to communicate with endpoint for callbacks |
TARGET | May be empty |
MESSAGE_ID | May be either a fault message for the single request or a data item for a group response |
REASON | Describes why the subscription ended - For example; Timeout or Blocked |
APP_CORRELATION_ID | Used to match this DeliveryAttempted record with a DeliveryResult |
The following table lists part names and service attributes used for statusError_DeliveryResult.
Attribute | Description |
---|---|
FAILURE_REASON | Empty if the DeliveryStatus = Success |
FAILURE_DETAIL | Empty if the DeliveryStatus = Success |
APP_CORRELATION_ID | Used to match this DeliveryResult record with a DeliveryAttempted |
The following table lists part names and service attributes used for statusEnd_DeliveryAttempted.
Attribute | Description |
---|---|
CORRELATOR | Used to communicate with endpoint for callbacks |
APP_CORRELATION_ID | Used to match this DeliveryAttempted record with a DeliveryResult |
The following table lists part names and service attributes used for statusEnd_DeliveryResult.
Attribute | Description |
---|---|
FAILURE_REASON | Empty if the DeliveryStatus = Success |
FAILURE_DETAIL | Empty if the DeliveryStatus = Success |
APP_CORRELATION_ID | Used to match this DeliveryResult record with a DeliveryAttempted |