Parlay X Terminal Status over Parlay uses the Usage Record component Web service to record Web service invocation details.
Parlay X Terminal Status over Parlay service record
Usage records for Parlay X Terminal Status over Parlay are created by capturing Parlay X-based API invocations from external clients. A single event marks the beginning and the end of request processing.
The following table describes the information that is passed to the
Usage Record component Web service for this Web service implementation.
Table 1. Usage record component service attributes and descriptionsAttribute |
Description |
RECORDID |
A unique record identifier |
SEGMENT |
Segment number used for subsequent truncated records. This number is incremented each time an overflow of the SERVICEDATA field is encountered and a subsequent record is added. Used by the SMS-based service implementations; a value of 0 is written for all others.
|
GLOBALID |
Global transaction identifier |
SERVICE |
Name of the service |
HOST |
Name of the host on which the usage record is being recorded |
EVENTTYPE |
Name of the operation being performed |
RECORDTIME |
The time that the usage record was written |
STATUSCODE |
One of the following: 0 = VALID
1 = FAILED_PRIVACY
2 = FAILED_ADDRESS_PLAN_VALIDATION
3 = EXCEEDED_MAX_TARGETS
4 = FAILED_PACER
5 = FAILED_CALL_LEVEL_PRIVACY
6 = FAILED_PROCESS_UP_TO_LIMIT
7 = FAILED_ADMISSION_CONTROL
8 = FAILED_SERVICE_NOT_RUNNING
9 = FAILED_JMS_ENQUEUE
10 = UNKNOWN_SCHEME
11 = FAILED_OPERATION
12 = FAILED_OTHER
13 = INVALID
14 = GROUPS_NOT_ALLOWED
15 = UNRESOLVED_GROUPS
16 = FAILED_TRAFFIC_SHAPING
|
SERVICEDATA |
Semicolon-delimited list of attributes described in the following tables, written in the format key=value;key=value... |
Service data for getStatus operation
The following table lists part names and service attributes used by getStatus.
Table 2. getStatus service attributes and descriptionsAttribute |
Description |
ASSIGNMENT_ID |
The Parlay assignment ID associated with sending the message |
REQUESTER |
Requester name requesting this operation |
RESPONSE_TIME |
Amount of time to take for the response |
START_TIME |
Time of the beginning of the operation |
SERVICE |
Service name requesting this operation |
TARGET |
Formatted target address |
Service data for getStatusForGroup operation
The following table lists part names and service attributes used by getStatusForGroup.
Table 3. getStatusForGroup service attributes and descriptionsAttribute |
Description |
ASSIGNMENT_ID |
The Parlay assignment ID associated with sending the message |
REQUESTER |
Names of the requesters for this operation: a group of terminal addresses, separated by comas |
RESPONSE_TIME |
Amount of time to take for the response |
START_TIME |
Time of the beginning of the operation |
SERVICE |
Service name requesting this operation |
TARGET |
Formatted target address |
Service data for startNotification operation
The following table lists part names and service attributes used by startNotification.
Table 4. startNotification service attributes and descriptionsAttribute |
Description |
REQUESTER |
Requester name requesting this operation |
SERVICE |
Service name requesting this operation |
DURATION |
Maximum duration of a notification request |
NOTIFICATION_EXPIRES_AT |
Expiration time of the notification |
TARGET |
Formatted target address |
ASSIGNMENT_ID |
The Parlay assignment ID associated with sending the message |
RESPONSE_TIME |
Amount of time to take for the response |
START_TIME |
Time of the beginning of the operation |
CORRELATOR |
Correlation information from the end point. Used to communicate with endpoint for callbacks, this information must be unique for this service and requester. |
NOTIFICATION_ENDPOINT |
Endpoint URL that will receive the notifications |
FREQUENCY |
Frequency of a notification request |
NOTIFICATION LIMIT |
Notification limit |
Service data for endNotification operation
The following table lists part names and service attributes used by endNotification.
Table 5. endNotification service attributes and descriptionsAttribute |
Description |
ASSIGNMENT_ID |
The Parlay assignment ID associated with sending the message |
REQUESTER |
Requester name requesting this operation |
RESPONSE_TIME |
Amount of time to take for the response |
START_TIME |
Time of the beginning of the operation |
CORRELATOR |
Correlation information from the end point. Used to communicate with endpoint for callbacks, this information must be unique for this service and requester. |
SERVICE |
Service name requesting this operation |
Service data for service exceptions
The following table lists part names and service attributes used for service exceptions.
Table 6. Exception service attributes and descriptionsAttribute |
Description |
FAILURE_REASON |
Error message identifier indicating the error |
FAILURE_DETAIL |
A detailed error text message |
ERROR_TYPE |
Type of error encountered |
Parlay X Terminal Status over Parlay records based on outgoing service notifications
These usage records capture outbound Web service-based notifications/callbacks related to StartNotification operations. Global transaction IDs allow these to be correlated with related StartNotification events.
The following table lists part names and service attributes used for statusNotification_DeliveryAttempted.
Table 7. statusNotification_DeliveryAttempted service attributes and descriptionsAttribute |
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.
Table 8. statusNotification_DeliveryResult service attributes and descriptionsAttribute |
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.
Table 9. statusError_DeliveryAttempted service attributes and descriptionsAttribute |
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 |
When an application receives the notification |
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.
Table 10. statusError_DeliveryResult service attributes and descriptionsAttribute |
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.
Table 11. statusEnd_DeliveryAttempted service attributes and descriptionsAttribute |
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.
Table 12. statusEnd_DeliveryResult service attributes and descriptionsAttribute |
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 |