REST API Reference for Billing Care

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

id(required): string

The ID of the service, such as 0.0.0.1+-service-telco-gsm-sms+234567.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The service details were returned successfully.

Root Schema : BillUnitServices

Type: object

Show Source

billUnitID: string

The bill unit's ID.
billUnitName: string

The bill unit's name.
services: array services

{
    "type":"object",
    "properties":{
        "billUnitID":{
            "type":"string",
            "description":"The bill unit's ID."
        },
        "billUnitName":{
            "type":"string",
            "description":"The bill unit's name."
        },
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Service"
            }
        }
    }
}

Nested Schema : services

Type: array

Show Source

Array of: object Service

A service associated with the bundle.

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

Nested Schema : Service

Type: object

A service associated with the bundle.

Show Source

aliasList: array aliasList

The list of aliases associated with the service.
login(required): string

The login associated with the service.
serviceId: object ResourceRef
serviceKey: string

The service key.
serviceType: string

The service type.
status: integer (int32)

The status.

{
    "required":[
        "login"
    ],
    "type":"object",
    "properties":{
        "serviceKey":{
            "type":"string",
            "description":"The service key."
        },
        "serviceType":{
            "type":"string",
            "description":"The service type."
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "serviceId":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        }
    },
    "description":"A service associated with the bundle."
}

Nested Schema : aliasList

Type: array

The list of aliases associated with the service.

Show Source

Array of: object AliasList

The list of aliases associated with the service.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

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 : AliasList

Type: object

The list of aliases associated with the service.

Show Source

elem: integer (int32)
name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

500 Response

An internal server error occurred.

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