2524436 - Q32017 (1708) Enhancement & Features for API-7426

SAP Knowledge Base Article - Public

2524436 - Q32017 (1708) Enhancement & Features for API-7426

Symptom

This KBA lists out the re-defined error codes and error descriptions for API response header and response payload which has been released with Q3 2017.

Environment

Success Factors

Resolution

To more easily find error messages in logs, we have introduced a unique error code available in both the response header and response payload and below is the complete list.

Custom Code

ErrorCode

Error Category

Error Message

Http Code

LGN0001

CATEGORY_DENIED

Category

Invalid endpoint

404

LGN0002

ODATA_ADMIN_PERM_REQUIRED

Login

Authentication failed, user doesn't have the OData Admin access permission. Please review granting of permission at the Roles Management menu of ******

403

LGN0003

CREDENTIALS_MISSING

Login

Authentication credentials are require. Please provide a valid user name, password and company id.

403

LGN0004

AUTHENTICATION_DENIED

Login

Accessing OData API using Basic authentication or External OAuth on non-API servers is forbidden.

403

LGN0005

OAUTH_TOKEN_FORMAT_INVALID

Login

The OAuth authentication token format is wrong.

403

LGN0006

INTERNAL_TOKEN_EXPIRED

Login

Token has been expired:{0}.Relogin to your application or perform a getToken operation to refresh your access token.

403

LGN0007

TOKEN_INVALID

Login

Invalid OAuth token:{0}. Please validate the value for your OAuth token.

403

LGN0008

COMPANY_NOT_FOUND

Login

Company [{0}] not found. Please validate the spelling of your company id, which is case-sensitive.

403

| Authentication failed due to invalid companyId(status code={0}). Please validate the spelling of your company id, which is case-sensitive.

LGN0009

ODATA_API_FEATURE_NOT_ENABLE

Login

OData API feature is not enabled for this company. Please contact support to enable ODATA.

403

LGN0010

BASIC_AUTH_OR_IP_DISABLED

Login

Basic authentication for ODATA API is disabled for company {0}

403

LGN0011

COMPANY_EXPIRED

Login

Authentication failed due to expired company(status code = {0})

403

LGN0012

COMPANY_INACTIVE

Login

Authentication failed due to inactive company(status code = {0})

 

LGN0013

IP_INVALID

Login

Authentication failed. Attempted login from unauthorized ip:{0} to company id {1} by username:{2}(status code = {3})

403

LGN0014

ACCOUNT_LOCKED

Login

Authentication failed, user account is locked (status code = {0}). Please contact your system administrator to unlock your account.

403

LGN0015

CREDENTIALS_INVALID

Login

Authentication failed, invalid user id or password(status code = {0})

403

LGN0016

USER_NO_LOGIN_PERMISSION

Login

Authentication failed, user doesn't have login permission. Please refer to documentation at http://******* for more details or contact your system administrator.(status code = {0})

403

LGN0017

USER_NEEDS_VALIDATION

Login

Authentication failed, user account needs to be validated. Please refer to documentation at https://******* for more details/ (Status code ={0})

403

LGN0018

PASSWORD_EXPIRED

Login

Authentication failed, passwod has expired(status code={0}). Please attempt to login to the SuccessFactors UI to reset, or contact your system administrator.

403

LGN0019

MANAGER_INVALID

Login

Authentication failed due to invalid manager(status code = {0}).

403

LGN0020

BASIC_AUTH_FORMAT_INVALID

Login

The HTTP Basic Authentication format is wrong. <username>@<company id>:<passowrd>, which must be encoded into Base64 text. | Basic Authentication String should start with the String 'Basic'.

 

LGN0021

INTERNAL_ERROR

Login

Internal error. Please ensure that you have a valid API request and contact support.Please refer to ducumentation at https://*****

 

LGN0022

REASON_UNKNOWN

Login

 

 

 

 

 

 

 

COE0001

COE_NO_PERMISSION

Engine

 

400

COE0002

COE_NO_ENTITY_PERMISSION

Engine

 

400

COE003

COE_BAD_PROPERTY_EXPRESSION

Engine

 

 

COE0004

COE_BAD_OPTION_VALUE

Engine

 

400

COE0005

COE_BAD_PROPERTY_VALUE

Engine

 

400

COE0006

COE_MODULE_NOT_FOUND

Engine

 

 

COE0007

COE_ENTITY_NOT_FOUND

Engine

 

400

COE0008

COE_FUNCTION_IMPORT_NOT_FOUND

Engine

 

400

COE0009

COE_ENTITY_NOT_INSERTABLE

Engine

 

400

COE0010

COE_ENTITY_NOT_UPDATABLE

Engine

 

400

COE0011

COE_ENTITY_NOT_UPSERTABLE

Engine

 

400

COE0012

COE_ENTITY_NOT_DELETABLE

Engine

 

400

COE0013

COE_ENTITY_NOT_REPLACABLE

Engine

 

400

COE0014

COE_ASSOCIATION_NOT_INSERTABLE

Engine

 

400

COE0015

COE_ASSOCIATION_NOT_UPDATABLE

Engine

 

400

COE0016

COE_ASSOCIATION_NOT_UPSERTABLE

Engine

 

400

COE0017

COE_ASSOCIATION_NOT_DELETABLE

Engine

 

400

COE0018

COE_GENERAL_BAD_REQUEST

Engine

 

400

COE0019

COE_GENERAL_SERVER_FAILURE

Engine

 

 

COE0020

COE_GENERAL_FORBIDDEN

Engine

 

403|400

COE0021

COE_PROPERTY_NOT_FOUND

Engine

 

400

COE0022

COE_PROPERTY_NOT_INCLUDED

Engine

 

400

COE0023

COE_PROPERTY_NOT_VIEWABLE

Engine

 

400

COE0024

COE_UNSUPPORTED_ENTITYSET_CATEGORY

Engine

 

400

COE0025

COE_UNSUPPORTED_FEATURE

Engine

 

400

COE0026

COE_UNSUPPORTED_LOCALE

Engine

 

400

COE0027

COE_MISSING_REQUIRED_PROPERTIES

Engine

 

400

COE0028

COE_RECORD_NOT_FOUND

Engine

 

400

COE0029

COE_RECORD_ALREADY_EXIST

Engine

 

400

COE0030

COE_PROPERTY_NOT_EDITABLE

Engine

 

400

COE0031

COE_PROPERTY_NOT_INSERTABLE

Engine

 

400

COE0032

COE_PROPERTY_NOT_UPDATABLE

Engine

 

400

COE0033

COE_PROPERTY_EXCEED_MAX_LENGTH

Engine

 

400

COE0034

COE_PROPERTY_NOINLINE_REQUIRED

Engine

 

400

COE0035

COE_ROLE_NAMES_UNABLE_TO_PARSE

Engine

 

400

COE0036

COE_ROLE_NAMES_UNABLE_TO_COLLECT

Engine

 

400

COE0037

COE_ENTITY_NOT_EDITABLE

Engine

 

400

COE0038

COE_SERVICE_ALIAS_NOT_FOUND

Engine

 

400

COE0039

COE_UNSUPPORTED_SERVICE_ALIAS_USAGE

Engine

 

400

COE0040

COE_SERVICE_TEMPORARILY_UNAVAILABLE

Engine

 

503

Keywords

  • error code
  • error description
  • Q3 2017 release
  • API new feature
  , KBA , LOD-SF-INT-API , SF API & Adhoc API Framework , LOD-SF-INT , SF Integrations - EC Payroll, Boomi/ HCI, API , Problem

Product

SAP SuccessFactors HCM Core 1708