Field Squared API Services

<back to all web services

Authentication

The following routes are available for this service:
POST/Authentication
import Foundation
import ServiceStack

public class Authentication : Codable
{
    public var email:String
    public var password:String
    public var code:String
    //subscriptionObject:Object ignored. Type could not be extended in Swift
    public var deviceId:String

    required public init(){}
}

public class AuthenticationResponse : Codable
{
    public var authToken:String
    public var workspace:String
    public var userId:String
    public var teams:[String] = []
    public var mobileTaskRangePast:Int
    public var mobileTaskRangeFuture:Int
    public var retainCustomerDatabase:String
    public var retainAssetDatabase:String
    public var userType:String

    required public init(){}
}


Swift 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
}