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 'package:servicestack/servicestack.dart';

class PortalUser implements IConvertible
{
    String? Workspace;
    String? ObjectId;
    String? Created;
    String? LastUpdated;
    String? ActivationEmailSent;
    String? Name;
    String? Email;
    String? Password;
    String? PasswordForUpdate;
    String? Phone;
    List<String>? Teams;
    String? TfaPreference;
    bool? UploadPermission;
    bool? DownloadPermission;
    bool? Activated;
    bool? Enabled;
    bool? Locked;
    String? ActivationCode;
    int? FailedLoginAttempts;
    bool? OverrideSso;

    PortalUser({this.Workspace,this.ObjectId,this.Created,this.LastUpdated,this.ActivationEmailSent,this.Name,this.Email,this.Password,this.PasswordForUpdate,this.Phone,this.Teams,this.TfaPreference,this.UploadPermission,this.DownloadPermission,this.Activated,this.Enabled,this.Locked,this.ActivationCode,this.FailedLoginAttempts,this.OverrideSso});
    PortalUser.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        ObjectId = json['ObjectId'];
        Created = json['Created'];
        LastUpdated = json['LastUpdated'];
        ActivationEmailSent = json['ActivationEmailSent'];
        Name = json['Name'];
        Email = json['Email'];
        Password = json['Password'];
        PasswordForUpdate = json['PasswordForUpdate'];
        Phone = json['Phone'];
        Teams = JsonConverters.fromJson(json['Teams'],'List<String>',context!);
        TfaPreference = json['TfaPreference'];
        UploadPermission = json['UploadPermission'];
        DownloadPermission = json['DownloadPermission'];
        Activated = json['Activated'];
        Enabled = json['Enabled'];
        Locked = json['Locked'];
        ActivationCode = json['ActivationCode'];
        FailedLoginAttempts = json['FailedLoginAttempts'];
        OverrideSso = json['OverrideSso'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'ObjectId': ObjectId,
        'Created': Created,
        'LastUpdated': LastUpdated,
        'ActivationEmailSent': ActivationEmailSent,
        'Name': Name,
        'Email': Email,
        'Password': Password,
        'PasswordForUpdate': PasswordForUpdate,
        'Phone': Phone,
        'Teams': JsonConverters.toJson(Teams,'List<String>',context!),
        'TfaPreference': TfaPreference,
        'UploadPermission': UploadPermission,
        'DownloadPermission': DownloadPermission,
        'Activated': Activated,
        'Enabled': Enabled,
        'Locked': Locked,
        'ActivationCode': ActivationCode,
        'FailedLoginAttempts': FailedLoginAttempts,
        'OverrideSso': OverrideSso
    };

    getTypeName() => "PortalUser";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'PortalUser': TypeInfo(TypeOf.Class, create:() => PortalUser()),
});

Dart 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>