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}

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalUser:
    workspace: Optional[str] = None
    object_id: Optional[str] = None
    created: Optional[str] = None
    last_updated: Optional[str] = None
    activation_email_sent: Optional[str] = None
    name: Optional[str] = None
    email: Optional[str] = None
    password: Optional[str] = None
    password_for_update: Optional[str] = None
    phone: Optional[str] = None
    teams: Optional[List[str]] = None
    tfa_preference: Optional[str] = None
    upload_permission: Optional[bool] = None
    download_permission: Optional[bool] = None
    activated: bool = False
    enabled: Optional[bool] = None
    locked: Optional[bool] = None
    activation_code: Optional[str] = None
    failed_login_attempts: Optional[int] = None
    override_sso: Optional[bool] = None

Python PortalUser DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<PortalUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.CustomerPortal">
  <Activated>false</Activated>
  <ActivationCode>String</ActivationCode>
  <ActivationEmailSent>String</ActivationEmailSent>
  <Created>String</Created>
  <DownloadPermission>false</DownloadPermission>
  <Email>String</Email>
  <Enabled>false</Enabled>
  <FailedLoginAttempts>0</FailedLoginAttempts>
  <LastUpdated>String</LastUpdated>
  <Locked>false</Locked>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <OverrideSso>false</OverrideSso>
  <Password>String</Password>
  <PasswordForUpdate>String</PasswordForUpdate>
  <Phone>String</Phone>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TfaPreference>String</TfaPreference>
  <UploadPermission>false</UploadPermission>
  <Workspace>String</Workspace>
</PortalUser>