FTOS_CB_AddUpdateContractParticipant

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

Syntax

The FTOS_CB_AddUpdateContractParticipant 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_AddUpdateContractParticipant",
        "Data": "{ \"ContractParticipantInfo\": { \"contractNo\":\"<contract_number>\",\"customerNo\":\"<customer_number>\",\"participantRole\":\"<participant_role>\",\"blockReason\":\"\",\"blockDate\":\"<block_date>\",\"blockDisburse\":<false>} }"
    },
    "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\".
contractParticipantIdentifier The id of the contract participant.
To create a new record, do NOT send this parameter. To update an existing record, fill and send this parameter in the ContractParticipantInfo section of the request.
contractNo Mandatory if contractId is not filled. The number of the contract.
contractId Mandatory if contractNo is not filled. The identifier of the contract.
customerNo Mandatory. The number of the customer, customerNo in the Account entity.
participantRole Mandatory. The role of the participant in this contract. Check the Dependencies page for possible values.
blockReason The reason for blocking the disbursement. Check the Dependencies page for possible values.
blockDate The date when the disbursement is blocked.
blockDisburse Possible values: true or false. If true, the disbursement is blocked.

Response

The response indicates the result of the code execution, specifically the result of creating or updating a record in the FTOS_CB_ContractParticipant entity. If the record is created or updated successfully, its contractParticipantIdentifier is returned.

Example

To create a new record, do not fill or send the contractParticipantIdentifier parameter.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractParticipant",
        "Data": "{ \"ContractParticipantInfo\": { \"contractNo\":\"2074 FiscoLine\",\"customerNo\":\"CL110\",\"participantRole\":\"Beneficiary\",\"blockReason\":\"\",\"blockDate\":\"2021-01-01\",\"blockDisburse\":false} }"
    },
    "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": "{\"contractParticipantIdentifier\":\"CP000000049\"}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}

To update an existing record, fill and send the contractParticipantIdentifier parameter with the desired value.

Request

Copy 
POST https://FintechOSStudio/api/openApi/CallAction
Content-Type: application/json
            
{
    "Request":{
        "ActionName":"FTOS_CB_AddUpdateContractParticipant",
        "Data": "{ \"ContractParticipantInfo\": { \"contractParticipantIdentifier\":\"CP000000005\",\"contractID\":\"SomeIntern20\",\"customerNo\":\"CL110\",\"participantRole\":\"Beneficiary\",\"blockReason\":\"LeftCompany\",\"blockDate\":\"2021-05-20\",\"blockDisburse\":false} }"
    },
    "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": "{\"contractParticipantIdentifier\":\"CP000000005\"}",
        "NavigateToPageNo": null
    },
    "Message": null,
    "IsSuccess": true,
    "ClientScript": null,
    "Serialized": null,
    "ErrorCode": 0
}