Oracle® Communications Services Gatekeeper Partner Relationship Management Guide Release 5.1 E37536-01 |
|
|
PDF · Mobi · ePub |
The Service Provider Utility Web Service allows the Service Provider to retrieve the call details records (CDRs) it has generated from Oracle Communications Services Gatekeeper.
The endpoint for this interface is: http://<host>:<port>/prm_sp/services/SpCdrUtil
where the value of host and port depend on the Oracle Communications Services Gatekeeper deployment.
Counts the number of CDRs for a certain Service for a specified time interval.
Note:
A Service is the generic name for a Oracle Communications Services Gatekeeper communication service, without regard for the Web Service version or the network plug-in being used. So, for example, the Service name for Parlay X 2.1 Third Party Call using Session Initiation Protocol (SIP) or Intelligent Network Application Part (INAP) or Parlay X 3.0 using Parlay 3.3 MultiProtocol Communication Controller (MPCC) is simply Third Party Call.Table 7-1 countCdrs(serviceName, fromDate, toDate, completionStatus, appAccountId)
Parameter Name | Type | Description |
---|---|---|
serviceName |
xsd:string |
Input parameter. The name of the Service for which to retrieve charge data records (CDRs). Use null to not filter on this parameter |
fromDate |
xsd:dateTime |
Input parameter. From date and time. Use null to not filter on this parameter |
toDate |
xsd:dateTime |
Input parameter. To date and time. Use null to not filter on this parameter. |
completionStatus |
tns1:CdrCompletionStatus |
Input parameter. Completion status of the CDR. See "CdrCompletionStatus". Use null to not filter on this parameter. |
appAccountId |
xsd:string |
Input parameter. ID of the Application Account to filter the result on. Use null to not filter on this parameter |
countCdrsReturn |
xsd:long |
Return parameter. The number of CDRs matching the given criteria. |
ACCESS_DENIED |
N/A |
Exception |
CommonException |
N/A |
Exception |
Retrieves all CDRs matching the given criteria.
Table 7-2 listCdrs(serviceName, fromDate, toDate, completionStatus, appAccountId, startIndex, maxEntries)
Parameter Name | Type | Description |
---|---|---|
serviceName |
xsd:string |
Input parameter. The name of the Service for which to retrieve CDRs. Use null to not filter on this parameter |
fromDate |
xsd:dateTime |
Input parameter. From the date and time. Use null to not filter on this parameter. |
toDate |
xsd:dateTime |
Input parameter. To the date and time. Use null to not filter on this parameter. |
completionStatus |
tns1:CdrCompletionStatus |
Input parameter. Completion status of the CDR.See "CdrCompletionStatus". Use null to not filter on this parameter. |
appAccountId |
xsd:string |
Input parameter. ID of the Application Account to filter the result on. Use null to not filter on this parameter. |
startIndex |
xsd:long |
Input parameter. Which entry, in the overall result set, to start the result list on (cursor). |
maxEntries |
xsd:int |
Input parameter. The maximum number of alarms returned. |
listCdrsReturn |
Array of tns1:CdrInfo |
Return parameter. List of CDRS. See "CdrInfo". |
ACCESS_DENIED |
N/A |
Exception |
CommonException |
N/A |
Exception |
These complex data types are used by this interface.
Data structure defining a CDR. All services that produce charging data do not use all fields, and they use the fields in a slightly different, depending on the type of the service. See Communication Service Guide for details of which fields that are relevant for the different services.
Element name | Datatype | Description |
---|---|---|
transactionId |
xsd:long |
The Oracle Communications Services Gatekeeper transaction sequence number. |
serviceName |
xsd:string |
The communication service whose use is being tracked |
timeStamp |
xsd:dateTime |
The time at which the event was triggered (in milliseconds from midnight 1 January 1970) |
origAddr |
xsd:string |
The address of the originating party. |
destAddr |
xsd:string |
The address of the destination party. |
spAccountD |
xsd:string |
The ID of the Service Provider that generated the CDR. |
appAccountID |
xsd:string |
The ID of the Application Account that generated the CDR. |
completionStatus |
tns1:CdrCompletionStatus |
Completion status of the CDR. See "CdrCompletionStatus". |
info |
xsd:string |
Additional info provided by the communication service |
additionalProperties |
impl:ArrayOf_tns1_Property |
Application defined data. See "CdrCompletionStatus". |
Enumeration defining the completion status of a CDR.
Element name | Datatype | Description |
---|---|---|
COMPLETED |
xsd:string |
The operation generating the CDR succeeded. |
FAILED |
xsd:string |
The operation generating the CDR failed. |
PARTIAL |
xsd:string |
The operation generating the CDR succeeded partially. May be supported, depending on the communication service. |
COMPLETED_NOTIFICATION_FAILED |
xsd:string |
The CDR is completed, but the notification was not delivered to the application. |
POLICY_DENIED |
xsd:string |
Policy denied the operation. |