Get Services for an Account
get
/bcws/webresources/v1.0/subscriptions/account/{id}
Gets the services for an account grouped by bill unit. These services optionally include the charge offers and discount offers sorted in descending order of the purchase date and ascending order of the purchase end date.
Request
Path Parameters
-
id(required): string
The ID of the account, such as 0.0.0.1+-account+123123.
Query Parameters
-
expand: string
Whether to include charge offers and discount offers in the service (offers) or not (any other value). The offers are included by default. Use includechild to include assets from child accounts as well.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The services were returned successfully.
Nested Schema : BillUnitServices
Type:
Show Source
object
-
billUnitID: string
The bill unit's ID.
-
billUnitName: string
The bill unit's name.
-
services: array
services
Nested Schema : Service
Type:
Show Source
object
-
accountNumber: string
The account number associated with the service.
-
discounts: array
discounts
-
extension: object
extension
The extended attributes.
-
products: array
products
-
serviceDetails: object
Discriminator: @class
Discriminator:
{ "propertyName":"@class" }
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Discriminator: @class
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
aliasList: array
aliasList
The list of aliases associated with the service.
-
balanceGroupRef: object
ResourceRef
-
balGrpIndex: integer
(int32)
The balance group index.
-
creationDate: string
(date-time)
The date and time the service type was created.
-
effectiveDate: string
(date-time)
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
lastModified: string
(date-time)
The date and time the service was last modified.
-
lastStatusChange: string
(date-time)
The date and time of the last status change.
-
lastStatusComment: string
The comment associated with the last status change.
-
lifeCycleState: integer
(int32)
The current life cycle state.
-
login(required): string
The login associated with the service.
-
name: string
The name of the service.
-
nameinfoObj: object
ResourceRef
-
password(required): string
The password associated with the service.
-
passwordExpiration: string
(date-time)
The date and time the password expires.
-
passwordStatus: integer
(int32)
The current status of the password.
-
pendingDeferredActionsCount: integer
(int32)
The number of deferred actions that are pending for the service.
-
serviceAccessLevel: string
The service access level.
-
status: integer
(int32)
The status.
-
statusFlags: integer
(int32)
The status flags.
-
subscriptionServiceRef: object
ResourceRef
-
svcExpLastNotiOffset: string
The notification offset.
-
svcExpLastNotiT: string
(date-time)
The last notification time.
Nested Schema : Discount
Type:
Show Source
object
-
description: string
The discount's description.
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
lastStatusChange: string
(date-time)
The date and time the discount's status was last changed.
-
name: string
The discount's name.
-
planName: string
The name of the package containing the discount.
-
purchaseDate(required): string
(date-time)
The date and time the discount was purchased.
-
purchaseEndDate(required): string
(date-time)
The date and time the purchase ends.
-
status: string
The discount's status
-
type: integer
(int32)
The type of discount. Can be one of the following:
- 0: Optional
- 1: Required
- 2: Regular
Nested Schema : extension
Type:
object
The extended attributes.
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 : Product
Type:
Show Source
object
-
contractEndDate: string
(date-time)
The end date for the contract.
-
contractName: string
The name of the contract.
-
contractRef: object
ResourceRef
-
contractStartDate: string
(date-time)
The start date for the contract.
-
description: string
The product's descritpion.
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
isOfferCustomized: boolean
Whether the product contains customized offers (true) or not (false).
-
lastStatusChange: string
(date-time)
The date and time the product's status was last changed.
-
name: string
The product's name.
-
planName: string
The name of the package that contains the product.
-
productRef: object
ResourceRef
-
purchaseDate(required): string
(date-time)
The date and time the product was purchased.
-
purchaseEndDate(required): string
(date-time)
The date and time the purchase ends.
-
status: string
The product's status.
-
termRef: object
ResourceRef
-
type: integer
(int32)
The type of product. Can be one of the following:
- 0: Optional
- 1: Required
- 2: Regular
Nested Schema : extension
Type:
object
The extended attributes.
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.
Nested Schema : extension
Type:
object
The extended attributes.
500 Response
An internal server error occurred.
Examples
This example shows how to get an account's services 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/account/0.0.0.1+-account+57615'
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.
{
"billUnitServices": [
{
"billUnitID": "0.0.0.1+-billinfo+60687",
"billUnitName": "Bill Unit(1)",
"services": [
{
"extension": null,
"serviceDetails": {
"@class": "com.oracle.communications.brm.cc.model.ServiceBase",
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+156801",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1600943653000,
"effectiveDate": 1601383372000,
"lastStatusComment": null,
"lastStatusChange": 1601383372000,
"login": "ip0",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
"accountNumber": "0.0.0.1-57615",
"products": [],
"discounts": []
},
{
"extension": null,
"serviceDetails": {
"@class": "com.oracle.communications.brm.cc.model.ServiceBase",
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+166570",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601448244000,
"effectiveDate": 1598954633000,
"lastStatusComment": null,
"lastStatusChange": 1596523436000,
"login": "IP_Service",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
"accountNumber": "0.0.0.1-57615",
"products": [],
"discounts": []
},
{
"extension": null,
"serviceDetails": {
"@class": "com.oracle.communications.brm.cc.model.ServiceBase",
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+161387",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601388328000,
"effectiveDate": 1600265109000,
"lastStatusComment": null,
"lastStatusChange": 1600265109000,
"login": "service_ip",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
"accountNumber": "0.0.0.1-57615",
"products": [],
"discounts": []
},
{
"extension": null,
"serviceDetails": {
"@class": "com.oracle.communications.brm.cc.model.ServiceBase",
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+165544",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601443489000,
"effectiveDate": 1601443489000,
"lastStatusComment": null,
"lastStatusChange": 1601443489000,
"login": "seivice-ip",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
"accountNumber": "0.0.0.1-57615",
"products": [],
"discounts": []
},
{
"extension": null,
"serviceDetails": {
"@class": "com.oracle.communications.brm.cc.model.ServiceBase",
"extension": null,
"id": {
"id": "0.0.0.1+-service-email+166825",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601536347000,
"effectiveDate": 1607347026000,
"lastStatusComment": null,
"lastStatusChange": 1601536345000,
"login": "email2@expample.com",
"lifeCycleState": 0,
"lastModified": null,
"name": "email",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
"accountNumber": "0.0.0.1-57615",
"products": [],
"discounts": []
},
{
"extension": null,
"serviceDetails": {
"@class": "com.oracle.communications.brm.cc.model.ServiceBase",
"extension": null,
"id": {
"id": "0.0.0.1+-service-email+165033",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601536346000,
"effectiveDate": 1601536345000,
"lastStatusComment": null,
"lastStatusChange": 1601536345000,
"login": "email1@example.com",
"lifeCycleState": 0,
"lastModified": null,
"name": "email",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
"accountNumber": "0.0.0.1-57615",
"products": [],
"discounts": []
},
{
"extension": null,
"serviceDetails": {
"@class": "com.oracle.communications.brm.cc.model.ServiceBase",
"extension": null,
"id": {
"id": "0.0.0.1+-service-email+57999",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1589182094000,
"effectiveDate": 1600956338000,
"lastStatusComment": null,
"lastStatusChange": 1589182094000,
"login": "email@example.com",
"lifeCycleState": 0,
"lastModified": null,
"name": "email",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
"accountNumber": "0.0.0.1-57615",
"products": [],
"discounts": []
},
{
"extension": null,
"serviceDetails": {
"@class": "com.oracle.communications.brm.cc.model.ServiceBase",
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+60815",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1589182094000,
"effectiveDate": 1601461071000,
"lastStatusComment": null,
"lastStatusChange": 1601461071000,
"login": "ip",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
"accountNumber": "0.0.0.1-57615",
"products": [],
"discounts": []
}
]
},
{
"billUnitID": "0.0.0.1+-billinfo+151613",
"billUnitName": "BU-fr",
"services": []
}
]
}