The User Group – List API call reads a full list of existing User Groups from Eyelit MES-M with no filtering. Using the User Groups – List API call has no impact on the data within the given Eyelit MES-M application, it is read-only. Figure 1 shows the logic used within the User Group – List API call. 

Figure 1 - Logic within User Group/List API Call 

Similarly to the UserGroup/List endpoint, there is no data required in Eyelit MES-M to act as a prerequisite to make the API call to list User Groups, although to be able to create a user and subsequently use Eyelit MES-M, at least one User Group is required. It is, therefore, not possible to receive an empty payload in response when calling this endpoint. Additionally, multiple default User Groups are provided automatically in an empty Eyelit MES-M environment.  

Table 1 shows the method and endpoint required to make the API call to list User Groups. 

Table 1 - Outbound Message Detail for User Group  - List 

As no parameters can be passed into this endpoint, the request requires no body. If a body is passed into the payload, it will be ignored, and the full list of all User Groups will be returned. 

The body of the request should consist of only the call to the endpoint as specified above.  

When using the User Group – List API call, a JSON payload will be returned containing data in the following structure: 

Sample Response 

See below for sample use cases with examples of the JSON payload format returned. 

No User Groups exist: 

Multiple User Groups exist: