UpdateContactInterfaceStatus (PUT)

  • Overview
  • Request
  • Response
  • Examples
  • Data Elements
Overview

This PUT API can be used to capture updates in contact interface details from ERP into GEP SMART, that can be used as a reference in P2P transactions.

 

URL Format: https://<Instance>/SmartInterfaceAPI/api/Contact/ContactInterfaceStatus

Request 
[
   {
     "clientContactCode": "String",
      "interfaceStatus": "String"
   }
]

 

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

 

Examples

Success Scenario - Request 

[
   {
      "clientContactCode": "CC-2017.023662",
      "interfaceStatus": "success"
   }
]

Success Scenario – Response

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "CC-2017.023662"
      }
   ]
}

Error Scenario - Request 
Request below describes that this is a missing value of the interfaceStatus which is the mandatory attribute:

[
   {
      "clientContactCode": "CC-2017.023662",
      "interfaceStatus": ""
   }
]


Error Scenario – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "Validation",
         "errors": [
            {
               "errorCode": "DataValidation",
               "errorDescription": "Interface Status is Mandatory"
            }
         ]
      }
   ],
   "successDetails": []
}

 

Data Elements
 

Update Contact Interface Status

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1

ClientContactCode

Yes

String

Contact Code of Client

  • Client Contact Code is mandatory

2

InterfaceStatus

Yes

String

Interface Status

  • Interface Status is mandatory