Evo Voice

<back to all web services

ListAddresses

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/addresses
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Settings

Namespace Global

    Namespace Voice.Api.Settings

        Public Partial Class AddressInfo
            Public Overridable Property Id As String
            Public Overridable Property FriendlyName As String
            Public Overridable Property EmergencyEnabled As Boolean
            Public Overridable Property CustomerName As String
            Public Overridable Property Street As String
            Public Overridable Property City As String
            Public Overridable Property Region As String
            Public Overridable Property PostalCode As String
            Public Overridable Property ISOCountry As String
        End Class

        Public Partial Class ListAddresses
            '''<Summary>
            '''The account ID whose addresses you want
            '''</Summary>
            <ApiMember(Description:="The account ID whose addresses you want")>
            Public Overridable Property AccountId As String
        End Class

        Public Partial Class ListAddressesResponse
            Public Sub New()
                Addresses = New List(Of AddressInfo)
            End Sub

            Public Overridable Property Addresses As List(Of AddressInfo)
        End Class
    End Namespace
End Namespace

VB.NET ListAddresses DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /addresses HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListAddressesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Settings">
  <Addresses>
    <AddressInfo>
      <City>String</City>
      <CustomerName>String</CustomerName>
      <EmergencyEnabled>false</EmergencyEnabled>
      <FriendlyName>String</FriendlyName>
      <ISOCountry>String</ISOCountry>
      <Id>String</Id>
      <PostalCode>String</PostalCode>
      <Region>String</Region>
      <Street>String</Street>
    </AddressInfo>
  </Addresses>
</ListAddressesResponse>