| GET | /accounts |
|---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Accounts;
using Voice.Api;
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; }
}
///<summary>
///Retrieve a list of accounts
///</summary>
[Api(Description="Retrieve a list of accounts")]
public partial class ListAccounts
: ListRequest<AccountInfo>
{
///<summary>
///Filter the results by name
///</summary>
[ApiMember(Description="Filter the results by name")]
public virtual string NameFilter { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /accounts HTTP/1.1 Host: evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListResponseOfAccountInfoLIonMsk5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">
<HasMorePages>false</HasMorePages>
<Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Voice.Api.Accounts">
<d2p1:AccountInfo>
<CreatedBy>String</CreatedBy>
<DateCreated>String</DateCreated>
<DateLastModified>String</DateLastModified>
<Id>String</Id>
<LastModifiedBy>String</LastModifiedBy>
<d2p1:AncestorIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:AncestorIds>
<d2p1:BillingSettings>
<d2p1:Base>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:Base>
<d2p1:InboundFaxes>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:InboundFaxes>
<d2p1:InboundSmsMessages>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:InboundSmsMessages>
<d2p1:InboundVoiceCalls>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:InboundVoiceCalls>
<d2p1:LocalNumbers>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:LocalNumbers>
<d2p1:OutboundFaxes>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:OutboundFaxes>
<d2p1:OutboundSmsMessages>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:OutboundSmsMessages>
<d2p1:OutboundVoiceCalls>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:OutboundVoiceCalls>
<d2p1:TollFreeNumbers>
<d2p1:Allowance>0</d2p1:Allowance>
<d2p1:BaseCost>0</d2p1:BaseCost>
<d2p1:RawUnitMultiplier>0</d2p1:RawUnitMultiplier>
<d2p1:UnitCost>0</d2p1:UnitCost>
</d2p1:TollFreeNumbers>
</d2p1:BillingSettings>
<d2p1:IsBYOA>false</d2p1:IsBYOA>
<d2p1:LogoId>String</d2p1:LogoId>
<d2p1:LogoUri>String</d2p1:LogoUri>
<d2p1:MaxPhoneNumbers>0</d2p1:MaxPhoneNumbers>
<d2p1:Name>String</d2p1:Name>
<d2p1:ParentAccountId>String</d2p1:ParentAccountId>
<d2p1:TrustHubProfileSid>String</d2p1:TrustHubProfileSid>
<d2p1:TwilioAccountSid>String</d2p1:TwilioAccountSid>
</d2p1:AccountInfo>
</Items>
<TotalCount>0</TotalCount>
<TotalPages>0</TotalPages>
</ListResponseOfAccountInfoLIonMsk5>