UpdateProcessedContractStatus (PUT) | GEP TECH DOCUMENTATION

Overview

This Acknowledgment API allows us to capture back the ERP processing status in Contract Status into GEP SMART, that is displayed to the user along with comments in case of failures.

URL Format: https://<Instance>/smartInterfaceAPI/api/Contract/ContractStatus

Request

{
   "model": [
      {
         "key": "string",
         "description": "string",
         "status": "string",
         "sourceSystemName": "string",
         "sourceSystemValue": "string",
         "lob": "string",
         "errorCode": "string"
      }
   ]
}

Response

{
  "data": null,
  "statusCode": "String",
  "errorDetails": [
    {
      "key": "string",
      "errors": [
        {
          "errorCode": "string",
          "errorDescription": "string"
        }
      ]
    }
  ],
  "successDetails": [
    {
      "key": "String"
    }
  ]
}

Examples

Success Scenario - Request

Below request only contains the mandatory attribute(s):

{
   "model": [
      {
         "key": "string",
         "description": "string",
         "status": "string",
         "sourceSystemName": "string",
         "sourceSystemValue": "string",
         "lob": "string",
         "errorCode": "string"
      }
   ]
}

Success Scenario – Response

{
  "data": null,
  "statusCode": "200",
  "errorDetails": [],
  "successDetails": [
    {
      "key": "CM_2014.000026"
    }
  ]
}

Error Scenario - Request

{
   "model": [
      {
         "key": "string",
         "description": "string",
         "status": "string",
         "sourceSystemName": "string",
         "sourceSystemValue": "string",
         "lob": "string",
         "errorCode": "string"
      }
   ]
}

Error Scenario - Response

{
  "data": null,
  "statusCode": "400",
  "errorDetails": [
    {
      "key": "CM_03939_02092",
      "errors": [
        {
          "errorCode": "DataValidation",
          "errorDescription": "Invalid Contract Number"
        }
      ]
    }
  ],
  "successDetails": []
}

Data Elements

UpdateProcessedContractStatus

S.No.

Property

Required?

Data type

Description

Validations/

Exceptions

1

Model

No

List of UpdateProcessedDocumentStatusModel object

Check data type UpdateProcessedDocumentStatusModel for details

	Model
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1.1	Status	No	ErrorDetail object	Check data type ErrorDetail for details
1.2	Key	Yes	String	Key of the entity	Key is mandatory Invalid Contract Number
1.3	Description	No	String	Description of the entity
1.4	SourceSystemDetailsName	No	String	Name of the entity
1.5	SourceSystemDetailsValue	No	String	Value of the entity
1.6	Lob	No	String	line-of-business
1.7	ErrorCode	No	String	Check data type Error Code