REST API for Customer Care Service in Oracle Advanced Risk Manager

Set a temporary allow

put

/customercare/v1/{customerId}/provision

Sets a temporary allow for the user.

Request

Path Parameters

customerId(required): string

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

Supported Media Types

application/xml
application/json

Root Schema : schema

Type: object

Show Source

expirationDate: string (date-time)

Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6 e.g format 2021-08-13T01:29:29.768Z
tempAllowType: integer

Should be one of the enumerated types in customercare.case.tempallow.level.enum

{
    "type":"object",
    "properties":{
        "tempAllowType":{
            "type":"integer",
            "description":"Should be one of the enumerated types in customercare.case.tempallow.level.enum"
        },
        "expirationDate":{
            "$ref":"#/components/schemas/DateTime"
        }
    }
}

Root Schema : schema

Type: object

Show Source

expirationDate: string (date-time)

Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6 e.g format 2021-08-13T01:29:29.768Z
tempAllowType: integer

Should be one of the enumerated types in customercare.case.tempallow.level.enum

{
    "type":"object",
    "properties":{
        "tempAllowType":{
            "type":"integer",
            "description":"Should be one of the enumerated types in customercare.case.tempallow.level.enum"
        },
        "expirationDate":{
            "$ref":"#/components/schemas/DateTime"
        }
    }
}

Response

Supported Media Types

application/xml
application/json

200 Response

Success

Root 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 granting a temporary allow permission to the user.

cURL Command to Grant a Temporary Allow in JSON Format

curl --location --request PUT '<RISKCC>/risk-cc/customercare/v1/{customerId}/provision' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
"tempAllowType":1,
"expirationDate":"2021-10-15T01:29:29.768Z"
}'

Sample Response in JSON Format

{
    "responseCode": "0",
    "responseMessage": "",
    "status": true
}

cURL Command to Grant a Temporary Allow in XML Format

curl --location --request PUT '<RISKCC>/risk-cc/customercare/v1/{customerId}/provision' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
--data '<?xml version="1.0" encoding="UTF-8" ?>
<TempAllowRequest>
<tempAllowType>1</tempAllowType>
<expirationDate>2025-10-15T01:29:29.768Z</expirationDate>
</TempAllowRequest>
'

Sample Response in XML Format

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