Get Events
get
/bcws/webresources/v1.0/events
Gets the list of events that match the specified criteria.
Request
Query Parameters
-
accountId: string
The ID for the account.
-
billId: string
The bill ID.
-
billUnitId: string
The bill unit ID.
-
createdEndTime: integer(int64)
The time the event creation ended.
-
createdStartTime: integer(int64)
The time the event creation started.
-
effectiveEndTime: integer(int64)
The maximum effective time of the event.
-
effectiveStartTime: integer(int64)
The minimum effective time of the event.
-
endTime: integer(int64)
The end time of the event.
-
eventType: array[string]
The event types list.
-
itemId: string
The item ID.
-
limit: integer(int32)
Number of events to return, used for pagination.
-
offset: integer(int32)
Starting point of the response, used for pagination.
-
serviceId: string
The service ID.
-
startTime: integer(int64)
The start time of the event.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The event information was returned successfully.
Nested Schema : event
Type:
Show Source
object-
accountRef: object
ResourceRef
-
archiveStatus: integer
(int32)
Archiving status for this event instance.
-
balanceImpacts(required): array
balanceImpacts
-
batchId(required): string
Batch ID for this event.
-
created(required): string
(date-time)
The time the event object was created.
-
currency: integer
(int32)
Currency of the account to which this event applies.
-
earnedEndTime(required): string
(date-time)
The time the event stops earning.
-
earnedStartTime(required): string
(date-time)
The time the event starts earning.
-
earnedType: integer
(int32)
Indicates earnings type: 0<\b> (default) indicates that the event is earned immediately, and 1<\b> indicates that the event is earned over a period of time.\b>\b>
-
effectiveT(required): string
(date-time)
Effective time of the event.
-
endTime(required): string
(date-time)
The time the event ends.
-
eventCategory(required): string
The name for the event tab in UI.
-
eventDesc(required): string
The event description.
-
eventNumber(required): string
The user-defined event number.
-
extension: object
extension
The extended attributes.
-
flags: integer
(int32)
Reserved for future use.
-
groupRef: object
ResourceRef
-
id: object
ResourceRef
-
incrQuantity: number
(double)
Incremental value for RUM Quantity rounding. RUM Quantity is always rounded to an integral multiple of this value.
-
incrUnit: number
(double)
Units for the incrQuantity.
-
invoiceData(required): string
Cache the fields in /event that are used for invoicing. This is to improve the performance in event search by moving some sub-table fields into this top level field.
-
itemRef: object
ResourceRef
-
linkObj: object
ResourceRef
-
loaderBatchRef: object
ResourceRef
-
minQuantity: number
(double)
Minimum value that for RUM Quantity rounding. Values smaller than this value are rounded to this value.
-
minUnit: integer
(int32)
Units for minQuantity. Can be one of the following:
- 0: None
- 1: Seconds
- 2: Minutes
- 3: Hours
- 4: Hours
-
modT(required): string
(date-time)
The epoch when this event was last modified.
-
monitorImpacts(required): array
monitorImpacts
-
monitorSubBalanceImpacts(required): array
monitorSubBalanceImpacts
-
name(required): string
The name of the event.
-
napIdAddress(required): string
The IP address of the client machine.
-
netQuantity: number
(double)
Net quantity calculated after performing the rounding.
-
networkSessionId(required): string
The session identifier for the event.
-
originalBatchId(required): string
Mediation Batch Id this event belongs to.
-
profileLabelList(required): string
This field contains list of ERA labels.
-
providerDescr(required): string
When a part of the charges associated with this event needs to be remitted to another vendor, this field identifies the topic to which it relates.
-
providerIpaddr(required): string
IP address of the service provider.
-
providerRef: object
ResourceRef
-
ratedTimezoneId(required): string
TimeZone ID actually used for rating.
-
rerateRef: object
ResourceRef
-
roundingMode: integer
(int32)
Specifies how RUM quantity is rounded.
-
rumMap(required): array
rumMap
-
rumName(required): string
Specifies which RUM was used to rate this event type. Must be a defined Candidate RUM for this event type.
-
serviceRef: object
ResourceRef
-
sessionRef: object
ResourceRef
-
startTime(required): string
(date-time)
The time when the event started.
-
subBalanceImpacts(required): array
subBalanceImpacts
-
sysDescr(required): string
The system-generated description that describes the event programmatically. The actual value depends on the event subtype.
-
taxJurisdictions(required): array
taxJurisdictions
-
taxLocales(required): string
Tax locales for the order origin, order acceptance, ship from, and ship to, separated by semicolons. If the location of the company is available, it is appended to the above string. If it is a telephony event, then NPA/NXX or Geocode information is appended to the string as well.
-
taxSupplier: integer
(int32)
The event's tax supplier.
-
timezoneAdjEndTime(required): string
(date-time)
The creation ends time adjusted to the subscriber's time zone.
-
timezoneAdjStartTime(required): string
(date-time)
The creation start time adjusted to the subscriber's time zone.
-
timezoneId(required): string
The time zone ID of the event as string.
-
timezoneMode: integer
(int32)
The time zone to use when applying time-dependent rates.
-
todMode: integer
(int32)
Time-of-day mode defines how time-dependant rates are applied to the event.
-
unit: integer
(int32)
Unit of the quantity applied.
-
unratedQuantity: number
(double)
Quantity which has not been rated.
-
usageType(required): string
The subscriber's usage scenario, for example, customer-to-customer call, birthdate call, closed-user-group call, friends and family, and so forth.
-
userRef: object
ResourceRef
Nested Schema : ResourceRef
Type:
Show Source
object-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : extension
Type:
objectThe extended attributes.
Nested Schema : BalanceImpact
Type:
Show Source
object-
accountRef: object
ResourceRef
-
amount: number
(double)
The impact to the account balance. The value may be either positive or negative.
-
balanceGroupRef: object
ResourceRef
-
deferredAmount: number
(double)
Tax-deferred amount.
-
discount: number
(double)
The discount applied to the balance impact.
-
discountInfo: string
Discount related information from IntegRate, loaded by the rated event loader
-
extension: object
extension
The extended attributes.
-
glId: integer
(int32)
G/L ID associated with this balance impact, which can be 0.
-
impactCategory: string
Name of the impact category that was used to generate this balance impact for the rated event.
-
impactType: integer
(int32)
Balance impact type, rated by the rated engine.
-
itemObj: object
ResourceRef
-
lineage: string
The lineage of event fields if a zone map is used in rate plan selection.
-
offeringRef: object
ResourceRef
-
originalAmount: number
(double)
The secondary currency amount specified in a pre-rated incoming event.
-
originalResourceId: integer
(int32)
Numeric value of the currency used to specify the amount in original amount field.
-
outstandingAmount: number
(double)
The outstanding amount.
-
percent: number
(double)
Proration percentage for cycle events.
-
productObj: object
ResourceRef
-
quantity: number
(double)
The number of units that were actually applied using this rate.
-
rateObj: object
ResourceRef
-
rateTag: string
Description of the rate used.
-
resourceId: integer
(int32)
Numeric ID of the resource that is impacted.
-
rumName: string
The name of the ratable usage metric (RUM).
-
taxCode: string
Tax code for the rate that was used. If taxes do not apply, this field will be set to 0.
-
taxExemptionCode: string
The tax exemption code.
Nested Schema : extension
Type:
objectThe extended attributes.
Nested Schema : MonitorImpact
Type:
Show Source
object-
accountRef: object
ResourceRef
-
amount: number
(double)
The impact to the account balance.
-
balanceGroupRef: object
ResourceRef
-
extension: object
extension
The extended attributes.
-
resourceId: integer
(int32)
Numeric value of the resource that is impacted.
Nested Schema : extension
Type:
objectThe extended attributes.
Nested Schema : SubBalanceImpact
Type:
Show Source
object-
availableLoanBalance: number
(double)
The loan balance available for this resource
-
balanceGroupObj: object
ResourceRef
-
currentBal: number
(double)
The total available main balance for this resource.
-
extension: object
extension
The extended attributes.
-
resourceId: integer
(int32)
Numeric ID of the resource that is impacted.
-
subBalances(required): array
subBalances
Nested Schema : extension
Type:
objectThe extended attributes.
Nested Schema : EventSubBalances
Type:
Show Source
object-
amount: number
The amount of the sub-balance.
-
contributorStr: string
The contributor for this sub-balance counter.
-
elementId: integer
(int32)
The ID of the element.
-
extension: object
extension
The extended attributes.
-
grantedBal: number
The granted balance of the sub-balance.
-
grantorObj: object
ResourceRef
-
rolloverData: integer
(int32)
Indicates whether balances in this bucket can be rolled over, and if so, how.
-
subType: integer
(int32)
The type of sub balance.
-
validFrom: string
(date-time)
Validity period start date and time
-
validFromDetails: integer
(int32)
Validity period start date and time details
-
validTo: string
(date-time)
Validity period end date and time
-
validToDetails: integer
(int32)
Validity period end date and time details
Nested Schema : extension
Type:
objectThe extended attributes.
Nested Schema : RumMap
Type:
Show Source
object-
extension: object
extension
The extended attributes.
-
netQuantity: number
(double)
Net quantity calculated after performing the rounding.
-
rumName(required): string
Specifies which RUM was used to rate the event. See /config/rum for details about RUMs.
-
unratedQuantity: number
(double)
Quantity which has not been rated.
Nested Schema : extension
Type:
objectThe extended attributes.
Nested Schema : TaxJurisdiction
Type:
Show Source
object-
amount: number
(double)
The actual tax that is levied for this jurisdiction.
-
amountExempt: number
(double)
Amount exempted from taxes.
-
amountGross: number
(double)
Gross amount. Taxable after deducting exemptions.
-
amountTaxed: number
(double)
Amount eligible for taxing in this jurisdiction. This is equal to the gross taxable amount minus the exemptions and any amounts that have been taxed already for a different jurisdiction.
-
elementId: integer
(int32)
Balance impact array element ID match.
-
extension: object
extension
The extended attributes.
-
name(required): string
The name of the jurisdiction, in the format: top-level-jurisdiction;{intermediate-levels-separated-by-semicolons};current-jurisdiction.
-
percent: number
(double)
Tax percentage for the jurisdiction type.
-
type: integer
(int32)
Jurisdiction type.
Nested Schema : extension
Type:
objectThe extended attributes.
204 Response
No search criteria were provided for the event search.
400 Response
The request is not valid.
500 Response
An internal server error occurred.
Examples
This example shows how to get event details by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X GET 'http://hostname:port/bcws/webresources/version/events
where:
- hostname is the URL for the Billing Care REST server.
- port is the port for the Billing Care REST server.
- version is the version of the API you're using, such as v1.0.
Example of Response Body
This example shows the contents of the response body in JSON format.
[
{
"extension": null,
"id": {
"id": "0.0.0.1+-newsfeed+358845410934774345",
"uri": null
},
"created": 1762419890000,
"accountRef": {
"id": "0.0.0.1+-account+384667",
"uri": null
},
"amount": -0.002,
"billInfoRef": {
"id": "0.0.0.1+-billinfo+384411",
"uri": null
},
"eventRef": {
"id": "0.0.0.1+-event-billing-dispute-event+358845410934772297",
"uri": null
},
"externalUser": "weblogic",
"message": "120",
"objectRef": {
"id": "0.0.0.1+-item-dispute+358845410934774857",
"uri": null
},
"reasonDomainId": 60,
"reasonId": 107,
"resourceId": 978,
"typeId": 3,
"typeStr": "D1-181"
},
{
"extension": null,
"id": {
"id": "0.0.0.1+-newsfeed+358845410934775625",
"uri": null
},
"created": 1762419973000,
"accountRef": {
"id": "0.0.0.1+-account+384667",
"uri": null
},
"amount": 0,
"billInfoRef": {
"id": "0.0.0.1+-billinfo+384411",
"uri": null
},
"eventRef": {
"id": "0.0.0.1+-event-billing-settlement-event+358845410934773577",
"uri": null
},
"externalUser": "weblogic",
"message": "123;;126;;999|~|0.002;;999|~|D1-181",
"objectRef": {
"id": "0.0.0.1+-item-settlement+358845410934774601",
"uri": null
},
"reasonDomainId": 60,
"reasonId": 108,
"resourceId": 978,
"typeId": 4,
"typeStr": ""
}
]