Agentivity API

<back to all web services

BookingEventsSummaryRequest

The following routes are available for this service:
All Verbs/BookingEventsSummary
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class BookingEventsSummaryRequest : CompanyLevelRequestBase()
{
    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var EventDateStart:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var EventDateEnd:String? = null

    /**
    * Comma Delimited List of PCCs
    */
    @DataMember
    open var OwningAgencyLocationID:ArrayList<String>? = null
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    @DataMember
    override var OwningCompanyCode:ArrayList<String>? = null

    /**
    * UserName in form of an email address
    */
    @DataMember
    override var UserName:String? = null
}

@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
    /**
    * Starting Record
    */
    @DataMember
    @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    open var Offset:String? = null

    /**
    * Number of records to return (PageSize)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    open var Limit:String? = null

    /**
    * Total Number of Records in a Full Reponse (if no paging)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    open var TotalRecords:Int? = null

    /**
    * Total Number of Records in this Reponse (on this page)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    open var ResponseRecords:Int? = null
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class BookingEventsSummaryRequestItemResponse : ItemResponse<BookingEventsSummary, BookingEventsSummaryRequestResponseReport>()
{
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class ItemResponse<TItem, TReport>
{
    @DataMember(Order=1)
    open var ResponseMetadata:ResponseMetadata? = null

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:TReport? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var ResponseError:AgentivityError? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
    @DataMember(Order=0)
    open var Success:Boolean? = null

    @DataMember(Order=1)
    open var HasCache:Boolean? = null

    @DataMember(Order=2)
    open var HasPaging:Boolean? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var CacheMetadata:CacheMetadata? = null

    @DataMember(Order=4, EmitDefaultValue=false)
    open var PagingMetadata:PagingMetadata? = null
}

@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
    @DataMember(Order=1)
    open var CachedAt:Date? = null

    @DataMember(Order=2)
    open var CacheExpiresAt:Date? = null

    @DataMember(Order=0)
    open var IsFromCache:Boolean? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
    @DataMember
    open var ErrorCode:String? = null

    @DataMember
    open var Message:String? = null

    @DataMember
    open var StatusCode:String? = null

    @DataMember
    open var VerboseMessage:String? = null
}

@DataContract(Name="BookingEventsSummary", Namespace="schemas.agentivity.com/types")
open class BookingEventsSummary
{
    @DataMember(Order=10)
    open var DateStart:Date? = null

    @DataMember(Order=20)
    open var DateEnd:Date? = null

    @DataMember(Order=30)
    open var Events:EventsSummary? = null

    @DataMember(Order=40)
    open var Branches:ArrayList<OwningAgencyLocationIdEventsSummary>? = null
}

@DataContract(Name="Events", Namespace="schemas.agentivity.com/types")
open class EventsSummary
{
    @DataMember(Order=10)
    open var Create:String? = null

    @DataMember(Order=20)
    open var Cancel:String? = null

    @DataMember(Order=30)
    open var Change:String? = null

    @DataMember(Order=50)
    open var Ticketing:String? = null

    @DataMember(Order=60)
    open var Service:String? = null

    @DataMember(Order=70)
    open var TicketsIssued:Int? = null
}

@DataContract(Name="Branch", Namespace="schemas.agentivity.com/types")
open class OwningAgencyLocationIdEventsSummary
{
    @DataMember(Order=10)
    open var BranchId:String? = null

    @DataMember(Order=20)
    open var Events:EventsSummary? = null

    @DataMember(Order=30)
    open var Accounts:ArrayList<AccountEventsSummary>? = null
}

@DataContract(Name="Account", Namespace="schemas.agentivity.com/types")
open class AccountEventsSummary
{
    @DataMember(Order=10)
    open var AccountId:String? = null

    @DataMember(Order=20)
    open var Events:EventsSummary? = null

    @DataMember(Order=30)
    open var Consultants:ArrayList<ConsultantEventsSummary>? = null
}

@DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")
open class ConsultantEventsSummary
{
    @DataMember(Order=10)
    open var ConsultantId:String? = null

    @DataMember(Order=20)
    open var Events:EventsSummary? = null
}

@DataContract(Name="BookingEventsSummary", Namespace="schemas.agentivity.com/types")
open class BookingEventsSummaryRequestResponseReport : Report<BookingEventsSummaryRequestItemResponse, BookingEventsSummary>()
{
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
    @DataMember(Order=1, EmitDefaultValue=false)
    open var Item:TItem? = null
}

Kotlin 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: api.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>