Agentivity API

BookingEventsSummaryRequest

The following routes are available for this service:
All Verbs	/BookingEventsSummary

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel.Types;
using AgentivityAPI.ServiceModel.Base;
using AgentivityAPI.ServiceModel;

namespace AgentivityAPI.ServiceModel
{
    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class ItemResponse<TItem, TReport>
    {
        [DataMember(Order=1)]
        public virtual ResponseMetadata ResponseMetadata { get; set; }

        [DataMember(Order=2, EmitDefaultValue=false)]
        public virtual TReport ResponseReport { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual AgentivityError ResponseError { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class Report<TItemResponse, TItem>
    {
        [DataMember(Order=1, EmitDefaultValue=false)]
        public virtual TItem Item { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Base
{
    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class CompanyLevelRequestBase
        : PagingMetadata, IMemberUsername, IMemberOwningCompanyCode
    {
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [DataMember]
        public virtual string[] OwningCompanyCode { get; set; }

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [DataMember]
        public virtual string UserName { get; set; }
    }

}

namespace AgentivityAPI.ServiceModel.Types
{
    [DataContract(Name="Account", Namespace="schemas.agentivity.com/types")]
    public partial class AccountEventsSummary
    {
        [DataMember(Order=10)]
        public virtual string AccountId { get; set; }

        [DataMember(Order=20)]
        public virtual EventsSummary Events { get; set; }

        [DataMember(Order=30)]
        public virtual List<ConsultantEventsSummary> Consultants { get; set; }
    }

    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class AgentivityError
    {
        [DataMember]
        public virtual string ErrorCode { get; set; }

        [DataMember]
        public virtual string Message { get; set; }

        [DataMember]
        public virtual string StatusCode { get; set; }

        [DataMember]
        public virtual string VerboseMessage { get; set; }
    }

    [DataContract(Name="BookingEventsSummary", Namespace="schemas.agentivity.com/types")]
    public partial class BookingEventsSummary
    {
        [DataMember(Order=10)]
        public virtual DateTime? DateStart { get; set; }

        [DataMember(Order=20)]
        public virtual DateTime? DateEnd { get; set; }

        [DataMember(Order=30)]
        public virtual EventsSummary Events { get; set; }

        [DataMember(Order=40)]
        public virtual List<OwningAgencyLocationIdEventsSummary> Branches { get; set; }
    }

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class BookingEventsSummaryRequest
        : CompanyLevelRequestBase
    {
        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string EventDateStart { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string EventDateEnd { get; set; }

        ///<summary>
        ///Comma Delimited List of PCCs
        ///</summary>
        [DataMember]
        public virtual string[] OwningAgencyLocationID { get; set; }
    }

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

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

    [DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class CacheMetadata
    {
        [DataMember(Order=1)]
        public virtual DateTime CachedAt { get; set; }

        [DataMember(Order=2)]
        public virtual DateTime CacheExpiresAt { get; set; }

        [DataMember(Order=0)]
        public virtual bool IsFromCache { get; set; }
    }

    [DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")]
    public partial class ConsultantEventsSummary
    {
        [DataMember(Order=10)]
        public virtual string ConsultantId { get; set; }

        [DataMember(Order=20)]
        public virtual EventsSummary Events { get; set; }
    }

    [DataContract(Name="Events", Namespace="schemas.agentivity.com/types")]
    public partial class EventsSummary
    {
        [DataMember(Order=10)]
        public virtual string Create { get; set; }

        [DataMember(Order=20)]
        public virtual string Cancel { get; set; }

        [DataMember(Order=30)]
        public virtual string Change { get; set; }

        [DataMember(Order=50)]
        public virtual string Ticketing { get; set; }

        [DataMember(Order=60)]
        public virtual string Service { get; set; }

        [DataMember(Order=70)]
        public virtual int TicketsIssued { get; set; }
    }

    [DataContract(Name="Branch", Namespace="schemas.agentivity.com/types")]
    public partial class OwningAgencyLocationIdEventsSummary
    {
        [DataMember(Order=10)]
        public virtual string BranchId { get; set; }

        [DataMember(Order=20)]
        public virtual EventsSummary Events { get; set; }

        [DataMember(Order=30)]
        public virtual List<AccountEventsSummary> Accounts { get; set; }
    }

    [DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")]
    public partial class PagingMetadata
    {
        ///<summary>
        ///Starting Record
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")]
        public virtual string Offset { get; set; }

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")]
        public virtual string Limit { get; set; }

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")]
        public virtual int TotalRecords { get; set; }

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")]
        public virtual int ResponseRecords { get; set; }
    }

    [DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")]
    public partial class ResponseMetadata
    {
        [DataMember(Order=0)]
        public virtual bool Success { get; set; }

        [DataMember(Order=1)]
        public virtual bool HasCache { get; set; }

        [DataMember(Order=2)]
        public virtual bool HasPaging { get; set; }

        [DataMember(Order=3, EmitDefaultValue=false)]
        public virtual CacheMetadata CacheMetadata { get; set; }

        [DataMember(Order=4, EmitDefaultValue=false)]
        public virtual PagingMetadata PagingMetadata { get; set; }
    }

}

C# BookingEventsSummaryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
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"}}