Read App Toolbar
After login, the app toolbar can be requested for the authenticated subscriber.
This is usually called when the login authentication API has been successful to return the app toolbar configuration.
Read App Studio Designed App Toolbar
POST AppStudio/ReadAppToolbar
This is a POST method which passes both the API and session keys as headers, and a body. If successful, the app toolbar can be displayed.
Headers
Name
Value
Content-Type
application/json
SiteKey
API Key
DataServicesKey
Session Key
Body
Name
Type
Description
TreeFormat
Boolean
true
Response
{
"Success": true,
"JSON": "base64 encoded string"
}Base64 JSON Decoding
The JSON data is Base64 encoded. You must decode this into a JSON string and convert that into a multi-hierarchical object.
Add Menu
This example shows the add menu on the rendered app toolbar on the top and a matching portion of the multi-hierarchical object returned from the API:
Custom Buttons
This example shows the custom buttons on the rendered app toolbar on the top and a matching portion of the multi-hierarchical object returned from the API:
Here is an example of a full app toolbar.
[
{
"text": "Navigation Bar",
"icon": "fa fa-bars",
"data": {
"Type": "NavBar",
"Locked": true,
"ID": "727fcb55-1677-4947-81b5-d926278fa5d2",
"Name": "Navigation Bar",
"Description": "Toolbar header for the navigation bar",
"Caption": "<strong>TriSys</strong> Flexiva",
"Icon": "fa fa-bars",
"Visible": true,
"ProductLogoImage": "",
"BrandName": "TriSys",
"ProductName": "Flexiva",
"NavBarBottomLogoImage": "images/nav-bar/trisys-flexiva-80hx190w-25percent.png",
"NavBarBottomLogoHeight": 80,
"NavBarBottomLogoWidth": 190,
"NavBarBottomLogoMargin": 5
},
"items": []
},
{
"text": "Search...",
"icon": "gi gi-search",
"data": {
"Type": "SearchBox",
"Locked": true,
"ID": "c7668bef-e618-4154-92af-10d81b20f712",
"Name": "Search Box",
"Description": "Search/lookup text box on toolbar",
"Caption": "Search...",
"Icon": "gi gi-search",
"Visible": true,
"DataSourceRequest": {
"RequestId": "cffda37d-430a-b739-d5c1-80b2ffb276d2",
"Type": "Read"
}
},
"items": []
},
{
"text": "History",
"icon": "gi gi-more_windows",
"data": {
"Type": "HistoryMenu",
"Locked": true,
"ID": "40c12a13-1cdf-4066-a4f8-555ac045ef21",
"Name": "History Menu",
"Description": "Drop down menu of previously opened forms",
"Caption": "History",
"Icon": "gi gi-more_windows",
"Visible": true
},
"items": []
},
{
"text": "Add",
"icon": "gi gi-plus",
"data": {
"Type": "AddMenu",
"Locked": true,
"ID": "5b45d6e8-d39a-4d07-b983-9f0888e84c1c",
"Name": "Add Menu Drop Down",
"Description": "Add a new record drop down menu",
"Caption": "Add",
"Icon": "gi gi-plus",
"Visible": true
},
"items": [
{
"text": "Club",
"icon": "gi gi-building",
"data": {
"Type": "AddMenuItem",
"ID": "ce83a01a-9714-e1ad-0050-a4b3d3d09689",
"Name": "Club",
"Description": "Added by Josie Musto on Friday 16 May 2025",
"Caption": "Club",
"Icon": "gi gi-building",
"Visible": true,
"DataEntryForm": "Club",
"SectionBefore": "Add New Record"
},
"items": []
},
{
"text": "Footballer",
"icon": "gi gi-soccer_ball",
"data": {
"Type": "AddMenuItem",
"ID": "6f26c62d-9a5a-67a5-1b13-db2eb0ad0471",
"Name": "Footballer",
"Description": "Added by Josie Musto on Friday 16 May 2025",
"Caption": "Footballer",
"Icon": "gi gi-soccer_ball",
"Visible": true,
"DataEntryForm": "Footballer"
},
"items": []
},
{
"text": "Nationality",
"icon": "gi gi-globe_af",
"data": {
"Type": "AddMenuItem",
"ID": "3cd5e876-5787-d011-97a7-77f978ac5171",
"Name": "Nationality",
"Description": "Added by Josie Musto on Friday 16 May 2025",
"Caption": "Nationality",
"Icon": "gi gi-globe_af",
"Visible": true,
"DataEntryForm": "Nationality"
},
"items": []
}
]
},
{
"text": "Custom Buttons",
"icon": "gi gi-magic",
"data": {
"Type": "CustomButtons",
"Locked": true,
"ID": "9f4b1423-22a0-44c0-a440-09719743863e",
"Name": "Custom Buttons List",
"Description": "List of custom buttons",
"Caption": "",
"Icon": "",
"Visible": true
},
"items": [
{
"text": "Clubs",
"icon": "gi gi-building",
"data": {
"Type": "CustomButton",
"ID": "8de77019-4ba3-458f-90fd-173042d0ca77",
"Name": "CustomButton1",
"Description": "Test custom button #1",
"Caption": "Clubs",
"Icon": "gi gi-building",
"Visible": true,
"Form": "Clubs",
"Style": "Red",
"Tooltip": "Lookup a football club"
},
"items": []
},
{
"text": "Footballers",
"icon": "gi gi-soccer_ball",
"data": {
"Type": "CustomButton",
"ID": "955f04cd-53fc-486c-9015-45da642028ca",
"Name": "CustomButton2",
"Description": "Test custom button #2",
"Caption": "Footballers",
"Icon": "gi gi-soccer_ball",
"Visible": true,
"Form": "Footballers",
"Style": "Yellow",
"Tooltip": "Lookup a footballer"
},
"items": []
},
{
"text": "Nationalities",
"icon": "gi gi-globe_af",
"data": {
"Type": "CustomButton",
"ID": "83cbb1d8-5538-b38a-d97f-e41f689f2fc9",
"Name": "Nationalities",
"Description": "Added by Josie Musto on Monday 19 May 2025",
"Caption": "Nationalities",
"Icon": "gi gi-globe_af",
"Visible": true,
"Form": "Nationalities",
"Style": "Blue",
"Tooltip": "Lookup a nationality"
},
"items": []
},
{
"text": "Cats",
"icon": "gi gi-certificate",
"data": {
"Type": "CustomButton",
"ID": "888cc48a-6054-c3ad-7733-a13fefd6c3f1",
"Name": "Yaay haway",
"Description": "Added by Josie Musto on Friday 16 May 2025",
"Caption": "Cats",
"Icon": "gi gi-certificate",
"Visible": false,
"Form": "Cats",
"Style": "Green",
"Tooltip": "List all types of cat"
},
"items": []
},
{
"text": "Dogs",
"icon": "gi gi-dog",
"data": {
"Type": "CustomButton",
"ID": "e3805263-adc5-cb24-aad0-e3c9be331572",
"Name": "Dogs",
"Description": "Added by Josie Musto on Monday 19 May 2025",
"Caption": "Dogs",
"Icon": "gi gi-dog",
"Visible": false,
"Form": "Dogs",
"Style": "Grey",
"Tooltip": "List all dog breeds"
},
"items": []
}
]
},
{
"text": "Show Help",
"icon": "gi gi-circle_question_mark",
"data": {
"Type": "ShowHelp",
"Locked": true,
"ID": "b15c0622-0cdc-4e7c-9d22-4554f927fb98",
"Name": "Show Help Button",
"Description": "Show Help Button in Primary theme colour",
"Caption": "Show Help",
"Icon": "gi gi-circle_question_mark",
"Visible": true,
"Style": "Green",
"Tooltip": "Show popup help about the currently displayed form"
},
"items": []
},
{
"text": "Account Summary",
"icon": "gi gi-user",
"data": {
"Type": "AccountSummary",
"Locked": true,
"ID": "043c7522-e6a5-4de6-a957-37bf8fe2ecf8",
"Name": "Account Summary drop down menu",
"Description": "Items in drop down menu for logged in subscriber",
"Caption": "",
"Icon": "gi gi-play_button",
"Visible": true
},
"items": [
{
"text": "Subscriber Name",
"icon": "gi gi-user",
"data": {
"Type": "AccountSummaryItem",
"Locked": true,
"ID": "9c78ddca-ce25-46d4-b098-1c749d5d03f3",
"Name": "Account Summary Subscriber Name",
"Description": "Show logged-in subscriber name",
"Caption": "",
"Icon": "gi gi-play_button",
"Visible": true
},
"items": []
},
{
"text": "Subscriber Company",
"icon": "gi gi-building",
"data": {
"Type": "AccountSummaryItem",
"Locked": true,
"ID": "d27434e0-2a5d-4b2d-a3f5-79a63e4e9182",
"Name": "Account Summary Subscriber Company",
"Description": "Show logged-in subscriber company",
"Caption": "",
"Icon": "gi gi-building",
"Visible": true
},
"items": []
},
{
"text": "Profile/User Settings",
"icon": "gi gi-nameplate",
"data": {
"Type": "AccountSummaryItem",
"Locked": true,
"ID": "6aca51f3-c2cb-41f3-ae35-005550b901ed",
"Name": "Profile/User Settings",
"Description": "Show subscriber settings",
"Caption": "Profile/User Settings",
"Icon": "gi gi-nameplate",
"Visible": true
},
"items": []
},
{
"text": "Lock Account",
"icon": "fa fa-lock",
"data": {
"Type": "AccountSummaryItem",
"Locked": true,
"ID": "4df40642-ed9b-4743-9fef-d89091fd036f",
"Name": "Lock Account",
"Description": "Lock application",
"Caption": "Lock Account",
"Icon": "fa fa-lock",
"Visible": true
},
"items": []
},
{
"text": "Logout",
"icon": "fa fa-ban",
"data": {
"Type": "AccountSummaryItem",
"Locked": true,
"ID": "1728cf85-48eb-473c-80e5-ef7c7bb7338a",
"Name": "Logout",
"Description": "Logout of application",
"Caption": "Logout",
"Icon": "fa fa-ban",
"Visible": true
},
"items": []
},
{
"text": "Activity Metrics",
"icon": "gi gi-charts",
"data": {
"Type": "AccountSummaryItem",
"Locked": true,
"ID": "c2fa5506-38aa-4d9a-bbf1-92b2e0935149",
"Name": "Activity Metrics",
"Description": "Activity metrics shown",
"Caption": "",
"Icon": "gi gi-charts",
"Visible": true
},
"items": []
}
]
}
]Last updated