API Navigation
Home / API / Navigation
Read - Details
Reads a summary of Subjects and Products for navigation purposes. If the ISO Language Code LngIsoCode parameter is sent then the API will return versions of Product name and Subject name in that language if such translations exist. Otherwise it returns the names in the default Language of the Product/Subject.
Authentication: Anonymous
Privilege : N/A
Method: PxStat.System.Navigation.Navigation_API.Read
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
LngIsoCode |
String | null | ISO Language Code |
Return: Array [ Object ]
Object - Details
| Name | Type | Description |
|---|---|---|
SbjCode |
Int | Subject code |
SbjValue |
String | Subject name |
product |
Array [Product] | A list of Products associated with this Subject |
product
| Name | Type | Description |
|---|---|---|
PrcCode |
Int | Product code |
PrcValue |
String | Subject code |
PrcReleaseCount |
Int | Count of live Releases associated with this Product |
Search - Details
To use this API either the "Search" parameter or at least one of the other parameters (apart from LngIsoCode) must be sent.
The ISO Language Code LngIsoCode parameter tells the API which language is used to return the data. If there is a version of a Matrix in that language then the returned data will be in that Language.
Authentication: Anonymous
Privilege : N/A
Method: PxStat.System.Navigation.Subject_API.Read
Parameters: Note - The Boolean parameters can be considered to be nullable. A null value does not equate to "false", rather it indicates that this parameter will not form part of the search.
| Name | Type | Default | Description |
|---|---|---|---|
LngIsoCode |
String | null | ISO Language Code |
MtrCode |
String | null | Matrix Code |
MtrOfficialFlag |
Boolean | null | Official Flag Indicator |
SbjCode |
Int | 0 | Subject Code |
PrcCode |
Int | 0 | Product Code |
CprCode |
String | null | Copyright Code |
RlsEmergencyFlag |
Boolean | null | Emergency Flag Indicator |
RlsReservationFlag |
Boolean | null | Reservation Flag Indicator |
RlsArchiveFlag |
Boolean | null | Archive Flag Indicator |
RlsAnalyticalFlag |
Boolean | null | Analytical Flag Indicator |
Search |
String | null | Search Term |
Return: Array [ Object ]
Object - Details
| Name | Type | Description |
|---|---|---|
MtrCode |
String | Matrix Code |
MtrTitle |
String | Matrix Title |
MtrOfficialFlag |
Boolean | Official Flag Indicator |
SbjCode |
Int | Subject Code |
SbjValue |
String | Subject Name |
PrcCode |
Int | Product Code |
PrcValue |
String | Product Value |
RlsLiveDatetimeFrom |
Date Time | Start date of Release |
RlsEmergencyFlag |
Boolean | Emergency Flag Indicator |
RlsReservationFlag |
Boolean | Reservation Flag Indicator |
RlsArchiveFlag |
Boolean | Archive Flag Indicator |
RlsAnalyticalFlag |
Boolean | Analytical Flag Indicator |
RlsDependencyFlag |
Boolean | Dependency Flag Indicator |
CprCode |
String | Copyright Code |
CprValue |
String | Copyright Value |
LngIsoCode |
String | ISO Language Code of the returned Matrix |
LngIsoName |
String | Language Name of the returned Matrix |
classification |
Array[object] |
Array of Classifications |
FrqCode |
String | Frequency Code |
FrqValue |
String | Frequency Value |
period |
Array[object] |
List of Periods |
Score |
Int | Relevance score for Keyword searches* |
*Higher score indicates more relevance. A score of zero is returned for entity searches. It is expected that entity search results take precedence over keyword searches.
Classification
| Name | Type | Description |
|---|---|---|
ClsCode |
String | Classification Code |
ClsValue |
String | Classification Value |
ClsGeoFlag |
String | Geo Flag - Indicates this is geographic data |
ClsGeoUrl |
String | Geo Url - The Url of the Geo resource |
Period
| Name | Type | Description |
|---|---|---|
PrdValue |
String | Product Value |
