ReST API for Oracle Banking Corporate Lending Process Management

Update an existing ExternalHandoff

put

/clmo-handoff-services/service/v1/externalHandoff/{handoffRefNo}/updatestatus

This operation update an existing ExternalHandoff using External Handoff Service.

Request

Supported Media Types

application/json
application/xml

Path Parameters

handoffRefNo(required): string

handoffRefNo of the External Handoff details that need to be updated

Request Body that contains data required for updating handoff response status

Root Schema : ExternalHandoffStatusModel

Type: object

ExternalHandoffService model

Show Source

errorCode: string

Error Code for failed handoff
errorDescription: string

Error description
handoffExtRefNo: string

Handoff External Ref No
handoffRefNumber(required): string

Handoff Reference Number
handoffStatus: string

Handoff Status
remarks: string

Remarks for the handoff

{
    "description":"ExternalHandoffService model",
    "type":"object",
    "required":[
        "applicationNumber",
        "handoffRefNumber"
    ],
    "properties":{
        "handoffRefNumber":{
            "description":"Handoff Reference Number",
            "type":"string"
        },
        "handoffExtRefNo":{
            "description":"Handoff External Ref No",
            "type":"string"
        },
        "remarks":{
            "description":"Remarks for the handoff",
            "type":"string"
        },
        "handoffStatus":{
            "description":"Handoff Status",
            "type":"string"
        },
        "errorCode":{
            "description":"Error Code for failed handoff",
            "type":"string"
        },
        "errorDescription":{
            "description":"Error description",
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Returns updated ExternalHandoffDetails

Root Schema : ResponseDtoWrapper

Type: object

Show Source

data: ResponseResourceSupport
messages: object ResponseDto

ResponseDto model

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Match All

Show Source

object ResponseResourceSupport-allOf[0]

Discriminator: resouce_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resouce_type"
        }
    ]
}

Nested Schema : ResponseDto

Type: object

ResponseDto model

Show Source

codes: string

Codes
httpStatusCode: array httpStatusCode

Schedule Details
keyId: string

KeyId
overrideAuthLevelsReqd: string

OverrideAuthLevelsReqd
requestId: string

RequestId
status: string

Status

{
    "description":"ResponseDto model",
    "properties":{
        "keyId":{
            "description":"KeyId",
            "type":"string"
        },
        "status":{
            "description":"Status",
            "type":"string"
        },
        "codes":{
            "description":"Codes",
            "type":"string"
        },
        "httpStatusCode":{
            "type":"array",
            "description":"Schedule Details",
            "items":{
                "$ref":"#/definitions/responseCodes"
            }
        },
        "overrideAuthLevelsReqd":{
            "description":"OverrideAuthLevelsReqd",
            "type":"string"
        },
        "requestId":{
            "description":"RequestId",
            "type":"string"
        }
    }
}

Nested Schema : ResponseResourceSupport-allOf[0]

Type: object

Discriminator: resouce_type

Nested Schema : httpStatusCode

Type: array

Schedule Details

Show Source

Array of: object responseCodes

ResponseCodes

{
    "type":"array",
    "description":"Schedule Details",
    "items":{
        "$ref":"#/definitions/responseCodes"
    }
}

Nested Schema : responseCodes

Type: object

ResponseCodes

Show Source

code: string

Code
desc: string

Description
error: string

Error
info: string

Info
language: string

Language
override: string

Override
type: string

Type

{
    "description":"ResponseCodes",
    "type":"object",
    "properties":{
        "code":{
            "description":"Code",
            "type":"string"
        },
        "desc":{
            "description":"Description",
            "type":"string"
        },
        "type":{
            "description":"Type",
            "type":"string"
        },
        "language":{
            "description":"Language",
            "type":"string"
        },
        "error":{
            "description":"Error",
            "type":"string"
        },
        "override":{
            "description":"Override",
            "type":"string"
        },
        "info":{
            "description":"Info",
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error