UpdatePartnerInterfaceStatus (PUT) | GEP TECH DOCUMENTATION

Overview

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

URL Format: https://<Instance>/SmartInterfaceAPI/api/Partner/PartnerInterfaceStatus

Request

{
 "lstPartnerCodes": [
 "String"
 ],
 "interfaceStatusCode":
}

Response

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

Examples

Success Scenario - Request

{
   "lstPartnerCodes": [
      "PC-SAY-002894-01"
   ],
   "interfaceStatusCode": 1
}

Success Scenario - Response

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "PC-SAY-002894-01"
      }
   ]
}

Error Scenario - Request

Request below describes that this contains Invalid partner code.

{
   "lstPartnerCodes": [
      "invalid"
   ],
   "interfaceStatusCode": 1
}

Error Scenario – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "invalid",
         "errors": [
            {
               "errorCode": "DataValidation",
               "errorDescription": "Invalid Partner Code"
            }
         ]
      }
   ],
   "successDetails": []
}

Data Elements

	UpdatePartnerInterfaceStatus
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	LstPartnerCodes	Yes	List of String	Partner Code of the Partner
2	InterfaceStatusCode	Yes	Int	Status Code of the Partner	Error while updating partner interface status