Field Squared API Services

<back to all web services

PortalUser

The following routes are available for this service:
GET/{Workspace}/CustomerPortal/User/{ObjectId}
PATCH/{Workspace}/CustomerPortal/User
GET, PUT, POST, PATCH, DELETE/{Workspace}/PortalUser
GET, DELETE/{Workspace}/PortalUser/{ObjectId}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class PortalUser
    {
        public String Workspace = null;
        public String ObjectId = null;
        public String Created = null;
        public String LastUpdated = null;
        public String ActivationEmailSent = null;
        public String Name = null;
        public String Email = null;
        public String Password = null;
        public String PasswordForUpdate = null;
        public String Phone = null;
        public ArrayList<String> Teams = null;
        public String TfaPreference = null;
        public Boolean UploadPermission = null;
        public Boolean DownloadPermission = null;
        public Boolean Activated = null;
        public Boolean Enabled = null;
        public Boolean Locked = null;
        public String ActivationCode = null;
        public Integer FailedLoginAttempts = null;
        public Boolean OverrideSso = null;
        
        public String getWorkspace() { return Workspace; }
        public PortalUser setWorkspace(String value) { this.Workspace = value; return this; }
        public String getObjectId() { return ObjectId; }
        public PortalUser setObjectId(String value) { this.ObjectId = value; return this; }
        public String getCreated() { return Created; }
        public PortalUser setCreated(String value) { this.Created = value; return this; }
        public String getLastUpdated() { return LastUpdated; }
        public PortalUser setLastUpdated(String value) { this.LastUpdated = value; return this; }
        public String getActivationEmailSent() { return ActivationEmailSent; }
        public PortalUser setActivationEmailSent(String value) { this.ActivationEmailSent = value; return this; }
        public String getName() { return Name; }
        public PortalUser setName(String value) { this.Name = value; return this; }
        public String getEmail() { return Email; }
        public PortalUser setEmail(String value) { this.Email = value; return this; }
        public String getPassword() { return Password; }
        public PortalUser setPassword(String value) { this.Password = value; return this; }
        public String getPasswordForUpdate() { return PasswordForUpdate; }
        public PortalUser setPasswordForUpdate(String value) { this.PasswordForUpdate = value; return this; }
        public String getPhone() { return Phone; }
        public PortalUser setPhone(String value) { this.Phone = value; return this; }
        public ArrayList<String> getTeams() { return Teams; }
        public PortalUser setTeams(ArrayList<String> value) { this.Teams = value; return this; }
        public String getTfaPreference() { return TfaPreference; }
        public PortalUser setTfaPreference(String value) { this.TfaPreference = value; return this; }
        public Boolean isUploadPermission() { return UploadPermission; }
        public PortalUser setUploadPermission(Boolean value) { this.UploadPermission = value; return this; }
        public Boolean isDownloadPermission() { return DownloadPermission; }
        public PortalUser setDownloadPermission(Boolean value) { this.DownloadPermission = value; return this; }
        public Boolean isActivated() { return Activated; }
        public PortalUser setActivated(Boolean value) { this.Activated = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public PortalUser setEnabled(Boolean value) { this.Enabled = value; return this; }
        public Boolean isLocked() { return Locked; }
        public PortalUser setLocked(Boolean value) { this.Locked = value; return this; }
        public String getActivationCode() { return ActivationCode; }
        public PortalUser setActivationCode(String value) { this.ActivationCode = value; return this; }
        public Integer getFailedLoginAttempts() { return FailedLoginAttempts; }
        public PortalUser setFailedLoginAttempts(Integer value) { this.FailedLoginAttempts = value; return this; }
        public Boolean isOverrideSso() { return OverrideSso; }
        public PortalUser setOverrideSso(Boolean value) { this.OverrideSso = value; return this; }
    }

}

Java PortalUser 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 /{Workspace}/PortalUser HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	ObjectId: String,
	Created: String,
	LastUpdated: String,
	ActivationEmailSent: String,
	Name: String,
	Email: String,
	Password: String,
	PasswordForUpdate: String,
	Phone: String,
	Teams: 
	[
		String
	],
	TfaPreference: String,
	UploadPermission: False,
	DownloadPermission: False,
	Activated: False,
	Enabled: False,
	Locked: False,
	ActivationCode: String,
	FailedLoginAttempts: 0,
	OverrideSso: False
}