ContractAcknowledgement (PUT) | GEP TECH DOCUMENTATION

Overview

We can update the outbound status of the contract by documentNumber or revisedContractNumber; you can also report the error message and source system keys. If both documentNumber and revisedContractNumber are provided, the system will prioritize the revised ContractNumber.

Please note that we can only mention success or failure as the outbound status in key.

URL Format: https://api-leoaksuat.gep.com/leo-clm-v2-aggregator/api/v2/aggregator/UpdateInterfaceStatus

Request

{
        "revisedContractNumber": "CDR0046139.0",
        "key": "failure",
        "errorDetails": "testError",
        "sourceSystemValue": "Test",
        "sourceSystemName": "ERP",
        "errorCode": "400"
    }

Response

{
    "exception": null,
    "data": {
        "successDetails": [
            {
                "key": "CDR0037339.0"
            }
        ],
        "errorDetails": []
    },
    "hasData": true,
    "hasException": false
}

Data Elements

Payload/Request
Property	Required?	Data type	Description	Validations / Exceptions
revisedContractNumber	Yes, if documentNumber is not provided in payload	String	Revised contract number for the contract for which acknowledgement is to be done	Either revisedContractNumber or documentNumber should be passed as mandatory
documentNumber	Yes, if revisedContractNumber is not provided in payload	String	Document Number for the contract for which acknowledgement is to be done	Either revisedContractNumber or documentNumber should be passed as mandatory
Key	Yes, only values valid are ‘success’ or ‘failure’	String	contract is acknowledged only as success or failure	only values valid are ‘success’ or ‘failure’
errorDetails	no	String	Description about the failure reason
sourceSystemvalue	no	String	Source System value can be passed here for reference
sourceSystemName	no	String	Source System name can be passed for reference
errorCode	No	String	Error Code Can be sent basis the error code received when trying to send this data to other source system

Response
Property	Required?	Data type	Description	Validations / Exceptions
Data		Object	An object that contains actual response data from API
hasData		boolean	It’s a Boolean flag that defines API has successfully executed
exception		Object	It’s provide stack trace if any exception occurred at API level
hasException		boolean	It’s a Boolean flag that defines API has exception

Data
Property	Required?	Data type	Description	Validations / Exceptions
errorDetails		List of errorDetail object	An array of errorDetail comes in response specific to document given in payload.
successDetails		List of successDetail object	An array of successDetail comes in response specific to document given in payload.

successDetails
Property	Required?	Data type	Description	Validations / Exceptions
Key		String	Revised Contract Number / Contract Number of successful or error data.

errorDetails
Property	Required?	Data type	Description	Validations / Exceptions
Key		String	Revised Contract Number / Contract Number of successful or error data.
description		String	Description of the handled error against the payload passed