| All Verbs | /BookingEventsSummary |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AgentivityAPI.ServiceModel.Types
Imports AgentivityAPI.ServiceModel.Base
Imports AgentivityAPI.ServiceModel
Namespace Global
Namespace AgentivityAPI.ServiceModel
<DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ItemResponse(Of TItem, TReport)
<DataMember(Order:=1)>
Public Overridable Property ResponseMetadata As ResponseMetadata
<DataMember(Order:=2, EmitDefaultValue:=false)>
Public Overridable Property ResponseReport As TReport
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property ResponseError As AgentivityError
End Class
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class Report(Of TItemResponse, TItem)
<DataMember(Order:=1, EmitDefaultValue:=false)>
Public Overridable Property Item As TItem
End Class
End Namespace
Namespace AgentivityAPI.ServiceModel.Base
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class CompanyLevelRequestBase
Inherits PagingMetadata
Implements IMemberUsername
Implements IMemberOwningCompanyCode
'''<Summary>
'''Comma Delimited List of Owning Company Codes
'''</Summary>
<DataMember>
Public Overridable Property OwningCompanyCode As String() Implements IMemberOwningCompanyCode.OwningCompanyCode
'''<Summary>
'''UserName in form of an email address
'''</Summary>
<DataMember>
Public Overridable Property UserName As String Implements IMemberUsername.UserName
End Class
End Namespace
Namespace AgentivityAPI.ServiceModel.Types
<DataContract(Name:="Account", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AccountEventsSummary
<DataMember(Order:=10)>
Public Overridable Property AccountId As String
<DataMember(Order:=20)>
Public Overridable Property Events As EventsSummary
<DataMember(Order:=30)>
Public Overridable Property Consultants As List(Of ConsultantEventsSummary)
End Class
<DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AgentivityError
<DataMember>
Public Overridable Property ErrorCode As String
<DataMember>
Public Overridable Property Message As String
<DataMember>
Public Overridable Property StatusCode As String
<DataMember>
Public Overridable Property VerboseMessage As String
End Class
<DataContract(Name:="BookingEventsSummary", Namespace:="schemas.agentivity.com/types")>
Public Partial Class BookingEventsSummary
<DataMember(Order:=10)>
Public Overridable Property DateStart As Date?
<DataMember(Order:=20)>
Public Overridable Property DateEnd As Date?
<DataMember(Order:=30)>
Public Overridable Property Events As EventsSummary
<DataMember(Order:=40)>
Public Overridable Property Branches As List(Of OwningAgencyLocationIdEventsSummary)
End Class
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class BookingEventsSummaryRequest
Inherits CompanyLevelRequestBase
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property EventDateStart As String
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property EventDateEnd As String
'''<Summary>
'''Comma Delimited List of PCCs
'''</Summary>
<DataMember>
Public Overridable Property OwningAgencyLocationID As String()
End Class
<DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class BookingEventsSummaryRequestItemResponse
Inherits ItemResponse(Of BookingEventsSummary, BookingEventsSummaryRequestResponseReport)
End Class
<DataContract(Name:="BookingEventsSummary", Namespace:="schemas.agentivity.com/types")>
Public Partial Class BookingEventsSummaryRequestResponseReport
Inherits Report(Of BookingEventsSummaryRequestItemResponse, BookingEventsSummary)
End Class
<DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CacheMetadata
<DataMember(Order:=1)>
Public Overridable Property CachedAt As Date
<DataMember(Order:=2)>
Public Overridable Property CacheExpiresAt As Date
<DataMember(Order:=0)>
Public Overridable Property IsFromCache As Boolean
End Class
<DataContract(Name:="Consultant", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ConsultantEventsSummary
<DataMember(Order:=10)>
Public Overridable Property ConsultantId As String
<DataMember(Order:=20)>
Public Overridable Property Events As EventsSummary
End Class
<DataContract(Name:="Events", Namespace:="schemas.agentivity.com/types")>
Public Partial Class EventsSummary
<DataMember(Order:=10)>
Public Overridable Property Create As String
<DataMember(Order:=20)>
Public Overridable Property Cancel As String
<DataMember(Order:=30)>
Public Overridable Property Change As String
<DataMember(Order:=50)>
Public Overridable Property Ticketing As String
<DataMember(Order:=60)>
Public Overridable Property Service As String
<DataMember(Order:=70)>
Public Overridable Property TicketsIssued As Integer
End Class
<DataContract(Name:="Branch", Namespace:="schemas.agentivity.com/types")>
Public Partial Class OwningAgencyLocationIdEventsSummary
<DataMember(Order:=10)>
Public Overridable Property BranchId As String
<DataMember(Order:=20)>
Public Overridable Property Events As EventsSummary
<DataMember(Order:=30)>
Public Overridable Property Accounts As List(Of AccountEventsSummary)
End Class
<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 Overridable Property Offset As String
'''<Summary>
'''Number of records to return (PageSize)
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
Public Overridable Property Limit As String
'''<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 Overridable Property TotalRecords As Integer
'''<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 Overridable Property ResponseRecords As Integer
End Class
<DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ResponseMetadata
<DataMember(Order:=0)>
Public Overridable Property Success As Boolean
<DataMember(Order:=1)>
Public Overridable Property HasCache As Boolean
<DataMember(Order:=2)>
Public Overridable Property HasPaging As Boolean
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property CacheMetadata As CacheMetadata
<DataMember(Order:=4, EmitDefaultValue:=false)>
Public Overridable Property PagingMetadata As PagingMetadata
End Class
End Namespace
End Namespace
VB.NET BookingEventsSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>