Jump to

• Request
• Response
• Examples

Create a Bucket

post

/bucket

Creates a bucket to store balances.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : schema

Type: object

A bucket, used in bucket create requests.

Show Source

• @baseType: string
  The object's superclass.
• @schemaLocation: string (uri)
  A URI to a JSON schema file that defines additional attributes and relationships.
• @type: string
  The object's subclass.
• description: string
  The text describes the contents of the balance managed by the bucket.
• isShared: boolean
  The value indicates whether the bucket is shared between several devices or users (true) or not (false).
• logicalResource: array logicalResource
• name: string
  A friendly name to identify the bucket.
• partyAccount: object Party Account Ref
  Title: Party Account Ref

  A reference to a party account.
• product: array product
• relatedParty: array relatedParty
  The value is used to provide information about any other entity with relation. to the balance. For instance, to define a customer hierarchy for the balance (such as customerId, userId).
• remainingValue: object Quantity
  Represents an amount in a specified unit.
• remainingValueName: string
  The remaining amount is provided in a formatted string for the bucket given. in the balance unit (for example, 1.9 Gb). For example, this formatted string could be used for display needs.
• reservedValue: object Quantity
  Represents an amount in a specified unit.
• status: string
  The status for the bucket: active, expired, or suspended.
• usageType(required): string
  The bucket's usage type.
• validFor: object TimePeriod
  Represents a time period with a start date, an end date, or both.

{
    "required":[
        "usageType"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "description":"The text describes the contents of the balance managed by the bucket."
        },
        "isShared":{
            "type":"boolean",
            "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",
            "items":{
                "$ref":"#/components/schemas/LogicalResourceRef"
            }
        },
        "name":{
            "type":"string",
            "description":"A friendly name to identify the bucket."
        },
        "partyAccount":{
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "product":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProductRef"
            }
        },
        "relatedParty":{
            "type":"array",
            "description":"The value is used to provide information about any other entity with relation. to the balance. For instance, to define a customer hierarchy for the balance (such as customerId, userId).",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "remainingValue":{
            "$ref":"#/components/schemas/Quantity"
        },
        "remainingValueName":{
            "type":"string",
            "description":"The remaining amount is provided in a formatted string for the bucket given. in the balance unit (for example, 1.9 Gb). For example, this formatted string could be used for display needs."
        },
        "reservedValue":{
            "$ref":"#/components/schemas/Quantity"
        },
        "status":{
            "type":"string",
            "description":"The status for the bucket&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, used in bucket create requests."
}

Nested Schema : logicalResource

Type: array

Show Source

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

  A reference to a logical resource.

{
    "type":"array",
    "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

Show Source

• Array of: object ProductRef
  A product reference.

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

Nested Schema : relatedParty

Type: array

The value is used to provide information about any other entity with relation. to the balance. For instance, to define a customer hierarchy for the balance (such as customerId, userId).

Show Source

• Array of: object Related Party
  Title: Related Party

  A party related to another object.

{
    "type":"array",
    "description":"The value is used to provide information about any other entity with relation. to the balance. For instance, to define a customer hierarchy for the balance (such as customerId, userId).",
    "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."
}

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

201 Response

The bucket was created successfully.

Body ()

Root 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."
        }
    }
}

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

The following examples show how to create buckets (balance groups in BRM) by submitting POST requests on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/brm/prepayBalanceManagement/version/bucket' -d @bucketCreate.json

Example of Request Body for Creating a Currency Bucket

The following is an example of the contents of the bucketCreate.json file sent as the request body to create a currency bucket. It specifies both partyAccount and product, but only one is required. It also specifies the units for the remaining value, but this is optional. If you do not specify the unit, the default account currency is used.

{
   "partyAccount": {
      "id": "0.0.0.1+-account+2090314"
   },
   "product": [
      {
         "id": "0.0.0.1+-service-telco-gsm-telephony+2092746"
      }
   ],
   "remainingValue": {
      "amount": 1000,
      "units": "USD"
   },
   "validFor": {
      "endDateTime": "2025-06-02T16:24:59+05:30",
      "startDateTime": "2024-10-02T13:04:42+05:30"
   },
   "usageType": "monetary"
}

Example of Response Body for Creating a Currency Bucket

The following is an example of the response body in JSON format.

{
   "id": "0.0.0.1+-balance_group+2090186+840+28",
   "href": "https://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2090186+840+28",
   "confirmationDate": null,
   "description": null,
   "isShared": null,
   "name": "Balance Group (1)",
   "remainingValueName": null,
   "requestedDate": null,
   "logicalResource": null,
   "partyAccount": {
      "id": "0.0.0.1+-account+2090314",
      "href": null,
      "description": null,
      "name": "aa sa",
      "status": "active",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
   },
   "product": [
      {
         "id": "0.0.0.1+-service-telco-gsm-telephony+2092746",
         "href": null,
         "name": "ServiceTelcoGsmTelephony",
         "@baseType": null,
         "@schemaLocation": null,
         "@type": "ProductRef",
         "@referredType": null
      }
   ],
   "relatedParty": null,
   "remainingValue": {
      "amount": 1000.0,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
   },
   "reservedValue": {
      "amount": 0.0,
      "units": "USD",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
   },
   "status": "ACTIVE",
   "usageType": null,
   "validFor": {
      "endDateTime": "2025-06-02T16:24:59+05:30",
      "startDateTime": "2024-10-02T13:04:42+05:30",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": null
   },
   "@baseType": "Bucket",
   "@schemaLocation": null,
   "@type": "Bucket"
}

Example of Request Body for Creating a Noncurrency Bucket

The following is an example of the contents of the bucketCreate.json file sent as the request body to create a noncurrency bucket.

{
   "partyAccount": {
      "id": "0.0.0.1+-account+2090314"
   },
   "remainingValue": {
      "amount": 9999,
      "units": "Free Domestic Minutes"
   },
   "validFor": {
      "endDateTime": "2025-05-02T16:24:59+05:30",
      "startDateTime": "2024-04-02T13:04:42+05:30"
   },
   "usageType": "other"
}

You can also transfer noncurrency product balances, with or without a cost.

Example of Response Body for Creating a Noncurrency Bucket

The following is an example of the response body in JSON format.

{
   "id": "0.0.0.1+-balance_group+2091210+1000010+4",
   "href": "https://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+2091210+1000010+4",
   "confirmationDate": null,
   "description": null,
   "isShared": null,
   "name": "Balance Group<Account>",
   "remainingValueName": null,
   "requestedDate": null,
   "logicalResource": null,
   "partyAccount": {
      "id": "0.0.0.1+-account+2090314",
      "href": null,
      "description": null,
      "name": "aa sa",
      "status": "active",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "PartyAccountRef",
      "@referredType": null
   },
   "product": null,
   "relatedParty": null,
   "remainingValue": {
      "amount": 9999.0,
      "units": "Free Domestic Minutes",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
   },
   "reservedValue": {
      "amount": 0.0,
      "units": "Free Domestic Minutes",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": "Quantity"
   },
   "status": "ACTIVE",
   "usageType": null,
   "validFor": {
      "endDateTime": "2025-05-02T16:24:59+05:30",
      "startDateTime": "2024-04-02T13:04:42+05:30",
      "@baseType": null,
      "@schemaLocation": null,
      "@type": null
   },
   "@baseType": "Bucket",
   "@schemaLocation": null,
   "@type": "Bucket"
}

Create a currency bucket using an account external ID

The following example creates a currency bucket using the account external ID in partyAccount.id.

curl -X POST 'http://host:port/brm/prepayBalanceManagement/v4/bucket' -H 'Content-Type: application/json' -d @currency-account-external-id.json

where:

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

The -d option specifies the request body file, currency-account-external-id.json.

Example of Request Body

{
  "partyAccount": {
    "id": "test_acct_264591"
  },
  "remainingValue": {
    "amount": 10,
    "units": "USD"
  },
  "usageType": "monetary"
}

Example of Response Body

{
  "id": "0.0.0.1+-balance_group+262223+840+24",
  "href": "https://localhost:8080/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+262223+840+24",
  "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": "677-20260429-024757-0-153527--213851008-cagbu-phx-1038"
    }
  ],
  "partyAccount": {
    "id": "test_acct_264591",
    "href": null,
    "description": null,
    "name": "non-currency2 Test2",
    "status": "active",
    "@baseType": "PartyAccountRef",
    "@schemaLocation": null,
    "@type": "PartyAccountRef",
    "@referredType": null
  },
  "product": [
    {
      "id": "0.0.0.1+-service-telco-gprs+264783",
      "href": null,
      "name": "ServiceTelcoGprs",
      "@baseType": "ProductRef",
      "@schemaLocation": null,
      "@type": "ProductRef",
      "@referredType": null
    }
  ],
  "relatedParty": [],
  "remainingValue": {
    "amount": 10.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-05-07T13:28:31+05:30",
    "@baseType": "TimePeriod",
    "@schemaLocation": null,
    "@type": "TimePeriod"
  },
  "@baseType": "Bucket",
  "@schemaLocation": "",
  "@type": "Bucket"
}

Create a noncurrency bucket using an account external ID

The following example creates a noncurrency bucket for Free Minutes using the account external ID in partyAccount.id.

curl -X POST 'http://host:port/brm/prepayBalanceManagement/v4/bucket' -H 'Content-Type: application/json' -d @noncurrency-account-external-id.json

where:

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

The -d option specifies the request body file, noncurrency-account-external-id.json.

Example of Request Body

{
  "partyAccount": {
    "id": "test_acct_264591"
  },
  "remainingValue": {
    "amount": 100,
    "units": "Free Minutes"
  },
  "usageType": "other"
}

Example of Response Body

{
  "id": "0.0.0.1+-balance_group+262223+100002+26",
  "href": "https://localhost:8080/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+262223+100002+26",
  "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": "677-20260429-024757-0-153527--213851008-cagbu-phx-1038"
    }
  ],
  "partyAccount": {
    "id": "test_acct_264591",
    "href": null,
    "description": null,
    "name": "non-currency2 Test2",
    "status": "active",
    "@baseType": "PartyAccountRef",
    "@schemaLocation": null,
    "@type": "PartyAccountRef",
    "@referredType": null
  },
  "product": [
    {
      "id": "0.0.0.1+-service-telco-gprs+264783",
      "href": null,
      "name": "ServiceTelcoGprs",
      "@baseType": "ProductRef",
      "@schemaLocation": null,
      "@type": "ProductRef",
      "@referredType": null
    }
  ],
  "relatedParty": [],
  "remainingValue": {
    "amount": 100.0,
    "units": "Free Minutes",
    "@baseType": "Quantity",
    "@schemaLocation": null,
    "@type": "Quantity"
  },
  "reservedValue": {
    "amount": 0.0,
    "units": "Free Minutes",
    "@baseType": "Quantity",
    "@schemaLocation": null,
    "@type": "Quantity"
  },
  "status": "ACTIVE",
  "usageType": "OTHER",
  "validFor": {
    "endDateTime": null,
    "startDateTime": "2026-05-07T13:30:34+05:30",
    "@baseType": "TimePeriod",
    "@schemaLocation": null,
    "@type": "TimePeriod"
  },
  "@baseType": "Bucket",
  "@schemaLocation": "",
  "@type": "Bucket"
}

Back to Top