SPICE Product Docs
SPICE 2.0 Docs
SPICE 2.0 Docs
  • Overview
    • 📒What is SPICE?
    • ✨SPICE App Workflows
      • Household Registration
      • Assessment
      • Follow-up
      • My Patients
      • Medical Review
      • Pharmacy
    • 👩‍⚕️SPICE Users
    • 🏢Admin Workflows
      • Admin Portal
    • 🔏Data Privacy & Security
      • Privacy Policy
      • Terms & Conditions of Use
    • ❓Frequently Asked Questions (FAQs)
  • Engineering
    • 🖥️Architecture
      • C4 Diagrams
      • Architecture Diagram
    • 🔧Technology Stack
    • 👨‍💻API Documentation
      • Common Services
        • Login
        • Reset Password
        • Logout
        • Verify Set Password
        • User Profile Update
        • Set Password for new User
        • Validate Phone Number
        • Get User Details
        • Change Password for Users
        • Forgot Password
        • Validate User Email
        • Get User Profile
      • Admin Services
        • Lab Test Customization
          • Lab Test Update
          • Lab Test List
          • Lab Test by Name
          • Lab Test Delete
          • Lab Test Create
          • Lab Test Validate
        • Medication
          • Medication List
          • Medication Create
          • Medication Update
          • Medication Remove
          • Medication Validate
        • User
          • User Validate
          • User List
          • User Remove
          • User Create and Update
        • Get Menu
        • Country List
        • Health Facility
          • Health Facility Update
          • Health Facility List
          • Health Facility Create
          • Health Facility Details
        • Region
          • Get Region Detail
          • Region Upload
          • Region Download
      • SPICE Service
        • Patient Search
        • Household Create
        • Patient List
        • Member Create
        • Offline Sync
          • Offline Household Create
          • Offline Member Create
        • Medical Review
          • ANC Pregnancy Create
          • ANC Pregnancy Detail
          • ICCM Under two months Create
          • ICCM Under five years Create
          • ICCM Under two months Details
          • Labour Mother Neonate Create
          • ICCM Under five years Details
          • Labour Mother Neonate Details
          • PNC Create
          • PNC Details
        • Assessment
          • Childhood Visit
          • ICCM
          • ANC
          • PNC
          • Other Symptoms
        • Investigation
          • Create Investigation
          • Investigation Remove
          • Investigation History List
        • Prescription
          • Prescription Remove
          • Prescribed Details
          • Prescription Create
        • App Version
        • Calculate WGS
        • Create Diagnosis
        • Diagnosis Details
        • Get Chiefdoms
        • Get Districts
        • Get Patient Status
        • Get Patient Details
        • Household Update
        • Member Update
  • Deploy
    • 🚀Deployment Guide
      • 📱Android
      • 🖥️Admin Portal
      • 🗄️HAPI FHIR Server
      • 🗄️Server
    • 🌎Customization Guide
      • Multi-Language Translation
        • Support for multiple languages
      • Clinical Workflow Customization
      • WHO Hearts Algorithm
      • Country Level Administrative Divisions
  • PRODUCT
    • 🥘Releases
    • 🛣️Roadmap
  • COMMUNITY
    • 🧑‍💻Engage
    • 📞Support
    • 📃Policies
  • LINKS
    • Source Code (GitHub)
    • Medtronic LABS
    • Developer Support
  • versions
    • SPICE 1.0
      • OVERVIEW
        • 📒What is SPICE?
        • ✨SPICE App Workflows
          • Screening
          • Enrollment
          • Assessment
          • Medical Review
            • Treatment Plan
            • Prescribe
            • Lab Test
          • My Patients
          • Pharmacy
          • Admin Portal
        • 👩‍⚕️SPICE Users
        • 🔏Data Privacy & Security
          • Privacy Policy
          • Terms & Conditions of Use
        • ❓Frequently Asked Questions (FAQs)
      • ENGINEERING
        • 🖥️Architecture
          • C4 Diagrams
          • FHIR & Standards
        • 🔧Technology Stack
        • 👨‍💻API Documentation
          • Common Services
            • Account Create
            • Change Password for Site Users
            • Country Create
            • Forgot Password
            • Get User Details
            • Get User Profile
            • Locked Users List
            • Login
            • Logout
            • Operating Unit Create
            • Reset Password
            • Set Password for New User
            • Site Create
            • Unlock User
            • User Profile Update
            • Validate User Email
            • Verify Set Password
            • Super Admin
              • Superadmin Details
              • Superadmin List
              • Superadmin Create
              • Superadmin Delete
              • Superadmin Update
          • Admin Services
            • Account
              • Account - Activate
              • Account - Deactivate
              • Account - Deactivated list
              • Account - Details
              • Account - Update
              • Account Admin - Create
              • Account Admin - Delete
              • Account Admin - Update
              • Account Dashboard - Region Admin
              • Account List - Admin
            • Clinical Workflow
              • Create
              • Delete
              • List
              • Update
              • Account Customization - Create
              • Account Customization - Details
              • Account Customization - Update
            • Country Dashboard - Superadmin
            • Lab Test
              • Create
              • Delete
              • Details
              • List
              • Update
              • Lab Test Range - Create
              • Lab Test Range - Delete
              • Lab Test Range - Details
              • Lab Test Range - Update
            • Medication
              • Create
              • Delete
              • Medication Validation
              • List
              • Update
            • Operating Unit
              • Operating Unit - Details
              • Operating Unit - Update
              • Operating Unit Admin - Create
              • Operating Unit Admin - Remove
              • Operating Unit Admin - Update
              • Operating Unit Dashboard - Account Admin
              • Operating Unit List - Admin
            • Program
              • Create
              • List
              • Delete
              • Details
              • Update
            • Region Admin
              • Region Admin - Create
              • Region admin - Delete
              • Region Admin - Details
              • Region admin - Update
            • Site
              • Site - Details
              • Site - Update
              • Site Dashboard - Operating Unit Admin
              • Site List - Admin
              • Site User - Create
              • Site User - Remove
              • Site User - Update
            • Site List - Region Admin
          • SPICE Services
            • Advance-search
            • Advanced search - Site
            • App Version
            • Assessment
            • Assessment Bplog Create
            • Assessment Glucose log Create
            • BPLog List
            • BPLog Create
            • Confirm Diagnosis
            • Device Details
            • Fill Prescription - Update
            • GlucoseLog Create
            • GlucoseLog List
            • Investigation Create
              • Fill Prescription List
            • Investigation List
            • Investigation Search
            • Labtest Result Create
            • Labtest Result Details
            • Labtest Result List
            • Lifestyle Create
            • Lifestyle List
            • Lifestyle remove
            • Lifestyle Update
            • Lifestyle Update view Status
            • Lifestyle view history
            • Medical Review Create - Continuous Medical Review
            • Medical Review Create - Initial Medical Review
            • Medical Review Static Data
            • Medical Review Count
            • Medical review list
            • Medical Review Summary
            • Mental Health Create
            • Mental Health Details
            • Mobile - Forgot Password
            • Mobile - Login
            • Mobile - Logout
            • Nutritionist Lifestyle Create
            • Patient Basic Details
            • Patient Details
            • Patient enrollment
            • Patient-labtest-list
            • Patient Labtest - Remove
            • Patient Labtest - Review
            • Patient-lifestyle-details
            • Patient list
            • Patient Pregnancy Details
            • Patient Pregnancy Details Create
            • Patient Remove
            • Patient Transfer - Create
            • Patient Transfer Count
            • Patient Transfer - Country Site List
            • Patient Transfer - Role user list
            • Patient Transfer List
            • Patient Transfer - Update
            • Patient Transfer - Validate
            • Patient update
            • Patient Visit
            • PatientVisit
            • Pregnancy Create
            • Pregnancy Details
            • Prescription History List
            • Prescription List
            • Prescription Remove
            • Prescription search
            • Pregnancy Update
            • Prescription-history list
            • Prescription Update
            • Refill Prescription History
            • Screening
            • Screening log details
            • Search
            • Transfer Notification Count
            • Treatment Plan Details
            • Treatment Plan Update
            • User Validate API
          • FHIR-Adapter Services
            • Add User
            • Get User By Id
            • Get User By Username
            • Get User List
            • Get User Profile
            • Update User
            • Reset User Password
            • Delete User by ID
            • Forgot Password Validation
            • Options
            • Receive Message
            • Login
            • Site Migration
            • User Migration
            • APIKey Manager API
              • Retrieve API Keys
              • Generate API Keys
              • Delete API Keys
              • Validate API Key
      • DEPLOY
        • 🚀Deployment Guide
          • 🗄️Server
          • 📱Android
          • 🖥️Admin Portal
          • 🗄️FHIR Adapter
        • 🌎Customization Guide
          • Multi-Language Translation
            • Support for multiple languages
          • Clinical Workflow Customization
          • WHO Hearts Algorithm
          • Country Level Administrative Divisions
      • PRODUCT
        • 🥘Releases
        • 🛣️Roadmap
      • LINKS
        • Source Code (GitHub)
        • Medtronic LABS
        • Developer Support
Powered by GitBook

@2024 Medtronic LABS

On this page
  1. Engineering
  2. API Documentation
  3. Admin Services

Get Menu

API URL

{{url}}/spice-service/static-data/menu

Method

POST

Description

Fetch static data menu details.

Sample Input

Field Name

Type

Mandatory

Example

countryId

Integer

Yes

Country id

roleName

String

Yes

SUPER_ADMIN

appTypes

String

Yes

COMMUNITY or NON_COMMUNITY

Authorization (Header)

String

Yes

Bearer 1ba363a1edf54402b51f58060aa52b11d30f99a490295adec900fdabf2b472181c0bfb165be18f4f5c430c7218a244bd29b9300d3471acc08197ccfb996118f6

client

String

Yes

web

{
  countryId: "1", 
  roleName: "SUPER_ADMIN", 
  appTypes: ["NON_COMMUNITY"]
}

Sample Output

Field Name

Type

Comments

message

String

Menu Details fetched successfully

id

Integer

Menu id

roleName

String

Role Names

menus

String

Menu and its details, e.g BY_REGION, BY_CHIEFDOM, BY_DISTRICT, BY_HEALTH_FACILITY

status

String

Menu status

{
    "message": "Menu Details fetched successfully.",
    "entity": {
        "id": 17,
        "roleName": "SUPER_ADMIN",
        "menus": [
            {
                "BY_REGION": [
                    {
                        "name": "REGION",
                        "order": 1,
                        "route": "/region/:regionId/:tenantId",
                        "displayName": "Region"
                    },
                    {
                        "name": "REGION_CUSTOMIZATION",
                        "order": 2,
                        "route": "/region/:regionId/:tenantId/customize",
                        "displayName": "Region Customization"
                    },
                    {
                        "name": "DISTRICT_BY_REGION",
                        "order": 3,
                        "route": "/region/:regionId/:tenantId/district",
                        "displayName": "County"
                    },
                    {
                        "name": "CHIEFDOM_BY_REGION",
                        "order": 4,
                        "route": "/region/:regionId/:tenantId/chiefdom",
                        "displayName": "Sub County"
                    },
                    {
                        "name": "HEALTH_FACILITY_BY_REGION",
                        "order": 5,
                        "route": "/region/:regionId/:tenantId/health-facility",
                        "displayName": "Health Facility"
                    },
                    {
                        "name": "ADMINS_BY_REGION",
                        "order": 6,
                        "route": "/region/:regionId/:tenantId/admin",
                        "displayName": "Admins"
                    },
                    {
                        "name": "USERS_BY_REGION",
                        "order": 7,
                        "route": "/region/:regionId/:tenantId/user",
                        "displayName": "Users"
                    },
                    {
                        "name": "PROGRAM_BY_REGION",
                        "order": 8,
                        "route": "/region/:regionId/:tenantId/program",
                        "displayName": "Program"
                    },
                    {
                        "name": "LAB_TEST_DATABASE_BY_REGION",
                        "order": 9,
                        "route": "/region/:regionId/:tenantId/lab-test",
                        "displayName": "Lab/Imaging Database"
                    },
                    {
                        "name": "MEDICATION_DATABASE_BY_REGION",
                        "order": 10,
                        "route": "/region/:regionId/:tenantId/medication/list",
                        "displayName": "Medication Database"
                    },
                    {
                        "name": "WORKFLOW_BY_REGION",
                        "order": 11,
                        "route": "/region/:regionId/:tenantId/workflow",
                        "displayName": "Workflow"
                    }
                ],
                "BY_CHIEFDOM": [
                    {
                        "name": "CHIEFDOM_SUMMARY",
                        "order": 1,
                        "route": "/chiefdom/:chiefdomId/:tenantId",
                        "displayName": "Sub County"
                    },
                    {
                        "name": "HEALTH_FACILITY_BY_CHIEFDOM",
                        "order": 2,
                        "route": "/chiefdom/:chiefdomId/:tenantId/health-facility",
                        "displayName": "Health Facility"
                    },
                    {
                        "name": "ADMINS_BY_CHIEFDOM",
                        "order": 3,
                        "route": "/chiefdom/:chiefdomId/:tenantId/admin",
                        "displayName": "Admins"
                    },
                    {
                        "name": "USERS_BY_CHIEFDOM",
                        "order": 4,
                        "route": "/chiefdom/:chiefdomId/:tenantId/user",
                        "displayName": "Users"
                    }
                ],
                "BY_DISTRICT": [
                    {
                        "name": "DISTRICT_SUMMARY",
                        "order": 1,
                        "route": "/district/:districtId/:tenantId",
                        "displayName": "County"
                    },
                    {
                        "name": "CHIEFDOM_BY_DISTRICT",
                        "order": 2,
                        "route": "/district/:districtId/:tenantId/chiefdom",
                        "displayName": "Sub County"
                    },
                    {
                        "name": "HEALTH_FACILITY_BY_DISTRICT",
                        "order": 3,
                        "route": "/district/:districtId/:tenantId/health-facility",
                        "displayName": "Health Facility"
                    },
                    {
                        "name": "ADMINS_BY_DISTRICT",
                        "order": 4,
                        "route": "/district/:districtId/:tenantId/admin",
                        "displayName": "Admins"
                    },
                    {
                        "name": "USERS_BY_DISTRICT",
                        "order": 5,
                        "route": "/district/:districtId/:tenantId/user",
                        "displayName": "Users"
                    }
                ],
                "BY_HEALTH_FACILITY": [
                    {
                        "name": "HEALTH_FACILITY_SUMMARY",
                        "order": 1,
                        "route": "/health-facility/:healthFacilityId/:tenantId",
                        "displayName": "Health Facility"
                    },
                    {
                        "name": "ADMINS_BY_HEALTH_FACILITY",
                        "order": 2,
                        "route": "/health-facility/:healthFacilityId/:tenantId/admin",
                        "displayName": "Admins"
                    },
                    {
                        "name": "USERS_BY_HEALTH_FACILITY",
                        "order": 3,
                        "route": "/health-facility/:healthFacilityId/:tenantId/user",
                        "displayName": "Users"
                    }
                ]
            }
        ],
        "meta": null,
        "metaForms": null,
        "jsonDisplayValues": null,
        "formDataId": null,
        "tenantId": null,
        "formName": null
    },
    "status": true,
    "entityList": null,
    "responseCode": 200,
    "totalCount": null
}
PreviousUser Create and UpdateNextCountry List
👨‍💻