| GET | /QcComments |
|---|
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 CollectionResponse(Of TItem)
<DataMember(Order:=1)>
Public Overridable Property ResponseMetadata As ResponseMetadata
<DataMember(Order:=2, EmitDefaultValue:=false)>
Public Overridable Property ResponseReport As List(Of ApiRequestPerHour)
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property ResponseError As AgentivityError
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:="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:="ApiRequestPerHour", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ApiRequestPerHour
<DataMember(Order:=10)>
Public Overridable Property RequestDate As Date
<DataMember(Order:=100)>
Public Overridable Property Hour0 As Integer
<DataMember(Order:=110)>
Public Overridable Property Hour1 As Integer
<DataMember(Order:=120)>
Public Overridable Property Hour2 As Integer
<DataMember(Order:=130)>
Public Overridable Property Hour3 As Integer
<DataMember(Order:=140)>
Public Overridable Property Hour4 As Integer
<DataMember(Order:=150)>
Public Overridable Property Hour5 As Integer
<DataMember(Order:=160)>
Public Overridable Property Hour6 As Integer
<DataMember(Order:=170)>
Public Overridable Property Hour7 As Integer
<DataMember(Order:=180)>
Public Overridable Property Hour8 As Integer
<DataMember(Order:=190)>
Public Overridable Property Hour9 As Integer
<DataMember(Order:=200)>
Public Overridable Property Hour10 As Integer
<DataMember(Order:=210)>
Public Overridable Property Hour11 As Integer
<DataMember(Order:=220)>
Public Overridable Property Hour12 As Integer
<DataMember(Order:=230)>
Public Overridable Property Hour13 As Integer
<DataMember(Order:=240)>
Public Overridable Property Hour14 As Integer
<DataMember(Order:=250)>
Public Overridable Property Hour15 As Integer
<DataMember(Order:=260)>
Public Overridable Property Hour16 As Integer
<DataMember(Order:=270)>
Public Overridable Property Hour17 As Integer
<DataMember(Order:=280)>
Public Overridable Property Hour18 As Integer
<DataMember(Order:=290)>
Public Overridable Property Hour19 As Integer
<DataMember(Order:=300)>
Public Overridable Property Hour20 As Integer
<DataMember(Order:=310)>
Public Overridable Property Hour21 As Integer
<DataMember(Order:=320)>
Public Overridable Property Hour22 As Integer
<DataMember(Order:=330)>
Public Overridable Property Hour23 As Integer
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(Namespace:="schemas.agentivity.com/types")>
Public Partial Class GetQcComments
Inherits CompanyLevelRequestBase
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property DateStart As String
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property DateEnd As String
'''<Summary>
'''Comma Delimited List of PCCs
'''</Summary>
<DataMember>
Public Overridable Property OwningAgencyLocationID As String() = New String(){}
'''<Summary>
'''Team name
'''</Summary>
<DataMember>
Public Overridable Property Team As String
'''<Summary>
'''Sort date by comments
'''</Summary>
<DataMember>
Public Overridable Property DateByComments As Boolean
'''<Summary>
'''Group by agent initials
'''</Summary>
<DataMember>
Public Overridable Property GroupByAgentInitials As Boolean
'''<Summary>
'''Comma Delimited List of Division codes
'''</Summary>
<DataMember>
Public Overridable Property DivisionCode As String()
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:="QcComments", Namespace:="schemas.agentivity.com/types")>
Public Partial Class QcComments
<DataMember(Order:=10)>
Public Overridable Property Consultant As String
<DataMember(Order:=20)>
Public Overridable Property AgentInitials As String
<DataMember(Order:=30)>
Public Overridable Property BookingsCount As Integer
<DataMember(Order:=40)>
Public Overridable Property CommentsCount As Integer
End Class
<DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class QcCommentsResponse
Inherits CollectionResponse(Of QcComments)
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
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /QcComments HTTP/1.1 Host: api.agentivity.com Accept: application/json
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":[{"Consultant":"String","AgentInitials":"String","BookingsCount":0,"CommentsCount":0}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}