Skip to content

API Language

Robert Polak edited this page Jun 21, 2019 · 39 revisions

Read

Read - Details

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 : Administrator , Moderator , Power User

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
RlsCount Int Number of Releases that use this Language

Create

Create - Details

The Create method must receive LngIsoCode and LngIsoName as parameters. If these are validated successfully, and the 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 or error


Update

Update - Details

Updates a language entity. Only the 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 or error


Delete

Delete - Details

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 success or error


Clone this wiki locally