| Requires any of the roles: | SystemAdministrator, Manager |
| GET | /users |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
/**
* Gets the users for the specified account
*/
@Api(Description="Gets the users for the specified account")
open class ListUsers : ListRequest<UserInfo>()
{
/**
* The account IDs whose users you want to retrieve
*/
@ApiMember(Description="The account IDs whose users you want to retrieve")
open var accountIds:ArrayList<String>? = null
/**
* Filter by email
*/
@ApiMember(Description="Filter by email")
open var emailFilter:String? = null
}
open class ListRequest<T> : IGet
{
/**
* The page of data to retrieve
*/
@ApiMember(Description="The page of data to retrieve")
open var page:Int? = null
/**
* If you want all objects to be returned. This should be used with care
*/
@ApiMember(Description="If you want all objects to be returned. This should be used with care")
open var all:Boolean? = null
/**
* The number per page to retrieve
*/
@ApiMember(Description="The number per page to retrieve")
open var countPerPage:Int? = null
/**
* Specific IDs
*/
@ApiMember(Description="Specific IDs")
open var specificIds:ArrayList<String>? = null
/**
* Specify a sort field
*/
@ApiMember(Description="Specify a sort field")
open var sortField:String? = null
/**
* Specify a sort order
*/
@ApiMember(Description="Specify a sort order")
open var sortOrder:SortOrders? = null
/**
* Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array
*/
@ApiMember(Description="Disables total / page counts - improves performance. Returns only data. If there is no more data, Items will be empty array")
open var simplifiedPaging:Boolean? = null
}
enum class SortOrders
{
Ascend,
Descend,
}
open class UserInfo
{
open var id:String? = null
open var isAuthenticated:Boolean? = null
open var firstName:String? = null
open var lastName:String? = null
open var name:String? = null
open var avatarUrl:String? = null
open var emailAddress:String? = null
open var roles:ArrayList<String>? = null
open var accountIds:ArrayList<String>? = null
open var accountNames:ArrayList<String>? = null
open var dashboardPermissions:ArrayList<DashboardPermissions>? = null
}
enum class DashboardPermissions
{
ViewFiles,
ViewNotifications,
ViewSessions,
ViewEndpoints,
ViewReports,
ViewCustomers,
ViewFlows,
}
open class ListResponse<T>
{
/**
* The items
*/
@ApiMember(Description="The items")
open var items:ArrayList<AccountInfo>? = null
/**
* The total number of items
*/
@ApiMember(Description="The total number of items")
open var totalCount:Int? = null
/**
* The total number of pages
*/
@ApiMember(Description="The total number of pages")
open var totalPages:Int? = null
/**
* Are there more pages of items? Used with simplified paging
*/
@ApiMember(Description="Are there more pages of items? Used with simplified paging")
open var hasMorePages:Boolean? = null
}
open class AccountInfo : EntityInfo()
{
/**
* The name of this account
*/
@ApiMember(Description="The name of this account")
open var name:String? = null
/**
* The ID of this account's parent
*/
@ApiMember(Description="The ID of this account's parent")
open var parentAccountId:String? = null
/**
* The twilio account SID
*/
@ApiMember(Description="The twilio account SID")
open var twilioAccountSid:String? = null
/**
* The ancestors of this account. Useful for breadcrumbs
*/
@ApiMember(Description="The ancestors of this account. Useful for breadcrumbs")
open var ancestorIds:ArrayList<String>? = null
/**
* The max number of phone numbers this account can have
*/
@ApiMember(Description="The max number of phone numbers this account can have")
open var maxPhoneNumbers:Int? = null
/**
* This account is BYOA
*/
@ApiMember(Description="This account is BYOA")
open var isBYOA:Boolean? = null
/**
* TrustHub Profile Sid
*/
@ApiMember(Description="TrustHub Profile Sid")
open var trustHubProfileSid:String? = null
/**
* The ID of the logo file
*/
@ApiMember(Description="The ID of the logo file")
open var logoId:String? = null
/**
* The URI of the logo file
*/
@ApiMember(Description="The URI of the logo file")
open var logoUri:String? = null
/**
* The billing settings for this account
*/
@ApiMember(Description="The billing settings for this account")
open var billingSettings:BillingSettings? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
open var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
open var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
open var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
open var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
open var lastModifiedBy:String? = null
}
open class BillingSettings
{
open var base:BillingItem? = null
open var localNumbers:BillingItem? = null
open var tollFreeNumbers:BillingItem? = null
open var inboundVoiceCalls:BillingItem? = null
open var outboundVoiceCalls:BillingItem? = null
open var inboundFaxes:BillingItem? = null
open var outboundFaxes:BillingItem? = null
open var inboundSmsMessages:BillingItem? = null
open var outboundSmsMessages:BillingItem? = null
open var aiInsights:BillingItem? = null
open var aiLiveMinutes:BillingItem? = null
}
open class BillingItem
{
open var baseCost:Double? = null
open var rawUnitMultiplier:Double? = null
open var unitCost:Double? = null
open var allowance:Int? = null
}
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
}