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}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.CustomerPortal;

namespace Field2Office.API.Model.CustomerPortal
{
    public partial class PortalUser
    {
        public PortalUser()
        {
            Teams = new List<string>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string Created { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string ActivationEmailSent { get; set; }
        public virtual string Name { get; set; }
        public virtual string Email { get; set; }
        public virtual string Password { get; set; }
        public virtual string PasswordForUpdate { get; set; }
        public virtual string Phone { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual string TfaPreference { get; set; }
        public virtual bool? UploadPermission { get; set; }
        public virtual bool? DownloadPermission { get; set; }
        public virtual bool Activated { get; set; }
        public virtual bool? Enabled { get; set; }
        public virtual bool? Locked { get; set; }
        public virtual string ActivationCode { get; set; }
        public virtual int? FailedLoginAttempts { get; set; }
        public virtual bool? OverrideSso { get; set; }
    }

}

C# PortalUser DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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}