REST API for Customer Care Service in Oracle Advanced Risk Manager

Get action count

get

/customercare/v1/{customerId}/action

Get the count of an action for a user. Action should be one of the enumerated actions in rule.action.enum.

Request

Path Parameters

customerId(required): string

It is the uniqueUserId of the user. Details can be found in the user preferences API.

Query Parameters

actionEnumId(required): integer

Action for which count is required. It should be one of rule.action.enum.
requestId(required): string

Request Id (session Id) for the user's session.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success

Root Schema : ActionCountResponse

Type: object

Show Source

actionCount: integer

value of the increment cache counter for the specified action
statusResponse: object StatusResponse

Status information for API call

{
    "type":"object",
    "properties":{
        "actionCount":{
            "type":"integer",
            "description":"value of the increment cache counter for the specified action"
        },
        "statusResponse":{
            "$ref":"#/components/schemas/StatusResponse"
        }
    }
}

Nested Schema : StatusResponse

Type: object

Status information for API call

Show Source

responseCode: string

status code of the request
responseMessage: string

response message related to the response code if needed.
sessionId: string

session id of the authentcation.
status: boolean

authentication update request status

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        }
    }
}

400 Response

Invalid input

404 Response

Customer ID not found

Examples

The following example shows a sample request and response for determining the number of times a user has performed a specific action.

cURL Command to Get Action Count in JSON Format

curl --location --request GET '<RISKCC>/customercare/v1/{customerId}/action?requestId=d09b6524-2ab7-46e4-ba16-2762de499009testuser3416/action?requestId=d09b6524-2ab7-46e4-ba16-2762de499009&actionEnumId=1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'  \

Sample Response in JSON Format

{
  "actionCount": 1,
  "statusResponse": {
    "responseCode": "0",
    "responseMessage": "",
    "status": true
  }
}

cURL Command to Get Action Count in XML Format

curl --location --request GET '<RISKCC>/customercare/v1/{customerId}/action?requestId=d09b6524-2ab7-46e4-ba16-2762de499009testuser3416/action?requestId=d09b6524-2ab7-46e4-ba16-2762de499009&actionEnumId=1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ActionCountResponse>
    <actionCount>1</actionCount>
    <statusResponse>
    <responseCode>0</responseCode>
    <responseMessage></responseMessage>    
    <status>true</status>
    </statusResponse>
</ActionCountResponse>