API Language
The API Language APIs to control creating, deleting, updating and reading Languages. Methods list with Parameters and Return examples.
The Read method is used to return one or more Languages related to the Matrix. If a valid LngIsoCode is passed in, the method will return the corresponding language. If the default value for LngIsoCode is passed in, the method will return all languages.
Authentication: Anonymous
Privilege : n/a
Method: PxStat.System.Settings.Language_API.Read
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
LngIsoCode |
String | null | ISO 639-1: two-letter codes ISO Codes |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
LngIsoCode |
String | ISO 639-1: two-letter codes ISO Codes |
LngIsoName |
String | ISO language name |
MtrCount |
Int | Number of Tables that use this Language |
The Create method must receive ISO Language Name LngIsoCode and ISO Language Code LngIsoName as parameters. If these are validated successfully, and the ISO Language Code LngIsoCode doesn't already exist then this method will create the new entry.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Language_API.Create
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
LngIsoCode |
String | ISO 639-1: two-letter codes ISO Codes | |
LngIsoName |
String | ISO Language Name |
Return: String with value of success.
Updates a language entity. Only the ISO Language Name LngIsoName can be changed.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Language_API.Update
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
LngIsoCode |
String | ISO 639-1: two-letter codes ISO Codes | |
LngIsoName |
String | ISO Language Name |
Return: String with value of success.
This method will delete an entity. A valid LngIsoCode must be supplied by the client.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Language_API.Delete.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
LngIsoCode |
String | ISO 639-1: two-letter codes ISO Codes |
Return: String with value of result.
The CheckIsLngIsoCode method must receive ISO Language Name LngIsoCode as a parameter. If this are validated successfully, and the ISO Language Code LngIsoCode has an associated language plugin.
Authentication: Windows
Privilege : Administrator , Power User
Method: PxStat.System.Settings.Language_API.CheckIsLngIsoCode
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
LngIsoCode |
String | ISO 639-1: two-letter codes ISO Codes |
Return: bool with value of result.
