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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddressInfo:
    id: Optional[str] = None
    friendly_name: Optional[str] = None
    emergency_enabled: Optional[bool] = None
    customer_name: Optional[str] = None
    street: Optional[str] = None
    city: Optional[str] = None
    region: Optional[str] = None
    postal_code: Optional[str] = None
    iso_country: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListAddressesResponse:
    addresses: Optional[List[AddressInfo]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListAddresses:
    # @ApiMember(Description="The account ID whose addresses you want")
    account_id: Optional[str] = None
    """
    The account ID whose addresses you want
    """

Python 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>