GET api/Users/LetterFilter/{userid}/{letter}/{take}/{filters}

Filter the users in the directory by letter. This will return row numbers so that subsequent filter requests can be carried out with the proper offset. NOTE: This should only be used when a letter is pressed. Subsequent requests should resort back to the regular filtering function.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userid

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

integer

Required

letter

The letter to perform the filter with.

string

Required

take

Must be more than 0 and less than 50

integer

Required

filters

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

string

None.

Body Parameters

None.

Response Information

Resource Description

LetterSearch
NameDescriptionTypeAdditional information
UserID

integer

None.

Name

string

None.

Img

string

None.

Type

integer

None.

IsStarred

boolean

None.

HasNotes

boolean

None.

Row

integer

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<LetterSearch 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>
  <Row>7</Row>
  <Type>4</Type>
  <UserID>1</UserID>
</LetterSearch>