POST api/GetUserGroups

Returns courses and classes for given institutionNumber

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
KnownSearchFields	Collection of string	None.
KnownSortFields	Collection of string	None.
InstitutionNumber	string	None.
PageSize	integer	None.
PageIndex	integer	None.
SearchBy	Collection of Filter	None.
SortBy	Collection of Sort	None.
GroupType	UserGroupType	None.

Request Formats

application/xml, text/xml

Sample:

<GetUserGroupInstitutionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Requests.UserGroups">
  <KnownSearchFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <d2p1:string>Name</d2p1:string>
    <d2p1:string>Level</d2p1:string>
  </KnownSearchFields>
  <KnownSortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">
    <d2p1:string>Name</d2p1:string>
    <d2p1:string>Level</d2p1:string>
  </KnownSortFields>
  <PageIndex xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">3</PageIndex>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Alice.Dto.Core">2</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>
  <GroupType>Default</GroupType>
  <InstitutionNumber>sample string 1</InstitutionNumber>
</GetUserGroupInstitutionRequest>

application/json, text/json

Sample:

{
  "GroupType": 0,
  "KnownSearchFields": [
    "Name",
    "Level"
  ],
  "KnownSortFields": [
    "Name",
    "Level"
  ],
  "InstitutionNumber": "sample string 1",
  "PageSize": 2,
  "PageIndex": 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
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiCollectionResponseOfGetUserGroupInstitutionResponse

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 GetUserGroupInstitutionResponse	None.
Errors	Collection of string	None.

Response Formats

application/xml, text/xml

Sample:

<ApiCollectionResponseOfGetUserGroupInstitutionResponsegmPb7CtU 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.UserGroups">
    <d2p1:GetUserGroupInstitutionResponse>
      <d2p1:Id>5db3e0b3-70f4-4680-9f05-d9fc3eb1a1e9</d2p1:Id>
      <d2p1:Level>sample string 3</d2p1:Level>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Type>Default</d2p1:Type>
    </d2p1:GetUserGroupInstitutionResponse>
    <d2p1:GetUserGroupInstitutionResponse>
      <d2p1:Id>5db3e0b3-70f4-4680-9f05-d9fc3eb1a1e9</d2p1:Id>
      <d2p1:Level>sample string 3</d2p1:Level>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Type>Default</d2p1:Type>
    </d2p1:GetUserGroupInstitutionResponse>
  </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>
</ApiCollectionResponseOfGetUserGroupInstitutionResponsegmPb7CtU>

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": [
    {
      "Id": "5db3e0b3-70f4-4680-9f05-d9fc3eb1a1e9",
      "Name": "sample string 2",
      "Level": "sample string 3",
      "Type": 0
    },
    {
      "Id": "5db3e0b3-70f4-4680-9f05-d9fc3eb1a1e9",
      "Name": "sample string 2",
      "Level": "sample string 3",
      "Type": 0
    }
  ],
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}