| Requires any of the roles: | SystemAdministrator, Manager |
| GET | /users |
|---|
namespace Voice.Api
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type DashboardPermissions =
| ViewFiles = 0
| ViewNotifications = 1
| ViewSessions = 2
| ViewEndpoints = 3
| ViewReports = 4
| ViewCustomers = 5
| ViewFlows = 6
[<AllowNullLiteral>]
type UserInfo() =
member val Id:String = null with get,set
member val IsAuthenticated:Boolean = new Boolean() with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Name:String = null with get,set
member val AvatarUrl:String = null with get,set
member val EmailAddress:String = null with get,set
member val Roles:ResizeArray<String> = null with get,set
member val AccountIds:ResizeArray<String> = null with get,set
member val AccountNames:ResizeArray<String> = null with get,set
member val DashboardPermissions:ResizeArray<DashboardPermissions> = null with get,set
type SortOrders =
| Ascend = 0
| Descend = 1
[<AllowNullLiteral>]
type ListRequest<T>() =
interface IGet
///<summary>
///The page of data to retrieve
///</summary>
[<ApiMember(Description="The page of data to retrieve")>]
member val Page:Int32 = new Int32() with 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")>]
member val All:Boolean = new Boolean() with get,set
///<summary>
///The number per page to retrieve
///</summary>
[<ApiMember(Description="The number per page to retrieve")>]
member val CountPerPage:Int32 = new Int32() with get,set
///<summary>
///Specific IDs
///</summary>
[<ApiMember(Description="Specific IDs")>]
member val SpecificIds:ResizeArray<String> = null with get,set
///<summary>
///Specify a sort field
///</summary>
[<ApiMember(Description="Specify a sort field")>]
member val SortField:String = null with get,set
///<summary>
///Specify a sort order
///</summary>
[<ApiMember(Description="Specify a sort order")>]
member val SortOrder:SortOrders = new SortOrders() with 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")>]
member val SimplifiedPaging:Boolean = new Boolean() with get,set
///<summary>
///Gets the users for the specified account
///</summary>
[<Api(Description="Gets the users for the specified account")>]
[<AllowNullLiteral>]
type ListUsers() =
inherit ListRequest<UserInfo>()
///<summary>
///The account IDs whose users you want to retrieve
///</summary>
[<ApiMember(Description="The account IDs whose users you want to retrieve")>]
member val AccountIds:ResizeArray<String> = null with get,set
///<summary>
///Filter by email
///</summary>
[<ApiMember(Description="Filter by email")>]
member val EmailFilter:String = null with get,set
[<AllowNullLiteral>]
type EntityInfo() =
///<summary>
///The ID of the object
///</summary>
[<ApiMember(Description="The ID of the object")>]
member val Id:String = null with get,set
///<summary>
///The date the object was created
///</summary>
[<ApiMember(Description="The date the object was created")>]
member val DateCreated:String = null with get,set
///<summary>
///The date the object was last modified
///</summary>
[<ApiMember(Description="The date the object was last modified")>]
member val DateLastModified:String = null with get,set
///<summary>
///The user that created this object
///</summary>
[<ApiMember(Description="The user that created this object")>]
member val CreatedBy:String = null with get,set
///<summary>
///The user that last modified this object
///</summary>
[<ApiMember(Description="The user that last modified this object")>]
member val LastModifiedBy:String = null with get,set
[<AllowNullLiteral>]
type BillingItem() =
member val BaseCost:Double = new Double() with get,set
member val RawUnitMultiplier:Double = new Double() with get,set
member val UnitCost:Double = new Double() with get,set
member val Allowance:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type BillingSettings() =
member val Base:BillingItem = null with get,set
member val LocalNumbers:BillingItem = null with get,set
member val TollFreeNumbers:BillingItem = null with get,set
member val InboundVoiceCalls:BillingItem = null with get,set
member val OutboundVoiceCalls:BillingItem = null with get,set
member val InboundFaxes:BillingItem = null with get,set
member val OutboundFaxes:BillingItem = null with get,set
member val InboundSmsMessages:BillingItem = null with get,set
member val OutboundSmsMessages:BillingItem = null with get,set
member val AIInsights:BillingItem = null with get,set
member val AILiveMinutes:BillingItem = null with get,set
[<AllowNullLiteral>]
type AccountInfo() =
inherit EntityInfo()
///<summary>
///The name of this account
///</summary>
[<ApiMember(Description="The name of this account")>]
member val Name:String = null with get,set
///<summary>
///The ID of this account's parent
///</summary>
[<ApiMember(Description="The ID of this account's parent")>]
member val ParentAccountId:String = null with get,set
///<summary>
///The twilio account SID
///</summary>
[<ApiMember(Description="The twilio account SID")>]
member val TwilioAccountSid:String = null with get,set
///<summary>
///The ancestors of this account. Useful for breadcrumbs
///</summary>
[<ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")>]
member val AncestorIds:ResizeArray<String> = null with 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")>]
member val MaxPhoneNumbers:Int32 = new Int32() with get,set
///<summary>
///This account is BYOA
///</summary>
[<ApiMember(Description="This account is BYOA")>]
member val IsBYOA:Boolean = new Boolean() with get,set
///<summary>
///TrustHub Profile Sid
///</summary>
[<ApiMember(Description="TrustHub Profile Sid")>]
member val TrustHubProfileSid:String = null with get,set
///<summary>
///The ID of the logo file
///</summary>
[<ApiMember(Description="The ID of the logo file")>]
member val LogoId:String = null with get,set
///<summary>
///The URI of the logo file
///</summary>
[<ApiMember(Description="The URI of the logo file")>]
member val LogoUri:String = null with get,set
///<summary>
///The billing settings for this account
///</summary>
[<ApiMember(Description="The billing settings for this account")>]
member val BillingSettings:BillingSettings = null with get,set
[<AllowNullLiteral>]
type ListResponse<T>() =
///<summary>
///The items
///</summary>
[<ApiMember(Description="The items")>]
member val Items:ResizeArray<AccountInfo> = null with get,set
///<summary>
///The total number of items
///</summary>
[<ApiMember(Description="The total number of items")>]
member val TotalCount:Int32 = new Int32() with get,set
///<summary>
///The total number of pages
///</summary>
[<ApiMember(Description="The total number of pages")>]
member val TotalPages:Int32 = new Int32() with 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")>]
member val HasMorePages:Boolean = new Boolean() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users HTTP/1.1 Host: team.evovoice.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}