Skip to content
liamie edited this page Jul 7, 2021 · 3 revisions

Home / API / Theme

Read.

Reads Themes. If neither Theme Code ThmCode nor Theme Value ThmValue are supplied then all Themes will be returned. If either or both of these parameters are supplied then the themes corresponding to these codes will be returned.

If ISO Language Code LngIsoCode is supplied then the API will return a translation of the theme names if they exist. If there is no translation available then the API will return the theme code and value in the default language of that Theme.

Authentication: Anonymous

Privilege : Public

Method: PxStat.System.Navigation.Theme_API.Read

Parameters:

Name Type Default Description
ThmCode String null Theme Code
ThmValue String null Theme Name
LngIsoCode String null ISO Language Code

Return: Array [ Object ]

Name Type Description
ThmCode String Theme Code
ThmValue String Theme Name
SbjCount Integer Count of Subjects featuring this theme

Create.

Creates a new Theme.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: PxStat.System.Navigation.Theme_API.Create

Parameters:

Name Type Default Description
ThmValue String Theme Name
LngIsoCode String ISO Language Code

Return: String with value of success


Update.

Updates a Theme. If ISO Language Code LngIsoCode is supplied and if this Language is different from the current Theme Language then it is assumed that we are adding or updating a translation of the Theme name to the alternative Language. If ISO Language Code LngIsoCode is not supplied then any update of Theme name will be in the Theme's default Language.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Theme_API.Update

Parameters:

Name Type Default Description
ThmCode Integer Theme Code
ThmValue String Theme Name

Return: String with value of success.


Delete.

Deletes a Theme.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Theme_API.Delete

Parameters:

Name Type Default Description
ThmCode String Theme Code

Return: String with value of success.

Clone this wiki locally