WebSphere brand IBM WebSphere Telecom Web Services Server, Version 7.1

Usage records for Parlay X Terminal Location over Parlay

The Parlay X Terminal Location over Parlay Web service implementation, uses the Usage Record component Web service to record events related to a service request.

Parlay X Terminal Location over Parlay service record

Usage records for Parlay X Terminal Location over Parlay are created by calling the Usage Record component Web service, which creates entries in the USAGERECORDS table.

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 descriptions
Attribute 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 getLocation operation

The following table lists part names and service attributes used by getLocation.
Table 2. getLocation service attributes and descriptions
Attribute Description
RESULT_CURRENCY Timestamp of the result
START_TIME Time the operation began
REQUEST_ACCEPTABLE_ACCURACY Lowest accuracy acceptable to requester
IS_ALTITUDE_REQUESTED Determines whether altitude information should be requested when location requests are made. Has to be one of the following:

Yes
No

REQUESTED_DELAY_TOLERANCE Priority of response time versus accuracy. Has to be one of the following:

P_M_DELAY_TOLERANT
P_M_LOW_DELAY
P_M_NO_DELAY

REQUESTER Requester name requesting this operation
RESULT_ACCURACY Accuracy of the resulting location
REQUESTED_RESPONSE_TIME Maximum time that the application can accept to wait for a response
IS_USING_EXTENDED_REQUEST Whether extended location requests should be made. Has to be one of the following:

Yes
No

REQUESTED_MAXIMUM_AGE_OF_RESPONSE Maximum acceptable age of the location information that is returned
SERVICE Service name requesting this operation
TARGET Formatted target address
ASSIGNMENT_ID Parlay assignment ID associated with the request
RESPONSE_TIME Amount of time to take for the response
REQUESTED_ACCURACY Accuracy of location information requested
LOCATION_METHOD Parlay gateway location method strings
LOCATION_TYPE Parlay gateway location type strings. Has to be one of the following:

P_M_CURRENT_OR_LAST_KNOWN
P_M_CURRENT
P_M_INITIAL

REQUEST_PRIORITY Location priority parameter passed to the Parlay gateway. Has to be one of the following:

P_M_NORMAL
P_M_HIGH

Service data for getLocationForGroup operation

The following table lists part names and service attributes used by getLocationForGroup.
Table 3. getLocationForGroup service attributes and descriptions
Attribute Description
IS_ALTITUDE_REQUESTED Determines whether altitude information should be requested when location requests are made. Has to be one of the following:

Yes
No

REQUESTED_DELAY_TOLERANCE Priority of response time versus accuracy. Has to be one of the following:

P_M_DELAY_TOLERANT
P_M_LOW_DELAY
P_M_NO_DELAY

REQUESTER Requester name requesting this operation
RESULT_ACCURACY Accuracy of the resulting location
REQUESTED_RESPONSE_TIME Maximum time that the application can accept to wait for a response
REQUESTED_MAXIMUM_AGE_OF_RESPONSE Maximum acceptable age of the location information that is returned
IS_USING_EXTENDED_REQUEST Whether extended location requests should be made. Has to be one of the following:

Yes
No

SERVICE Service name requesting this operation
TARGET Formatted target address
ASSIGNMENT_ID Parlay assignment ID associated with the request
RESPONSE_TIME Amount of time to take for the response
REQUESTED_ACCURACY Accuracy of location information requested
LOCATION_METHOD Parlay gateway location method strings
LOCATION_TYPE Parlay gateway location type strings. Has to be one of the following:

P_M_CURRENT_OR_LAST_KNOWN
P_M_CURRENT
P_M_INITIAL

REQUEST_PRIORITY Location priority parameter passed to the Parlay gateway. Has to be one of the following:

P_M_NORMAL
P_M_HIGH

RESULT_CURRENCY Timestamp of the result
START_TIME Time the operation began

Service data for getTerminalDistance operation

The following table lists part names and service attributes used by getTerminalDistance.
Table 4. getTerminalDistance service attributes and descriptions
Attribute Description
RESULT_ACCURACY Accuracy of the resulting location
REQUESTED_RESPONSE_TIME Maximum time that the application can accept to wait for a response
IS_USING_EXTENDED_REQUEST Whether extended location requests should be made. Has to be one of the following: Has to be one of the following:

Yes
No

REQUESTED_MAXIMUM_AGE_OF_RESPONSE Maximum acceptable age of the location information that is returned
SERVICE Service name requesting this operation
TARGET Formatted target address
ASSIGNMENT_ID Parlay assignment ID associated with the request
RESPONSE_TIME Amount of time to take for the response
REQUESTED_ACCURACY Accuracy of location information requested
LOCATION_METHOD Parlay gateway location method strings
LOCATION_TYPE Parlay gateway location type strings. Has to be one of the following:

P_M_CURRENT_OR_LAST_KNOWN
P_M_CURRENT
P_M_INITIAL

REQUEST_PRIORITY Location priority parameter passed to the Parlay gateway. Has to be one of the following:

P_M_NORMAL
P_M_HIGH

RESULT_CURRENCY Timestamp of the result
START_TIME Time the operation began
REQUEST_ACCEPTABLE_ACCURACY Lowest accuracy acceptable to requester
IS_ALTITUDE_REQUESTED Determines whether altitude information should be requested when location requests are made. Has to be one of the following:

Yes
No

REQUESTED_DELAY_TOLERANCE Priority of response time versus accuracy. Has to be one of the following:

P_M_DELAY_TOLERANT
P_M_LOW_DELAY
P_M_NO_DELAY

REQUESTER Requester name requesting this operation

Service data for startGeographicalNotification operation

The following table lists part names and service attributes used by startGeographicalNotification.
Table 5. startGeographicalNotification service attributes and descriptions
Attribute Description
REQUESTER Requester name requesting this operation
RESULT_ACCURACY Accuracy of the resulting location
REQUESTED_RESPONSE_TIME Maximum time that the application can accept to wait for a response
IS_USING_EXTENDED_REQUEST Whether extended location requests should be made. Has to be one of the following:

Yes
No

REQUESTED_MAXIMUM_AGE_OF_RESPONSE Maximum acceptable age of the location information that is returned
REQUESTED_MAXIMUM_NOTIFICATION_FREQUENCY Maximum frequency of a notification request
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
LOCATION_METHOD Parlay gateway location method strings
NOTIFICATION_CRITERIA Indicates whether the notification should occur when the terminal enters or leaves the target area. Has to be one of the following:

P_UL_LEAVING_AREA
P_UL_ENTERING_AREA

LOCATION_TYPE Parlay gateway location type strings. Has to be one of the following:

P_M_CURRENT_OR_LAST_KNOWN
P_M_CURRENT
P_M_INITIAL

REQUEST_PRIORITY Location priority parameter passed to the Parlay gateway. Has to be one of the following:

P_M_NORMAL
P_M_HIGH

RESULT_CURRENCY Timestamp of the result
START_TIME Time the operation began
NOTIFICATION_TRIGGER_RADIUS Requested triggered radius
NOTIFICATION_ENDPOINT Endpoint URL that will receive the notifications
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 LIMIT Notification limit
REQUEST_ACCEPTABLE_ACCURACY Lowest accuracy acceptable to requester
IS_ALTITUDE_REQUESTED Determines whether altitude information should be requested when location requests are made. Has to be one of the following:

Yes
No

REQUESTED_DELAY_TOLERANCE Priority of response time versus accuracy. Has to be one of the following:

P_M_DELAY_TOLERANT
P_M_LOW_DELAY
P_M_NO_DELAY

ASSIGNMENT_ID Parlay assignment ID associated with the request
RESPONSE_TIME Amount of time to take for the response
REQUESTED_ACCURACY Accuracy of location information requested

Service data for startPeriodicNotification operation

The following table lists part names and service attributes used by startPeriodicNotification.
Table 6. startPeriodicNotification service attributes and descriptions
Attribute Description
CORRELATOR Correlation information from the end point. Used to communicate with endpoint for callbacks, this information must be unique for this service and requester.
FREQUENCY Frequency of a notification request
REQUEST_PRIORITY Location priority parameter passed to the Parlay gateway. Has to be one of the following:

P_M_NORMAL
P_M_HIGH

LOCATION_METHOD Parlay gateway location method strings
TARGET Formatted target address
ASSIGNMENT_ID Parlay assignment ID associated with the request
REQUESTER Requester name requesting this operation
SERVICE Service name requesting this operation
NOTIFICATION_EXPIRES_AT Expiration time of the notification
START_TIME Time the operation began
REQUESTED_DELAY_TOLERANCE Priority of response time versus accuracy. Has to be one of the following:

P_M_DELAY_TOLERANT
P_M_LOW_DELAY
P_M_NO_DELAY

RESPONSE_TIME Amount of time to take for the response
DURATION Maximum duration of a notification request
REQUEST_ACCEPTABLE_ACCURACY Lowest accuracy acceptable to requester
NOTIFICATION_ENDPOINT Endpoint URL that will receive the notifications
REQUESTED_RESPONSE_TIME Maximum time that the application can accept to wait for a response
LOCATION_TYPE Parlay gateway location type strings. Has to be one of the following:

P_M_CURRENT_OR_LAST_KNOWN
P_M_CURRENT
P_M_INITIAL

IS_ALTITUDE_REQUESTED Determines whether altitude information should be requested when location requests are made

Service data for endNotification operation

The following table lists part names and service attributes used by endNotification.
Table 7. endNotification service attributes and descriptions
Attribute Description
REQUESTER Requester name requesting this operation
SERVICE Service name requesting this operation
NOTIFICATION_TYPE Notification type. Has to be one of the following:

Triggered
Periodic

ASSIGNMENT_ID Parlay assignment ID associated with the request
RESPONSE_TIME Amount of time to take for the response
START_TIME Time the operation began
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 data for service exceptions

The following table lists part names and service attributes used for service exceptions.
Table 8. Exception service attributes and descriptions
Attribute Description
FAILURE_REASON Error message identifier indicating the error
FAILURE_DETAIL A detailed error text message
ERROR_TYPE Type of error encountered

Service data for locationError, locationNotification, locationEnd

Usage records are not generated for locationError, locationNotification, and locationEnd operations.




Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.