FTOS_CB_ApproveContractDocument

Changes the business status of a contract document record to Signed. This endpoint is available starting with Core Banking v3.2.

Syntax

The FTOS_CB_ApproveContractDocument 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_ApproveContractDocument",
        "Data": "{"ContractName":"<contract_number>","DocumentName":"<document_name>"}"
    },
    "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\".
ContractName Mandatory. The number of the contract.
DocumentName Mandatory. The name of the contract document.

Response

The response indicates the result of the code execution, specifically the result of changing a contract document's status to Signed, as well as the contract document name.

Example

To approve a contract document by changing its status to Signed, send the following request, changing the parameter values with your desired values. Make sure that the record contains values for DocumentSigned and FileNameSigned, otherwise, the record's status cannot be changed to Signed.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_ApproveContractDocument",
        "Data": "{"ContractName":"5136","DocumentName":"5136BI/CI"}"
    },
    "ApiInfo":{
        "UserName":"host",
        "Token":"5b445502-f776-4e11-8b9b-8562b23b01aa"
    }
}

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": "{"documentName":"5136BI/CI"}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}