Evo Voice

<back to all web services

PatchUser

Update the specified login

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Update the specified login
    */
    @Api(Description="Update the specified login")
    public static class PatchUser implements IPatch
    {
        /**
        * The account IDs that this user has access to
        */
        @ApiMember(Description="The account IDs that this user has access to")
        public ArrayList<String> accountIds = null;

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

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

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

        /**
        * 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 String newPassword = null;

        /**
        * 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 ArrayList<String> roles = null;
        
        public ArrayList<String> getAccountIds() { return accountIds; }
        public PatchUser setAccountIds(ArrayList<String> value) { this.accountIds = value; return this; }
        public String getUserId() { return userId; }
        public PatchUser setUserId(String value) { this.userId = value; return this; }
        public String getFirstName() { return firstName; }
        public PatchUser setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public PatchUser setLastName(String value) { this.lastName = value; return this; }
        public String getNewPassword() { return newPassword; }
        public PatchUser setNewPassword(String value) { this.newPassword = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public PatchUser setRoles(ArrayList<String> value) { this.roles = value; return this; }
    }

    public static class UserInfo
    {
        public String id = null;
        public Boolean isAuthenticated = null;
        public String firstName = null;
        public String lastName = null;
        public String name = null;
        public String avatarUrl = null;
        public String emailAddress = null;
        public ArrayList<String> roles = null;
        public ArrayList<String> accountIds = null;
        public ArrayList<String> accountNames = null;
        public ArrayList<DashboardPermissions> dashboardPermissions = null;
        
        public String getId() { return id; }
        public UserInfo setId(String value) { this.id = value; return this; }
        public Boolean getIsAuthenticated() { return isAuthenticated; }
        public UserInfo setIsAuthenticated(Boolean value) { this.isAuthenticated = value; return this; }
        public String getFirstName() { return firstName; }
        public UserInfo setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public UserInfo setLastName(String value) { this.lastName = value; return this; }
        public String getName() { return name; }
        public UserInfo setName(String value) { this.name = value; return this; }
        public String getAvatarUrl() { return avatarUrl; }
        public UserInfo setAvatarUrl(String value) { this.avatarUrl = value; return this; }
        public String getEmailAddress() { return emailAddress; }
        public UserInfo setEmailAddress(String value) { this.emailAddress = value; return this; }
        public ArrayList<String> getRoles() { return roles; }
        public UserInfo setRoles(ArrayList<String> value) { this.roles = value; return this; }
        public ArrayList<String> getAccountIds() { return accountIds; }
        public UserInfo setAccountIds(ArrayList<String> value) { this.accountIds = value; return this; }
        public ArrayList<String> getAccountNames() { return accountNames; }
        public UserInfo setAccountNames(ArrayList<String> value) { this.accountNames = value; return this; }
        public ArrayList<DashboardPermissions> getDashboardPermissions() { return dashboardPermissions; }
        public UserInfo setDashboardPermissions(ArrayList<DashboardPermissions> value) { this.dashboardPermissions = value; return this; }
    }

    public static enum DashboardPermissions
    {
        ViewFiles,
        ViewNotifications,
        ViewSessions,
        ViewEndpoints,
        ViewReports,
        ViewCustomers,
        ViewFlows;
    }

}

Java 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>
  <Name>String</Name>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Roles>
</UserInfo>