| GET | /users | gets a list of BootView users |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsActive | query | int | No | 0 = Inactive, 1 = Active, 2 = All |
| IsInternal | query | int | No | 0 = External, 1 = Internal, 2 = All |
| UserNameContains | query | string | No | |
| FirstNameContains | query | string | No | |
| LastNameContains | query | string | No | |
| CityContains | query | string | No | |
| StateCode | query | string | No | |
| PhoneNumber | query | string | No | |
| LanguageCode | query | string | No | EN = English | SP = Spanish |
| CustomerId | query | Guid | No | |
| GroupId | query | Guid | No | |
| UserAliasContains | query | string | No | |
| MobileAppsAllowed | query | bool | No | |
| CanUseMIMS | query | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users HTTP/1.1 Host: api.paylock.com Accept: application/xml
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>
<ApiTokenId>00000000-0000-0000-0000-000000000000</ApiTokenId>
<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>