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}

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.CustomerPortal

Namespace Global

    Namespace Field2Office.API.Model.CustomerPortal

        Public Partial Class PortalUser
            Public Sub New()
                Teams = New List(Of String)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property Created As String
            Public Overridable Property LastUpdated As String
            Public Overridable Property ActivationEmailSent As String
            Public Overridable Property Name As String
            Public Overridable Property Email As String
            Public Overridable Property Password As String
            Public Overridable Property PasswordForUpdate As String
            Public Overridable Property Phone As String
            Public Overridable Property Teams As List(Of String)
            Public Overridable Property TfaPreference As String
            Public Overridable Property UploadPermission As Nullable(Of Boolean)
            Public Overridable Property DownloadPermission As Nullable(Of Boolean)
            Public Overridable Property Activated As Boolean
            Public Overridable Property Enabled As Nullable(Of Boolean)
            Public Overridable Property Locked As Nullable(Of Boolean)
            Public Overridable Property ActivationCode As String
            Public Overridable Property FailedLoginAttempts As Nullable(Of Integer)
            Public Overridable Property OverrideSso As Nullable(Of Boolean)
        End Class
    End Namespace
End Namespace

VB.NET 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}