MobileApp
Update User Menu Details
Function: update_user_menu_details Type: API Endpoint (post)
Purpose: Updates the menu access details for a specified user based on the provided Customer_Key and User_Code. If the user belongs to a group, it ensures their menu access aligns with the group's access.
Headers:
- Customer_Key (str, required): The customer key used for authentication.
- User_Code (str, required): The user code identifying the user to update.
Request Body: A JSON object containing the update instructions, including menu details:
{
"menu_details": [
{
"menu_id": "string",
"access": 0
}
],
"username": "string"
}
Response: A JSON response indicating the status of the update operation:
- status: The outcome of the update operation (e.g., "success", "failed", "no_changes").
- message: A detailed message regarding the operation result.
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 or no menu details are provided.
post/api/MobileApp/update_user_menu_details
Headers
Customer-Keystring required
User-Codestring required
Request body
Response
Successful Response
{"stackTrail":"paths:/api/MobileApp/update_user_menu_details:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}
Changes
No recorded changes to this endpoint across all 1 revision of this API.