Evo Voice

<back to all web services

GetDashboardHome

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, CallCenterDashboard
The following routes are available for this service:
All Verbs/dashboard/home
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 DashboardCustomerSpend:
    customer_id: Optional[str] = None
    customer_name: Optional[str] = None
    call_spend: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DashboardHomeData:
    customer_spends: Optional[List[DashboardCustomerSpend]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetDashboardHome:
    account_id: Optional[str] = None
    start_date: Optional[str] = None
    end_date: Optional[str] = None

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

POST /dashboard/home HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetDashboardHome xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Dashboard">
  <AccountId>String</AccountId>
  <EndDate>String</EndDate>
  <StartDate>String</StartDate>
</GetDashboardHome>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardHomeData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Dashboard">
  <CustomerSpends>
    <DashboardCustomerSpend>
      <CallSpend>0</CallSpend>
      <CustomerId>String</CustomerId>
      <CustomerName>String</CustomerName>
    </DashboardCustomerSpend>
  </CustomerSpends>
</DashboardHomeData>