BootView WebApi

<back to all web services

GetUser

The following routes are available for this service:
GET/users/{Id}gets a single bootview user by user id
GetUser Parameters:
NameParameterData TypeRequiredDescription
IdqueryGuidYesthe GUID user id
UserResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
UserNameformstringNo
FirstNameformstringNo
LastNameformstringNo
AliasformstringNo
EmailAddressformstringNo
CityformstringNo
StateCodeformstringNo
Address1formstringNo
Address2formstringNo
GroupIdformGuidNo
IsActiveformboolNo
IsInternalformboolNo
LanguageCodeformstringNo
MobilePhoneformstringNo
PhoneformstringNo
TimeZoneformstringNo
ZipformstringNo
StatusformintNo
HomePageIdformint?No
GroupPermissionsformList<string>No
MobileAppsAllowedformboolNo
CanUseMIMSformboolNo

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

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

<UserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1: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>