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.*


open class PortalUser
{
    var Workspace:String? = null
    var ObjectId:String? = null
    var Created:String? = null
    var LastUpdated:String? = null
    var ActivationEmailSent:String? = null
    var Name:String? = null
    var Email:String? = null
    var Password:String? = null
    var PasswordForUpdate:String? = null
    var Phone:String? = null
    var Teams:ArrayList<String> = ArrayList<String>()
    var TfaPreference:String? = null
    var UploadPermission:Boolean? = null
    var DownloadPermission:Boolean? = null
    var Activated:Boolean? = null
    var Enabled:Boolean? = null
    var Locked:Boolean? = null
    var ActivationCode:String? = null
    var FailedLoginAttempts:Int? = null
    var OverrideSso:Boolean? = null
}

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