Evo Voice

PatchUser

Update the specified login

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager

The following routes are available for this service:
PATCH	/users/{userId}

import Foundation
import ServiceStack

/**
* Update the specified login
*/
// @Api(Description="Update the specified login")
public class PatchUser : IPatch, Codable
{
    /**
    * The account IDs that this user has access to
    */
    // @ApiMember(Description="The account IDs that this user has access to")
    public var accountIds:[String]

    /**
    * The ID of the user
    */
    // @ApiMember(Description="The ID of the user")
    public var userId:String

    /**
    * The user's first name
    */
    // @ApiMember(Description="The user's first name")
    public var firstName:String

    /**
    * The user's last name
    */
    // @ApiMember(Description="The user's last name")
    public var lastName:String

    /**
    * The new password for the user (leave null to not change)
    */
    // @ApiMember(Description="The new password for the user (leave null to not change)")
    public var newPassword:String

    /**
    * The roles to associate with the login. Can only specify if system admin
    */
    // @ApiMember(Description="The roles to associate with the login. Can only specify if system admin")
    public var roles:[String]

    required public init(){}
}

public class UserInfo : Codable
{
    public var id:String
    public var isAuthenticated:Bool
    public var firstName:String
    public var lastName:String
    public var name:String
    public var avatarUrl:String
    public var emailAddress:String
    public var roles:[String]
    public var accountIds:[String]
    public var accountNames:[String]
    public var managerAccess:UserManagerAccess
    public var dashboardPermissions:[DashboardPermissions]

    required public init(){}
}

public enum UserManagerAccess : String, Codable
{
    case ReadOnly
    case ReadWrite
    case ReadWriteDelete
}

public enum DashboardPermissions : String, Codable
{
    case ViewFiles
    case ViewNotifications
    case ViewSessions
    case ViewEndpoints
    case ViewReports
    case ViewCustomers
    case ViewFlows
    case ViewCallCenter
}

Swift PatchUser 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.

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>