| GET | /QcComments |
|---|
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 CollectionResponse<TItem>
{
[DataMember(Order=1)]
public virtual ResponseMetadata ResponseMetadata { get; set; }
[DataMember(Order=2, EmitDefaultValue=false)]
public virtual List<ApiRequestPerHour> ResponseReport { get; set; }
[DataMember(Order=3, EmitDefaultValue=false)]
public virtual AgentivityError ResponseError { 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="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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")]
public partial class ApiRequestPerHour
{
[DataMember(Order=10)]
public virtual DateTime RequestDate { get; set; }
[DataMember(Order=100)]
public virtual int Hour0 { get; set; }
[DataMember(Order=110)]
public virtual int Hour1 { get; set; }
[DataMember(Order=120)]
public virtual int Hour2 { get; set; }
[DataMember(Order=130)]
public virtual int Hour3 { get; set; }
[DataMember(Order=140)]
public virtual int Hour4 { get; set; }
[DataMember(Order=150)]
public virtual int Hour5 { get; set; }
[DataMember(Order=160)]
public virtual int Hour6 { get; set; }
[DataMember(Order=170)]
public virtual int Hour7 { get; set; }
[DataMember(Order=180)]
public virtual int Hour8 { get; set; }
[DataMember(Order=190)]
public virtual int Hour9 { get; set; }
[DataMember(Order=200)]
public virtual int Hour10 { get; set; }
[DataMember(Order=210)]
public virtual int Hour11 { get; set; }
[DataMember(Order=220)]
public virtual int Hour12 { get; set; }
[DataMember(Order=230)]
public virtual int Hour13 { get; set; }
[DataMember(Order=240)]
public virtual int Hour14 { get; set; }
[DataMember(Order=250)]
public virtual int Hour15 { get; set; }
[DataMember(Order=260)]
public virtual int Hour16 { get; set; }
[DataMember(Order=270)]
public virtual int Hour17 { get; set; }
[DataMember(Order=280)]
public virtual int Hour18 { get; set; }
[DataMember(Order=290)]
public virtual int Hour19 { get; set; }
[DataMember(Order=300)]
public virtual int Hour20 { get; set; }
[DataMember(Order=310)]
public virtual int Hour21 { get; set; }
[DataMember(Order=320)]
public virtual int Hour22 { get; set; }
[DataMember(Order=330)]
public virtual int Hour23 { get; set; }
}
[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(Namespace="schemas.agentivity.com/types")]
public partial class GetQcComments
: CompanyLevelRequestBase
{
///<summary>
///Date in format YYYYMMDD
///</summary>
[DataMember]
public virtual string DateStart { get; set; }
///<summary>
///Date in format YYYYMMDD
///</summary>
[DataMember]
public virtual string DateEnd { get; set; }
///<summary>
///Comma Delimited List of PCCs
///</summary>
[DataMember]
public virtual string[] OwningAgencyLocationID { get; set; } = [];
///<summary>
///Team name
///</summary>
[DataMember]
public virtual string Team { get; set; }
///<summary>
///Sort date by comments
///</summary>
[DataMember]
public virtual bool DateByComments { get; set; }
///<summary>
///Group by agent initials
///</summary>
[DataMember]
public virtual bool GroupByAgentInitials { get; set; }
///<summary>
///Comma Delimited List of Division codes
///</summary>
[DataMember]
public virtual string[] DivisionCode { 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="QcComments", Namespace="schemas.agentivity.com/types")]
public partial class QcComments
{
[DataMember(Order=10)]
public virtual string Consultant { get; set; }
[DataMember(Order=20)]
public virtual string AgentInitials { get; set; }
[DataMember(Order=30)]
public virtual int BookingsCount { get; set; }
[DataMember(Order=40)]
public virtual int CommentsCount { get; set; }
}
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class QcCommentsResponse
: CollectionResponse<QcComments>
{
}
[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; }
}
}
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"}}