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

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

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

Response

200 Response

The request ID is returned successfully.

500 Response

An internal server error occurred.

Examples

This example shows how to record a request by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X POST 'http://hostname:port/bcws/webresources/v1.0/request' -H 'content-type: application/json' -d @recordRequest.json

where:

hostname is the URL for the Billing Care REST server.
port is the port for the Billing Care REST server.
version is the version of the API you're using, such as v1.0.
recordRequest.json is the JSON file that specifies the event dispute to create.

Example of Request Body

This example shows the contents of the recordRequest.json file sent as the request body.

{
        "accountId": "0.0.0.1+-account+174883",
        "payloadStr": "{\"extension\":null,\"payinfoTypeObject\":{\"@class\":\"com.oracle.communications.brm.cc.model.PayinfoCcType\",\"extension\":null,\"id\":{\"id\":\"0.0.0.1+-payinfo-cc+0\",\"uri\":null},\"creationDate\":null,\"accountObj\":{\"id\":\"0.0.0.1+-account+174883\",\"uri\":null},\"paymentType\":10003,\"name\":null,\"ccInfo\":[{\"address\":\"a\",\"city\":\"a\",\"country\":\"AF\",\"debitExp\":\"\",\"debitNum\":\"\",\"securityCode\":\"\",\"name\":\"a a\",\"state\":\"A\",\"zip\":\"a\",\"elem\":null}]},\"currency\":840,\"selectedBillUnit\":\"0.0.0.1+-billinfo+173859\",\"itemPaymentRef\":\"0.0.0.1+-account+174883\",\"amount\":3,\"notes\":{\"extension\":null,\"id\":null,\"accountId\":\"0.0.0.1+-account+174883\",\"amount\":3,\"billUnitId\":\"0.0.0.1+-billinfo+173859\",\"billId\":null,\"closedDate\":null,\"count\":null,\"effectiveDate\":null,\"eventId\":null,\"header\":null,\"itemId\":null,\"subType\":null,\"type\":null,\"domainId\":5,\"reasonId\":12,\"serviceId\":null,\"status\":101,\"comments\":[{\"csrLoginId\":null,\"csrFirstName\":null,\"csrLastName\":null,\"csrAccountId\":null,\"externalUser\":\"weblogic\",\"comment\":\"\",\"trackingId\":null,\"entryDate\":null}]}}",
        "status": 1,
        "contentType": "application/json",
        "partial": 1,
        "descr": "Make Payment",
        "correlationId": "3:nisgarg-mac:BillingCare:0:[ACTIVE] ExecuteThread: '14' for queue: 'weblogic.kernel.Default (self-tuning)':113:1741288532346003:48:root.0.0.0.1::weblogic::opcode_timeout=-1",
        "userId": "0.0.0.1+-service-pcm_client+1",
        "requestInfo": {
            "method": "POST",
            "url": "http://localhost:8001",
            "path": "/bc/webresources/v1.0/payments",
            "queryParam": "savePaymentType=false"
        },
        "failedInfo": {
            "errorCode": "",
            "errorDescr": "ERR_NO_MATCH\ncom.oracle.communications.brm.cc.model.Payment:0: ErrBuf Fields:\nError=ERR_NO_MATCH    Loc=Unknown Location\nField=UnknownField0    Rec=0    reserved=0\nFacility=0    MessageID=0    Time=12:45 AM    Version=0    Reserved2=0\nArgs=<none>\nNested Error:\n<none>\n\n\tat com.oracle.communications.brm.cc.modules.pcm.PCMPaymentModule.makePayment(PCMPaymentModule.java:291)\n\tat com.oracle.communications.brm.cc.ws.payment.PaymentResource.makePayment(PaymentResource.java:161)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)\n\tat sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)\n\tat sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)\n\tat java.lang.reflect.Method.invoke(Method.java:498)\n\tat org.glassfish.jersey.server.model.internal.ResourceMethodInvocationHandlerFactory.lambda$static$0(ResourceMethodInvocationHandlerFactory.java:52)\n\tat org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher$1.run(AbstractJavaResourceMethodDispatcher.java:146)\n\tat org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher.invoke(AbstractJavaResourceMethodDispatcher.java:189)\n\tat org.glassfish.jersey.server.model.internal.JavaResourceMethodDispatcherProvider$ResponseOutInvoker.doDispatch(JavaResourceMethodDispatcherProvider.java:176)\n\tat org.glassfish.jersey.server.model.internal.AbstractJavaResourceMethodDispatcher.dispatch(AbstractJavaResourceMethodDispatcher.java:93)\n\tat org.glassfish.jersey.server.model.ResourceMethodInvoker.invoke(ResourceMethodInvoker.java:478)\n\tat org.glassfish.jersey.server.model.ResourceMethodInvoker.apply(ResourceMethodInvoker.java:400)\n\tat org.glassfish.jersey.server.model.ResourceMethodInvoker.apply(ResourceMethodInvoker.java:81)\n\tat org.glassfish.jersey.server.ServerRuntime$1.run(ServerRuntime.java:256)\n\tat org.glassfish.jersey.internal.Errors$1.call(Errors.java:248)\n\tat org.glassfish.jersey.internal.Errors$1.call(Errors.java:244)\n\tat org.glassfish.jersey.internal.Errors.process(Errors.java:292)\n\tat org.glassfish.jersey.internal.Errors.process(Errors.java:274)\n\tat org.glassfish.jersey.internal.Errors.process(Errors.java:244)\n\tat org.glassfish.jersey.process.internal.RequestScope.runInScope(RequestScope.java:265)\n\tat org.glassfish.jersey.server.ServerRuntime.process(ServerRuntime.java:235)\n\tat org.glassfish.jersey.server.ApplicationHandler.handle(ApplicationHandler.java:684)\n\tat org.glassfish.jersey.servlet.WebComponent.serviceImpl(WebComponent.java:397)\n\tat org.glassfish.jersey.servlet.WebComponent.service(WebComponent.java:349)\n\tat org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:379)\n\tat org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:312)\n\tat org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:205)\n\tat weblogic.servlet.internal.StubSecurityHelper$ServletServiceAction.run(StubSecurityHelper.java:295)\n\tat weblogic.servlet.internal.StubSecurityHelper$ServletServiceAction.run(StubSecurityHelper.java:260)\n\tat weblogic.servlet.internal.StubSecurityHelper.invokeServlet(StubSecurityHelper.java:137)\n\tat weblogic.servlet.internal.ServletStubImpl.execute(ServletStubImpl.java:353)\n\tat weblogic.servlet.internal.TailFilter.doFilter(TailFilter.java:25)\n\tat weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:78)\n\tat com.oracle.communications.brm.cc.util.CSRFTokenFilter.doFilter(CSRFTokenFilter.java:77)\n\tat weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:78)\n\tat com.oracle.communications.brm.cc.util.HTTPSecurityHeadersFilter.doFilter(HTTPSecurityHeadersFilter.java:60)\n\tat weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:78)\n\tat com.oracle.communications.brm.cc.util.ClickjackFilter.doFilter(ClickjackFilter.java:53)\n\tat weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:78)\n\tat com.oracle.communications.brm.cc.util.AuthenticationFilter.doFilter(AuthenticationFilter.java:83)\n\tat weblogic.servlet.internal.FilterChainImpl.doFilter(FilterChainImpl.java:78)\n\tat weblogic.servlet.internal.WebAppServletContext$ServletInvocationAction.wrapRun(WebAppServletContext.java:3797)\n\tat weblogic.servlet.internal.WebAppServletContext$ServletInvocationAction.run(WebAppServletContext.java:3763)\n\tat weblogic.security.acl.internal.AuthenticatedSubject.doAs(AuthenticatedSubject.java:344)\n\tat weblogic.security.service.SecurityManager.runAsForUserCode(SecurityManager.java:197)\n\tat weblogic.servlet.provider.WlsSecurityProvider.runAsForUserCode(WlsSecurityProvider.java:203)\n\tat weblogic.servlet.provider.WlsSubjectHandle.run(WlsSubjectHandle.java:71)\n\tat weblogic.servlet.internal.WebAppServletContext.doSecuredExecute(WebAppServletContext.java:2451)\n\tat weblogic.servlet.internal.WebAppServletContext.securedExecute(WebAppServletContext.java:2299)\n\tat weblogic.servlet.internal.WebAppServletContext.execute(WebAppServletContext.java:2277)\n\tat weblogic.servlet.internal.ServletRequestImpl.runInternal(ServletRequestImpl.java:1720)\n\tat weblogic.servlet.internal.ServletRequestImpl.run(ServletRequestImpl.java:1680)\n\tat weblogic.servlet.provider.ContainerSupportProviderImpl$WlsRequestExecutor.run(ContainerSupportProviderImpl.java:272)\n\tat weblogic.invocation.ComponentInvocationContextManager._runAs(ComponentInvocationContextManager.java:352)\n\tat weblogic.invocation.ComponentInvocationContextManager.runAs(ComponentInvocationContextManager.java:337)\n\tat weblogic.work.LivePartitionUtility.doRunWorkUnderContext(LivePartitionUtility.java:57)\n\tat weblogic.work.PartitionUtility.runWorkUnderContext(PartitionUtility.java:41)\n\tat weblogic.work.SelfTuningWorkManagerImpl.runWorkUnderContext(SelfTuningWorkManagerImpl.java:655)\n\tat weblogic.work.ExecuteThread.execute(ExecuteThread.java:420)\n\tat weblogic.work.ExecuteThread.run(ExecuteThread.java:360)\n"
        },
        "opcodeInfo": null,
        "headerInfo": [
            {
                "name": "Accept",
                "value": "application/json"
            },
            {
                "name": "Content-Length",
                "value": "350"
            },
            {
                "name": "Content-Type",
                "value": "application/json"
            }
        ],
        "errorInfo": []
    }

Example of Response Body

This following shows the contents of the response body.

{
    "extension": null,
    "reference": {
        "id": "0.0.0.1+-request-failed-rest+322951",
        "uri": "http://hostname/bc/webresources/v1.0/request/0.0.0.1+-request-failed-rest+322951"
    }
}