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

HTTP + JSV

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

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

{
	id: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}