Field Squared API Services

<back to all web services

UserLocationList

Returns a list of all user's locations for the entire workspace.

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 UserLocation(Location):
    """
    Service representing a UserLocation in a workspace.
    """

    workspace: Optional[str] = None
    object_id: Optional[str] = None
    version_id: Optional[str] = None
    based_on: Optional[str] = None
    user_status: Optional[UserStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserLocationList:
    """
    Returns a list of all user's locations for the entire workspace.
    """

    workspace: Optional[str] = None
    date_generated: Optional[str] = None
    user_locations: Optional[List[UserLocation]] = None

Python UserLocationList DTOs

GET /{Workspace}/UserLocationList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv