REST API Reference for Billing Care

Get Services for a Contract

get

/bcws/webresources/v1.0/subscriptions/contracts/{id}/services

Gets a list of all services associated with a contract.

Request

Path Parameters

id(required): string

The ID of the contract.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The list of services associated with the contract was retrieved successfully.

Root Schema : schema

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 a list of all services associated with a contract 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/contract/0.0.0.1+-subscriber_contract+183887/services'

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,
        "serviceDetails": {
            "@class": "com.oracle.communications.brm.cc.model.ServiceBase",
            "extension": null,
            "id": {
                "id": "0.0.0.1+-service-ip+328998",
                "uri": null
            },
            "pendingDeferredActionsCount": null,
            "accountRef": {
                "id": "0.0.0.1+-account+112724",
                "uri": null
            },
            "aliasList": [],
            "balanceGroupRef": null,
            "creationDate": 1711030499000,
            "effectiveDate": null,
            "lastStatusComment": null,
            "lastStatusChange": 1711030499000,
            "login": "a1111111112as",
            "lifeCycleState": 0,
            "lastModified": null,
            "name": "ip",
            "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": [],
        "discounts": []
    }
]