| All Verbs | /BookingEventsSummary |
|---|
namespace AgentivityAPI.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract(Name="Events", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type EventsSummary() =
[<DataMember(Order=10)>]
member val Create:String = null with get,set
[<DataMember(Order=20)>]
member val Cancel:String = null with get,set
[<DataMember(Order=30)>]
member val Change:String = null with get,set
[<DataMember(Order=50)>]
member val Ticketing:String = null with get,set
[<DataMember(Order=60)>]
member val Service:String = null with get,set
[<DataMember(Order=70)>]
member val TicketsIssued:Int32 = new Int32() with get,set
[<DataContract(Name="Consultant", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ConsultantEventsSummary() =
[<DataMember(Order=10)>]
member val ConsultantId:String = null with get,set
[<DataMember(Order=20)>]
member val Events:EventsSummary = null with get,set
[<DataContract(Name="Account", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AccountEventsSummary() =
[<DataMember(Order=10)>]
member val AccountId:String = null with get,set
[<DataMember(Order=20)>]
member val Events:EventsSummary = null with get,set
[<DataMember(Order=30)>]
member val Consultants:ResizeArray<ConsultantEventsSummary> = null with get,set
[<DataContract(Name="Branch", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type OwningAgencyLocationIdEventsSummary() =
[<DataMember(Order=10)>]
member val BranchId:String = null with get,set
[<DataMember(Order=20)>]
member val Events:EventsSummary = null with get,set
[<DataMember(Order=30)>]
member val Accounts:ResizeArray<AccountEventsSummary> = null with get,set
[<DataContract(Name="BookingEventsSummary", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingEventsSummary() =
[<DataMember(Order=10)>]
member val DateStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=20)>]
member val DateEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=30)>]
member val Events:EventsSummary = null with get,set
[<DataMember(Order=40)>]
member val Branches:ResizeArray<OwningAgencyLocationIdEventsSummary> = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type Report<TItemResponse, TItem>() =
[<DataMember(Order=1, EmitDefaultValue=false)>]
member val Item:TItem = null with get,set
[<DataContract(Name="BookingEventsSummary", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingEventsSummaryRequestResponseReport() =
inherit Report<BookingEventsSummaryRequestItemResponse, BookingEventsSummary>()
[<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CacheMetadata() =
[<DataMember(Order=1)>]
member val CachedAt:DateTime = new DateTime() with get,set
[<DataMember(Order=2)>]
member val CacheExpiresAt:DateTime = new DateTime() with get,set
[<DataMember(Order=0)>]
member val IsFromCache:Boolean = new Boolean() with get,set
[<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type PagingMetadata() =
///<summary>
///Starting Record
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
member val Offset:String = null with 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")>]
member val Limit:String = null with 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")>]
member val TotalRecords:Int32 = new Int32() with 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")>]
member val ResponseRecords:Int32 = new Int32() with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ResponseMetadata() =
[<DataMember(Order=0)>]
member val Success:Boolean = new Boolean() with get,set
[<DataMember(Order=1)>]
member val HasCache:Boolean = new Boolean() with get,set
[<DataMember(Order=2)>]
member val HasPaging:Boolean = new Boolean() with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val CacheMetadata:CacheMetadata = null with get,set
[<DataMember(Order=4, EmitDefaultValue=false)>]
member val PagingMetadata:PagingMetadata = null with get,set
[<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgentivityError() =
[<DataMember>]
member val ErrorCode:String = null with get,set
[<DataMember>]
member val Message:String = null with get,set
[<DataMember>]
member val StatusCode:String = null with get,set
[<DataMember>]
member val VerboseMessage:String = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ItemResponse<TItem, TReport>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:TReport = null with get,set
[<DataMember(Order=3, EmitDefaultValue=false)>]
member val ResponseError:AgentivityError = null with get,set
[<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingEventsSummaryRequestItemResponse() =
inherit ItemResponse<BookingEventsSummary, BookingEventsSummaryRequestResponseReport>()
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CompanyLevelRequestBase() =
inherit PagingMetadata()
///<summary>
///Comma Delimited List of Owning Company Codes
///</summary>
[<DataMember>]
member val OwningCompanyCode:String[] = null with get,set
///<summary>
///UserName in form of an email address
///</summary>
[<DataMember>]
member val UserName:String = null with get,set
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type BookingEventsSummaryRequest() =
inherit CompanyLevelRequestBase()
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val EventDateStart:String = null with get,set
///<summary>
///Date in format YYYYMMDD
///</summary>
[<DataMember>]
member val EventDateEnd:String = null with get,set
///<summary>
///Comma Delimited List of PCCs
///</summary>
[<DataMember>]
member val OwningAgencyLocationID:String[] = null with get,set
F# BookingEventsSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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"}}