Field Squared API Services

<back to all web services

Mileage

Returns an HTML report showing the mileage for the team for the week/month/year. 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}/Mileage/Week/{Date}/{Recipient}/?format=CSV
/{Workspace}/Mileage/Week/{Date}/{Recipient}/?format=HTML

The following routes are available for this service:
GET/{Workspace}/Mileage/Week/{Date}
GET/{Workspace}/Mileage/Month/{Date}
GET/{Workspace}/Mileage/Year/{Date}
GET/{Workspace}/Direct/{RequestKey}/Mileage/Week/{Date}
GET/{Workspace}/Direct/{RequestKey}/Mileage/Month/{Date}
GET/{Workspace}/Direct/{RequestKey}/Mileage/Year/{Date}
GET/{Workspace}/Mileage/Week/{Date}/{Recipient}
GET/{Workspace}/Mileage/Month/{Date}/{Recipient}
GET/{Workspace}/Mileage/Year/{Date}/{Recipient}
GET/{Workspace}/Mileage/{StartDate}/{EndDate}/{Period}
GET/{Workspace}/Mileage/{StartDate}/{EndDate}/{Period}/{Recipient}
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Returns an HTML report showing the mileage for the team for the week/month/year.  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}/Mileage/Week/{Date}/{Recipient}/?format=CSV/{Workspace}/Mileage/Week/{Date}/{Recipient}/?format=HTML
*/
open class Mileage
{
    var Date:String? = null
    var Workspace:String? = null
    var Recipient:String? = null
    var RequestKey:String? = null
    var StartDate:String? = null
    var EndDate:String? = null
    var Period:String? = null
}

Kotlin Mileage 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}/Mileage/Week/{Date} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv