REST Services Manager API for Billing and Revenue Management

Create a Bill Format

post

/billFormat

Creates a BillFormat entity.

Request

Query Parameters

fields: string

The comma-separated properties to be provided in response.

Supported Media Types

application/json

Root Schema : schema

Match All

The detailed description of the way in which a bill is presented.

Show Source

object allOf Entity_FVO

The Base entity schema for use in TMForum Open-APIs Property.
object type

The detailed description of the way in which a bill is presented.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity_FVO"
        },
        {
            "type":"object",
            "description":"The detailed description of the way in which a bill is presented.",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The short descriptive name."
                },
                "description":{
                    "type":"string",
                    "description":"The explanatory text for this bill format."
                }
            },
            "required":[
                "name"
            ]
        }
    ]
}

Nested Schema : Entity_FVO

Type: object

The Base entity schema for use in TMForum Open-APIs Property.

Match All

The Base entity schema for use in TMForum Open-APIs Property.

Show Source

object Extensible_FVO

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Addressable_FVO

The base schema for adressable entities.

{
    "type":"object",
    "description":"The Base entity schema for use in TMForum Open-APIs Property.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible_FVO"
        },
        {
            "$ref":"#/components/schemas/Addressable_FVO"
        }
    ]
}

Nested Schema : Extensible_FVO

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The definition of the super-class, when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships.
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The definition of the super-class, when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable_FVO

Type: object

The base schema for adressable entities.

Show Source

id: string

The unique identifier.

{
    "type":"object",
    "description":"The base schema for adressable entities.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique identifier."
        }
    }
}

Nested Schema : type

Type: object

The detailed description of the way in which a bill is presented.

Show Source

description: string

The explanatory text for this bill format.
name(required): string

The short descriptive name.

{
    "type":"object",
    "description":"The detailed description of the way in which a bill is presented.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The short descriptive name."
        },
        "description":{
            "type":"string",
            "description":"The explanatory text for this bill format."
        }
    },
    "required":[
        "name"
    ]
}

Examples

Response

201 Response

The bill format was created.

Root Schema : BillFormat

Match All

The detailed description of the way in which a bill is presented.

Show Source

object allOf Entity

The Base entity schema for use in TMForum Open-APIs Property.
object BillFormat-allOf[1]

The detailed description of the way in which a bill is presented.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Entity"
        },
        {
            "type":"object",
            "description":"The detailed description of the way in which a bill is presented.",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"The short descriptive name."
                },
                "description":{
                    "type":"string",
                    "description":"The explanatory text for this bill format."
                }
            }
        }
    ]
}

Nested Schema : Entity

Type: object

The Base entity schema for use in TMForum Open-APIs Property.

Match All

The Base entity schema for use in TMForum Open-APIs Property.

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Addressable

The base schema for adressable entities.

{
    "type":"object",
    "description":"The Base entity schema for use in TMForum Open-APIs Property.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        }
    ]
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to a JSON-Schema file that defines additional attributes and relationships"
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

The base schema for adressable entities.

Show Source

href: string

The hyperlink reference.
id: string

The unique identifier.

{
    "type":"object",
    "description":"The base schema for adressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The unique identifier."
        }
    }
}

Nested Schema : BillFormat-allOf[1]

Type: object

The detailed description of the way in which a bill is presented.

Show Source

description: string

The explanatory text for this bill format.
name: string

The short descriptive name.

{
    "type":"object",
    "description":"The detailed description of the way in which a bill is presented.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The short descriptive name."
        },
        "description":{
            "type":"string",
            "description":"The explanatory text for this bill format."
        }
    }
}

Examples

202 Response

The operation has been accepted.

400 Response

The server received a bad request.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

401 Response

The request was not authorized.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

403 Response

The request was forbidden.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

404 Response

The requested resource cannot be found.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

405 Response

The method is not allowed.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

409 Response

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

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

500 Response

THe system has encountered an internal server error.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

501 Response

The request was not implemented.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

503 Response

The service is unavailable.

Root Schema : Error

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Match All

The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).

Show Source

object Extensible

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application relevant detail, defined in the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"The explanation of the reason for the error which can be shown to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"The details and corrective actions related to the error which can be shown to a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP Error code extension"
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation describing the error."
                }
            }
        }
    ],
    "description":"The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)."
}

Nested Schema : Extensible

Type: object

The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type

Show Source

@baseType: string

The defines the super-class when sub-classing.
@schemaLocation: string

The URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

The definition of the sub-class extensible name, when sub-classing.

{
    "type":"object",
    "description":"The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type",
    "properties":{
        "@type":{
            "type":"string",
            "description":"The definition of the sub-class extensible name, when sub-classing."
        },
        "@baseType":{
            "type":"string",
            "description":"The defines the super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"The URI to 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 relevant detail, defined in the API or a common list.
message: string

The details and corrective actions related to the error which can be shown to a client user.
reason(required): string

The explanation of the reason for the error which can be shown to a client user.
referenceError: string

The URI of documentation describing the error.
status: string

The HTTP Error code extension

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application relevant detail, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"The explanation of the reason for the error which can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"The details and corrective actions related to the error which can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation describing the error."
        }
    }
}

Examples

The following example shows how to create a BillFormat entity by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST 'http://host:port/brm/accountManagement/version/billFormat/'

Example of Request Body

The following is an example of how to create a BillFormat entity.

{
    "@type": "BillFormat",
    "name": "Post-BillFormat-Mail-2-test-007",
    "description": "testing_Fields",
	"id": "billFormat-id007"
}

Example of Response Body

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

{
    "id": "0.0.0.1+-config-bill_format+85964",
    "href": "https://localhost:9998/brm/accountManagement/v5/billFormat/0.0.0.1+-config-bill_format+85964",
    "@type": "BillFormat",
    "name": "Post-BillFormat-Mail-2-test-007",
    "description": "testing_Fields"
}