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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"EventDateStart":"String","EventDateEnd":"String","OwningAgencyLocationID":["String"],"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

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

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"DateStart":"\/Date(-62135596800000-0000)\/","DateEnd":"\/Date(-62135596800000-0000)\/","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Branches":[{"BranchId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Accounts":[{"AccountId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0},"Consultants":[{"ConsultantId":"String","Events":{"Create":"String","Cancel":"String","Change":"String","Ticketing":"String","Service":"String","TicketsIssued":0}}]}]}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}