Field Squared API Services

<back to all web services

TimeOnSite

Returns an HTML report showing the time on site 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}/TimeOnSite/Week/{Date}/{Recipient}/?format=CSV
/{Workspace}/TimeOnSite/Week/{Date}/{Recipient}/?format=HTML

The following routes are available for this service:
GET/{Workspace}/TimeOnSite/Week/{Date}
GET/{Workspace}/TimeOnSite/Month/{Date}
GET/{Workspace}/TimeOnSite/Year/{Date}
GET/{Workspace}/TimeOnSite/Week/{Date}/{Recipient}
GET/{Workspace}/TimeOnSite/Month/{Date}/{Recipient}
GET/{Workspace}/TimeOnSite/Year/{Date}/{Recipient}
GET/{Workspace}/TimeOnSite/{StartDate}/{EndDate}/{Period}
GET/{Workspace}/TimeOnSite/{StartDate}/{EndDate}/{Period}/{Recipient}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.TimeOnSite

Namespace Global

    Namespace Field2Office.API.Model.TimeOnSite

        '''<Summary>
        '''Returns an HTML report showing the time on site 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}/TimeOnSite/Week/{Date}/{Recipient}/?format=CSV/{Workspace}/TimeOnSite/Week/{Date}/{Recipient}/?format=HTML
        '''</Summary>
        Public Partial Class TimeOnSite
            Public Overridable Property [Date] As String
            Public Overridable Property Workspace As String
            Public Overridable Property Recipient As String
            Public Overridable Property StartDate As String
            Public Overridable Property EndDate As String
            Public Overridable Property Period As String
        End Class
    End Namespace
End Namespace

VB.NET TimeOnSite DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /{Workspace}/TimeOnSite/Week/{Date} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv