SA Language Strings

Get SA multi-lingual strings by organization ID

GET /api/.../sysadmin/languagestrings/merged/{orgid}

This method retrieves all language string values for a specific product based on the specified organization ID.

Custom values will be merged into the result set overlaying default string values. The product ID and language used to retrieve the language string values are provided in the root URL.

Request Information

Parameters
Name Type Required Description
orgid Integer Yes Organization ID used to determine list of language strings.

Response Information

Returns the list of language strings.
Properties
Property Type Nullable Description
LanguageID Int No System administration ID of language. Determined by string language that is part of the request URL.
Mnemonic String No Language string mnemonic.
OrganizationID Int No Organization ID.
ProductID Int No Product ID. Determined by product ID that is part of the request URL.
Value String No Value of language string.
Possible Values
LanguageID ISO 639-2 Language Code Language
1031gerGerman
1033engEnglish
1042korKorean
1043dutDutch
1049rusRussian
1065perPersian
1066vieVietnamese
1141hawHawaiian
2052chiChinese
3082spaSpanish
3084freFrench
12289araArabic
15372hatHaitian Creole
Example
application/json, text/json 
[
    {
        "ProductID":20,
        "LanguageID":1033,
        "OrganizationID":0,
        "Mnemonic":"SW_CI_CHCKOUTIND_AUTH",
        "Value":"AUTHOR"
    },
    {
        "ProductID":20,
        "LanguageID":1033,
        "OrganizationID":0,
        "Mnemonic":"SW_CI_CHCKOUTIND_BRCD",
        "Value":"BARCODE"
    }
]

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Invalid organization ID
404 FAILURE.
  • organization not found

Get SA multi-lingual strings by organization ID - Simple JSON

GET /api/.../sysadmin/languagestrings/merged/{orgid}?simplejson

This method retrieves all language string values for a specific product based on the specified organization ID.

The returned data will be a simple JSON object containing mnemonics as property names and the string as the property value.

Custom values will be merged into the result set overlaying default string values. The product ID and language used to retrieve the language string values are provided in the root URL.

Request Information

Parameters
Name Type Required Description
orgid Integer Yes Organization ID used to determine list of language strings.
Example with "simplejson" Supplied
application/json, text/json 
{
    "SW_CI_CHCKOUTIND_AUTH":"AUTHOR",
    "SW_CI_CHCKOUTIND_BRCD":"BARCODE",
    "SW_CI_CHCKOUTIND_BRNCH":"BRANCH",
    "SW_CI_CHCKOUTIND_CHCKOUT":"Checkout",
    "SW_CI_CHCKOUTIND_CHCKOUTITM":"Checkout an item:",
    "SW_CI_CHCKOUTIND_CLLNO":"CALL NO."
}

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Invalid organization ID
404 FAILURE.
  • organization not found

Get SA multi-lingual string value by organization ID and mnemonic

GET /api/.../sysadmin/languagestrings/merged/{orgid}/{mnemonic}

This method retrieves a specific language string value for a product based on the specified organization ID and mnemonic.

If a custom value exists, it will be returned instead of the default string value. The product ID and language used to retrieve the language string value are provided in the root URL.

Request Information

Parameters
Name Type Required Description
orgid Integer Yes Organization ID.
mnemonic String Yes Mnemonic value of string to retrieve.

Response Information

Returns the multi-lingual string value associated with the mnemonic.
Example
application/json, text/json 
"AUTHOR"

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Invalid organization ID
404 FAILURE.
  • organization not found