Overview

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

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

Request

[
 {
 "gepPartnerCode": 0,
 "formCodes": [
 0
 ],
 "description": "string"
 }
]

Response

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

Examples

Success Scenario - Request

[
    {
        "gepPartnerCode": 539047,
        "formCodes": [1457, 1482],
        "description": ""
    }
]

Success Scenario - Response

{
	"data": null,
	"statusCode": "200",
	"errorDetails": [],
	"successDetails": [{
		"key": "539047"
	}]
}

Error Scenario - Request

The request below describes that this contains an Invalid partner code and Invalid Form code.

[
    {
        "gepPartnerCode": InvalidPC,
        "formCodes": [InvalidFC],
        "description": ""
    }
]

Error Scenario – Response

{
	"data": null,
	"statusCode": "400",
	"errorDetails": [{
		"key": "InvalidPC",
		"errors": [{
			"errorCode": "DataException",
			"errorDescription": "Invalid Partner Code"
		},
		{
			"errorCode": "DataException",
			"errorDescription": "Invalid Form Code InvalidFC"
		}]
	}],
	"successDetails": []
}

Data Elements

UpdatePartnerInterfaceStatus
PROPERTY	REQUIRED?	DATA TYPE	DESCRIPTION	VALIDATIONS/EXCEPTIONS
GEPPartnerCode	Yes	Int	Partner Code of the Partner	Invalid Partner Code
FormCodes	Yes	List of Int	Form Code of the Partner	Invalid Form Code
Description	No	String

UpdatePartnerFormInterfaceStatus (PUT)

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