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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/FindUsers HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/csv
Content-Length: length

{"isActive":0,"isInternal":0,"userNameContains":"String","firstNameContains":"String","lastNameContains":"String","cityContains":"String","stateCode":"String","phoneNumber":"String","languageCode":"String","customerId":"00000000000000000000000000000000","groupId":"00000000000000000000000000000000","userAliasContains":"String","mobileAppsAllowed":false,"canUseMIMS":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"id":"00000000000000000000000000000000","userName":"String","firstName":"String","lastName":"String","alias":"String","emailAddress":"String","city":"String","stateCode":"String","address1":"String","address2":"String","groupId":"00000000000000000000000000000000","isActive":false,"isInternal":false,"languageCode":"String","mobilePhone":"String","phone":"String","timeZone":"String","zip":"String","status":0,"homePageId":0,"groupPermissions":["String"],"mobileAppsAllowed":false,"canUseMIMS":false}]