<back to all web services
XWSUserList
The following routes are available for this service:| GET | /{Workspace}/XWSUserList/ | | |
|---|
XWSUserList Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | path | string | No | |
| DateGenerated | query | string | No | |
| Users | query | List<User> | No | |
| Teams | query | List<Team> | No | |
User Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| TimeZone | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| Created | form | string | No | |
| LastUpdated | form | string | No | |
| BasedOn | form | string | No | |
| ExternalId | form | string | No | |
| Name | form | string | No | |
| Initials | form | string | No | |
| Phone | form | string | No | |
| Email | form | string | No | |
| Password | form | string | No | |
| RequestUser | form | string | No | |
| Location | form | Location | No | |
| UserType | form | string | No | |
| ProposedRoute | form | List<Location> | No | |
| ActualRoute | form | List<Location> | No | |
| Image | form | string | No | |
| UserStatus | form | UserStatus | No | |
| RecordStatus | form | string | No | |
| Documents | form | List<string> | No | |
| SubscribeToEmails | form | bool | No | |
| Address | form | Address | No | |
| SkillTags | form | List<string> | No | |
| Enabled | form | bool | No | |
| UIPrefTaskColumnsOff | form | List<string> | No | |
| UIPrefTaskColumns | form | List<UIColumnPref> | No | |
| Data | form | Dictionary<string, string> | No | |
| Teams | form | List<string> | No | |
| Events | form | List<EventItem> | No | |
| Color | form | string | No | |
| VehicleAsset | form | string | No | |
| ExternalAuth | form | bool | No | |
| CreatedBy | form | string | No | |
| ServiceAccount | form | bool | No | |
| Assets | form | List<string> | No | |
| TfaRequired | form | bool | No | |
| TfaPreference | form | string | No | |
| WorkWeek | form | List<WorkDay> | No | |
| CustomSchedulesEnabled | form | bool | No | |
| CustomSchedules | form | List<CustomSchedule> | No | |
| OverrideSso | form | bool | No | |
Location Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| y | form | double | No | |
| x | form | double | No | |
UserStatus Enum:| NotStarted | |
| Driving | |
| InProgress | |
| Complete | |
| Blocked | |
Address Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Street | form | string | No | |
| Unit | form | string | No | |
| City | form | string | No | |
| State | form | string | No | |
| Zip | form | string | No | |
| ContactTitle | form | string | No | |
| ContactName | form | string | No | |
| ContactPhone | form | string | No | |
| ContactEmail | form | string | No | |
| Location | form | Location | No | |
| SiteName | form | string | No | |
| GeocodeFailed | form | bool | No | |
| Country | form | string | No | |
UIColumnPref Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Name | form | string | No | |
| Width | form | double | No | |
EventItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ObjectId | form | string | No | |
| Date | form | string | No | |
| Location | form | Location | No | |
| Barcode | form | string | No | |
| Details | form | string | No | |
| Type | form | string | No | |
| IsScan | form | bool | No | |
| User | form | string | No | |
| SelectedBy | form | string | No | |
| Status | form | string | No | |
| StatusType | form | string | No | |
| DateCreated | form | string | No | |
| Automatic | form | bool | No | |
WorkDay Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| DayOfWeek | form | int | No | |
| Start | form | int | No | |
| End | form | int | No | |
| Lunch | form | int | No | |
CustomSchedule Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Date | form | string | No | |
| Start | form | int | No | |
| End | form | int | No | |
| Type | form | string | No | |
Team Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| TimeZone | form | string | No | |
| ObjectId | form | string | No | |
| ExternalId | form | string | No | |
| VersionId | form | string | No | |
| BasedOn | form | string | No | |
| Name | form | string | No | |
| Enabled | form | bool | No | |
| Members | form | List<DomainItem> | No | |
| Lead | form | DomainItem | No | |
| Parent | form | DomainItem | No | |
| Address | form | Address | No | |
| Data | form | Dictionary<string, string> | No | |
| Teams | form | List<string> | No | |
| Events | form | List<EventItem> | No | |
| CreatedBy | form | string | No | |
| ActiveLaborTypes | form | Dictionary<string, Object> | No | |
DomainItem Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Workspace | form | string | No | |
| ObjectId | form | string | No | |
| VersionId | form | string | No | |
| LastUpdated | form | string | No | |
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.
GET /{Workspace}/XWSUserList/ HTTP/1.1
Host: dev.fieldsquared.com
Accept: application/xml