BootView WebApi

<back to all web services

FindUsers

The following routes are available for this service:
GET/usersgets a list of BootView users
FindUsers Parameters:
NameParameterData TypeRequiredDescription
IsActivequeryintNo0 = Inactive, 1 = Active, 2 = All
IsInternalqueryintNo0 = External, 1 = Internal, 2 = All
UserNameContainsquerystringNo
FirstNameContainsquerystringNo
LastNameContainsquerystringNo
CityContainsquerystringNo
StateCodequerystringNo
PhoneNumberquerystringNo
LanguageCodequerystringNoEN = English | SP = Spanish
CustomerIdqueryGuidNo
GroupIdqueryGuidNo
UserAliasContainsquerystringNo
MobileAppsAllowedqueryboolNo
CanUseMIMSqueryboolNo

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/FindUsers HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<FindUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CanUseMIMS>false</CanUseMIMS>
  <CityContains>String</CityContains>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <FirstNameContains>String</FirstNameContains>
  <GroupId>00000000-0000-0000-0000-000000000000</GroupId>
  <IsActive>0</IsActive>
  <IsInternal>0</IsInternal>
  <LanguageCode>String</LanguageCode>
  <LastNameContains>String</LastNameContains>
  <MobileAppsAllowed>false</MobileAppsAllowed>
  <PhoneNumber>String</PhoneNumber>
  <StateCode>String</StateCode>
  <UserAliasContains>String</UserAliasContains>
  <UserNameContains>String</UserNameContains>
</FindUsers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <UserResponse>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <Alias>String</Alias>
    <CanUseMIMS>false</CanUseMIMS>
    <City>String</City>
    <EmailAddress>String</EmailAddress>
    <FirstName>String</FirstName>
    <GroupId>00000000-0000-0000-0000-000000000000</GroupId>
    <GroupPermissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </GroupPermissions>
    <HomePageId>0</HomePageId>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <IsActive>false</IsActive>
    <IsInternal>false</IsInternal>
    <LanguageCode>String</LanguageCode>
    <LastName>String</LastName>
    <MobileAppsAllowed>false</MobileAppsAllowed>
    <MobilePhone>String</MobilePhone>
    <Phone>String</Phone>
    <StateCode>String</StateCode>
    <Status>0</Status>
    <TimeZone>String</TimeZone>
    <UserName>String</UserName>
    <Zip>String</Zip>
  </UserResponse>
</ArrayOfUserResponse>