Field Squared API Services

UserImport

Bulk import a set of users.

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Location:
    y: float = 0.0
    x: float = 0.0


class UserStatus(str, Enum):
    NOT_STARTED = 'NotStarted'
    DRIVING = 'Driving'
    IN_PROGRESS = 'InProgress'
    COMPLETE = 'Complete'
    BLOCKED = 'Blocked'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Address:
    street: Optional[str] = None
    unit: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    zip: Optional[str] = None
    contact_title: Optional[str] = None
    contact_name: Optional[str] = None
    contact_phone: Optional[str] = None
    contact_email: Optional[str] = None
    location: Optional[Location] = None
    site_name: Optional[str] = None
    geocode_failed: bool = False
    country: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UIColumnPref:
    name: Optional[str] = None
    width: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventItem:
    object_id: Optional[str] = None
    date: Optional[str] = None
    location: Optional[Location] = None
    barcode: Optional[str] = None
    details: Optional[str] = None
    type: Optional[str] = None
    is_scan: bool = False
    user: Optional[str] = None
    selected_by: Optional[str] = None
    status: Optional[str] = None
    status_type: Optional[str] = None
    date_created: Optional[str] = None
    automatic: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkDay:
    day_of_week: int = 0
    start: int = 0
    end: int = 0
    lunch: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomSchedule:
    date: Optional[str] = None
    start: int = 0
    end: int = 0
    type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class 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.
    """

    workspace: Optional[str] = None
    time_zone: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    created: Optional[str] = None
    last_updated: Optional[str] = None
    based_on: Optional[str] = None
    external_id: Optional[str] = None
    name: Optional[str] = None
    initials: Optional[str] = None
    phone: Optional[str] = None
    email: Optional[str] = None
    password: Optional[str] = None
    request_user: Optional[str] = None
    location: Optional[Location] = None
    user_type: Optional[str] = None
    proposed_route: Optional[List[Location]] = None
    actual_route: Optional[List[Location]] = None
    image: Optional[str] = None
    user_status: Optional[UserStatus] = None
    record_status: Optional[str] = None
    documents: Optional[List[str]] = None
    subscribe_to_emails: bool = False
    address: Optional[Address] = None
    skill_tags: Optional[List[str]] = None
    enabled: bool = False
    ui_pref_task_columns_off: Optional[List[str]] = None
    ui_pref_task_columns: Optional[List[UIColumnPref]] = None
    data: Optional[Dict[str, str]] = None
    teams: Optional[List[str]] = None
    events: Optional[List[EventItem]] = None
    color: Optional[str] = None
    vehicle_asset: Optional[str] = None
    external_auth: bool = False
    created_by: Optional[str] = None
    service_account: bool = False
    assets: Optional[List[str]] = None
    tfa_required: bool = False
    tfa_preference: Optional[str] = None
    work_week: Optional[List[WorkDay]] = None
    custom_schedules_enabled: bool = False
    custom_schedules: Optional[List[CustomSchedule]] = None
    override_sso: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserImport:
    """
    Bulk import a set of users.
    """

    workspace: Optional[str] = None
    users: Optional[List[User]] = None
    request_id: Optional[str] = None

Python UserImport DTOs

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>