Field Squared API Services

<back to all web services

XWSUserList

The following routes are available for this service:
GET/{Workspace}/XWSUserList/
XWSUserList Parameters:
NameParameterData TypeRequiredDescription
WorkspacepathstringNo
DateGeneratedquerystringNo
UsersqueryList<User>No
TeamsqueryList<Team>No
User Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
TimeZoneformstringNo
ObjectIdformstringNo
VersionIdformstringNo
CreatedformstringNo
LastUpdatedformstringNo
BasedOnformstringNo
ExternalIdformstringNo
NameformstringNo
InitialsformstringNo
PhoneformstringNo
EmailformstringNo
PasswordformstringNo
RequestUserformstringNo
LocationformLocationNo
UserTypeformstringNo
ProposedRouteformList<Location>No
ActualRouteformList<Location>No
ImageformstringNo
UserStatusformUserStatusNo
RecordStatusformstringNo
DocumentsformList<string>No
SubscribeToEmailsformboolNo
AddressformAddressNo
SkillTagsformList<string>No
EnabledformboolNo
UIPrefTaskColumnsOffformList<string>No
UIPrefTaskColumnsformList<UIColumnPref>No
DataformDictionary<string, string>No
TeamsformList<string>No
EventsformList<EventItem>No
ColorformstringNo
VehicleAssetformstringNo
ExternalAuthformboolNo
CreatedByformstringNo
ServiceAccountformboolNo
AssetsformList<string>No
TfaRequiredformboolNo
TfaPreferenceformstringNo
WorkWeekformList<WorkDay>No
CustomSchedulesEnabledformboolNo
CustomSchedulesformList<CustomSchedule>No
OverrideSsoformboolNo
Location Parameters:
NameParameterData TypeRequiredDescription
yformdoubleNo
xformdoubleNo
UserStatus Enum:
NotStarted
Driving
InProgress
Complete
Blocked
Address Parameters:
NameParameterData TypeRequiredDescription
StreetformstringNo
UnitformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
ContactTitleformstringNo
ContactNameformstringNo
ContactPhoneformstringNo
ContactEmailformstringNo
LocationformLocationNo
SiteNameformstringNo
GeocodeFailedformboolNo
CountryformstringNo
UIColumnPref Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
WidthformdoubleNo
EventItem Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
DateformstringNo
LocationformLocationNo
BarcodeformstringNo
DetailsformstringNo
TypeformstringNo
IsScanformboolNo
UserformstringNo
SelectedByformstringNo
StatusformstringNo
StatusTypeformstringNo
DateCreatedformstringNo
AutomaticformboolNo
WorkDay Parameters:
NameParameterData TypeRequiredDescription
DayOfWeekformintNo
StartformintNo
EndformintNo
LunchformintNo
CustomSchedule Parameters:
NameParameterData TypeRequiredDescription
DateformstringNo
StartformintNo
EndformintNo
TypeformstringNo
Team Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
TimeZoneformstringNo
ObjectIdformstringNo
ExternalIdformstringNo
VersionIdformstringNo
BasedOnformstringNo
NameformstringNo
EnabledformboolNo
MembersformList<DomainItem>No
LeadformDomainItemNo
ParentformDomainItemNo
AddressformAddressNo
DataformDictionary<string, string>No
TeamsformList<string>No
EventsformList<EventItem>No
CreatedByformstringNo
ActiveLaborTypesformDictionary<string, Object>No
DomainItem Parameters:
NameParameterData TypeRequiredDescription
WorkspaceformstringNo
ObjectIdformstringNo
VersionIdformstringNo
LastUpdatedformstringNo

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.

GET /{Workspace}/XWSUserList/ HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv