| GET,POST,PUT,DELETE | /{Workspace}/User/{ObjectId} | ||
|---|---|---|---|
| GET | /{Workspace}/User |
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; }
}
}
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,
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>