LegalCompanyName (POST) | GEP TECH DOCUMENTATION

Overview

This POST API can be available for loading contract legal company names.

URL Format: https://api-smartdev.gep.com/SmartInterfaceAPI/api/Contract/LegalCompanyName

Request

[
   {
      "legalCompanyName": "TestLegalCompanyName100.2",
      "legalCompanyCode": "TLC101",
      "isDeleted": false
   }
]

Response

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "TestLegalCompanyName100.2"
      }
   ]
}

Examples

Success Scenario - Request
Request below describes that this contains only the mandatory attributes:

[
   {
      "legalCompanyName": "TestLegalCompanyName100.4"
   },
   {
      "legalCompanyName": "TestLegalCompanyName100.5"
   }
]

Success Scenario - Response

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "TestLegalCompanyName100.4"
      },
      {
         "key": "TestLegalCompanyName100.5"
      }
   ]
}

Error Scenario - Request
Request below describes that this has invalid persona code:

[
   {
      "legalCompanyName": "TestLegalCompanyName100.8",
      "legalCompanyCode": "TLC102",
      "isDeleted": true
   },
   {
      "legalCompanyName": "TestLegalCompanyName100.9",
      "legalCompanyCode": "TLC102",
      "isDeleted": true
   }
]

Error Scenario – Response

{
   "data": null,
   "statusCode": "400",
   "errorDetails": [
      {
         "key": "TestLegalCompanyName100.8",
         "errors": [
            {
               "errorCode": "DataValidation",
               "errorDescription": "Invalid legal company name TestLegalCompanyName100.8"
            }
         ]
      },
      {
         "key": "TestLegalCompanyName100.9",
         "errors": [
            {
               "errorCode": "DataValidation",
               "errorDescription": "Invalid legal company name TestLegalCompanyName100.9"
            }
         ]
      }
   ],
   "successDetails": []
}

Data Elements

Save Legal Company Details
Property	Required?	Data type	Description	Validations/Exceptions
Data		List of ContractLegalCompanyDetails object
Status Code		String(100)
ErrorDetails		List of Error details
SuccessDetails		List of Success details

ContractLegalCompanyDetails
Property	Required?	Data type	Description	Validations/Exceptions
LegalCompanyName	Yes	String	Legal company name is an official name of the individual or corporation taking part in the agreement.	Legal Company Name is mandatory, Legal Company Name max length is 100
LegalCompanyCode	No	String	Legal company code is an unique number for the legal entity.	Legal Company Code max length is 100
IsDeleted	No	bool	Flag to delete old legal company name and insert new one

ErrorDetails
Property	Required?	Data type	Description	Validations/Exceptions
Key		String
Errors		String	It returns error status code and error description	Data validation or mandatory error details will throw

Errors
Property	Required?	Data type	Description	Validations/Exceptions
ErrorCode
ErrorDescription	String		Return success status code as 400 and legal company name as success response	"StatusCode": "200", "ErrorDetails": [], " SuccessDetails ": [ {"key": "TestLegalCompanyName100.4"}

SuccessDetails
Property	Required?	Data type	Description	Validations/Exceptions
Key	String		Return error code as 200 and error description with key	"SuccessDetails": [ {"key": "TestLegalCompanyName100.4"}