Field Squared API Services

<back to all web services

Authentication

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

export class Authentication
{
    public Email: string;
    public Password: string;
    public Code: string;
    public SubscriptionObject: Object;
    public DeviceId: string;

    public constructor(init?: Partial<Authentication>) { (Object as any).assign(this, init); }
}

export class AuthenticationResponse
{
    public AuthToken: string;
    public Workspace: string;
    public UserId: string;
    public Teams: string[];
    public MobileTaskRangePast: number;
    public MobileTaskRangeFuture: number;
    public RetainCustomerDatabase: string;
    public RetainAssetDatabase: string;
    public UserType: string;

    public constructor(init?: Partial<AuthenticationResponse>) { (Object as any).assign(this, init); }
}

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

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

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

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