API Subscription Subscription
Home / API / Subscription
Read all of the available subscriptions to tables. If a TsbTable value is included then all subscriptions for that table will be returned, otherwise all subscriptions to all tables will be returned.
Authentication: Windows
Privilege : PowerUser,Moderator
Method: PxStat.Subscription.Subscription_API.TableSubscriptionRead
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
TsbTable |
String | optional | Table code, e.g. MTR01 |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
TsbTable |
String | Table code, e.g. MTR01 |
MtrTitle |
String | Title of the table, read from the last release version |
CcnUsername |
String | AD username if this is an Active Directory user |
SbrUserId |
String | Firebase user identifier (uid) if this is a firebase user |
CcnEmail |
String | User's email address |
LngIsoCode |
String | Langugage ISO 639-1 Code as preferred by the user |
RlsLiveDatetimeFrom |
String | Release date of the latest release of this table |
RlsExceptionalFlag |
String | Flag to indicate if the latest release of this table was an Exceptional release |
Reads table subscriptions for the current user
Authentication: Windows for AD User, Firebase for Subscriber
Privilege : None
Method: PxStat.Subscription.Subscription_API.TableReadCurrent
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
Uid |
String | required for Firebase user | Firebase identifier. This will be read from Firebase during login |
AccessToken |
String | required for Firebase user | This will be issued by Firebase during login and has a lifetime of one hour |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
TsbTable |
String | Table code, e.g. MTR01 |
MtrTitle |
String | Title of the table, read from the last release version |
RlsLiveDatetimeFrom |
String | Release date of the latest release of this table |
RlsExceptionalFlag |
String | Flag to indicate if the latest release of this table was an Exceptional release |
Creates a new subscription to a table
Authentication: Firebase, Windows
Privilege : None
Method: PxStat.Subscription.Subscription_API.TableSubscriptionCreate
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
TsbTable |
String | Table code, e.g. MTR01 | |
Uid |
String | required for Firebase user | Firebase identifier. This will be read from Firebase during login |
AccessToken |
String | required for Firebase user | This will be issued by Firebase during login and has a lifetime of one hour |
Return: success or error
Deletes a subscription to a table
Authentication: Firebase, Windows
Privilege : None
Method: PxStat.Subscription.Subscription_API.TableSubscriptionDelete
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
TsbTable |
String | Table code, e.g. MTR01 | |
Uid |
String | required for Firebase user | Firebase identifier. This will be read from Firebase during login |
AccessToken |
String | required for Firebase user | This will be issued by Firebase during login and has a lifetime of one hour |
Return: success or error
Read all of the available subscriptions to channels. If a ChnCode value is included then all subscriptions for that channel will be returned, otherwise all subscriptions to all channels will be returned.
Authentication: Windows
Privilege : PowerUser,Moderator
Method: PxStat.Subscription.Subscription_API.ChannelSubscriptionRead
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
ChnCode |
String | optional | Channel code, e.g. TECHNICAL |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
ChnCode |
String | Channel code, e.g. TECHNICAL |
ChnName |
String | Channel name, e.g. Technical |
CcnUsername |
String | Username if this is an Active Directory or Local user |
SbrUserId |
String | UID if this is a Firebase user |
CcnEmail |
String | User's email |
LngIsoCode |
String | Langugage ISO 639-1 Code as preferred by the user |
Reads channel subscriptions for the current user
Authentication: Windows for AD User, Firebase for Subscriber
Privilege : None
Method: PxStat.Subscription.Subscription_API.ChannelSubscriptionReadCurrent
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
Uid |
String | required for Firebase user | Firebase identifier. This will be read from Firebase during login |
AccessToken |
String | required for Firebase user | This will be issued by Firebase during login and has a lifetime of one hour |
Return: Array [ Object ]
| Name | Type | Description |
|---|---|---|
ChnCode |
String | Channel code, e.g. TECHNICAL |
ChnName |
String | Channel name, e.g. Technical |
Creates a new subscription to a channel
Authentication: Firebase, Windows
Privilege : None
Method: PxStat.Subscription.Subscription_API.ChannelSubscriptionCreate
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
ChnCode |
String | required | Channel code, e.g. TECHNICAL |
Uid |
String | required for Firebase user | Firebase identifier. This will be read from Firebase during login |
AccessToken |
String | required for Firebase user | This will be issued by Firebase during login and has a lifetime of one hour |
Return: success or error
Deletes a subscription to a channel
Authentication: Firebase, Windows
Privilege : None
Method: PxStat.Subscription.Subscription_API.ChannelSubscriptionDelete
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
ChnCode |
String | required | Channel code, e.g. TECHNICAL |
Uid |
String | required for Firebase user | Firebase identifier. This will be read from Firebase during login |
AccessToken |
String | required for Firebase user | This will be issued by Firebase during login and has a lifetime of one hour |
