GetUsersFromGroup

≥4.6

Interface Function

Acquire user information under specified group.

Request Parameter

[warning] Note

To control interface performance and return data volumn, the interface limits PageSize to a maximum of 100. The interface returns 100 pieces of data if the maximum value is exceeded.

Return Data Type

JObject Reference return sample

Return Sample

{
   "Total": 200,
   "Users": [
    {
       "OfficeCode": null,
       "CurrOfficeCode": null,
       "CountryCode": null,
       "LoS": null,
       "LoSCode": null,
       "Location": null,
       "OUCode": null,
       "OU": null,
       "GradeCode": null,
       "Grade": null,
       "EntityGroupCode": null,
       "CurrGroupCode": null,
       "CurrEntityCode": null,
       "IsProfessional": null,
       "JobTitle": null,
       "NotesID": null,
       "TermDate": null,
       "Email": "appadmin@digitalmaker.com",
       "FirstName": null,
       "LastName": null,
       "OrganizationCode": "DemoTenant",
       "Phone": "888",
       "UserName": "appadmin",
       "UserID": "b8859dae-aea4-4947-bc97-b5c9c59b1440",
       "StaffCode": "##190111030237723",
       "Avatar": null,
       "ActiveFlag": "true"
     },
     {
       "OfficeCode": null,
       "CurrOfficeCode": null,
       "CountryCode": null,
       "LoS": null,
       "LoSCode": null,
       "Location": null,
       "OUCode": null,
       "OU": null,
       "GradeCode": null,
       "Grade": null,
       "EntityGroupCode": null,
       "CurrGroupCode": null,
       "CurrEntityCode": null,
       "IsProfessional": null,
       "JobTitle": null,
       "NotesID": null,
       "TermDate": null,
       "Email": "demo@digitalmaker.com",
       "FirstName": null,
       "LastName": null,
       "OrganizationCode": "DemoTenant",
       "Phone": "888",
       "UserName": "DemoUser",
       "UserID": "420e8692-814b-491a-96c3-af63ea2a3ec1",
       "StaffCode": "##190111030819430",
       "Avatar": null,
       "ActiveFlag": "true"
     },
    ]
}

Code example

//
var GroupName="demogroup";
var PageIndex=1;
var PageSize=20;
var WithSubGroupUser=true;
var result=Service.GetUsersFromGroup(GroupName,PageIndex,PageSize,WithSubGroupUser);
Service.ConsoleLog("GetUsersFromGroup result",result);