DeactivateOrgEntities (PUT)

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

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

 

URL Format: https://<Instance>/SmartInterfaceAPI/api/Organization/Deactivate

Request

https://<Instance>/SmartInterfaceAPI/api/Organization/Deactivate?EntityType=Cost Center

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

 

Examples

Success Scenario - Request 

https://<Instance>/SmartInterfaceAPI/api/Organization/Deactivate?EntityType=Cost Center

 

Success Scenario – Response

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

 

Error Scenario 1 - Request 
Below request contains a missing value of the mandatory attribute - EntityType :

https://<Instance>/SmartInterfaceAPI/api/Organization/Deactivate?EntityType=

 

Error Scenario 1 – Response

{
   "statuscode": 404,
   "message": "Resource not found"
}

 

Data Elements
 

Deactivate Org Entities

S.No.

Property

Required?

Data type

Description

Validations/Exceptions

1

EntityType

Yes

String

Entity Type of the entity

  • Entity Code is mandatory