BootView WebApi

<back to all web services

GetUserTypeAheadResults

The following routes are available for this service:
GET/users/typeaheadPerforms a type-ahead search on all active BootView users based on loose matches to user name, first name, last name, and group name.
GetUserTypeAheadResults Parameters:
NameParameterData TypeRequiredDescription
TypeAheadqueryStringYesThe type-ahead string
UserTypeAheadResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
UserNameformstringNo
FirstNameformstringNo
LastNameformstringNo
GroupNameformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetUserTypeAheadResults HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetUserTypeAheadResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <TypeAhead>String</TypeAhead>
</GetUserTypeAheadResults>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserTypeAheadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <FirstName>String</FirstName>
  <GroupName>String</GroupName>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <LastName>String</LastName>
  <UserName>String</UserName>
</UserTypeAheadResponse>