Field Squared API Services

<back to all web 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 'package:servicestack/servicestack.dart';

/**
* Returns a user summary report for the period.  Date format is yyyymmdd.  
*/
class UserSummary implements IConvertible
{
    String? StartDate;
    String? EndDate;
    String? Period;
    String? Workspace;
    String? Recipient;

    UserSummary({this.StartDate,this.EndDate,this.Period,this.Workspace,this.Recipient});
    UserSummary.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        StartDate = json['StartDate'];
        EndDate = json['EndDate'];
        Period = json['Period'];
        Workspace = json['Workspace'];
        Recipient = json['Recipient'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'StartDate': StartDate,
        'EndDate': EndDate,
        'Period': Period,
        'Workspace': Workspace,
        'Recipient': Recipient
    };

    getTypeName() => "UserSummary";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'UserSummary': TypeInfo(TypeOf.Class, create:() => UserSummary()),
});

Dart 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