Field Squared API Services

<back to all web services

TimeBreakdown

Returns an HTML report showing the time breakdown report for the team for the day or week. Specify the date as yyyymmdd.
For the week report, this date represents Sunday (1st day of the week) for the week to return.
Alternatively, these services email a recipient with the report in .csv or .html format.
i.e. /{Workspace}/TBR/Day/{Date}/{Recipient}/?format=CSV
/{Workspace}/TBR/Day/{Date}/{Recipient}/?format=HTML

The following routes are available for this service:
GET/{Workspace}/TBR/Day/{Date}
GET/{Workspace}/TBR/Week/{Date}
GET/{Workspace}/TBR/Day/{Date}/{Recipient}
GET/{Workspace}/TBR/Week/{Date}/{Recipient}
GET/{Workspace}/TBR/{StartDate}/{EndDate}/{Period}
GET/{Workspace}/TBR/{StartDate}/{EndDate}/{Period}/{Recipient}
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 TimeBreakdown:
    """
    Returns an HTML report showing the time breakdown report for the team for the day or week.  Specify the date as yyyymmdd.  For the week report, this date represents Sunday (1st day of the week) for the week to return.  Alternatively, these services email a recipient with the report in .csv or .html format. i.e. /{Workspace}/TBR/Day/{Date}/{Recipient}/?format=CSV/{Workspace}/TBR/Day/{Date}/{Recipient}/?format=HTML
    """

    date: Optional[str] = None
    workspace: Optional[str] = None
    recipient: Optional[str] = None
    start_date: Optional[str] = None
    end_date: Optional[str] = None
    period: Optional[str] = None

Python TimeBreakdown 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.

GET /{Workspace}/TBR/Day/{Date} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv