MDM NEW

User List

Function: user_list Type: API Endpoint (GET)

Purpose:
This function retrieves a paginated list of users who have MDM access for a specific LSCode. It decodes the LSCode from the request headers, queries the database for user details, and returns a JSON response containing the user information.

URL:
GET /api/new_mdm/user_list/?page=<page_num>&limit=<limit_num>

Request Headers:

  • Customer_Key (Header, required):
    A base64 encoded string that identifies the Customer_Key(LSCode|FirmCode).

Response Example:

{
    "users": [
        {
            "Name": "<First Name>",
            "Email": "<Email>",
            "Mobile": "<Mobile>",
            "Role": "<User Group Name>",
            "Status": "<Isactive>",
            "UserCode": "<Encoded User Code>",
            "groupCode": "<Encoded Group Code>"
            "isAdministrator": "<Is Administrator>"
        },
        ...
    ]
}

Error Handling:

  • Raises HTTP 400 if lscode header is missing.
  • Raises HTTP 500 for any other exceptions encountered during execution.
get/api/new_mdm/user_list

Headers

Customer-Keystring required

Response

Successful Response

{"stackTrail":"paths:/api/new_mdm/user_list: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.