REST API Reference for Billing Care

Get Newsfeed Events

get

/bcws/webresources/v1.0/newsfeed

Gets the newsfeed events for an account that match the specified criteria.

Request

Query Parameters

accountId: string

The ID for the account.
billinfoId: string

The ID for the billinfo.
limit: integer(int32)

Number of events to return, used for pagination.
locale: string

The locale for messages to be fetched.
offset: integer(int32)

Starting point of the response, used for pagination.
referenceId: string

The reference of an associated object. This parameter is ignored when locale is passed.
types: string

The comma-separated string containing different types of newsfeed to fetch.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The newsfeed events were retrieved successfully

Root Schema : schema

Type: array

Show Source

Array of: object newsfeed

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Newsfeed"
    }
}

Nested Schema : newsfeed

Type: object

Show Source

accountRef: object ResourceRef
amount: number

The amount held in newsfeed.
billInfoRef: object ResourceRef
created(required): string (date-time)

The time the newsfeed object was created.
eventRef: object ResourceRef
extension: object extension

The extended attributes.
externalUser: string

The external CSR who created this newsfeed.
id: object ResourceRef
message: string

The combination of ID and value used for localizing details.
objectRef: object ResourceRef
reasonDomainId: integer (int32)

The reason code domain ID for the newsfeed entry.
reasonId: integer (int32)

The reason code ID for this newsfeed.
resourceId: integer (int32)

Numeric ID of the resource that is impacted.
typeId: integer (int32)

The specific type of the newsfeed entry.
typeStr: string

Additional details related to the type newsfeed type.

{
    "required":[
        "created"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "created":{
            "type":"string",
            "description":"The time the newsfeed object was created.",
            "format":"date-time"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "amount":{
            "type":"number",
            "description":"The amount held in newsfeed."
        },
        "billInfoRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "eventRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "externalUser":{
            "type":"string",
            "description":"The external CSR who created this newsfeed."
        },
        "message":{
            "type":"string",
            "description":"The combination of ID and value used for localizing details."
        },
        "objectRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "reasonDomainId":{
            "type":"integer",
            "description":"The reason code domain ID for the newsfeed entry.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason code ID for this newsfeed.",
            "format":"int32"
        },
        "resourceId":{
            "type":"integer",
            "description":"Numeric ID of the resource that is impacted.",
            "format":"int32"
        },
        "typeId":{
            "type":"integer",
            "description":"The specific type of the newsfeed entry.",
            "format":"int32"
        },
        "typeStr":{
            "type":"string",
            "description":"Additional details related to the type newsfeed type."
        }
    },
    "xml":{
        "name":"newsfeed"
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

400 Response

The request isn't valid.

500 Response

An internal server error occurred.

Examples

This example shows how to get a newsfeed 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/newsfeed

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. You can see the bill items grouped separately under the IP service and the email service.

 [
    {
        "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": ""
    }
]