Field Squared API Services

<back to all web services

PunchReport

Returns an HTML report showing the total clocked in time 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 yyyymmdd.
For year, specify date as yyyy.
Alternatively, these services email a recipient with the report in .csv or .html format.
i.e. /{Workspace}/PunchReport/Week/{Date}/{Recipient}/?format=CSV
/{Workspace}/PunchReport/Week/{Date}/{Recipient}/?format=HTML

The following routes are available for this service:
GET/{Workspace}/PunchReport/Week/{Date}
GET/{Workspace}/PunchReport/Month/{Date}
GET/{Workspace}/PunchReport/Year/{Date}
GET/{Workspace}/PunchReport/Week/{Date}/{Recipient}
GET/{Workspace}/PunchReport/Month/{Date}/{Recipient}
GET/{Workspace}/PunchReport/Year/{Date}/{Recipient}
GET/{Workspace}/PunchReport/{StartDate}/{EndDate}/{Period}
GET/{Workspace}/PunchReport/{StartDate}/{EndDate}/{Period}/{Recipient}
namespace Field2Office.API.Model.Reports.PunchReport

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Returns an HTML report showing the total clocked in time 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 yyyymmdd. For year, specify date as yyyy. Alternatively, these services email a recipient with the report in .csv or .html format. i.e. /{Workspace}/PunchReport/Week/{Date}/{Recipient}/?format=CSV/{Workspace}/PunchReport/Week/{Date}/{Recipient}/?format=HTML
    ///</summary>
    [<AllowNullLiteral>]
    type PunchReport() = 
        member val Date:String = null with get,set
        member val Workspace:String = null with get,set
        member val Recipient:String = null with get,set
        member val StartDate:String = null with get,set
        member val EndDate:String = null with get,set
        member val Period:String = null with get,set

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