FTOS_CB_AddUpdateContractCollateral

Adds or updates a record in the FTOS_CB_ContractCollateral entity representing a contract collateral. The set of parameters sent via the request body determines the operation performed at the database level.

Syntax

The FTOS_CB_AddUpdateContractCollateral custom endpoint is called from within the callAction endpoint. Visit the callAction page for more details.

Copy 
POST <host_address>/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractCollateral",
        "Data": "{\"ContractCollateral\":{\"contractNo\":\"<contract_number>\",\"contractID\":\"<contract_id>\",\"guarantorNo\":\"<guarantor_number>\",\"collateralRegisterNo\":\"<collateral_register_number>\",\"coverValue\":<covered_value>,\"coverPercent\":<covered_percentage>,\"coverValueContractCurrency\":<covered_value_in_contract_currency>,\"status\":\"<record_status>\"}}"
    },
    "ApiInfo":{
        "UserName":"<user_name>",
        "Token":"<access_token>"
    }
}

Here's a list of the available parameters:

Parameter Description
host_address URL of the High Productivity Fintech Infrastructure server.
access_token Access token used to connect to the API endpoint. For details, see GetToken.
user_name The username of an existing user account on the High Productivity Fintech Infrastructure, previously used to get the access token.
Data Key-value pairs of any input parameters to be passed to the internal endpoint in JSON format. Double quotes that enclose string parameter values must be escaped with backslash characters, eg.: \"string value\".
contractNo Mandatory if contractId is not filled. The number of the contract.
contractId Mandatory if contractNo is not filled. The identifier of the contract.
guarantorNo Mandatory. The number of the customer who will be a guarantor for the specified contract.
collateralRegisterNo Mandatory. The collateral register number.
coverValue Mandatory. The collateral's cover value.
coverPercent The collateral's cover percentage.
coverValueContractCurrency The collateral's cover value expressed in the contract's currency.
status The status of the collateral. Possible values: Active or Secured.

Response

The response indicates the result of the code execution, specifically the result of creating or updating a record in the FTOS_CB_ContractCollateral entity .

Example

To create a new record, the contractNo, guarantorNo, or collateralRegisterNo should not identify a contract collateral already in the system.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractCollateral",
        "Data": "{\"ContractCollateral\":{\"contractNo\":\"2263 CLT USD\",\"contractID\":\"2263 CLT USD\",\"guarantorNo\":\"CL97\",\"collateralRegisterNo\":\"CC000000007\",\"coverValue\":999.00,\"coverPercent\":10.00,\"coverValueContractCurrency\":1000.00,\"status\":\"Active\"}}"
    },
    "ApiInfo":{
        "UserName":"host",
        "Token":"e4fa9110-4cd4-46e0-a6bb-86e6de919590"
    }
}

Response

Copy 
{
    "UIResult": {
        "NavigateToEntityPage": false,
        "NavigateToEntityPageOnEdit": false,
        "NavigateToEntityFormName": null,
        "NavigateToEntityName": null,
        "NavigateToEntityId": null,
        "NavigateToEntityInsertDefaults": null,
        "NavigateToUrl": null,
        "DownloadFile": null,
        "ReloadPage": false,
        "Message": null,
        "IsSuccess": false,
        "Data": "{\"isSuccess\":true}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}

To update an existing record, the contractNo, guarantorNo, or collateralRegisterNo should identify a contract collateral already in the system.

If status is not filled, then the collateral's status becomes Active.

Is status is filled with Secured value, then the record's identified status can only be Active.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractCollateral",
        "Data": "{\"ContractCollateral\":{\"contractNo\":\"2054 CLT USD\",\"contractID\":\"2054 CLT USD\",\"guarantorNo\":\"CL97\",\"collateralRegisterNo\":\"CC000000008\",\"coverValue\":1000.00,\"coverPercent\":10.00,\"coverValueContractCurrency\":1000.00,\"status\":\"Active\"}}"
    },
    "ApiInfo":{
        "UserName":"host",
        "Token":"e4fa9110-4cd4-46e0-a6bb-86e6de919590"
    }
}

Response

Copy 
{
    "UIResult": {
        "NavigateToEntityPage": false,
        "NavigateToEntityPageOnEdit": false,
        "NavigateToEntityFormName": null,
        "NavigateToEntityName": null,
        "NavigateToEntityId": null,
        "NavigateToEntityInsertDefaults": null,
        "NavigateToUrl": null,
        "DownloadFile": null,
        "ReloadPage": false,
        "Message": null,
        "IsSuccess": false,
        "Data": "{\"isSuccess\":true}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}