Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The service details were returned successfully.

Body ()

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

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

Nested Schema : Service

Type: object

Show Source

• 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" }

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "serviceDetails":{
            "$ref":"#/components/schemas/ServiceBase"
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number associated with the service."
        },
        "products":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Product"
            }
        },
        "discounts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Discount"
            }
        }
    }
}

Nested Schema : discounts

Type: array

Show Source

• Array of: object Discount

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

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : products

Type: array

Show Source

• Array of: object Product

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

Nested Schema : Discriminator: @class

Type: object

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• 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.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : Discount

Type: object

Show Source

• 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

{
    "required":[
        "purchaseDate",
        "purchaseEndDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The discount's name."
        },
        "planName":{
            "type":"string",
            "description":"The name of the package containing the discount."
        },
        "description":{
            "type":"string",
            "description":"The discount's description."
        },
        "purchaseDate":{
            "type":"string",
            "description":"The date and time the discount was purchased.",
            "format":"date-time"
        },
        "purchaseEndDate":{
            "type":"string",
            "description":"The date and time the purchase ends.",
            "format":"date-time"
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time the discount's status was last changed.",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "description":"The discount's status"
        },
        "type":{
            "type":"integer",
            "description":"The type of discount. Can be one of the following: <ul><li><b>0</b>: Optional</li><li><b>1</b>: Required</li><li><b>2</b>: Regular</li></ul>",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

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

Type: object

Show Source

• 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

{
    "required":[
        "purchaseDate",
        "purchaseEndDate"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "productRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The product's name."
        },
        "planName":{
            "type":"string",
            "description":"The name of the package that contains the product."
        },
        "description":{
            "type":"string",
            "description":"The product's descritpion."
        },
        "purchaseDate":{
            "type":"string",
            "description":"The date and time the product was purchased.",
            "format":"date-time"
        },
        "purchaseEndDate":{
            "type":"string",
            "description":"The date and time the purchase ends.",
            "format":"date-time"
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time the product's status was last changed.",
            "format":"date-time"
        },
        "isOfferCustomized":{
            "type":"boolean",
            "description":"Whether the product contains customized offers (<b>true</b>) or not (<b>false</b>)."
        },
        "status":{
            "type":"string",
            "description":"The product's status."
        },
        "type":{
            "type":"integer",
            "description":"The type of product. Can be one of the following: <ul><li><b>0</b>: Optional</li><li><b>1</b>: Required</li><li><b>2</b>: Regular</li></ul>",
            "format":"int32"
        },
        "contractName":{
            "type":"string",
            "description":"The name of the contract."
        },
        "contractStartDate":{
            "type":"string",
            "description":"The start date for the contract.",
            "format":"date-time"
        },
        "contractEndDate":{
            "type":"string",
            "description":"The end date for the contract.",
            "format":"date-time"
        },
        "contractRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "termRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    }
}

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.

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

Nested Schema : extension

Type: object

The extended attributes.

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.

Back to Top