Field Squared API Services

<back to all web services

SideTrips

Returns an HTML report showing the side trip details for each task completed by the team for the specified day/week/month/year.
For day, specify the date as yyyymmdd. For week, specify the date as yyyymmdd.
This date represents Sunday (1st day of the week) for the week to return. For month, specify the date as yyyymm.
For year, specify the date as yyyy.
Alternatively, these services email a recipient with the report in .csv or .html format.
i.e. /{Workspace}/SideTrips/Week/{Date}/{Recipient}/?format=CSV
/{Workspace}/SideTrips/Week/{Date}/{Recipient}/?format=HTML

The following routes are available for this service:
GET/{Workspace}/SideTrips/Day/{Date}
GET/{Workspace}/SideTrips/Week/{Date}
GET/{Workspace}/SideTrips/Month/{Date}
GET/{Workspace}/SideTrips/Year/{Date}
GET/{Workspace}/SideTrips/Task/{Task}
GET/{Workspace}/SideTrips/Day/{Date}/{Recipient}
GET/{Workspace}/SideTrips/Week/{Date}/{Recipient}
GET/{Workspace}/SideTrips/Month/{Date}/{Recipient}
GET/{Workspace}/SideTrips/Year/{Date}/{Recipient}
GET/{Workspace}/SideTrips/Task/{Task}/{Recipient}
GET/{Workspace}/SideTrips/{StartDate}/{EndDate}/{Period}
GET/{Workspace}/SideTrips/Day/{Date}/User/{User}
GET/{Workspace}/SideTrips/Week/{Date}/User/{User}
GET/{Workspace}/SideTrips/Month/{Date}/User/{User}
GET/{Workspace}/SideTrips/Year/{Date}/User/{User}
GET/{Workspace}/SideTrips/{StartDate}/{EndDate}/{Period}/{Recipient}
GET/{Workspace}/SideTrips/Day/{Date}/User/{User}/{Recipient}
GET/{Workspace}/SideTrips/Week/{Date}/User/{User}/{Recipient}
GET/{Workspace}/SideTrips/Month/{Date}/User/{User}/{Recipient}
GET/{Workspace}/SideTrips/Year/{Date}/User/{User}/{Recipient}
import Foundation
import ServiceStack

/**
* Returns an HTML report showing the side trip details for each task completed by the team for the specified  day/week/month/year. For day, specify the date as yyyymmdd.  For week, specify the date as yyyymmdd.  This date represents Sunday (1st day of the week) for the week to return.  For month, specify the date as yyyymm.  For year, specify the date as yyyy.  Alternatively, these services email a recipient with the report in .csv or .html format. i.e. /{Workspace}/SideTrips/Week/{Date}/{Recipient}/?format=CSV/{Workspace}/SideTrips/Week/{Date}/{Recipient}/?format=HTML
*/
public class SideTrips : Codable
{
    public var date:String
    public var workspace:String
    public var recipient:String
    public var user:String
    public var task:String
    public var startDate:String
    public var endDate:String
    public var period:String

    required public init(){}
}

Swift SideTrips 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}/SideTrips/Day/{Date} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv