Read Navigation Bar
After login, the navigation bar can be requested for the authenticated subscriber.
This is usually called when the login authentication API has been successful to return the navigation bar configuration.
When an end-user opens a form, it is this navigation bar data which determines whether the form exists, and then the form design can be read and rendered using this API call.
Read App Studio Designed Navigation Bar
POST AppStudio/ReadNavigationBar
This is a POST method which passes both the API and session keys as headers, and a body. If successful, the navigation bar 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.
This example shows the rendered navigation bar on the left and the top portion of the multi-hierarchical object returned from the API.
Here is an example of a full navigation bar.
[
{
"id": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
"text": "Navigation Bar Menu",
"expanded": true,
"hasChildren": true,
"icon": null,
"items": [
{
"id": "8f566550-65a7-6a50-686a-9505b862af6b",
"text": "Step by Step",
"expanded": true,
"hasChildren": true,
"icon": "gi gi-keys",
"navItem": {
"ID": "navBar-Step1",
"Caption": "Step by Step",
"ImagePath": "gi gi-keys",
"Open": true,
"Visible": true
},
"items": [
{
"id": "b93f133e-8168-910e-891b-0b628bf01f07",
"text": "Step 1",
"hasChildren": true,
"icon": "gi gi-lightbulb",
"formPage": {
"FormName": "AANew",
"EntityName": "",
"ImagePath": "gi gi-lightbulb",
"Caption": "Step 1",
"ViewName": "AANew.json",
"Visible": true
},
"navItem": {
"ID": "navBar-Step1",
"Caption": "Step 1",
"ImagePath": "gi gi-keys",
"Open": true,
"Visible": true
},
"items": []
}
]
},
{
"id": "3c4b5a69-d8e7-f691-a2b3-c4d5e6f7a8b9",
"text": "Football Industry",
"expanded": false,
"hasChildren": true,
"icon": "gi gi-global",
"navItem": {
"ID": "navBar-FootballIndustry",
"Caption": "Football Industry",
"ImagePath": "gi gi-global",
"Open": true,
"Visible": true
},
"items": [
{
"id": "8f7e6d5c-4b3a-2918-7654-321098765432",
"text": "Clubs/Teams",
"hasChildren": false,
"icon": "gi gi-bank",
"formPage": {
"FormName": "Clubs",
"EntityName": "",
"ImagePath": "gi gi-bank",
"Caption": "Clubs/Teams",
"ViewName": "Clubs.json",
"Visible": true
},
"navItem": {
"ID": "navBar-FootballIndustry",
"Caption": "Football Industry",
"ImagePath": "gi gi-global",
"Open": true,
"Visible": true
},
"items": []
},
{
"id": "2d3e4f5a-6b7c-8901-2345-6789abcdefgh",
"text": "Club/Team",
"hasChildren": false,
"icon": "gi gi-bank",
"formPage": {
"FormName": "Club",
"EntityName": "",
"ImagePath": "gi gi-bank",
"Caption": "Club/Team",
"ViewName": "Club.json",
"Visible": false,
"EntityForm": true,
"RecordId": 0
},
"navItem": {
"ID": "navBar-FootballIndustry",
"Caption": "Football Industry",
"ImagePath": "gi gi-global",
"Open": true,
"Visible": true
},
"items": []
},
{
"id": "7a8b9c0d-1e2f-3456-7890-abcdef123456",
"text": "Footballers",
"hasChildren": false,
"icon": "gi gi-soccer_ball",
"formPage": {
"FormName": "Footballers",
"EntityName": "",
"ImagePath": "gi gi-soccer_ball",
"Caption": "Footballers",
"ViewName": "Footballers.json",
"Visible": true
},
"navItem": {
"ID": "navBar-FootballIndustry",
"Caption": "Football Industry",
"ImagePath": "gi gi-global",
"Open": true,
"Visible": true
},
"items": []
},
{
"id": "b5c6d7e8-f9a0-1234-5678-90abcdef1234",
"text": "Footballer",
"hasChildren": false,
"icon": "gi gi-soccer_ball",
"formPage": {
"FormName": "Footballer",
"EntityName": "",
"ImagePath": "gi gi-soccer_ball",
"Caption": "Footballer",
"ViewName": "Footballer.json",
"Visible": false,
"EntityForm": true
},
"navItem": {
"ID": "navBar-FootballIndustry",
"Caption": "Football Industry",
"ImagePath": "gi gi-global",
"Open": true,
"Visible": true
},
"items": []
},
{
"id": "4d5e6f7a-8b9c-0123-4567-89abcdef0123",
"text": "Nationalities",
"hasChildren": false,
"icon": "gi gi-globe_af",
"formPage": {
"FormName": "Nationalities",
"EntityName": "",
"ImagePath": "gi gi-globe_af",
"Caption": "Nationalities",
"ViewName": "Nationalities.json",
"Visible": true
},
"navItem": {
"ID": "navBar-FootballIndustry",
"Caption": "Football Industry",
"ImagePath": "gi gi-global",
"Open": true,
"Visible": true
},
"items": []
},
{
"id": "9e8f7a6b-5c4d-3e2f-1a0b-9c8d7e6f5a4b",
"text": "Nationality",
"hasChildren": false,
"icon": "gi gi-globe_af",
"formPage": {
"FormName": "Nationality",
"EntityName": "",
"ImagePath": "gi gi-globe_af",
"Caption": "Nationality",
"ViewName": "Nationality.json",
"Visible": false,
"EntityForm": true
},
"navItem": {
"ID": "navBar-FootballIndustry",
"Caption": "Football Industry",
"ImagePath": "gi gi-global",
"Open": true,
"Visible": true
},
"items": []
}
]
},
{
"id": "69479713-c93b-6098-b529-502a7153301a",
"text": "Miscellaneous",
"expanded": false,
"hasChildren": true,
"icon": "gi gi-picture",
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-picture",
"Visible": true
},
"items": [
{
"id": "d464aee6-8083-4bb1-d8ad-3718a48913f9",
"text": "Astronomy",
"hasChildren": true,
"icon": "gi gi-star",
"formPage": {
"FormName": "Astronomy",
"EntityName": "",
"ImagePath": "gi gi-star",
"Caption": "Astronomy",
"ViewName": "Astronomy.json",
"Visible": true
},
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-warning_sign"
},
"items": []
},
{
"id": "ff21b0ef-7dda-e4f8-d2c6-2ca03359d138",
"text": "Fashion Brands",
"hasChildren": true,
"icon": "gi gi-ring",
"formPage": {
"FormName": "Fashion",
"EntityName": "",
"ImagePath": "gi gi-ring",
"Caption": "Fashion Brands",
"ViewName": "Fashion.json",
"Visible": true
},
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-picture",
"Visible": true
},
"items": []
},
{
"id": "fd28b568-860d-033c-a0a9-59b79abd6378",
"text": "Footballers Pagination",
"hasChildren": true,
"icon": "gi gi-soccer_ball",
"formPage": {
"FormName": "FootballersGridPaginationTest",
"EntityName": "",
"ImagePath": "gi gi-soccer_ball",
"Caption": "Footballers Pagination",
"ViewName": "FootballersGridPaginationTest.json",
"Visible": true
},
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-picture",
"Visible": true
},
"items": []
},
{
"id": "97831c64-ebef-327b-ad0d-bda264885044",
"text": "Music Tracks",
"hasChildren": true,
"icon": "gi gi-music",
"formPage": {
"FormName": "Music",
"EntityName": "",
"ImagePath": "gi gi-music",
"Caption": "Music Tracks",
"ViewName": "Music.json",
"Visible": true
},
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-picture",
"Visible": true
},
"items": []
},
{
"id": "38a750ce-c446-32fe-eb2e-042f457ad2d4",
"text": "Real Estate",
"hasChildren": true,
"icon": "gi gi-home",
"formPage": {
"FormName": "RealEstate",
"EntityName": "",
"ImagePath": "gi gi-home",
"Caption": "Real Estate",
"ViewName": "RealEstate.json",
"Visible": true
},
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-picture",
"Visible": true
},
"items": []
},
{
"id": "8e27b9b6-f749-ea6d-b853-cf8228e0d4cf",
"text": "Real Estate Property",
"hasChildren": true,
"icon": "gi gi-home",
"formPage": {
"FormName": "RealEstateProperty",
"EntityName": "",
"ImagePath": "gi gi-home",
"Caption": "Real Estate Property",
"ViewName": "RealEstateProperty.json",
"Visible": true,
"EntityForm": true
},
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-picture",
"Visible": true
},
"items": []
},
{
"id": "68b42ab3-c837-cafb-e393-dc868548f55d",
"text": "Wines",
"hasChildren": true,
"icon": "gi gi-glass",
"formPage": {
"FormName": "Wines",
"EntityName": "",
"ImagePath": "gi gi-glass",
"Caption": "Wines",
"ViewName": "Wines.json",
"Visible": true
},
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-picture",
"Visible": true
},
"items": []
},
{
"id": "bcc76368-7b73-a59e-cb37-641983a8fe67",
"text": "Selected Wine",
"hasChildren": true,
"icon": "gi gi-glass",
"formPage": {
"FormName": "Wine",
"EntityName": "",
"ImagePath": "gi gi-glass",
"Caption": "Selected Wine",
"ViewName": "Wine.json",
"Visible": false,
"EntityForm": true
},
"navItem": {
"ID": "navBar-Miscellaneous",
"Caption": "Miscellaneous",
"ImagePath": "gi gi-picture",
"Visible": true
},
"items": []
}
]
},
{
"id": "1a2b3c4d-5e6f-7890-abcd-ef1234567890",
"text": "Administration",
"expanded": false,
"hasChildren": true,
"icon": "gi gi-cogwheel",
"navItem": {
"ID": "navBar-SystemAdministration",
"Caption": "Administration",
"ImagePath": "gi gi-cogwheel",
"Open": false,
"Visible": true,
"Locked": true
},
"items": [
{
"id": "3b4a5968-7e0f-1d2c-3b4a-596807ef1d2c",
"text": "App Studio",
"hasChildren": false,
"icon": "gi gi-magic",
"formPage": {
"FormName": "AppStudioHome",
"EntityName": "",
"ImagePath": "gi gi-magic",
"Caption": "App Studio",
"ViewName": "AppStudioHome.html",
"Visible": true,
"DesignerOnly": true
},
"navItem": {
"ID": "navBar-SystemAdministration",
"Caption": "Administration",
"ImagePath": "gi gi-cogwheel",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "e3f4a5b6-c7d8-9012-3456-789abcdef012",
"text": "User Options",
"hasChildren": false,
"icon": "fa fa-user",
"formPage": {
"FormName": "UserOptions",
"EntityName": null,
"ImagePath": "fa fa-user",
"Caption": "User Options",
"ViewName": "UserOptions.html",
"Visible": true,
"Locked": true
},
"navItem": {
"ID": "navBar-SystemAdministration",
"Caption": "Administration",
"ImagePath": "gi gi-cogwheel",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
}
]
},
{
"id": "8c9d0e1f-2a3b-4c5d-6e7f-8a9b0c1d2e3f",
"text": "Help",
"expanded": false,
"hasChildren": true,
"icon": "gi gi-book",
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": [
{
"id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e",
"text": "About",
"hasChildren": false,
"icon": "gi gi-circle_info",
"formPage": {
"FormName": "About",
"EntityName": null,
"ImagePath": "gi gi-circle_info",
"Caption": "About",
"ViewName": null,
"Function": "TriSysApex.Forms.AboutTriSys",
"Visible": true,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "f2a3b4c5-d6e7-f8a9-b0c1-d2e3f4a5b6c7",
"text": "Welcome",
"hasChildren": false,
"icon": "gi gi-home",
"formPage": {
"FormName": "Welcome",
"EntityName": null,
"ImagePath": "gi gi-home",
"ViewName": "Welcome.html",
"Caption": "Welcome",
"Visible": false,
"Locked": true,
"RecordId": 0
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "a7b8c9d0-e1f2-a3b4-c5d6-e7f8a9b0c1d2",
"text": "Quick Start",
"hasChildren": false,
"icon": "gi gi-circle_question_mark",
"formPage": {
"FormName": "QuickStart",
"EntityName": null,
"ImagePath": "gi gi-circle_question_mark",
"Caption": "Quick Start",
"ViewName": "QuickStart.html",
"Visible": false,
"Phone": false,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "3e4f5a6b-7c8d-9e0f-1a2b-3c4d5e6f7a8b",
"text": "User Guide",
"hasChildren": false,
"icon": "fa fa-book",
"formPage": {
"FormName": "UserGuide",
"EntityName": null,
"ImagePath": "fa fa-book",
"Caption": "User Guide",
"ViewName": "UserGuide.html",
"Visible": false,
"Phone": false,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "d9c8b7a6-5f4e-3d2c-1b0a-9f8e7d6c5b4a",
"text": "Welcome Wizard",
"hasChildren": false,
"icon": "gi gi-magic",
"formPage": {
"FormName": "WelcomeWizard",
"EntityName": null,
"ImagePath": "gi gi-magic",
"Caption": "Welcome Wizard",
"ViewName": "WelcomeWizard.html",
"Function": "TriSysApex.ModalDialogue.WelcomeWizard.Show",
"Visible": false,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "7f8a9b0c-1d2e-3f4a-5b6c-7d8e9f0a1b2c",
"text": "Application",
"hasChildren": false,
"icon": "gi gi-circle_question_mark",
"formPage": {
"FormName": "Application",
"EntityName": null,
"ImagePath": "gi gi-circle_question_mark",
"Caption": "Application",
"ViewName": "ApplicationHelp.html",
"Visible": false,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "c2d3e4f5-a6b7-c8d9-e0f1-a2b3c4d5e6f7",
"text": "Terms & Conditions",
"hasChildren": false,
"icon": "gi gi-more_items",
"formPage": {
"FormName": "TermsAndConditions",
"EntityName": null,
"ImagePath": "gi gi-more_items",
"Caption": "Terms & Conditions",
"ViewName": null,
"Function": "TriSysApex.ModalDialogue.TermsAndConditions.Show",
"Visible": true,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "8a9b0c1d-2e3f-4a5b-6c7d-8e9f0a1b2c3d",
"text": "Lock",
"hasChildren": false,
"icon": "gi gi-lock",
"formPage": {
"FormName": "Lock",
"EntityName": null,
"ImagePath": "gi gi-lock",
"Caption": "Lock",
"ViewName": "Lock.html",
"ShowWhenLoggedIn": true,
"LoadRecord": "TriSysApex.Forms.Lock.Initialise",
"Visible": false,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "4c5d6e7f-8a9b-0c1d-2e3f-4a5b6c7d8e9f",
"text": "Logoff",
"hasChildren": false,
"icon": "gi gi-exit",
"formPage": {
"FormName": "Logoff",
"EntityName": null,
"ImagePath": "gi gi-exit",
"Caption": "Logoff",
"ViewName": "Logoff.html",
"Function": "TriSysApex.LoginCredentials.LogoffWithPrompt",
"Visible": false,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "9f0e1d2c-3b4a-5968-7e0f-1d2c3b4a5968",
"text": "Contact Us",
"hasChildren": false,
"icon": "fa fa-pencil-square-o",
"formPage": {
"FormName": "ContactUs",
"EntityName": null,
"ImagePath": "fa fa-pencil-square-o",
"Caption": "Contact Us",
"ViewName": "ContactUs.html",
"ShowWhenLoggedIn": true,
"Visible": true,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
},
{
"id": "2a1b0c9d-8e7f-6a5b-4c3d-2e1f0a9b8c7d",
"text": "Support Portal",
"hasChildren": false,
"icon": "fa fa-support",
"formPage": {
"FormName": "SupportPortal",
"EntityName": null,
"ImagePath": "fa fa-support",
"Caption": "Support Portal",
"ShowWhenLoggedIn": true,
"Function": "TriSysApex.Forms.SupportPortal",
"Visible": true,
"Locked": true
},
"navItem": {
"ID": "navBar-Help",
"Caption": "Help",
"ImagePath": "gi gi-book",
"Open": false,
"Visible": true,
"Locked": true
},
"items": []
}
]
}
]
}
]Last updated