REST API Reference for Billing Care

Record a Request

post

/bcws/webresources/v1.0/request

Record a given request in BRM.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

The details of the request which is to be recorded.

Root Schema : schema

Type: object

Show Source

accountId(required): string

The Account ID of the request.
contentType(required): string

The type of content in the request.
correlationId: string

The correlation ID of the request.
descr: string

The descriptionof the request.
errorInfo: array errorInfo

Information about the error.
extension: object extension

The extended attributes.
failedInfo: object FailedInfo

Failure information for the request.
headerInfo: array headerInfo

The header information for the request.
id: string

The ID of the request.
opcodeInfo: object OpcodeInfo

Information about the opcode related to the request.
partial: integer (int32)
payloadStr(required): string

The payload of the request.
requestInfo: object RequestInfo

Information about the request.
status: integer (int32)

The status of the request.
userId: string

The UserID of the request.

{
    "required":[
        "accountId",
        "contentType",
        "payloadStr"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID of the request."
        },
        "accountId":{
            "type":"string",
            "description":"The Account ID of the request."
        },
        "payloadStr":{
            "type":"string",
            "description":"The payload of the request."
        },
        "status":{
            "type":"integer",
            "description":"The status of the request.",
            "format":"int32"
        },
        "contentType":{
            "type":"string",
            "description":"The type of content in the request."
        },
        "partial":{
            "type":"integer",
            "format":"int32"
        },
        "descr":{
            "type":"string",
            "description":"The descriptionof the request."
        },
        "correlationId":{
            "type":"string",
            "description":"The correlation ID of the request."
        },
        "userId":{
            "type":"string",
            "description":"The UserID of the request."
        },
        "requestInfo":{
            "$ref":"#/components/schemas/RequestInfo"
        },
        "failedInfo":{
            "$ref":"#/components/schemas/FailedInfo"
        },
        "opcodeInfo":{
            "$ref":"#/components/schemas/OpcodeInfo"
        },
        "headerInfo":{
            "type":"array",
            "description":"The header information for the request.",
            "items":{
                "$ref":"#/components/schemas/HeaderInfo"
            }
        },
        "errorInfo":{
            "type":"array",
            "description":"Information about the error.",
            "items":{
                "$ref":"#/components/schemas/ErrorInfo"
            }
        }
    },
    "xml":{
        "name":"requestDetails"
    }
}

Nested Schema : errorInfo

Type: array

Information about the error.

Show Source

Array of: object ErrorInfo

Information about the error.

{
    "type":"array",
    "description":"Information about the error.",
    "items":{
        "$ref":"#/components/schemas/ErrorInfo"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : FailedInfo

Type: object

Failure information for the request.

Show Source

errorCode(required): string

The error code of the failure.
errorDescr: string

The description of the error.

{
    "required":[
        "errorCode"
    ],
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code of the failure."
        },
        "errorDescr":{
            "type":"string",
            "description":"The description of the error."
        }
    },
    "description":"Failure information for the request."
}

Nested Schema : headerInfo

Type: array

The header information for the request.

Show Source

Array of: object HeaderInfo

The header information for the request.

{
    "type":"array",
    "description":"The header information for the request.",
    "items":{
        "$ref":"#/components/schemas/HeaderInfo"
    }
}

Nested Schema : OpcodeInfo

Type: object

Information about the opcode related to the request.

Show Source

flags: integer (int32)

The flags passed ioth the opcode.
opcode: integer (int32)

The name of the opcode.

{
    "type":"object",
    "properties":{
        "opcode":{
            "type":"integer",
            "description":"The name of the opcode.",
            "format":"int32"
        },
        "flags":{
            "type":"integer",
            "description":"The flags passed ioth the opcode.",
            "format":"int32"
        }
    },
    "description":"Information about the opcode related to the request."
}

Nested Schema : RequestInfo

Type: object

Information about the request.

Show Source

method(required): string

The method of the request.
path(required): string

The path of the request.
queryParam: string

The query parameters associated with the request.
url(required): string

The URL of the request.

{
    "required":[
        "method",
        "path",
        "url"
    ],
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"The method of the request."
        },
        "url":{
            "type":"string",
            "description":"The URL of the request."
        },
        "path":{
            "type":"string",
            "description":"The path of the request."
        },
        "queryParam":{
            "type":"string",
            "description":"The query parameters associated with the request."
        }
    },
    "description":"Information about the request."
}

Nested Schema : ErrorInfo

Type: object

Information about the error.

Show Source

className: string

The class name.
elementId: integer (int32)

The element ID.
errorCode: string

The error code.
fieldNum: integer (int32)

The field number.
location: string

The location of the error.
reasonDomainId: integer (int32)

The domain ID of the reason for the error.
reasonId: integer (int32)

The ID of the reason for the error.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code."
        },
        "location":{
            "type":"string",
            "description":"The location of the error."
        },
        "className":{
            "type":"string",
            "description":"The class name."
        },
        "fieldNum":{
            "type":"integer",
            "description":"The field number.",
            "format":"int32"
        },
        "elementId":{
            "type":"integer",
            "description":"The element ID.",
            "format":"int32"
        },
        "reasonDomainId":{
            "type":"integer",
            "description":"The domain ID of the reason for the error.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The ID of the reason for the error.",
            "format":"int32"
        }
    },
    "description":"Information about the error."
}

Nested Schema : HeaderInfo

Type: object

The header information for the request.

Show Source

name(required): string

The name of the header information paramerter.
value(required): string

The value of the header information parameter.

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the header information paramerter."
        },
        "value":{
            "type":"string",
            "description":"The value of the header information parameter."
        }
    },
    "description":"The header information for the request."
}

The details of the request which is to be recorded.

Root Schema : schema

Type: object

Show Source

accountId(required): string

The Account ID of the request.
contentType(required): string

The type of content in the request.
correlationId: string

The correlation ID of the request.
descr: string

The descriptionof the request.
errorInfo: array errorInfo

Information about the error.
extension: object extension

The extended attributes.
failedInfo: object FailedInfo

Failure information for the request.
headerInfo: array headerInfo

The header information for the request.
id: string

The ID of the request.
opcodeInfo: object OpcodeInfo

Information about the opcode related to the request.
partial: integer (int32)
payloadStr(required): string

The payload of the request.
requestInfo: object RequestInfo

Information about the request.
status: integer (int32)

The status of the request.
userId: string

The UserID of the request.

{
    "required":[
        "accountId",
        "contentType",
        "payloadStr"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID of the request."
        },
        "accountId":{
            "type":"string",
            "description":"The Account ID of the request."
        },
        "payloadStr":{
            "type":"string",
            "description":"The payload of the request."
        },
        "status":{
            "type":"integer",
            "description":"The status of the request.",
            "format":"int32"
        },
        "contentType":{
            "type":"string",
            "description":"The type of content in the request."
        },
        "partial":{
            "type":"integer",
            "format":"int32"
        },
        "descr":{
            "type":"string",
            "description":"The descriptionof the request."
        },
        "correlationId":{
            "type":"string",
            "description":"The correlation ID of the request."
        },
        "userId":{
            "type":"string",
            "description":"The UserID of the request."
        },
        "requestInfo":{
            "$ref":"#/components/schemas/RequestInfo"
        },
        "failedInfo":{
            "$ref":"#/components/schemas/FailedInfo"
        },
        "opcodeInfo":{
            "$ref":"#/components/schemas/OpcodeInfo"
        },
        "headerInfo":{
            "type":"array",
            "description":"The header information for the request.",
            "items":{
                "$ref":"#/components/schemas/HeaderInfo"
            }
        },
        "errorInfo":{
            "type":"array",
            "description":"Information about the error.",
            "items":{
                "$ref":"#/components/schemas/ErrorInfo"
            }
        }
    },
    "xml":{
        "name":"requestDetails"
    }
}

Nested Schema : errorInfo

Type: array

Information about the error.

Show Source

Array of: object ErrorInfo

Information about the error.

{
    "type":"array",
    "description":"Information about the error.",
    "items":{
        "$ref":"#/components/schemas/ErrorInfo"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : FailedInfo

Type: object

Failure information for the request.

Show Source

errorCode(required): string

The error code of the failure.
errorDescr: string

The description of the error.

{
    "required":[
        "errorCode"
    ],
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code of the failure."
        },
        "errorDescr":{
            "type":"string",
            "description":"The description of the error."
        }
    },
    "description":"Failure information for the request."
}

Nested Schema : headerInfo

Type: array

The header information for the request.

Show Source

Array of: object HeaderInfo

The header information for the request.

{
    "type":"array",
    "description":"The header information for the request.",
    "items":{
        "$ref":"#/components/schemas/HeaderInfo"
    }
}

Nested Schema : OpcodeInfo

Type: object

Information about the opcode related to the request.

Show Source

flags: integer (int32)

The flags passed ioth the opcode.
opcode: integer (int32)

The name of the opcode.

{
    "type":"object",
    "properties":{
        "opcode":{
            "type":"integer",
            "description":"The name of the opcode.",
            "format":"int32"
        },
        "flags":{
            "type":"integer",
            "description":"The flags passed ioth the opcode.",
            "format":"int32"
        }
    },
    "description":"Information about the opcode related to the request."
}

Nested Schema : RequestInfo

Type: object

Information about the request.

Show Source

method(required): string

The method of the request.
path(required): string

The path of the request.
queryParam: string

The query parameters associated with the request.
url(required): string

The URL of the request.

{
    "required":[
        "method",
        "path",
        "url"
    ],
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"The method of the request."
        },
        "url":{
            "type":"string",
            "description":"The URL of the request."
        },
        "path":{
            "type":"string",
            "description":"The path of the request."
        },
        "queryParam":{
            "type":"string",
            "description":"The query parameters associated with the request."
        }
    },
    "description":"Information about the request."
}

Nested Schema : ErrorInfo

Type: object

Information about the error.

Show Source

className: string

The class name.
elementId: integer (int32)

The element ID.
errorCode: string

The error code.
fieldNum: integer (int32)

The field number.
location: string

The location of the error.
reasonDomainId: integer (int32)

The domain ID of the reason for the error.
reasonId: integer (int32)

The ID of the reason for the error.

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"The error code."
        },
        "location":{
            "type":"string",
            "description":"The location of the error."
        },
        "className":{
            "type":"string",
            "description":"The class name."
        },
        "fieldNum":{
            "type":"integer",
            "description":"The field number.",
            "format":"int32"
        },
        "elementId":{
            "type":"integer",
            "description":"The element ID.",
            "format":"int32"
        },
        "reasonDomainId":{
            "type":"integer",
            "description":"The domain ID of the reason for the error.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The ID of the reason for the error.",
            "format":"int32"
        }
    },
    "description":"Information about the error."
}

Nested Schema : HeaderInfo

Type: object

The header information for the request.

Show Source

name(required): string

The name of the header information paramerter.
value(required): string

The value of the header information parameter.

{
    "required":[
        "name",
        "value"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the header information paramerter."
        },
        "value":{
            "type":"string",
            "description":"The value of the header information parameter."
        }
    },
    "description":"The header information for the request."
}

Record a Request

Request

Response

200 Response

500 Response