Field Squared API Services

<back to all web services

Authentication

The following routes are available for this service:
POST/Authentication
import java.math.*
import java.util.*
import net.servicestack.client.*


open class Authentication
{
    var Email:String? = null
    var Password:String? = null
    var Code:String? = null
    var SubscriptionObject:Object? = null
    var DeviceId:String? = null
}

open class AuthenticationResponse
{
    var AuthToken:String? = null
    var Workspace:String? = null
    var UserId:String? = null
    var Teams:ArrayList<String> = ArrayList<String>()
    var MobileTaskRangePast:Int? = null
    var MobileTaskRangeFuture:Int? = null
    var RetainCustomerDatabase:String? = null
    var RetainAssetDatabase:String? = null
    var UserType:String? = null
}

Kotlin Authentication 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.

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

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

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