Field Squared API Services

User

Represents a DTO for a user in a workspace. Calls without an ObjectId will retrieve an array of all user objects for the workspace.

The following routes are available for this service:
GET,POST,PUT,DELETE	/{Workspace}/User/{ObjectId}
GET	/{Workspace}/User

**User** Parameters:
Name	Parameter	Data Type	Required
Workspace	path	string	No
TimeZone	body	string	No
ObjectId	path	string	No
VersionId	body	string	No
Created	body	string	No
LastUpdated	body	string	No
BasedOn	body	string	No
ExternalId	body	string	No
Name	body	string	No
Initials	body	string	No
Phone	body	string	No
Email	body	string	No
Password	body	string	No
RequestUser	body	string	No
Location	body	Location	No
UserType	body	string	No
ProposedRoute	body	List<Location>	No
ActualRoute	body	List<Location>	No
Image	body	string	No
UserStatus	body	UserStatus	No
RecordStatus	body	string	No
Documents	body	List<string>	No
SubscribeToEmails	body	bool	No
Address	body	Address	No
SkillTags	body	List<string>	No
Enabled	body	bool	No
UIPrefTaskColumnsOff	body	List<string>	No
UIPrefTaskColumns	body	List<UIColumnPref>	No
Data	body	Dictionary<string, string>	No
Teams	body	List<string>	No
Events	body	List<EventItem>	No
Color	body	string	No
VehicleAsset	body	string	No
ExternalAuth	body	bool	No
CreatedBy	body	string	No
ServiceAccount	body	bool	No
Assets	body	List<string>	No
TfaRequired	body	bool	No
TfaPreference	body	string	No
WorkWeek	body	List<WorkDay>	No
CustomSchedulesEnabled	body	bool	No
CustomSchedules	body	List<CustomSchedule>	No
OverrideSso	body	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
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
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
DayOfWeek	form	int	No
Start	form	int	No
End	form	int	No
Lunch	form	int	No

**CustomSchedule** Parameters:
Name	Parameter	Data Type	Required
Date	form	string	No
Start	form	int	No
End	form	int	No
Type	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.

POST /{Workspace}/User/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Users">
  <ActualRoute xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:Location>
      <d2p1:x>0</d2p1:x>
      <d2p1:y>0</d2p1:y>
    </d2p1:Location>
  </ActualRoute>
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:City>String</d2p1:City>
    <d2p1:ContactEmail>String</d2p1:ContactEmail>
    <d2p1:ContactName>String</d2p1:ContactName>
    <d2p1:ContactPhone>String</d2p1:ContactPhone>
    <d2p1:ContactTitle>String</d2p1:ContactTitle>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:GeocodeFailed>false</d2p1:GeocodeFailed>
    <d2p1:Location>
      <d2p1:x>0</d2p1:x>
      <d2p1:y>0</d2p1:y>
    </d2p1:Location>
    <d2p1:SiteName>String</d2p1:SiteName>
    <d2p1:State>String</d2p1:State>
    <d2p1:Street>String</d2p1:Street>
    <d2p1:Unit>String</d2p1:Unit>
    <d2p1:Zip>String</d2p1:Zip>
  </Address>
  <Assets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Assets>
  <BasedOn>String</BasedOn>
  <Color>String</Color>
  <Created>String</Created>
  <CreatedBy>String</CreatedBy>
  <CustomSchedules>
    <CustomSchedule>
      <Date>String</Date>
      <End>0</End>
      <Start>0</Start>
      <Type>String</Type>
    </CustomSchedule>
  </CustomSchedules>
  <CustomSchedulesEnabled>false</CustomSchedulesEnabled>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Data>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Documents>
  <Email>String</Email>
  <Enabled>false</Enabled>
  <Events xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:EventItem>
      <d2p1:Automatic>false</d2p1:Automatic>
      <d2p1:Barcode>String</d2p1:Barcode>
      <d2p1:Date>String</d2p1:Date>
      <d2p1:DateCreated>String</d2p1:DateCreated>
      <d2p1:Details>String</d2p1:Details>
      <d2p1:IsScan>false</d2p1:IsScan>
      <d2p1:Location>
        <d2p1:x>0</d2p1:x>
        <d2p1:y>0</d2p1:y>
      </d2p1:Location>
      <d2p1:ObjectId>String</d2p1:ObjectId>
      <d2p1:SelectedBy>String</d2p1:SelectedBy>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:StatusType>String</d2p1:StatusType>
      <d2p1:Type>String</d2p1:Type>
      <d2p1:User>String</d2p1:User>
    </d2p1:EventItem>
  </Events>
  <ExternalAuth>false</ExternalAuth>
  <ExternalId>String</ExternalId>
  <Image>String</Image>
  <Initials>String</Initials>
  <LastUpdated>String</LastUpdated>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:x>0</d2p1:x>
    <d2p1:y>0</d2p1:y>
  </Location>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <OverrideSso>false</OverrideSso>
  <Password>String</Password>
  <Phone>String</Phone>
  <ProposedRoute xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:Location>
      <d2p1:x>0</d2p1:x>
      <d2p1:y>0</d2p1:y>
    </d2p1:Location>
  </ProposedRoute>
  <RecordStatus>String</RecordStatus>
  <RequestUser>String</RequestUser>
  <ServiceAccount>false</ServiceAccount>
  <SkillTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SkillTags>
  <SubscribeToEmails>false</SubscribeToEmails>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TfaPreference>String</TfaPreference>
  <TfaRequired>false</TfaRequired>
  <TimeZone>String</TimeZone>
  <UIPrefTaskColumns xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:UIColumnPref>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Width>0</d2p1:Width>
    </d2p1:UIColumnPref>
  </UIPrefTaskColumns>
  <UIPrefTaskColumnsOff xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UIPrefTaskColumnsOff>
  <UserStatus>NotStarted</UserStatus>
  <UserType>String</UserType>
  <VehicleAsset>String</VehicleAsset>
  <VersionId>String</VersionId>
  <WorkWeek xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Workspaces">
    <d2p1:WorkDay>
      <d2p1:DayOfWeek>0</d2p1:DayOfWeek>
      <d2p1:End>0</d2p1:End>
      <d2p1:Lunch>0</d2p1:Lunch>
      <d2p1:Start>0</d2p1:Start>
    </d2p1:WorkDay>
  </WorkWeek>
  <Workspace>String</Workspace>
</User>