Field Squared API Services

UserSummary

Returns a user summary report for the period. Date format is yyyymmdd.

The following routes are available for this service:
GET	/{Workspace}/UserSummary/{StartDate}/{EndDate}/{Period}
GET	/{Workspace}/UserSummary/{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 UserSummary:
    """
    Returns a user summary report for the period.  Date format is yyyymmdd.  
    """

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

Python UserSummary 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}/UserSummary/{StartDate}/{EndDate}/{Period} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv