Agentivity API

<back to all web services

AgencyActivitiesByConsultant

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@DataContract(Namespace="schemas.agentivity.com/types")
open class AgencyActivitiesByConsultant : CompanyLevelRequestBase()
{
    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var EventDateStart:String? = null

    /**
    * Date in format YYYYMMDD
    */
    @DataMember
    open var EventDateEnd:String? = null

    /**
    * Id of the owning consultant
    */
    @DataMember
    open var OwningConsultantID:String? = null

    /**
    * Comma Delimited List of PCCs
    */
    @DataMember
    open var OwningAgencyLocationID:ArrayList<String>? = null

    /**
    * Team name
    */
    @DataMember
    open var Team:String? = null

    /**
    * Format style
    */
    @DataMember
    open var FormatStyle:FormattingStyle? = null
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
    /**
    * Comma Delimited List of Owning Company Codes
    */
    @DataMember
    override var OwningCompanyCode:ArrayList<String>? = null

    /**
    * UserName in form of an email address
    */
    @DataMember
    override var UserName:String? = null
}

@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
    /**
    * Starting Record
    */
    @DataMember
    @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    open var Offset:String? = null

    /**
    * Number of records to return (PageSize)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    open var Limit:String? = null

    /**
    * Total Number of Records in a Full Reponse (if no paging)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    open var TotalRecords:Int? = null

    /**
    * Total Number of Records in this Reponse (on this page)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    open var ResponseRecords:Int? = null
}

@Flags()
enum class FormattingStyle(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") Html(1),
    @SerializedName("2") Charting(2),
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class AgencyActivitiesByConsultantItemResponse : ItemResponse<AgencyActivityByConsultant, AgencyActivitiesByConsultantResponseReport>()
{
}

@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class ItemResponse<TItem, TReport>
{
    @DataMember(Order=1)
    open var ResponseMetadata:ResponseMetadata? = null

    @DataMember(Order=2, EmitDefaultValue=false)
    open var ResponseReport:TReport? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var ResponseError:AgentivityError? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
    @DataMember(Order=0)
    open var Success:Boolean? = null

    @DataMember(Order=1)
    open var HasCache:Boolean? = null

    @DataMember(Order=2)
    open var HasPaging:Boolean? = null

    @DataMember(Order=3, EmitDefaultValue=false)
    open var CacheMetadata:CacheMetadata? = null

    @DataMember(Order=4, EmitDefaultValue=false)
    open var PagingMetadata:PagingMetadata? = null
}

@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
    @DataMember(Order=1)
    open var CachedAt:Date? = null

    @DataMember(Order=2)
    open var CacheExpiresAt:Date? = null

    @DataMember(Order=0)
    open var IsFromCache:Boolean? = null
}

@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
    @DataMember
    open var ErrorCode:String? = null

    @DataMember
    open var Message:String? = null

    @DataMember
    open var StatusCode:String? = null

    @DataMember
    open var VerboseMessage:String? = null
}

@DataContract(Name="AgencyActivityByConsultant", Namespace="schemas.agentivity.com/types")
open class AgencyActivityByConsultant
{
    @DataMember(Order=10)
    open var Items:ArrayList<AgencyActivityItem>? = null

    @DataMember(Order=20)
    open var Formatted:String? = null
}

@DataContract(Name="AgencyActivityItem", Namespace="schemas.agentivity.com/types")
open class AgencyActivityItem
{
    @DataMember(Order=10)
    open var EventHour:Int? = null

    @DataMember(Order=20)
    open var EventType:String? = null

    @DataMember(Order=30)
    open var TotalBookings:Int? = null
}

@DataContract(Name="AgencyActivityByConsultant", Namespace="schemas.agentivity.com/types")
open class AgencyActivitiesByConsultantResponseReport : Report<AgencyActivitiesByConsultantItemResponse, AgencyActivityByConsultant>()
{
}

@DataContract(Namespace="schemas.agentivity.com/types")
open class Report<TItemResponse, TItem>
{
    @DataMember(Order=1, EmitDefaultValue=false)
    open var Item:TItem? = null
}

Kotlin AgencyActivitiesByConsultant DTOs

GET /AgencyActivityByConsultants HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml

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>
      <Items>
        <AgencyActivityItem>
          <EventHour>0</EventHour>
          <EventType>String</EventType>
          <TotalBookings>0</TotalBookings>
        </AgencyActivityItem>
      </Items>
      <Formatted>String</Formatted>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>