API Keyword Release

Home / API / Keyword Release

Read.

Reads a Keyword Release. If no parameters are sent then all Keyword Releases will be returned. If only the Keyword Release Value KrlValue is sent then that Keyword Release will be returned. If only the Release Code RlsCode is sent then all Keyword Releases for that RlsCode will be returned.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Keyword_Release_API.Read

Parameters:

Name	Type	Default	Description
RlsCode	Integer	0 or empty	Release Code
KrlCode	String	null	Keyword Release Value

Return: Array [ Object ]

Name	Type	Description
KrlCode	Integer	Keyword Release Code
KrlValue	String	Keyword Release Value
KrlMandatoryFlag	Boolean	Indicates if it is a Mandatory Keyword
RlsCode	Integer	Release Code
KrlSingularisedFlag	Boolean	Indicates if this keyword is to be singularised*
*This usually applies to words, e.g. acronyms, that will not be singularised as part of the search

---

Create.

Creates a non-mandatory Release Keyword.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Keyword_Release_API.Create

Parameters:

Name	Type	Default	Description
RlsCode	Integer		Release Code
KrlValue	String		Keyword Release Value

Return: String with value of success.

---

Update.

Updates a Release Keyword.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Keyword_Release_API.Update

Parameters:

Name	Type	Default	Description
KrlCode	Integer		Keyword Release Code
KrlValue	String		Keyword Release Value

Return: String with value of success.

---

Delete.

Deletes a Release Keyword.

Authentication: Windows

Privilege : Administrator , Power User

Method: PxStat.System.Navigation.Keyword_Release_API.Delete

Parameters:

Name	Type	Default	Description
KrlCode	Integer		Keyword Release Code

Return: String with value of success.