1. REST API Reference for Billing Care
  2. Tasks
  3. Subscriptions

Get Service Details

get

/bcws/webresources/v1.0/subscriptions/service/{id}

Get the details for the service that matches the specified ID.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The service details were returned successfully.
Body ()
Root Schema : BillUnitServices
Type: object
Show Source
Nested Schema : services
Type: array
Show Source
Nested Schema : Service
Type: object
Show Source
Nested Schema : discounts
Type: array
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : products
Type: array
Show Source
Nested Schema : Discriminator: @class
Type: object
Show Source
Nested Schema : Discount
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : ResourceRef
Type: object
Show Source
Nested Schema : Product
Type: object
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : aliasList
Type: array
The list of aliases associated with the service.
Show Source
Nested Schema : extension
Type: object
The extended attributes.
Nested Schema : AliasList
Type: object
The list of aliases associated with the service.
Show Source

500 Response

An internal server error occurred.
Back to Top

Examples

This example shows how to get details of a given service 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/subscriptions/service/0.0.0.1+-service-email+175025

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. 

{
    "billUnitID": null,
    "billUnitName": null,
    "services": [
        {
            "extension": null,
            "serviceDetails": {
                "@class": "com.oracle.communications.brm.cc.model.ServiceBase",
                "extension": null,
                "id": {
                    "id": "0.0.0.1+-service-email+175025",
                    "uri": null
                },
                "pendingDeferredActionsCount": null,
                "accountRef": {
                    "id": "0.0.0.1+-account+174257",
                    "uri": null
                },
                "aliasList": [],
                "balanceGroupRef": null,
                "creationDate": 1514793600000,
                "effectiveDate": null,
                "lastStatusComment": null,
                "lastStatusChange": 1514793600000,
                "login": "parent_csg@portal.com",
                "lifeCycleState": 0,
                "lastModified": null,
                "name": "email",
                "password": null,
                "passwordExpiration": null,
                "passwordStatus": null,
                "status": 10100,
                "statusFlags": null,
                "subscriptionServiceRef": null,
                "serviceAccessLevel": null,
                "balGrpIndex": null,
                "nameinfoObj": null,
                "svcExpLastNotiOffset": null,
                "svcExpLastNotiT": null
            },
            "accountNumber": null,
            "products": [
                {
                    "extension": null,
                    "id": {
                        "id": "0.0.0.1+-purchased_product+174001",
                        "uri": null
                    },
                    "productRef": {
                        "id": "0.0.0.1+-product+44832",
                        "uri": null
                    },
                    "name": "Product 1b - Email Account",
                    "planName": "Plan 1 - Measured Web Access with Discounts",
                    "description": "Charges monthly for 1 email account.",
                    "purchaseDate": 1514793600000,
                    "purchaseEndDate": 1514793600000,
                    "lastStatusChange": 1514793600000,
                    "isOfferCustomized": false,
                    "status": "3",
                    "type": 0,
                    "contractName": null,
                    "contractStartDate": null,
                    "contractEndDate": null,
                    "contractRef": null,
                    "termRef": null
                }
            ],
            "discounts": []
        }
    ]
}
Back to Top