Jump to

• Request
• Response
• Examples

Get Bucket Balances

get

/bucket

Gets the bucket balances that match the specified query criteria.

Request

Query Parameters

• @type: string
  The type of object to return. Use @type=Bucket for a base object or @type=BucketOracle for an extended object.
• fields: string
  The list of comma-separated fields to return in the response.

  Examples

  Select an example fields=name,partyAccount,product

• limit: integer
  The maximum number of results to return.

  Examples

  Select an example Use limit=10 to return the first 10 results only.

• offset: integer
  The number of results to offset the response by.

  Examples

  Select an example Use offset=10 to return results 10 and higher.

• partyAccount.id: string
  Retrieves buckets with the associated party account ID or External ID.

  Examples

  Select an example partyAccount.id=0.0.0.1+-account+288459 partyAccount.id=test_acc_14080

• product.id: string
  Retrieves the buckets for the product with the specified ID, Login ID or Alias Name.

  Examples

  Select an example product.id=0.0.0.1+-service-telco-gsm+67479 product.id=aliasGSM_1101

• status: string
  Retrieves buckets with the specified status: ACTIVE, INACTIVE, or CLOSED.

  Examples

  Select an example status=ACTIVE

• usageType: string
  Retrieves buckets with the specified usage type: monetary or other.

  Examples

  Select an example usageType=monetary

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

The bucket balances were retrieved successfully.

Headers

• X-Result-Count:
  The number of items returned in the response body.
• X-Total-Count:
  The total number of items that matched the criteria.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object Bucket
  Title: Bucket

  A bucket that tracks a quantity of usage (remaining or consumed) for currency or noncurrency resources (such as messages, minutes, data).

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

Nested Schema : Bucket

Type: object

Title: Bucket

A bucket that tracks a quantity of usage (remaining or consumed) for currency or noncurrency resources (such as messages, minutes, data).

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property).
• @type: string
  Title: Type

  The object's subclass.
• description: string
  The bucket's description. (BRM does not use this property).
• href(required): string
  Title: Bucket Href

  The bucket's href. (BRM does not use this property).
• id(required): string
  Title: Bucket ID

  The bucket's ID.
• isShared: boolean
  Title: Is Shared

  The value indicates whether the bucket is shared between several devices or users (true) or not (false).
• logicalResource: array logicalResource
  The logical resources are associated with the bucket.
• name: string
  Title: Bucket Name

  The bucket's name.
• partyAccount: object Party Account Ref
  Title: Party Account Ref

  A reference to a party account.
• product: array product
  The products are associated with the bucket.
• relatedParty: array relatedParty
  The parties are related to the bucket. (BRM does not use this property).
• remainingValue: object Quantity
  Represents an amount in a specified unit.
• remainingValueName: string
  Title: Remaining Value

  A string, including value and unit, representing the remaining amount in the bucket, used for display purposes. For example, 1.9 GB.
• reservedValue: object Quantity
  Represents an amount in a specified unit.
• status(required): string
  The bucket's status. For example: active, expired, or suspended.
• usageType: string
  The bucket's usage type.
• validFor(required): object TimePeriod
  Represents a time period with a start date, an end date, or both.

{
    "required":[
        "id",
        "href",
        "validFor",
        "status"
    ],
    "type":"object",
    "title":"Bucket",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property).",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "description":"The bucket's description. (BRM does not use this property)."
        },
        "href":{
            "type":"string",
            "title":"Bucket Href",
            "description":"The bucket's href. (BRM does not use this property)."
        },
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "isShared":{
            "type":"boolean",
            "title":"Is Shared",
            "description":"The value indicates whether the bucket is shared between several devices or users (<b>true</b>) or not (<b>false</b>)."
        },
        "logicalResource":{
            "type":"array",
            "description":"The logical resources are associated with the bucket.",
            "items":{
                "$ref":"#/components/schemas/LogicalResourceRef"
            }
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket's name."
        },
        "partyAccount":{
            "description":"The party account associated with the bucket.",
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "product":{
            "type":"array",
            "description":"The products are associated with the bucket.",
            "items":{
                "$ref":"#/components/schemas/ProductRef"
            }
        },
        "relatedParty":{
            "type":"array",
            "description":"The parties are related to the bucket. (BRM does not use this property).",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "remainingValue":{
            "description":"The amount remaining in the bucket.",
            "$ref":"#/components/schemas/Quantity"
        },
        "remainingValueName":{
            "type":"string",
            "title":"Remaining Value",
            "description":"A string, including value and unit, representing the remaining amount in the bucket, used for display purposes. For example, <b>1.9 GB</b>."
        },
        "reservedValue":{
            "description":"The amount reserved in the bucket.",
            "$ref":"#/components/schemas/Quantity"
        },
        "status":{
            "type":"string",
            "description":"The bucket's status. For example&colon; <b>active</b>, <b>expired</b>, or <b>suspended</b>."
        },
        "usageType":{
            "type":"string",
            "description":"The bucket's usage type."
        },
        "validFor":{
            "description":"The time period for which the bucket is valid.",
            "$ref":"#/components/schemas/TimePeriod"
        }
    },
    "description":"A bucket that tracks a quantity of usage (remaining or consumed) for currency or noncurrency resources (such as messages, minutes, data)."
}

Nested Schema : logicalResource

Type: array

The logical resources are associated with the bucket.

Show Source

• Array of: object Logical Resource Ref
  Title: Logical Resource Ref

  A reference to a logical resource.

{
    "type":"array",
    "description":"The logical resources are associated with the bucket.",
    "items":{
        "$ref":"#/components/schemas/LogicalResourceRef"
    }
}

Nested Schema : Party Account Ref

Type: object

Title: Party Account Ref

A reference to a party account.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• description: string
  Title: Description

  The party account's description.
• href: string
  Title: Href

  The party account's href.
• id(required): string
  Title: Account ID

  The party account's ID.
• name: string
  Title: Name

  The party account's name.
• status: string
  Title: Status

  The overall status of the account. For example: due, paid, or in arrears.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Party Account Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The party account's name."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The overall status of the account. For example&colon; <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        }
    },
    "description":"A reference to a party account."
}

Nested Schema : product

Type: array

The products are associated with the bucket.

Show Source

• Array of: object ProductRef
  A product reference.

{
    "type":"array",
    "description":"The products are associated with the bucket.",
    "items":{
        "$ref":"#/components/schemas/ProductRef"
    }
}

Nested Schema : relatedParty

Type: array

The parties are related to the bucket. (BRM does not use this property).

Show Source

• Array of: object Related Party
  Title: Related Party

  A party related to another object.

{
    "type":"array",
    "description":"The parties are related to the bucket. (BRM does not use this property).",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

Nested Schema : Quantity

Type: object

Represents an amount in a specified unit.

Show Source

• amount: number (double)
  Default Value: 1

  The numeric value in the specified unit.
• units: string
  The unit.

{
    "type":"object",
    "description":"Represents an amount in a specified unit.",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "default":1,
            "description":"The numeric value in the specified unit."
        },
        "units":{
            "type":"string",
            "nullable":true,
            "description":"The unit."
        }
    }
}

Nested Schema : TimePeriod

Type: object

Represents a time period with a start date, an end date, or both.

Show Source

• endDateTime: string (date-time)
  The end of the time period in IETF RFC 3339 format.

  Example: 1985-04-12T23:20:50.52Z
• startDateTime: string (date-time)
  The start of the time period in IETF RFC 3339 format.

  Example: 1985-04-12T23:20:50.52Z

{
    "type":"object",
    "description":"Represents a time period with a start date, an end date, or both.",
    "properties":{
        "startDateTime":{
            "description":"The start of the time period in IETF RFC 3339 format.",
            "type":"string",
            "nullable":true,
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z"
        },
        "endDateTime":{
            "description":"The end of the time period in IETF RFC 3339 format.",
            "type":"string",
            "nullable":true,
            "format":"date-time",
            "example":"1985-04-12T23:20:50.52Z"
        }
    }
}

Nested Schema : Logical Resource Ref

Type: object

Title: Logical Resource Ref

A reference to a logical resource.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType: string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• href: string
  Title: Href

  The resource's href.
• id(required): string
  Title: ID

  The resource's ID.
• name: string
  Title: Name

  The resource's name.
• value: string
  The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN).

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Logical Resource Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The resource's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The resource's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The resource's name."
        },
        "value":{
            "type":"string",
            "description":"The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN)."
        }
    },
    "description":"A reference to a logical resource."
}

Nested Schema : ProductRef

Type: object

A product reference.

Match All

A product reference.

A product reference.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• allOf EntityRef

{
    "type":"object",
    "description":"A product reference.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Addressable
  Defines a base schema for addressable entities.
• object EntityRef-allOf[2]
  Represents an entity reference schema for EntityRef classes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"Represents an entity reference schema for EntityRef classes.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The referred entity's name."
                },
                "@referredType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

• href: string
  The hyperlink reference.
• id: string
  The ID.

{
    "type":"object",
    "description":"Defines a base schema for addressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

• @referredType: string
  The actual type of the target instance when needed for disambiguation.
• href: string
  The URI of the referred entity.
• id(required): string
  The identifier of the referred entity.
• name: string
  The referred entity's name.

{
    "type":"object",
    "description":"Represents an entity reference schema for EntityRef classes.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The referred entity's name."
        },
        "@referredType":{
            "type":"string",
            "nullable":true,
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

Nested Schema : Related Party

Type: object

Title: Related Party

A party related to another object.

Show Source

• @baseType: string
  Title: Base Type

  The object's superclass.
• @referredType(required): string
  Title: Referred Type

  The object's type in the target system, if baseType and type need further disambiguation.
• @schemaLocation: string (uri)
  Title: Schema Location

  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  Title: Type

  The object's subclass.
• href: string (uri)
  Title: Href

  The party's href.
• id(required): string
  Title: Party ID

  The party's ID.
• name: string
  Title: Party Name

  The party's name.
• role: string
  Title: Party Role

  The party's role.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Party",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Party ID",
            "description":"The party's ID."
        },
        "name":{
            "type":"string",
            "title":"Party Name",
            "description":"The party's name."
        },
        "role":{
            "type":"string",
            "title":"Party Role",
            "description":"The party's role."
        }
    },
    "description":"A party related to another object."
}

400 Response

The request isn't valid.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

401 Response

The client doesn't have the correct privileges.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

403 Response

The request wasn't authorized.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

404 Response

The requested resource couldn't be found.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

405 Response

This method is not allowed.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

409 Response

The request could not be processed due to the conflict with the existing state of the resource.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

500 Response

The system encountered an internal error.

Body ()

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

• object Extensible
  Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
• object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

• @baseType: string
  The superclass.
• @schemaLocation: string
  The URI of a JSON Schema file that defines additional attributes and relationships.
• @type(required): string
  The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

• code(required): string
  The application-specific error detail defined by the API or a common list.
• message: string
  Provides error details and corrective actions for a client user.
• reason(required): string
  Explains the error to a client user.
• referenceError: string
  The URI of documentation that describes the error.
• status: string
  The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

Back to Top

Examples

• Example 1: Get Bucket Balances Using Product ID Query Parameter

• Example 2: Get Bucket Balances Using Status Query Parameter

Example 1: Get Bucket Balances Using Product ID Query Parameter

The following example shows how to get bucket balances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses the product.id query parameter to restrict the results.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/bucket?product.id=0.0.0.1+-service-telco-gsm-sms+102975'

Response Body

The following example shows the contents of the response body in JSON format.

[
   {
      "id": "0.0.0.1+-balance_group+106463",
      "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+106463",
      "confirmationDate": null,
      "description": null,
      "isShared": null,
      "name": "Account Balance Group",
      "remainingValueName": null,
      "requestedDate": null,
      "logicalResource": null,
      "partyAccount": {
         "id": "0.0.0.1+-account+102879",
         "href": null,
         "description": null,
         "name": "Adam Baker",
         "status": "active",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "PartyAccountRef",
         "@referredType": null
      },
      "product": [
         {
            "id": "0.0.0.1+-service-telco-gsm-sms+102975",
            "href": null,
            "name": "ServiceTelcoGsmSms",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "ProductRef",
            "@referredType": null
         },
         {
            "id": "0.0.0.1+-service-telco-gsm-telephony+104255",
            "href": null,
            "name": "ServiceTelcoGsmTelephony",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "ProductRef",
            "@referredType": null
         }
      ],
      "relatedParty": null,
      "remainingValue": {
         "amount": 45.0,
         "units": "EUR",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "Quantity"
      },
      "reservedValue": {
         "amount": 0.0,
         "units": "EUR",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "Quantity"
      },
      "status": "ACTIVE",
      "usageType": null,
      "validFor": {
         "endDateTime": null,
         "startDateTime": "2025-05-02T00:00:00-07:00"
      },
      "@baseType": "Bucket",
      "@schemaLocation": null,
      "@type": "Bucket"
   }
]

Example 2: Get Bucket Balances Using Status Query Parameter

The following example shows how to get bucket balances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses the status query parameter to restrict the results.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/bucket?status=ACTIVE'

Response Body

The following example shows the contents of the response body in JSON format.

[
   {
      "id": "0.0.0.1+-balance_group+12345",
      "href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+12345",
      "confirmationDate": null,
      "description": null,
      "isShared": null,
      "name": "Account Balance Group",
      "remainingValueName": null,
      "requestedDate": null,
      "logicalResource": null,
      "partyAccount": {
         "id": "0.0.0.1+-account+98765",
         "href": null,
         "description": null,
         "name": "Sunita Patel",
         "status": "active",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "PartyAccountRef",
         "@referredType": null
      },
      "product": [
         {
            "id": "0.0.0.1+-service-telco-gsm-sms+475867",
            "href": null,
            "name": "ServiceTelcoGsmSms",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "ProductRef",
            "@referredType": null
         },
         {
            "id": "0.0.0.1+-service-telco-gsm-telephony+104255",
            "href": null,
            "name": "ServiceTelcoGsmTelephony",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": "ProductRef",
            "@referredType": null
         }
      ],
      "relatedParty": null,
      "remainingValue": {
         "amount": 10.0,
         "units": "USD",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "Quantity"
      },
      "reservedValue": {
         "amount": 15.0,
         "units": "USD",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "Quantity"
      },
      "status": "ACTIVE",
      "usageType": null,
      "validFor": {
         "endDateTime": null,
         "startDateTime": "2025-01-02T00:00:00-07:00"
      },
      "@baseType": "Bucket",
      "@schemaLocation": null,
      "@type": "Bucket"
   }
]

Get bucket balances using an account external ID

The following example retrieves bucket balances using the account external ID in the partyAccount.id query parameter.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/v4/bucket?@type=BucketOracle&partyAccount.id=test_account_140598'

where:

• host is the URL for the REST server.
• port is the port for the REST server.

Example of Response Body

[
  {
    "id": "0.0.0.1+-balance_group+141494+840+0",
    "href": "https://localhost:8080/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+141494+840+0",
    "confirmationDate": "0",
    "description": "",
    "isShared": false,
    "name": "Balance Group<Account>",
    "remainingValueName": "",
    "requestedDate": "0",
    "logicalResource": [
      {
        "@baseType": "LogicalResourceRef",
        "@referredType": null,
        "@schemaLocation": null,
        "@type": "LogicalResourceRef",
        "href": null,
        "id": null,
        "name": null,
        "value": "472-20260410-072856-0-245742-906351744-cagbu-phx-1038"
      }
    ],
    "partyAccount": {
      "id": "test_account_140598",
      "href": null,
      "description": null,
      "name": "Venkateswari Moorthy",
      "status": "active",
      "@baseType": "PartyAccountRef",
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
    },
    "product": [
      {
        "id": "0.0.0.1+-service-telco-gsm-telephony+143030",
        "href": null,
        "name": "ServiceTelcoGsmTelephony",
        "@baseType": "ProductRef",
        "@schemaLocation": null,
        "@type": "ProductRef",
        "@referredType": null
      }
    ],
    "relatedParty": [],
    "remainingValue": {
      "amount": 176.21,
      "units": "USD",
      "@baseType": "Quantity",
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "reservedValue": {
      "amount": 0.0,
      "units": "USD",
      "@baseType": "Quantity",
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "status": "ACTIVE",
    "usageType": "MONETARY",
    "validFor": {
      "endDateTime": null,
      "startDateTime": "2026-04-10T12:30:00+05:30",
      "@baseType": "TimePeriod",
      "@schemaLocation": null,
      "@type": "TimePeriod"
    },
    "@baseType": "Bucket",
    "@schemaLocation": "",
    "@type": "Bucket"
  }
]

Get bucket balances using a service alias

The following example retrieves bucket balances using a service alias in the product.id query parameter.

curl -X GET 'http://host:port/brm/prepayBalanceManagement/v4/bucket?@type=BucketOracle&product.id=aliasIMEIBase_0010'

where:

• host is the URL for the REST server.
• port is the port for the REST server.

Example of Response Body

[
  {
    "id": "0.0.0.1+-balance_group+175837+840+0",
    "href": "https://localhost:8080/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+175837+840+0",
    "confirmationDate": "0",
    "description": "",
    "isShared": false,
    "name": "",
    "remainingValueName": "",
    "requestedDate": "0",
    "logicalResource": [
      {
        "@baseType": "LogicalResourceRef",
        "@referredType": null,
        "@schemaLocation": null,
        "@type": "LogicalResourceRef",
        "href": null,
        "id": null,
        "name": null,
        "value": ""
      }
    ],
    "partyAccount": {
      "id": "0.0.0.1+-account+173981",
      "href": null,
      "description": null,
      "name": "Rachel Douglas",
      "status": "active",
      "@baseType": "PartyAccountRef",
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
    },
    "product": [
      {
        "id": "aliasIMEIBase_0010",
        "href": null,
        "name": "ServiceTelcoGsmTelephony",
        "@baseType": "ProductRef",
        "@schemaLocation": null,
        "@type": "ProductRef",
        "@referredType": null
      }
    ],
    "relatedParty": [],
    "remainingValue": {
      "amount": 260.0,
      "units": "USD",
      "@baseType": "Quantity",
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "reservedValue": {
      "amount": 0.0,
      "units": "USD",
      "@baseType": "Quantity",
      "@schemaLocation": null,
      "@type": "Quantity"
    },
    "status": "ACTIVE",
    "usageType": "MONETARY",
    "validFor": {
      "endDateTime": null,
      "startDateTime": "2026-04-27T12:30:00+05:30",
      "@baseType": "TimePeriod",
      "@schemaLocation": null,
      "@type": "TimePeriod"
    },
    "@baseType": "Bucket",
    "@schemaLocation": "",
    "@type": "Bucket"
  }
]

Back to Top