Field Squared API Services

UserImport

Bulk import a set of users.

The following routes are available for this service:
POST	/{Workspace}/UserImport

**UserImport** Parameters:
Name	Parameter	Data Type	Required
Workspace	path	string	No
Users	body	List<User>	No
RequestId	body	string	No

**User** Parameters:
Name	Parameter	Data Type	Required
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
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}/UserImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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