Field Squared API 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}

namespace Field2Office.API.Model.CustomerPortal

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type PortalUser() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val Created:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val ActivationEmailSent:String = null with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val Password:String = null with get,set
        member val PasswordForUpdate:String = null with get,set
        member val Phone:String = null with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val TfaPreference:String = null with get,set
        member val UploadPermission:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val DownloadPermission:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Activated:Boolean = new Boolean() with get,set
        member val Enabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val Locked:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val ActivationCode:String = null with get,set
        member val FailedLoginAttempts:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OverrideSso:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# PortalUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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}