Field Squared API Services

UserLocation

Service representing a UserLocation in a workspace.

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


export class Location
{
    public y: number;
    public x: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export enum UserStatus
{
    NotStarted = 'NotStarted',
    Driving = 'Driving',
    InProgress = 'InProgress',
    Complete = 'Complete',
    Blocked = 'Blocked',
}

/** @description Service representing a UserLocation in a workspace. */
export class UserLocation extends Location
{
    public Workspace: string;
    public ObjectId: string;
    public VersionId: string;
    public BasedOn: string;
    public UserStatus: UserStatus;

    public constructor(init?: Partial<UserLocation>) { super(init); (Object as any).assign(this, init); }
}

TypeScript UserLocation 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}/UserLocation/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	ObjectId: String,
	VersionId: String,
	BasedOn: String,
	UserStatus: NotStarted,
	y: 0,
	x: 0
}