Evo Voice

<back to all web services

ListUsers

Gets the users for the specified account

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

namespace Voice.Api
{
    public partial class EntityInfo
    {
        ///<summary>
        ///The ID of the object
        ///</summary>
        [ApiMember(Description="The ID of the object")]
        public virtual string Id { get; set; }

        ///<summary>
        ///The date the object was created
        ///</summary>
        [ApiMember(Description="The date the object was created")]
        public virtual string DateCreated { get; set; }

        ///<summary>
        ///The date the object was last modified
        ///</summary>
        [ApiMember(Description="The date the object was last modified")]
        public virtual string DateLastModified { get; set; }

        ///<summary>
        ///The user that created this object
        ///</summary>
        [ApiMember(Description="The user that created this object")]
        public virtual string CreatedBy { get; set; }

        ///<summary>
        ///The user that last modified this object
        ///</summary>
        [ApiMember(Description="The user that last modified this object")]
        public virtual string LastModifiedBy { get; set; }
    }

    public partial class ListRequest<T>
        : IGet
    {
        public ListRequest()
        {
            SpecificIds = new List<string>{};
        }

        ///<summary>
        ///The page of data to retrieve
        ///</summary>
        [ApiMember(Description="The page of data to retrieve")]
        public virtual int Page { get; set; }

        ///<summary>
        ///If you want all objects to be returned. This should be used with care
        ///</summary>
        [ApiMember(Description="If you want all objects to be returned. This should be used with care")]
        public virtual bool All { get; set; }

        ///<summary>
        ///The number per page to retrieve
        ///</summary>
        [ApiMember(Description="The number per page to retrieve")]
        public virtual int CountPerPage { get; set; }

        ///<summary>
        ///Specific IDs
        ///</summary>
        [ApiMember(Description="Specific IDs")]
        public virtual List<string> SpecificIds { get; set; }

        ///<summary>
        ///Specify a sort field
        ///</summary>
        [ApiMember(Description="Specify a sort field")]
        public virtual string SortField { get; set; }

        ///<summary>
        ///Specify a sort order
        ///</summary>
        [ApiMember(Description="Specify a sort order")]
        public virtual SortOrders SortOrder { get; set; }

        ///<summary>
        ///Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
        ///</summary>
        [ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")]
        public virtual bool SimplifiedPaging { get; set; }
    }

    public partial class ListResponse<AccountInfo>
    {
        public ListResponse()
        {
            Items = new List<AccountInfo>{};
        }

        ///<summary>
        ///The items
        ///</summary>
        [ApiMember(Description="The items")]
        public virtual List<AccountInfo> Items { get; set; }

        ///<summary>
        ///The total number of items
        ///</summary>
        [ApiMember(Description="The total number of items")]
        public virtual int TotalCount { get; set; }

        ///<summary>
        ///The total number of pages
        ///</summary>
        [ApiMember(Description="The total number of pages")]
        public virtual int TotalPages { get; set; }

        ///<summary>
        ///Are there more pages of items? Used with simplified paging
        ///</summary>
        [ApiMember(Description="Are there more pages of items? Used with simplified paging")]
        public virtual bool HasMorePages { get; set; }
    }

    public enum SortOrders
    {
        Ascend,
        Descend,
    }

}

namespace Voice.Api.Accounts
{
    public partial class AccountInfo
        : EntityInfo
    {
        public AccountInfo()
        {
            AncestorIds = new List<string>{};
        }

        ///<summary>
        ///The name of this account
        ///</summary>
        [ApiMember(Description="The name of this account")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The ID of this account's parent
        ///</summary>
        [ApiMember(Description="The ID of this account's parent")]
        public virtual string ParentAccountId { get; set; }

        ///<summary>
        ///The twilio account SID
        ///</summary>
        [ApiMember(Description="The twilio account SID")]
        public virtual string TwilioAccountSid { get; set; }

        ///<summary>
        ///The ancestors of this account. Useful for breadcrumbs
        ///</summary>
        [ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")]
        public virtual List<string> AncestorIds { get; set; }

        ///<summary>
        ///The max number of phone numbers this account can have
        ///</summary>
        [ApiMember(Description="The max number of phone numbers this account can have")]
        public virtual int MaxPhoneNumbers { get; set; }

        ///<summary>
        ///This account is BYOA
        ///</summary>
        [ApiMember(Description="This account is BYOA")]
        public virtual bool IsBYOA { get; set; }

        ///<summary>
        ///TrustHub Profile Sid
        ///</summary>
        [ApiMember(Description="TrustHub Profile Sid")]
        public virtual string TrustHubProfileSid { get; set; }

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

        ///<summary>
        ///The URI of the logo file
        ///</summary>
        [ApiMember(Description="The URI of the logo file")]
        public virtual string LogoUri { get; set; }

        ///<summary>
        ///The billing settings for this account
        ///</summary>
        [ApiMember(Description="The billing settings for this account")]
        public virtual BillingSettings BillingSettings { get; set; }
    }

    public partial class BillingItem
    {
        public virtual double BaseCost { get; set; }
        public virtual double RawUnitMultiplier { get; set; }
        public virtual double UnitCost { get; set; }
        public virtual int Allowance { get; set; }
    }

    public partial class BillingSettings
    {
        public virtual BillingItem Base { get; set; }
        public virtual BillingItem LocalNumbers { get; set; }
        public virtual BillingItem TollFreeNumbers { get; set; }
        public virtual BillingItem InboundVoiceCalls { get; set; }
        public virtual BillingItem OutboundVoiceCalls { get; set; }
        public virtual BillingItem InboundFaxes { get; set; }
        public virtual BillingItem OutboundFaxes { get; set; }
        public virtual BillingItem InboundSmsMessages { get; set; }
        public virtual BillingItem OutboundSmsMessages { get; set; }
    }

}

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

    ///<summary>
    ///Gets the users for the specified account
    ///</summary>
    [Api(Description="Gets the users for the specified account")]
    public partial class ListUsers
        : ListRequest<UserInfo>
    {
        public ListUsers()
        {
            AccountIds = new List<string>{};
        }

        ///<summary>
        ///The account IDs whose users you want to retrieve
        ///</summary>
        [ApiMember(Description="The account IDs whose users you want to retrieve")]
        public virtual List<string> AccountIds { get; set; }

        ///<summary>
        ///Filter by email
        ///</summary>
        [ApiMember(Description="Filter by email")]
        public virtual string EmailFilter { get; set; }
    }

    public partial class UserInfo
    {
        public UserInfo()
        {
            Roles = new List<string>{};
            AccountIds = new List<string>{};
            AccountNames = new List<string>{};
            DashboardPermissions = new List<DashboardPermissions>{};
        }

        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 List<DashboardPermissions> DashboardPermissions { get; set; }
    }

}

C# ListUsers DTOs

GET /users HTTP/1.1 
Host: evovoice.io 
Accept: application/json

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

{"items":[{"id":"String","isAuthenticated":false,"firstName":"String","lastName":"String","name":"String","avatarUrl":"String","emailAddress":"String","roles":["String"],"accountIds":["String"],"accountNames":["String"],"dashboardPermissions":["ViewFiles"]}],"totalCount":0,"totalPages":0,"hasMorePages":false}