Evo Voice

<back to all web services

PatchUser

Update the specified login

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Authentication;
using Voice.Api.Endpoints;

namespace Voice.Api.Authentication
{
    public enum DashboardPermissions
    {
        ViewFiles,
        ViewNotifications,
        ViewSessions,
        ViewEndpoints,
        ViewReports,
        ViewCustomers,
        ViewFlows,
        ViewCallCenter,
    }

    ///<summary>
    ///Update the specified login
    ///</summary>
    [Api(Description="Update the specified login")]
    public partial class PatchUser
        : IPatch
    {
        ///<summary>
        ///The account IDs that this user has access to
        ///</summary>
        [ApiMember(Description="The account IDs that this user has access to")]
        public virtual List<string> AccountIds { get; set; }

        ///<summary>
        ///The ID of the user
        ///</summary>
        [ApiMember(Description="The ID of the user")]
        public virtual string UserId { get; set; }

        ///<summary>
        ///The user's first name
        ///</summary>
        [ApiMember(Description="The user's first name")]
        public virtual string FirstName { get; set; }

        ///<summary>
        ///The user's last name
        ///</summary>
        [ApiMember(Description="The user's last name")]
        public virtual string LastName { get; set; }

        ///<summary>
        ///The new password for the user (leave null to not change)
        ///</summary>
        [ApiMember(Description="The new password for the user (leave null to not change)")]
        public virtual string NewPassword { get; set; }

        ///<summary>
        ///The roles to associate with the login. Can only specify if system admin
        ///</summary>
        [ApiMember(Description="The roles to associate with the login. Can only specify if system admin")]
        public virtual List<string> Roles { get; set; }
    }

    public partial class UserInfo
    {
        public virtual string Id { get; set; }
        public virtual bool IsAuthenticated { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string Name { get; set; }
        public virtual string AvatarUrl { get; set; }
        public virtual string EmailAddress { get; set; }
        public virtual List<string> Roles { get; set; }
        public virtual List<string> AccountIds { get; set; }
        public virtual List<string> AccountNames { get; set; }
        public virtual UserManagerAccess ManagerAccess { get; set; }
        public virtual List<DashboardPermissions> DashboardPermissions { get; set; }
    }

}

namespace Voice.Api.Endpoints
{
    public enum UserManagerAccess
    {
        ReadOnly,
        ReadWrite,
        ReadWriteDelete,
    }

}

C# PatchUser DTOs

PATCH /users/{userId} HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountIds>
  <FirstName>String</FirstName>
  <LastName>String</LastName>
  <NewPassword>String</NewPassword>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
  <UserId>String</UserId>
</PatchUser>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Authentication">
  <AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountIds>
  <AccountNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AccountNames>
  <AvatarUrl>String</AvatarUrl>
  <DashboardPermissions>
    <DashboardPermissions>ViewFiles</DashboardPermissions>
  </DashboardPermissions>
  <EmailAddress>String</EmailAddress>
  <FirstName>String</FirstName>
  <Id>String</Id>
  <IsAuthenticated>false</IsAuthenticated>
  <LastName>String</LastName>
  <ManagerAccess>ReadOnly</ManagerAccess>
  <Name>String</Name>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</UserInfo>