POST api/UserGroup/Get
Returns all User Groups in specific Account context based on provided filters
Request Information
URI Parameters
None.
Body Parameters
GetUserGroupRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| FilterInstitutionNumber | string |
None. |
|
| FilterGroupName | string |
None. |
|
| FilterGroupType | string |
None. |
|
| FilterOwnerId | string |
None. |
|
| FilterMunicipality | string |
None. |
|
| FilterCity | string |
None. |
|
| FilterAddress | string |
None. |
|
| FilterContactPerson | string |
None. |
|
| FilterContactEmail | string |
None. |
|
| SortGroupName | string |
None. |
|
| Filters | Dictionary of string [key] and FilterValue [value] |
None. |
|
| SortFields | Dictionary of string [key] and OrderType [value] |
None. |
|
| AvailablePageSizes | Collection of integer |
None. |
|
| PageSize | integer |
None. |
|
| PageIndex | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"FilterInstitutionNumber": "InstitutionNumber",
"FilterGroupName": "GroupName",
"FilterGroupType": "GroupType",
"FilterOwnerId": "OwnerId",
"FilterMunicipality": "Municipality",
"FilterCity": "City",
"FilterAddress": "Address",
"FilterContactPerson": "ContactPerson",
"FilterContactEmail": "ContactEmail",
"SortGroupName": "GroupName",
"Filters": {
"InstitutionNumber": {
"Value": "",
"FilterType": 0
},
"GroupName": {
"Value": "",
"FilterType": 0
},
"GroupType": {
"Value": "",
"FilterType": 0
},
"OwnerId": {
"Value": "",
"FilterType": 0
},
"Municipality": {
"Value": "",
"FilterType": 0
},
"City": {
"Value": "",
"FilterType": 0
},
"Address": {
"Value": "",
"FilterType": 0
},
"ContactPerson": {
"Value": "",
"FilterType": 0
},
"ContactEmail": {
"Value": "",
"FilterType": 0
}
},
"SortFields": {
"GroupName": 0
},
"AvailablePageSizes": [
10,
50,
100
],
"PageSize": 1,
"PageIndex": 2
}
application/xml, text/xml
Sample:
<GetUserGroupRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.GetRequests">
<AvailablePageSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
<d2p1:int>10</d2p1:int>
<d2p1:int>50</d2p1:int>
<d2p1:int>100</d2p1:int>
</AvailablePageSizes>
<Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>InstitutionNumber</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>GroupName</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>GroupType</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>OwnerId</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>Municipality</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>City</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>Address</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>ContactPerson</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>ContactEmail</d2p1:Key>
<d2p1:Value>
<FilterType>None</FilterType>
<Value></Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
</Filters>
<PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">2</PageIndex>
<PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">1</PageSize>
<SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
<d2p1:KeyValueOfstringOrderTypevpR9PHaG>
<d2p1:Key>GroupName</d2p1:Key>
<d2p1:Value>None</d2p1:Value>
</d2p1:KeyValueOfstringOrderTypevpR9PHaG>
</SortFields>
</GetUserGroupRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiCollectionResponseOfIEnumerableOfGetUserGroupResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess | boolean |
None. |
|
| Errors | Collection of string |
None. |
|
| Data | Collection of GetUserGroupResponse |
None. |
|
| Filters | Dictionary of string [key] and FilterValue [value] |
None. |
|
| SortFields | Dictionary of string [key] and OrderType [value] |
None. |
|
| AvailablePageSizes | Collection of integer |
None. |
|
| PageSize | integer |
None. |
|
| PageIndex | integer |
None. |
|
| Total | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccess": true,
"Errors": [
"sample string 1",
"sample string 2"
],
"Data": [
{
"Id": "7166f01b-567d-406d-a81f-54d57046648d",
"Name": "sample string 2",
"UserGroupType": 0,
"Users": [
{
"Id": "e2c579b5-53a5-4470-800f-5092019a12fb",
"Username": "sample string 2",
"EmailAddress": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"LoginProviders": [
{
"Id": "fe6ec04a-705f-4733-b80c-ec8cf7096de6",
"ProviderName": "sample string 2",
"ProviderKey": "sample string 3",
"UserId": "34655033-d088-4b5d-8982-e086baa3b6f9"
},
{
"Id": "fe6ec04a-705f-4733-b80c-ec8cf7096de6",
"ProviderName": "sample string 2",
"ProviderKey": "sample string 3",
"UserId": "34655033-d088-4b5d-8982-e086baa3b6f9"
}
],
"Roles": [
"sample string 1",
"sample string 2"
],
"IsActive": true,
"IsPrivateCustomer": true
},
{
"Id": "e2c579b5-53a5-4470-800f-5092019a12fb",
"Username": "sample string 2",
"EmailAddress": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"LoginProviders": [
{
"Id": "fe6ec04a-705f-4733-b80c-ec8cf7096de6",
"ProviderName": "sample string 2",
"ProviderKey": "sample string 3",
"UserId": "34655033-d088-4b5d-8982-e086baa3b6f9"
},
{
"Id": "fe6ec04a-705f-4733-b80c-ec8cf7096de6",
"ProviderName": "sample string 2",
"ProviderKey": "sample string 3",
"UserId": "34655033-d088-4b5d-8982-e086baa3b6f9"
}
],
"Roles": [
"sample string 1",
"sample string 2"
],
"IsActive": true,
"IsPrivateCustomer": true
}
],
"InstitutionNumber": "sample string 3",
"CommuneNumber": "sample string 4",
"ZipCode": "sample string 5",
"City": "sample string 6",
"Email": "sample string 7",
"HasWs17Agreement": true,
"LastSynchonized": "2025-12-25T15:44:42.5448633+00:00",
"LastSynchonizationError": "sample string 9",
"Address": "sample string 10"
},
{
"Id": "7166f01b-567d-406d-a81f-54d57046648d",
"Name": "sample string 2",
"UserGroupType": 0,
"Users": [
{
"Id": "e2c579b5-53a5-4470-800f-5092019a12fb",
"Username": "sample string 2",
"EmailAddress": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"LoginProviders": [
{
"Id": "fe6ec04a-705f-4733-b80c-ec8cf7096de6",
"ProviderName": "sample string 2",
"ProviderKey": "sample string 3",
"UserId": "34655033-d088-4b5d-8982-e086baa3b6f9"
},
{
"Id": "fe6ec04a-705f-4733-b80c-ec8cf7096de6",
"ProviderName": "sample string 2",
"ProviderKey": "sample string 3",
"UserId": "34655033-d088-4b5d-8982-e086baa3b6f9"
}
],
"Roles": [
"sample string 1",
"sample string 2"
],
"IsActive": true,
"IsPrivateCustomer": true
},
{
"Id": "e2c579b5-53a5-4470-800f-5092019a12fb",
"Username": "sample string 2",
"EmailAddress": "sample string 3",
"FirstName": "sample string 4",
"LastName": "sample string 5",
"LoginProviders": [
{
"Id": "fe6ec04a-705f-4733-b80c-ec8cf7096de6",
"ProviderName": "sample string 2",
"ProviderKey": "sample string 3",
"UserId": "34655033-d088-4b5d-8982-e086baa3b6f9"
},
{
"Id": "fe6ec04a-705f-4733-b80c-ec8cf7096de6",
"ProviderName": "sample string 2",
"ProviderKey": "sample string 3",
"UserId": "34655033-d088-4b5d-8982-e086baa3b6f9"
}
],
"Roles": [
"sample string 1",
"sample string 2"
],
"IsActive": true,
"IsPrivateCustomer": true
}
],
"InstitutionNumber": "sample string 3",
"CommuneNumber": "sample string 4",
"ZipCode": "sample string 5",
"City": "sample string 6",
"Email": "sample string 7",
"HasWs17Agreement": true,
"LastSynchonized": "2025-12-25T15:44:42.5448633+00:00",
"LastSynchonizationError": "sample string 9",
"Address": "sample string 10"
}
],
"Filters": {
"sample string 1": {
"Value": "sample string 1",
"FilterType": 0
},
"sample string 2": {
"Value": "sample string 1",
"FilterType": 0
}
},
"SortFields": {
"sample string 1": 0,
"sample string 2": 0
},
"AvailablePageSizes": [
10,
50,
100
],
"PageSize": 2,
"PageIndex": 3,
"Total": 4
}
application/xml, text/xml
Sample:
<ApiCollectionResponseOfArrayOfGetUserGroupResponseLgVmlFmJ xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Response">
<AvailablePageSizes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>10</d2p1:int>
<d2p1:int>50</d2p1:int>
<d2p1:int>100</d2p1:int>
</AvailablePageSizes>
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses">
<d2p1:GetUserGroupResponse>
<d2p1:Address>sample string 10</d2p1:Address>
<d2p1:City>sample string 6</d2p1:City>
<d2p1:CommuneNumber>sample string 4</d2p1:CommuneNumber>
<d2p1:Email>sample string 7</d2p1:Email>
<d2p1:HasWs17Agreement>true</d2p1:HasWs17Agreement>
<d2p1:Id>7166f01b-567d-406d-a81f-54d57046648d</d2p1:Id>
<d2p1:InstitutionNumber>sample string 3</d2p1:InstitutionNumber>
<d2p1:LastSynchonizationError>sample string 9</d2p1:LastSynchonizationError>
<d2p1:LastSynchonized>2025-12-25T15:44:42.5448633+00:00</d2p1:LastSynchonized>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:UserGroupType>Default</d2p1:UserGroupType>
<d2p1:Users>
<d2p1:GetUserResponse>
<d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:Id>e2c579b5-53a5-4470-800f-5092019a12fb</d2p1:Id>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
<d2p1:LastName>sample string 5</d2p1:LastName>
<d2p1:LoginProviders>
<d2p1:GetLoginProviderResponse>
<d2p1:Id>fe6ec04a-705f-4733-b80c-ec8cf7096de6</d2p1:Id>
<d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
<d2p1:ProviderName>sample string 2</d2p1:ProviderName>
<d2p1:UserId>34655033-d088-4b5d-8982-e086baa3b6f9</d2p1:UserId>
</d2p1:GetLoginProviderResponse>
<d2p1:GetLoginProviderResponse>
<d2p1:Id>fe6ec04a-705f-4733-b80c-ec8cf7096de6</d2p1:Id>
<d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
<d2p1:ProviderName>sample string 2</d2p1:ProviderName>
<d2p1:UserId>34655033-d088-4b5d-8982-e086baa3b6f9</d2p1:UserId>
</d2p1:GetLoginProviderResponse>
</d2p1:LoginProviders>
<d2p1:Roles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</d2p1:Roles>
<d2p1:Username>sample string 2</d2p1:Username>
</d2p1:GetUserResponse>
<d2p1:GetUserResponse>
<d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:Id>e2c579b5-53a5-4470-800f-5092019a12fb</d2p1:Id>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
<d2p1:LastName>sample string 5</d2p1:LastName>
<d2p1:LoginProviders>
<d2p1:GetLoginProviderResponse>
<d2p1:Id>fe6ec04a-705f-4733-b80c-ec8cf7096de6</d2p1:Id>
<d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
<d2p1:ProviderName>sample string 2</d2p1:ProviderName>
<d2p1:UserId>34655033-d088-4b5d-8982-e086baa3b6f9</d2p1:UserId>
</d2p1:GetLoginProviderResponse>
<d2p1:GetLoginProviderResponse>
<d2p1:Id>fe6ec04a-705f-4733-b80c-ec8cf7096de6</d2p1:Id>
<d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
<d2p1:ProviderName>sample string 2</d2p1:ProviderName>
<d2p1:UserId>34655033-d088-4b5d-8982-e086baa3b6f9</d2p1:UserId>
</d2p1:GetLoginProviderResponse>
</d2p1:LoginProviders>
<d2p1:Roles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</d2p1:Roles>
<d2p1:Username>sample string 2</d2p1:Username>
</d2p1:GetUserResponse>
</d2p1:Users>
<d2p1:ZipCode>sample string 5</d2p1:ZipCode>
</d2p1:GetUserGroupResponse>
<d2p1:GetUserGroupResponse>
<d2p1:Address>sample string 10</d2p1:Address>
<d2p1:City>sample string 6</d2p1:City>
<d2p1:CommuneNumber>sample string 4</d2p1:CommuneNumber>
<d2p1:Email>sample string 7</d2p1:Email>
<d2p1:HasWs17Agreement>true</d2p1:HasWs17Agreement>
<d2p1:Id>7166f01b-567d-406d-a81f-54d57046648d</d2p1:Id>
<d2p1:InstitutionNumber>sample string 3</d2p1:InstitutionNumber>
<d2p1:LastSynchonizationError>sample string 9</d2p1:LastSynchonizationError>
<d2p1:LastSynchonized>2025-12-25T15:44:42.5448633+00:00</d2p1:LastSynchonized>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:UserGroupType>Default</d2p1:UserGroupType>
<d2p1:Users>
<d2p1:GetUserResponse>
<d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:Id>e2c579b5-53a5-4470-800f-5092019a12fb</d2p1:Id>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
<d2p1:LastName>sample string 5</d2p1:LastName>
<d2p1:LoginProviders>
<d2p1:GetLoginProviderResponse>
<d2p1:Id>fe6ec04a-705f-4733-b80c-ec8cf7096de6</d2p1:Id>
<d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
<d2p1:ProviderName>sample string 2</d2p1:ProviderName>
<d2p1:UserId>34655033-d088-4b5d-8982-e086baa3b6f9</d2p1:UserId>
</d2p1:GetLoginProviderResponse>
<d2p1:GetLoginProviderResponse>
<d2p1:Id>fe6ec04a-705f-4733-b80c-ec8cf7096de6</d2p1:Id>
<d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
<d2p1:ProviderName>sample string 2</d2p1:ProviderName>
<d2p1:UserId>34655033-d088-4b5d-8982-e086baa3b6f9</d2p1:UserId>
</d2p1:GetLoginProviderResponse>
</d2p1:LoginProviders>
<d2p1:Roles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</d2p1:Roles>
<d2p1:Username>sample string 2</d2p1:Username>
</d2p1:GetUserResponse>
<d2p1:GetUserResponse>
<d2p1:EmailAddress>sample string 3</d2p1:EmailAddress>
<d2p1:FirstName>sample string 4</d2p1:FirstName>
<d2p1:Id>e2c579b5-53a5-4470-800f-5092019a12fb</d2p1:Id>
<d2p1:IsActive>true</d2p1:IsActive>
<d2p1:IsPrivateCustomer>true</d2p1:IsPrivateCustomer>
<d2p1:LastName>sample string 5</d2p1:LastName>
<d2p1:LoginProviders>
<d2p1:GetLoginProviderResponse>
<d2p1:Id>fe6ec04a-705f-4733-b80c-ec8cf7096de6</d2p1:Id>
<d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
<d2p1:ProviderName>sample string 2</d2p1:ProviderName>
<d2p1:UserId>34655033-d088-4b5d-8982-e086baa3b6f9</d2p1:UserId>
</d2p1:GetLoginProviderResponse>
<d2p1:GetLoginProviderResponse>
<d2p1:Id>fe6ec04a-705f-4733-b80c-ec8cf7096de6</d2p1:Id>
<d2p1:ProviderKey>sample string 3</d2p1:ProviderKey>
<d2p1:ProviderName>sample string 2</d2p1:ProviderName>
<d2p1:UserId>34655033-d088-4b5d-8982-e086baa3b6f9</d2p1:UserId>
</d2p1:GetLoginProviderResponse>
</d2p1:LoginProviders>
<d2p1:Roles xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</d2p1:Roles>
<d2p1:Username>sample string 2</d2p1:Username>
</d2p1:GetUserResponse>
</d2p1:Users>
<d2p1:ZipCode>sample string 5</d2p1:ZipCode>
</d2p1:GetUserGroupResponse>
</Data>
<Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</Errors>
<Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
<d4p1:FilterType>None</d4p1:FilterType>
<d4p1:Value>sample string 1</d4p1:Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:KeyValueOfstringFilterValueN3g1kdQt>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value xmlns:d4p1="http://schemas.datacontract.org/2004/07/Alice.Api.Common.Request">
<d4p1:FilterType>None</d4p1:FilterType>
<d4p1:Value>sample string 1</d4p1:Value>
</d2p1:Value>
</d2p1:KeyValueOfstringFilterValueN3g1kdQt>
</Filters>
<IsSuccess>true</IsSuccess>
<PageIndex>3</PageIndex>
<PageSize>2</PageSize>
<SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringOrderTypevpR9PHaG>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>None</d2p1:Value>
</d2p1:KeyValueOfstringOrderTypevpR9PHaG>
<d2p1:KeyValueOfstringOrderTypevpR9PHaG>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value>None</d2p1:Value>
</d2p1:KeyValueOfstringOrderTypevpR9PHaG>
</SortFields>
<Total>4</Total>
</ApiCollectionResponseOfArrayOfGetUserGroupResponseLgVmlFmJ>