API Query

Create.

Creates a widget query snippet for a specific user.

Authentication: Windows, Firebase

Privilege : Administrator , Moderator , Power User

Method: PxStat.Subscription.Query_API.Create

Parameters:

Name	Type	Description
`Uid`	String	Firebase User UID*
`AccessToken`	String	Firebase access token*
`TagName`	String	Tag name for widget query**
`Matrix`	String	Matrix name
`Snippet`	Object	Snippet object Note: Query field is the widget query in Base64

*Parameter is not needed for Windows authentication ** The TagName has to be unique for every widget query a subscriber wants to save

Example of Snippet object:

{
   "Snippet":{
      "Type":"table",
      "Query":"eyIgYXV0b3VwZGF0ZSAiOnRydWUsIiBmbHVpZFRpbWUgIjpbMl0sIiBjb3B5cmlnaHQgIjp0cnVlLCIgdGl0bGUgIjp0cnVlLCIgbGluayAiOiIgaHR0cHM6IC8vZGV2LWRhdGEuY3NvLmllL3RhYmxlL0xSVzA3IiwicGl2b3QiOm51bGwsInJlbW92ZVJlZHVuZGFudENvbHVtbnMiOmZhbHNlLCJpbnRlcm5hdGlvbmFsaXNhdGlvbiI6eyJ1bml0IjoiVW5pdCIsInZhbHVlIjoiVmFsdWUifSwiZGVmYXVsdENvbnRlbnQiOiIuLiIsImRhdGEiOnsiYXBpIjp7InF1ZXJ5Ijp7InVybCI6Imh0dHBzOi8vZGV2LXdzLmNzby5pZS9wdWJsaWMvYXBpLmpzb25ycGMiLCJkYXRhIjp7Impzb25ycGMiOiIyLjAiLCJtZXRob2QiOiJQeFN0YXQuRGF0YS5DdWJlX0FQSS5SZWFkRGF0YXNldCIsInBhcmFtcyI6eyJjbGFzcyI6InF1ZXJ5IiwiaWQiOlsiVExJU1QoVzEpIiwiQzAyNjY1VjAzMjI1Il0sImRpbWVuc2lvbiI6eyJUTElTVChXMSkiOnsiY2F0ZWdvcnkiOnsiaW5kZXgiOlsiMjAyMVcxNSJdfX0sIkMwMjY2NVYwMzIyNSI6eyJjYXRlZ29yeSI6eyJpbmRleCI6WyItIl19fX0sImV4dGVuc2lvbiI6eyJwaXZvdCI6bnVsbCwiY29kZXMiOmZhbHNlLCJsYW5ndWFnZSI6eyJjb2RlIjoiZW4ifSwiZm9ybWF0Ijp7InR5cGUiOiJKU09OLXN0YXQiLCJ2ZXJzaW9uIjoiMi4wIn0sIm1hdHJpeCI6IkxSVzA3In0sInZlcnNpb24iOiIyLjAifX19LCJyZXNwb25zZSI6e319fSwibWV0YWRhdGEiOnsiYXBpIjp7InF1ZXJ5Ijp7InVybCI6Imh0dHBzOi8vZGV2LXdzLmNzby5pZS9wdWJsaWMvYXBpLmpzb25ycGMiLCJkYXRhIjp7Impzb25ycGMiOiIyLjAiLCJtZXRob2QiOiJQeFN0YXQuRGF0YS5DdWJlX0FQSS5SZWFkTWV0YWRhdGEiLCJwYXJhbXMiOnsibWF0cml4IjoiTFJXMDciLCJsYW5ndWFnZSI6ImVuIiwiZm9ybWF0Ijp7InR5cGUiOiJKU09OLXN0YXQiLCJ2ZXJzaW9uIjoiMi4wIn19LCJ2ZXJzaW9uIjoiMi4wIn19LCJyZXNwb25zZSI6e319fSwib3B0aW9ucyI6eyJsYW5ndWFnZSI6eyJkZWNpbWFsIjoiLiIsImVtcHR5VGFibGUiOiJObyBkYXRhIGF2YWlsYWJsZSBpbiB0YWJsZSIsImluZm8iOiJTaG93aW5nIF9TVEFSVF8gdG8gX0VORF8gb2YgX1RPVEFMXyBlbnRyaWVzIiwiaW5mb0VtcHR5IjoiU2hvd2luZyAwIHRvIDAgb2YgMCBlbnRyaWVzIiwiaW5mb0ZpbHRlcmVkIjoiKGZpbHRlcmVkIGZyb20gX01BWF8gdG90YWwgZW50cmllcykiLCJpbmZvUG9zdEZpeCI6IiIsInRob3VzYW5kcyI6IiwiLCJsZW5ndGhNZW51IjoiU2hvdyBfTUVOVV8gZW50cmllcyIsImxvYWRpbmdSZWNvcmRzIjoiTG9hZGluZy4uLiIsInByb2Nlc3NpbmciOiJQcm9jZXNzaW5nLi4uIiwic2VhcmNoIjoiU2VhcmNoOiIsInplcm9SZWNvcmRzIjoiTm8gbWF0Y2hpbmcgcmVjb3JkcyBmb3VuZCIsInBhZ2luYXRlIjp7ImZpcnN0IjoiRmlyc3QiLCJsYXN0IjoiTGFzdCIsIm5leHQiOiJOZXh0IiwicHJldmlvdXMiOiJQcmV2aW91cyJ9LCJhcmlhIjp7InNvcnRBc2NlbmRpbmciOiI6IGFjdGl2YXRlIHRvIHNvcnQgY29sdW1uIGFzY2VuZGluZyIsInNvcnREZXNjZW5kaW5nIjoiOiBhY3RpdmF0ZSB0byBzb3J0IGNvbHVtbiBkZXNjZW5kaW5nIn19LCJzZWFyY2giOnsic2VhcmNoIjoiIn0sImRvbSI6IkJmbHRpcCIsInNjcm9sbFgiOmZhbHNlLCJyZXNwb25zaXZlIjp0cnVlLCJidXR0b25zIjpbeyJleHRlbmQiOiJjc3YiLCJ0ZXh0IjoiRG93bmxvYWQgQ1NWIiwiY2xhc3NOYW1lIjoiZXhwb3J0LWJ1dHRvbiIsInRpdGxlIjoiTFJXMDcuMjAyMjAxMDRUMTQwMTQ5In0seyJleHRlbmQiOiJwcmludCIsInRleHQiOiJQcmludCIsImNsYXNzTmFtZSI6ImV4cG9ydC1idXR0b24ifV0sIm9yZGVyIjpbWzAsImFzYyJdXSwib3B0aW9ucyI6e319fQ==",
      "Isogram":"https://dev-data.cso.ie/roched/4.0.0/widget/js/isogram.js",
      "FluidTime":false
   }
}

Return: String with value of success

Read.

Returns a snippet corresponding to a UserQueryId from a specific user.

Authentication: Windows, Firebase

Privilege : Administrator , Moderator , Power User

Method: PxStat.Subscription.Query_API.Create

Parameters:

Name	Type	Description
`Uid`	String	Firebase User UID*
`AccessToken`	String	Firebase access token*
`UserQueryId`	String	The User Query ID

*Parameter is not needed for Windows authentication

Example of Return object:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "Id": 4,
            "TagName": "testMonday",
            "Matrix": "LRW07",
            "SnippetType": "table",
            "SnippetQueryBase64": "eyIgYXV0b3VwZGF0ZSAiOnRydWUsIiBmbHVpZFRpbWUgIjpbMl0sIiBjb3B5cmlnaHQgIjp0cnVlLCIgdGl0bGUgIjp0cnVlLCIgbGluayAiOiIgaHR0cHM6IC8vZGV2LWRhdGEuY3NvLmllL3RhYmxlL0xSVzA3IiwicGl2b3QiOm51bGwsInJlbW92ZVJlZHVuZGFudENvbHVtbnMiOmZhbHNlLCJpbnRlcm5hdGlvbmFsaXNhdGlvbiI6eyJ1bml0IjoiVW5pdCIsInZhbHVlIjoiVmFsdWUifSwiZGVmYXVsdENvbnRlbnQiOiIuLiIsImRhdGEiOnsiYXBpIjp7InF1ZXJ5Ijp7InVybCI6Imh0dHBzOi8vZGV2LXdzLmNzby5pZS9wdWJsaWMvYXBpLmpzb25ycGMiLCJkYXRhIjp7Impzb25ycGMiOiIyLjAiLCJtZXRob2QiOiJQeFN0YXQuRGF0YS5DdWJlX0FQSS5SZWFkRGF0YXNldCIsInBhcmFtcyI6eyJjbGFzcyI6InF1ZXJ5IiwiaWQiOlsiVExJU1QoVzEpIiwiQzAyNjY1VjAzMjI1Il0sImRpbWVuc2lvbiI6eyJUTElTVChXMSkiOnsiY2F0ZWdvcnkiOnsiaW5kZXgiOlsiMjAyMVcxNSJdfX0sIkMwMjY2NVYwMzIyNSI6eyJjYXRlZ29yeSI6eyJpbmRleCI6WyItIl19fX0sImV4dGVuc2lvbiI6eyJwaXZvdCI6bnVsbCwiY29kZXMiOmZhbHNlLCJsYW5ndWFnZSI6eyJjb2RlIjoiZW4ifSwiZm9ybWF0Ijp7InR5cGUiOiJKU09OLXN0YXQiLCJ2ZXJzaW9uIjoiMi4wIn0sIm1hdHJpeCI6IkxSVzA3In0sInZlcnNpb24iOiIyLjAifX19LCJyZXNwb25zZSI6e319fSwibWV0YWRhdGEiOnsiYXBpIjp7InF1ZXJ5Ijp7InVybCI6Imh0dHBzOi8vZGV2LXdzLmNzby5pZS9wdWJsaWMvYXBpLmpzb25ycGMiLCJkYXRhIjp7Impzb25ycGMiOiIyLjAiLCJtZXRob2QiOiJQeFN0YXQuRGF0YS5DdWJlX0FQSS5SZWFkTWV0YWRhdGEiLCJwYXJhbXMiOnsibWF0cml4IjoiTFJXMDciLCJsYW5ndWFnZSI6ImVuIiwiZm9ybWF0Ijp7InR5cGUiOiJKU09OLXN0YXQiLCJ2ZXJzaW9uIjoiMi4wIn19LCJ2ZXJzaW9uIjoiMi4wIn19LCJyZXNwb25zZSI6e319fSwib3B0aW9ucyI6eyJsYW5ndWFnZSI6eyJkZWNpbWFsIjoiLiIsImVtcHR5VGFibGUiOiJObyBkYXRhIGF2YWlsYWJsZSBpbiB0YWJsZSIsImluZm8iOiJTaG93aW5nIF9TVEFSVF8gdG8gX0VORF8gb2YgX1RPVEFMXyBlbnRyaWVzIiwiaW5mb0VtcHR5IjoiU2hvd2luZyAwIHRvIDAgb2YgMCBlbnRyaWVzIiwiaW5mb0ZpbHRlcmVkIjoiKGZpbHRlcmVkIGZyb20gX01BWF8gdG90YWwgZW50cmllcykiLCJpbmZvUG9zdEZpeCI6IiIsInRob3VzYW5kcyI6IiwiLCJsZW5ndGhNZW51IjoiU2hvdyBfTUVOVV8gZW50cmllcyIsImxvYWRpbmdSZWNvcmRzIjoiTG9hZGluZy4uLiIsInByb2Nlc3NpbmciOiJQcm9jZXNzaW5nLi4uIiwic2VhcmNoIjoiU2VhcmNoOiIsInplcm9SZWNvcmRzIjoiTm8gbWF0Y2hpbmcgcmVjb3JkcyBmb3VuZCIsInBhZ2luYXRlIjp7ImZpcnN0IjoiRmlyc3QiLCJsYXN0IjoiTGFzdCIsIm5leHQiOiJOZXh0IiwicHJldmlvdXMiOiJQcmV2aW91cyJ9LCJhcmlhIjp7InNvcnRBc2NlbmRpbmciOiI6IGFjdGl2YXRlIHRvIHNvcnQgY29sdW1uIGFzY2VuZGluZyIsInNvcnREZXNjZW5kaW5nIjoiOiBhY3RpdmF0ZSB0byBzb3J0IGNvbHVtbiBkZXNjZW5kaW5nIn19LCJzZWFyY2giOnsic2VhcmNoIjoiIn0sImRvbSI6IkJmbHRpcCIsInNjcm9sbFgiOmZhbHNlLCJyZXNwb25zaXZlIjp0cnVlLCJidXR0b25zIjpbeyJleHRlbmQiOiJjc3YiLCJ0ZXh0IjoiRG93bmxvYWQgQ1NWIiwiY2xhc3NOYW1lIjoiZXhwb3J0LWJ1dHRvbiIsInRpdGxlIjoiTFJXMDcuMjAyMjAxMDRUMTQwMTQ5In0seyJleHRlbmQiOiJwcmludCIsInRleHQiOiJQcmludCIsImNsYXNzTmFtZSI6ImV4cG9ydC1idXR0b24ifV0sIm9yZGVyIjpbWzAsImFzYyJdXSwib3B0aW9ucyI6e319fQ==",
            "FluidTime": false,
            "SnippetIsogram": "https://dev-data.cso.ie/roched/4.0.0/widget/js/isogram.js"
        }
    ],
    "id": 123
}

Read All.

Returns a subset of all the snippets corresponding to a specific user.

Authentication: Windows, Firebase

Privilege : Administrator , Moderator , Power User

Method: PxStat.Subscription.Query_API.Create

Parameters:

Name	Type	Default	Description
`Uid`	String		Firebase User UID*
`AccessToken`	String		Firebase access token*

*Parameter is not needed for Windows authentication

Example of Return object:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "Id": 4,
            "TagName": "testMonday",
            "Matrix": "LRW07",
            "SnippetType": "table",
            "FluidTime": false
        }
    ],
    "id": null
}