API Classification

Home / API / Classification

Search.

Searches for Classifications based on a search string. The API searches for matches in the Classification Value, Classification Code and associated Variable Values.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: PxStat.Data.Classification_API.Search

Parameters:

Name	Type	Default	Description
Search	String		The search string
LngIsoCode	String	null	The ISO language code. This restricts the search to matrices in this language only.

Return: Array [ Object ]

Name	Type	Description
ClsValue	String	Classification Value (name)
ClsCode	String	Classification Code (note this is not a unique identifier)
ClsID	Int	Classification Identifier
ClsGeoUrl	String	Geo Url of the Classification
MtrCode	String	Matrix Code
VrbCount	Int	Variable Count - number of variables associated with this Classification

---

Read.

Reads an individual Classification based on a ClassificationID.

Authentication: Windows

Privilege : Administrator , Moderator , Power User

Method: PxStat.Data.Classification_API.Read

Parameters:

Name	Type	Default	Description
ClsID	Int	Null	Classification Identifier

Return: Array [ Object ]

Name	Type	Description
ClsCode	String	Classification Code (note this is not a unique identifier)
ClsValue	String	Classification Value (name)
ClsGeoUrl	String	Geo Url of the Classification
VrbCode	String	Variable Code
VrbValue	String	Variable Value
MtrCode	String	Matrix Code
VrbEliminationFlag	Boolean	Variable Elimination associated with this Classification
VrbCount	Int	Variable Count - total number of variables associated with this Classification
ClsID	Int	Null