Agentivity API

<back to all web services

BookingEventsSummaryRequest

The following routes are available for this service:
All Verbs/BookingEventsSummary
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 PagingMetadata:
    # @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    offset: Optional[str] = None
    """
    Starting Record
    """


    # @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    limit: Optional[str] = None
    """
    Number of records to return (PageSize)
    """


    # @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    total_records: int = 0
    """
    Total Number of Records in a Full Reponse (if no paging)
    """


    # @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    response_records: int = 0
    """
    Total Number of Records in this Reponse (on this page)
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyLevelRequestBase(PagingMetadata, IMemberUsername, IMemberOwningCompanyCode):
    owning_company_code: Optional[List[str]] = None
    """
    Comma Delimited List of Owning Company Codes
    """

    user_name: Optional[str] = None
    """
    UserName in form of an email address
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EventsSummary:
    create: Optional[str] = None
    cancel: Optional[str] = None
    change: Optional[str] = None
    ticketing: Optional[str] = None
    service: Optional[str] = None
    tickets_issued: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ConsultantEventsSummary:
    consultant_id: Optional[str] = None
    events: Optional[EventsSummary] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccountEventsSummary:
    account_id: Optional[str] = None
    events: Optional[EventsSummary] = None
    consultants: Optional[List[ConsultantEventsSummary]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OwningAgencyLocationIdEventsSummary:
    branch_id: Optional[str] = None
    events: Optional[EventsSummary] = None
    accounts: Optional[List[AccountEventsSummary]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingEventsSummary:
    date_start: Optional[datetime.datetime] = None
    date_end: Optional[datetime.datetime] = None
    events: Optional[EventsSummary] = None
    branches: Optional[List[OwningAgencyLocationIdEventsSummary]] = None


TItemResponse = TypeVar('TItemResponse')
TItem = TypeVar('TItem')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Report(Generic[TItemResponse, TItem]):
    item: Optional[TItem] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingEventsSummaryRequestResponseReport(Report[BookingEventsSummaryRequestItemResponse, BookingEventsSummary]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CacheMetadata:
    cached_at: datetime.datetime = datetime.datetime(1, 1, 1)
    cache_expires_at: datetime.datetime = datetime.datetime(1, 1, 1)
    is_from_cache: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResponseMetadata:
    success: bool = False
    has_cache: bool = False
    has_paging: bool = False
    cache_metadata: Optional[CacheMetadata] = None
    paging_metadata: Optional[PagingMetadata] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentivityError:
    error_code: Optional[str] = None
    message: Optional[str] = None
    status_code: Optional[str] = None
    verbose_message: Optional[str] = None


TItem = TypeVar('TItem')
TReport = TypeVar('TReport')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemResponse(Generic[TItem, TReport]):
    response_metadata: Optional[ResponseMetadata] = None
    response_report: Optional[TReport] = None
    response_error: Optional[AgentivityError] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingEventsSummaryRequestItemResponse(ItemResponse[BookingEventsSummary, BookingEventsSummaryRequestResponseReport]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingEventsSummaryRequest(CompanyLevelRequestBase):
    event_date_start: Optional[str] = None
    """
    Date in format YYYYMMDD
    """

    event_date_end: Optional[str] = None
    """
    Date in format YYYYMMDD
    """

    owning_agency_location_i_d: Optional[List[str]] = None
    """
    Comma Delimited List of PCCs
    """

Python BookingEventsSummaryRequest 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 /BookingEventsSummary HTTP/1.1 
Host: servicestack.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BookingEventsSummaryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <EventDateEnd>String</EventDateEnd>
  <EventDateStart>String</EventDateStart>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
</BookingEventsSummaryRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <Item>
      <DateStart>0001-01-01T00:00:00</DateStart>
      <DateEnd>0001-01-01T00:00:00</DateEnd>
      <Events>
        <Create>String</Create>
        <Cancel>String</Cancel>
        <Change>String</Change>
        <Ticketing>String</Ticketing>
        <Service>String</Service>
        <TicketsIssued>0</TicketsIssued>
      </Events>
      <Branches>
        <Branch>
          <BranchId>String</BranchId>
          <Events>
            <Create>String</Create>
            <Cancel>String</Cancel>
            <Change>String</Change>
            <Ticketing>String</Ticketing>
            <Service>String</Service>
            <TicketsIssued>0</TicketsIssued>
          </Events>
          <Accounts>
            <Account>
              <AccountId>String</AccountId>
              <Events>
                <Create>String</Create>
                <Cancel>String</Cancel>
                <Change>String</Change>
                <Ticketing>String</Ticketing>
                <Service>String</Service>
                <TicketsIssued>0</TicketsIssued>
              </Events>
              <Consultants>
                <Consultant>
                  <ConsultantId>String</ConsultantId>
                  <Events>
                    <Create>String</Create>
                    <Cancel>String</Cancel>
                    <Change>String</Change>
                    <Ticketing>String</Ticketing>
                    <Service>String</Service>
                    <TicketsIssued>0</TicketsIssued>
                  </Events>
                </Consultant>
              </Consultants>
            </Account>
          </Accounts>
        </Branch>
      </Branches>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>