GET api/Users/Filter/{userid}/{take}/{skip}/{filters}

Filter the users in the directory.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userid

UserID of user performing the search. Needed to return contact annotations.

integer

Required

take

Must be more than 0 and less than 50

integer

Required

skip

Number of rows to skip

integer

Required

filters

$name=john doe$visible=1$type=student$excludegroup=1234$excludeevent=1234

string

None.

Body Parameters

None.

Response Information

Resource Description

UserLookup
NameDescriptionTypeAdditional information
UserID

integer

None.

Name

string

None.

Img

string

None.

Type

integer

None.

IsStarred

boolean

None.

HasNotes

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "UserID": 1,
  "Name": "sample string 2",
  "Img": "sample string 3",
  "Type": 4,
  "IsStarred": true,
  "HasNotes": true
}

application/xml, text/xml

Sample:
<UserLookup xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PulseAPI.Controllers">
  <HasNotes>true</HasNotes>
  <Img>sample string 3</Img>
  <IsStarred>true</IsStarred>
  <Name>sample string 2</Name>
  <Type>4</Type>
  <UserID>1</UserID>
</UserLookup>