Field Squared API Services

<back to all web services

Authentication

The following routes are available for this service:
POST/Authentication
namespace Field2Office.API.Model.Authentication

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

    [<AllowNullLiteral>]
    type Authentication() = 
        member val Email:String = null with get,set
        member val Password:String = null with get,set
        member val Code:String = null with get,set
        member val SubscriptionObject:Object = null with get,set
        member val DeviceId:String = null with get,set

    [<AllowNullLiteral>]
    type AuthenticationResponse() = 
        member val AuthToken:String = null with get,set
        member val Workspace:String = null with get,set
        member val UserId:String = null with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val MobileTaskRangePast:Int32 = new Int32() with get,set
        member val MobileTaskRangeFuture:Int32 = new Int32() with get,set
        member val RetainCustomerDatabase:String = null with get,set
        member val RetainAssetDatabase:String = null with get,set
        member val UserType:String = null with get,set

F# Authentication DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Authentication HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Email":"String","Password":"String","Code":"String","SubscriptionObject":{},"DeviceId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"AuthToken":"String","Workspace":"String","UserId":"String","Teams":["String"],"MobileTaskRangePast":0,"MobileTaskRangeFuture":0,"RetainCustomerDatabase":"String","RetainAssetDatabase":"String","UserType":"String"}