MobileApp

Get User Menu Details

Function: get_user_menu_details Type: API Endpoint (GET)

Purpose: Retrieves the menu details for a specified user based on the provided Customer_Key and user_code.

Headers:

  • Customer_Key (str, required): The customer key used for authentication.
  • user_code (str, required): The user code identifying the user to retrieve menu details for.
  • App_Code (str, optional): The application code to filter menus. Default is "AP0001".

Response: A JSON response containing the menu details for the given user:

  • menu_details: A list of objects containing the menu details:
    • menu_id: The menu code.
    • menu_name: The menu name.
    • access: The access level for the menu (0 = no access, 1 = view, 2 = manage).
    • icon: The icon associated with the menu.

Exceptions:

  • Raises HTTPException with a 500 status code for any internal server errors.
  • Returns a JSON response with a "failed" status if the customer key is invalid.
get/api/MobileApp/user_menu_details

Headers

Customer-Keystring required
User-Codestring required
App-Codestring

Response

Successful Response

{"stackTrail":"paths:/api/MobileApp/user_menu_details:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.