Field Squared API Services

UserImport

Bulk import a set of users.

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Users;
using Field2Office.API.Model;
using Field2Office.DomainObjects;
using Field2Office.API.Model.Workspaces;

namespace Field2Office.API.Model
{
    public partial class Address
    {
        public virtual string Street { get; set; }
        public virtual string Unit { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual string ContactTitle { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string ContactPhone { get; set; }
        public virtual string ContactEmail { get; set; }
        public virtual Location Location { get; set; }
        public virtual string SiteName { get; set; }
        public virtual bool GeocodeFailed { get; set; }
        public virtual string Country { get; set; }
    }

    public partial class EventItem
    {
        public virtual string ObjectId { get; set; }
        public virtual string Date { get; set; }
        public virtual Location Location { get; set; }
        public virtual string Barcode { get; set; }
        public virtual string Details { get; set; }
        public virtual string Type { get; set; }
        public virtual bool IsScan { get; set; }
        public virtual string User { get; set; }
        public virtual string SelectedBy { get; set; }
        public virtual string Status { get; set; }
        public virtual string StatusType { get; set; }
        public virtual string DateCreated { get; set; }
        public virtual bool Automatic { get; set; }
    }

    public partial class Location
    {
        public virtual double y { get; set; }
        public virtual double x { get; set; }
    }

    public partial class UIColumnPref
    {
        public virtual string Name { get; set; }
        public virtual double Width { get; set; }
    }

}

namespace Field2Office.API.Model.Users
{
    public partial class CustomSchedule
    {
        public virtual string Date { get; set; }
        public virtual int Start { get; set; }
        public virtual int End { get; set; }
        public virtual string Type { get; set; }
    }

    ///<summary>
    ///Represents a DTO for a user in a workspace. Calls without an ObjectId will retrieve an array of all user objects for the workspace.
    ///</summary>
    public partial class User
    {
        public User()
        {
            ProposedRoute = new List<Location>{};
            ActualRoute = new List<Location>{};
            Documents = new List<string>{};
            SkillTags = new List<string>{};
            UIPrefTaskColumnsOff = new List<string>{};
            UIPrefTaskColumns = new List<UIColumnPref>{};
            Data = new Dictionary<string, string>{};
            Teams = new List<string>{};
            Events = new List<EventItem>{};
            Assets = new List<string>{};
            WorkWeek = new List<WorkDay>{};
            CustomSchedules = new List<CustomSchedule>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string Created { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string ExternalId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Initials { get; set; }
        public virtual string Phone { get; set; }
        public virtual string Email { get; set; }
        public virtual string Password { get; set; }
        public virtual string RequestUser { get; set; }
        public virtual Location Location { get; set; }
        public virtual string UserType { get; set; }
        public virtual List<Location> ProposedRoute { get; set; }
        public virtual List<Location> ActualRoute { get; set; }
        public virtual string Image { get; set; }
        public virtual UserStatus UserStatus { get; set; }
        public virtual string RecordStatus { get; set; }
        public virtual List<string> Documents { get; set; }
        public virtual bool SubscribeToEmails { get; set; }
        public virtual Address Address { get; set; }
        public virtual List<string> SkillTags { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual List<string> UIPrefTaskColumnsOff { get; set; }
        public virtual List<UIColumnPref> UIPrefTaskColumns { get; set; }
        public virtual Dictionary<string, string> Data { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual List<EventItem> Events { get; set; }
        public virtual string Color { get; set; }
        public virtual string VehicleAsset { get; set; }
        public virtual bool ExternalAuth { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual bool ServiceAccount { get; set; }
        public virtual List<string> Assets { get; set; }
        public virtual bool TfaRequired { get; set; }
        public virtual string TfaPreference { get; set; }
        public virtual List<WorkDay> WorkWeek { get; set; }
        public virtual bool CustomSchedulesEnabled { get; set; }
        public virtual List<CustomSchedule> CustomSchedules { get; set; }
        public virtual bool OverrideSso { get; set; }
    }

    ///<summary>
    ///Bulk import a set of users.
    ///</summary>
    public partial class UserImport
    {
        public UserImport()
        {
            Users = new List<User>{};
        }

        public virtual string Workspace { get; set; }
        public virtual List<User> Users { get; set; }
        public virtual string RequestId { get; set; }
    }

}

namespace Field2Office.API.Model.Workspaces
{
    public partial class WorkDay
    {
        public virtual int DayOfWeek { get; set; }
        public virtual int Start { get; set; }
        public virtual int End { get; set; }
        public virtual int Lunch { get; set; }
    }

}

namespace Field2Office.DomainObjects
{
    public enum UserStatus
    {
        NotStarted,
        Driving,
        InProgress,
        Complete,
        Blocked,
    }

}

C# UserImport DTOs

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.

POST /{Workspace}/UserImport HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	Users: 
	[
		{
			Workspace: String,
			TimeZone: String,
			ObjectId: String,
			VersionId: String,
			Created: String,
			LastUpdated: String,
			BasedOn: String,
			ExternalId: String,
			Name: String,
			Initials: String,
			Phone: String,
			Email: String,
			Password: String,
			RequestUser: String,
			Location: 
			{
				y: 0,
				x: 0
			},
			UserType: String,
			ProposedRoute: 
			[
				{
					y: 0,
					x: 0
				}
			],
			ActualRoute: 
			[
				{
					y: 0,
					x: 0
				}
			],
			Image: String,
			UserStatus: NotStarted,
			RecordStatus: String,
			Documents: 
			[
				String
			],
			SubscribeToEmails: False,
			Address: 
			{
				Street: String,
				Unit: String,
				City: String,
				State: String,
				Zip: String,
				ContactTitle: String,
				ContactName: String,
				ContactPhone: String,
				ContactEmail: String,
				Location: 
				{
					y: 0,
					x: 0
				},
				SiteName: String,
				GeocodeFailed: False,
				Country: String
			},
			SkillTags: 
			[
				String
			],
			Enabled: False,
			UIPrefTaskColumnsOff: 
			[
				String
			],
			UIPrefTaskColumns: 
			[
				{
					Name: String,
					Width: 0
				}
			],
			Data: 
			{
				String: String
			},
			Teams: 
			[
				String
			],
			Events: 
			[
				{
					ObjectId: String,
					Date: String,
					Location: 
					{
						y: 0,
						x: 0
					},
					Barcode: String,
					Details: String,
					Type: String,
					IsScan: False,
					User: String,
					SelectedBy: String,
					Status: String,
					StatusType: String,
					DateCreated: String,
					Automatic: False
				}
			],
			Color: String,
			VehicleAsset: String,
			ExternalAuth: False,
			CreatedBy: String,
			ServiceAccount: False,
			Assets: 
			[
				String
			],
			TfaRequired: False,
			TfaPreference: String,
			WorkWeek: 
			[
				{
					DayOfWeek: 0,
					Start: 0,
					End: 0,
					Lunch: 0
				}
			],
			CustomSchedulesEnabled: False,
			CustomSchedules: 
			[
				{
					Date: String,
					Start: 0,
					End: 0,
					Type: String
				}
			],
			OverrideSso: False
		}
	],
	RequestId: String
}