SaveOrganizationEntityCulture (POST) | GEP TECH DOCUMENTATION

Overview

This POST API allows to create and update Org Entity translation.

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

Request

[
   {
      "EntityCode": "string",
      "EntityType": "string",
      "EntityTranslation": "string",
      "LOBEntityCode": "string",
      "LOBEntityType": "string",
      "CultureCode": "string"
   }
]

Response

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

Additional Information

Following are the culture code values:

CultureCode	CultureName
ar-SA	Arabic
cs-CZ	Czech
da-DK	Danish
de-DE	Deutsch
el-GR	Greek
en-AU	English (AU)
en-US	English
es-ES	Español
fi-FI	Finnish
fr-FR	Français
hr-HR	Croatian
hu-HU	Hungarian
id-ID	Indonesian (Bahasa)
it-IT	Italiano
ja-JP	Japanese
ko-KR	Korean
ms-MY	Malaysian
nl-NL	Dutch
nn-NO	Norsk
pl-PL	Polish
pt-BR	Portuguese (Brazilian)
pt-PT	Portuguese
ro-RO	Romanian
ru-RU	Russian
sk-SK	Slovak
sv-SE	Swedish
th-TH	Thai
tr-TR	Turkish
vi-VN	Vietnamese
zh-CHT	Chinese (Traditional)
zh-CN	Chinese(Simplified)

Examples

Success Scenario - Request

The below request only contains mandatory attributes:

[
   {
      "EntityCode": "0001",
      "EntityType": "BusinessUnit",
      "EntityTranslation": "test",
      "LOBEntityCode": "101",
      "LOBEntityType": "Organization",
      "CultureCode": "ar-SA"
   }
]

Success Scenario – Response

{
   "data": null,
   "statusCode": "200",
   "errorDetails": [],
   "successDetails": [
      {
         "key": "EntityCode: 0001 | EntityType: BusinessUnit | CultureCode: ar-SA | LOBEntityCode: 101 | LOBEntityType: Organization | EntityTranslation: test"
      }
   ]
}

Error Scenario - Request

[
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "test",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "test",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "",
      "EntityType": "Business Region",
      "EntityTranslation": "test",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "",
      "EntityTranslation": "test",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "test",
      "LOBEntityCode": "",
      "LOBEntityType": "Organization",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "test",
      "LOBEntityCode": "1000",
      "LOBEntityType": "",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "test",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": ""
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "test",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "testjbj"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "nxQdIpM7KZ7dIgEa4tbR3HR9ZuMTuDeuZ2Aet1GzjoBby4gVns5q2FUhlBaIeGRemKVe8PxXeNbZ1JMT2EkvfAocY7A4wpXFdv1pokv7FkgGGaapJPVXafF4k9DFlhky5gpH71YiqE810YNc5grIJyynUmodzlbO69k4U7BGboMbqpR6f9kzYHtdzAb1buySkoUwujwoZRvP6R8ZNeBzQU05Wuc9NwRz5RXuglbjUZ4TnAgHhZfiBDTiWmGQ1unW62RYaZBus5bnIMmS4T2OW6OhqxtuIqOkEGxKqEnk1wa6NNES4JdN4WJD3TZBjTH03NLE4oHx1mXXJMsduWXeb0nhiYmpTvcRp0zHstYghdE6pLTR4LwoNKwyZjU8cwGrr69kT2PWUeIpUlCHjR1wK8Zn53t8wlmiyJBfFM7SpWGvKNGrwQN0XIYqQmuGNJTsAp2Vagi3gIKbkTfaVS9F31biYbYPyeO9LxKmQe6YTvfrpcaoR07fE6fb2JezCI8W0",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "ghfgbdj",
      "EntityType": "Business Region",
      "EntityTranslation": "test",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "fi-FI"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "tes888t",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "pt-PT"
   },
   {
      "EntityCode": "KAP",
      "EntityType": "Business Region",
      "EntityTranslation": "tes888t",
      "LOBEntityCode": "1000",
      "LOBEntityType": "Organization",
      "CultureCode": "ru-RU"
   }
]

Error Scenario - Response

{
    "data": null,
    "statusCode": "400",
    "errorDetails": [
        {
            "key": "EntityCode:  | EntityType: Business Region | CultureCode: fi-FI | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: test",
            "errors": [
                {
                    "errorCode": "MandatoryException",
                    "errorDescription": "EntityCode is Mandatory"
                }
            ]
        },
        {
            "key": "EntityCode: KAP | EntityType:  | CultureCode: fi-FI | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: test",
            "errors": [
                {
                    "errorCode": "MandatoryException",
                    "errorDescription": "EntityType is Mandatory"
                }
            ]
        },
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode: fi-FI | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation:",
            "errors": [
                {
                    "errorCode": "MandatoryException",
                    "errorDescription": "EntityTranslation is Mandatory"
                }
            ]
        },
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode: fi-FI | LOBEntityCode:  | LOBEntityType: Organization | EntityTranslation: test",
            "errors": [
                {
                    "errorCode": "MandatoryException",
                    "errorDescription": "LOBEntityCode is Mandatory"
                }
            ]
        },
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode: fi-FI | LOBEntityCode: 1000 | LOBEntityType:  | EntityTranslation: test",
            "errors": [
                {
                    "errorCode": "MandatoryException",
                    "errorDescription": "LOBEntityType is Mandatory"
                }
            ]
        },
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode:  | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: test",
            "errors": [
                {
                    "errorCode": "MandatoryException",
                    "errorDescription": "CultureCode is Mandatory"
                }
            ]
        },
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode: testjbj | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: test",
            "errors": [
                {
                    "errorCode": "DataException",
                    "errorDescription": "The Culture Code is either blank, invalid, or does not exist in the system"
                }
            ]
        },
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode: fi-FI | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: nxQdIpM7KZ7dIgEa4tbR3HR9ZuMTuDeuZ2Aet1GzjoBby4gVns5q2FUhlBaIeGRemKVe8PxXeNbZ1JMT2EkvfAocY7A4wpXFdv1pokv7FkgGGaapJPVXafF4k9DFlhky5gpH71YiqE810YNc5grIJyynUmodzlbO69k4U7BGboMbqpR6f9kzYHtdzAb1buySkoUwujwoZRvP6R8ZNeBzQU05Wuc9NwRz5RXuglbjUZ4TnAgHhZfiBDTiWmGQ1unW62RYaZBus5bnIMmS4T2OW6OhqxtuIqOkEGxKqEnk1wa6NNES4JdN4WJD3TZBjTH03NLE4oHx1mXXJMsduWXeb0nhiYmpTvcRp0zHstYghdE6pLTR4LwoNKwyZjU8cwGrr69kT2PWUeIpUlCHjR1wK8Zn53t8wlmiyJBfFM7SpWGvKNGrwQN0XIYqQmuGNJTsAp2Vagi3gIKbkTfaVS9F31biYbYPyeO9LxKmQe6YTvfrpcaoR07fE6fb2JezCI8W0",
            "errors": [
                {
                    "errorCode": "LengthException",
                    "errorDescription": "Org Entity Translation cannot exceed 512 characters"
                }
            ]
        },
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode: fi-FI | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: test",
            "errors": [
                {
                    "errorCode": "DataException",
                    "errorDescription": "A combination of EntityCode, EntityType, CultureCode, LOBEntityCode, LOBEntityType, EntityTranslation already exists in the same data feed
"
                },
                {
                    "errorCode": "DataException",
                    "errorDescription": "A combination of EntityCode, EntityType, CultureCode, LOBEntityCode, LOBEntityType, EntityTranslation already exists in the same data feed
"
                }
            ]
        },
        {
            "key": "EntityCode: ghfgbdj | EntityType: Business Region | CultureCode: fi-FI | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: test",
            "errors": [
                {
                    "errorCode": "DataException",
                    "errorDescription": "The combination of LOB Entity Code, LOB Entity Type, Entity Code and Entity Type is either inactive or does not exist in the system"
                }
            ]
        }
    ],
    "successDetails": [
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode: pt-PT | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: tes888t"
        },
        {
            "key": "EntityCode: KAP | EntityType: Business Region | CultureCode: ru-RU | LOBEntityCode: 1000 | LOBEntityType: Organization | EntityTranslation: tes888t"
        }
    ]
}

Data Elements

UserGroup
Property	Required?	Data type	Description	Validations/Exceptions
EntityCode	Yes	String	EntityCode which needs to be provided	Mandate validation
EntityType	Yes	String	EntityType which needs to be provided	Mandate validation
EntityTranslation	Yes	String	EntityTranslation which needs to be provided	Mandate validation
LOBEntityCode	Yes	String	LOBEntityCode which needs to be provided	Mandate validation
LOBEntityType	Yes	String	LOBEntityType which needs to be provided	Mandate validation
CultureCode	Yes	String	CultureCode which needs to be provided	The value of CultureCode must be from the list provided. For more information, see the Additional Information section.