POST api/GetUsersInInstitution

Gets information about users assigned to given institution (profile scope required)

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
KnownSearchFields	Collection of string	None.
KnownSortFields	Collection of string	None.
InstitutionGroupName	string	None.
InstitutionNumber	string	None.
UserGroupId	globally unique identifier	None.
PageSize	integer	None.
PageIndex	integer	None.
SearchBy	Collection of Filter	None.
SortBy	Collection of Sort	None.

Request Formats

application/xml, text/xml

Sample:

<GetUsersInInstitutionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.Users">
  <KnownSearchFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core" />
  <KnownSortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core" />
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">4</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">3</PageSize>
  <SearchBy xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
  </SearchBy>
  <SortBy xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
  </SortBy>
  <InstitutionGroupName>sample string 1</InstitutionGroupName>
  <InstitutionNumber>sample string 2</InstitutionNumber>
  <UserGroupId>c108b9f4-a2e1-434d-b8e7-7b4cfb711557</UserGroupId>
</GetUsersInInstitutionRequest>

application/json, text/json

Sample:

{
  "KnownSearchFields": [],
  "KnownSortFields": [],
  "InstitutionGroupName": "sample string 1",
  "InstitutionNumber": "sample string 2",
  "UserGroupId": "c108b9f4-a2e1-434d-b8e7-7b4cfb711557",
  "PageSize": 3,
  "PageIndex": 4,
  "SearchBy": [
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    },
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    }
  ],
  "SortBy": [
    {
      "Key": "sample string 1",
      "Order": 0
    },
    {
      "Key": "sample string 1",
      "Order": 0
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns users from given institution

ApiCollectionResponseOfGetUsersInInstitutionResponse

Name	Type	Additional information
PageSize	integer	None.
PageIndex	integer	None.
Total	integer	None.
SearchBy	Collection of Filter	None.
SortBy	Collection of Sort	None.
Data	Collection of GetUsersInInstitutionResponse	None.
Errors	Collection of string	None.

Response Formats

application/xml, text/xml

Sample:

<ApiCollectionResponseOfGetUsersInInstitutionResponsedU_PB272I xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Alice.Dto.Responses.User">
    <d2p1:GetUsersInInstitutionResponse>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:FullName>sample string 3</d2p1:FullName>
      <d2p1:LastName>sample string 2</d2p1:LastName>
      <d2p1:RoleId>7684fb8d-90c2-4684-aa5f-6a7d3b6d6d46</d2p1:RoleId>
      <d2p1:RoleName>sample string 6</d2p1:RoleName>
      <d2p1:UserGroupId>5e352384-76ab-48b4-b8fd-b87a3b9e6a7f</d2p1:UserGroupId>
      <d2p1:UserGroupName>sample string 7</d2p1:UserGroupName>
      <d2p1:UserId>33dc8590-7d09-4c7d-a7aa-dda5e82d979d</d2p1:UserId>
      <d2p1:UserName>sample string 5</d2p1:UserName>
    </d2p1:GetUsersInInstitutionResponse>
    <d2p1:GetUsersInInstitutionResponse>
      <d2p1:FirstName>sample string 1</d2p1:FirstName>
      <d2p1:FullName>sample string 3</d2p1:FullName>
      <d2p1:LastName>sample string 2</d2p1:LastName>
      <d2p1:RoleId>7684fb8d-90c2-4684-aa5f-6a7d3b6d6d46</d2p1:RoleId>
      <d2p1:RoleName>sample string 6</d2p1:RoleName>
      <d2p1:UserGroupId>5e352384-76ab-48b4-b8fd-b87a3b9e6a7f</d2p1:UserGroupId>
      <d2p1:UserGroupName>sample string 7</d2p1:UserGroupName>
      <d2p1:UserId>33dc8590-7d09-4c7d-a7aa-dda5e82d979d</d2p1:UserId>
      <d2p1:UserName>sample string 5</d2p1:UserName>
    </d2p1:GetUsersInInstitutionResponse>
  </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>
  <PageIndex>2</PageIndex>
  <PageSize>1</PageSize>
  <SearchBy>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
    <Filter>
      <Key>sample string 1</Key>
      <Type>None</Type>
      <Value />
    </Filter>
  </SearchBy>
  <SortBy>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
    <Sort>
      <Key>sample string 1</Key>
      <Order>None</Order>
    </Sort>
  </SortBy>
  <Total>3</Total>
</ApiCollectionResponseOfGetUsersInInstitutionResponsedU_PB272I>

application/json, text/json

Sample:

{
  "PageSize": 1,
  "PageIndex": 2,
  "Total": 3,
  "SearchBy": [
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    },
    {
      "Key": "sample string 1",
      "Value": {},
      "Type": 0
    }
  ],
  "SortBy": [
    {
      "Key": "sample string 1",
      "Order": 0
    },
    {
      "Key": "sample string 1",
      "Order": 0
    }
  ],
  "Data": [
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "FullName": "sample string 3",
      "UserId": "33dc8590-7d09-4c7d-a7aa-dda5e82d979d",
      "UserName": "sample string 5",
      "RoleName": "sample string 6",
      "RoleId": "7684fb8d-90c2-4684-aa5f-6a7d3b6d6d46",
      "UserGroupId": "5e352384-76ab-48b4-b8fd-b87a3b9e6a7f",
      "UserGroupName": "sample string 7"
    },
    {
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "FullName": "sample string 3",
      "UserId": "33dc8590-7d09-4c7d-a7aa-dda5e82d979d",
      "UserName": "sample string 5",
      "RoleName": "sample string 6",
      "RoleId": "7684fb8d-90c2-4684-aa5f-6a7d3b6d6d46",
      "UserGroupId": "5e352384-76ab-48b4-b8fd-b87a3b9e6a7f",
      "UserGroupName": "sample string 7"
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}