FTOS_CB_AddContractGuarantor

Adds a new record to the FTOS_CB_ContractGuarantor entity representing a guarantor for a contract.

Syntax

The FTOS_CB_AddContractGuarantor 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_AddContractGuarantor",
        "Data": "{ \"ContractGuarantor\": { \"contractNo\":\"<contract_number>\",\"contractId\":\"<contract_identifier>\",\"guarantorNo\":\"<guarantor_customer_number>\"} }"
    },
    "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.
To create a new record, do NOT send this parameter.
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.

Response

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

Example

To create a new record, do not fill or send the contractNo parameter. Also, make sure that the contractId does not exist in the system as an internalId value.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddContractGuarantor",
        "Data": "{\"ContractGuarantor\":{\"contractNo\":\"2054 CLT USD\",\"contractID\":\"2054 CLT USD\",\"guarantorNo\":\"CL111\"}}"
    },
    "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
}