Get Localized Error Message

Description

The localizedErrorMessage service retrieves a localized error message based on a given error code and a mandatory language parameter, ensuring an enhanced user experience with clear and specific error information.

This service supports the following languages: French, Spanish, English, and German.
The language parameter is mandatory and must be provided in one of the following formats:

• Short format: fr, en, es, de.
• Full format: as returned by applicationLanguageCode in userProfile, e.g., fr-FR.

For example, if the error code is global.businessErrors.invalidSteuernumberNumber and the requested language is en, the response will be The identification number is not valid.

Required Parameters

To utilize this service, you must provide the following parameters:

• errorCode: The unique identifier for the business error.
• language: A required parameter specifying the language in which the error message should be localized.
  Must be in short format (fr, en, es, de) or full format (fr-FR).

Response

The service returns the localized error message for the specified error code and language.

Header

query($errorCode: String!, $language: String!) {
  localizedErrorMessage(errorCode: $errorCode, language: $language) {
    message
  }
}

{
  "errorCode": "sales.businessErrors.codeCannotContainBlankSpaces",
  "language": "en"
}

{
  "data": {
    "localizedErrorMessage": {
      "message": "You cannot enter a code that includes blank spaces. Enter a code that only contains letters or numbers. "
    }
  }
}

Error Handling

If errorCode or language is unsupported or invalid, the API responds with informative messages:

{
  "errors": [
    {
      "message": "Unrecognized error code 'Xaccounting.businessErrors.accountingAccountApplyVatFalseAndDatevEnabledDE'. Please check the error code and try again."
    }
  ],
  "data": null
}

{
  "errors": [
    {
      "message": "The specified language 'XF' is unsupported."
    }
  ],
  "data": null
}

localizedErrorMessage Input parameters

localizedErrorMessage Response