Skip to content

API Subject

liamie edited this page Jul 9, 2021 · 27 revisions

Home / API / Subject

Read.

Reads a Subject. If the Subject Code SbjCode parameter is supplied then the Subject corresponding to that code will be returned. Otherwise all Subjects are returned.

If the ISO Language Code LngIsoCode parameter is supplied then the API will return the Subject name in that Language provided a translation exists. If no translation exists then the Subject name will be returned in the default Language of the Subject.

Authentication: Anonymous

Privilege : Public

Method: PxStat.System.Navigation.Subject_API.Read

Parameters:

Name Type Default Description
SbjCode Int null Subject Code
LngIsoCode String null ISO Language Code

Return: Array [ Object ]

Name Type Description
SbjCode Int
SbjValue String
ThmValue String
ThmCode String
PrcCount Int Count of Products attached to this Subject

Create.

Creates a new Subject.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Subject_API.Create

Parameters:

Name Type Default Description
SbjValue String Subject Name
ThmCode String Theme Code

Return: String with value of success.


Update.

Updates a Subject. If the ISO Language Code LngIsoCode parameter is supplied, and the Language is different to the default Language, we assume that this is a request to create a translation of the Subject name to the requested Language.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Subject_API.Update

Parameters:

Name Type Default Description
SbjCode Integer Subject Code
SbjValue String Subject Value
LngIsoCode String null ISO Language Code
ThmCode String Theme Code

Return: String with value of success.


Delete.

Deletes a Subject.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Subject_API.Delete

Parameters:

Name Type Default Description
SbjCode Integer Subject Code

Return: String with value of success.

Clone this wiki locally