Agentivity API

<back to all web services

ConsultantsGdsSegmentPerformance

The following routes are available for this service:
GET/ConsultantsGdsSegmentPerformance
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


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

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

    /**
    * Comma Delimited List of PCCs
    */
    @DataMember
    open var OwningAgencyLocationID:ArrayList<String> = ArrayList<String>()
}

@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
}

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

@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="ConsultantGdsSegmentPerformance", Namespace="schemas.agentivity.com/types")
open class ConsultantGdsSegmentPerformance
{
    @DataMember(Order=10)
    open var OwningConsultantID:String? = null

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

    @DataMember(Order=30)
    open var OwningAgencyLocationID:String? = null

    @DataMember(Order=40)
    open var AirCount:Int? = null

    @DataMember(Order=42)
    open var AirCountOnline:Int? = null

    @DataMember(Order=50)
    open var HotelCount:Int? = null

    @DataMember(Order=52)
    open var HotelCountOnline:Int? = null

    @DataMember(Order=60)
    open var CarCount:Int? = null

    @DataMember(Order=62)
    open var CarCountOnline:Int? = null

    @DataMember(Order=70)
    open var PassiveHotelCount:Int? = null

    @DataMember(Order=72)
    open var PassiveHotelCountOnline:Int? = null

    @DataMember(Order=80)
    open var PassiveCarCount:Int? = null

    @DataMember(Order=82)
    open var PassiveCarCountOnline:Int? = null

    @DataMember(Order=90)
    open var TURCount:Int? = null

    @DataMember(Order=92)
    open var TURCountOnline:Int? = null

    @DataMember(Order=100)
    open var OtherCount:Int? = null

    @DataMember(Order=102)
    open var OtherCountOnline:Int? = null

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

    @DataMember(Order=120)
    open var OwningAgencyLocationCountryCode:String? = null

    @DataMember(Order=130)
    open var OwningAgencyLocationCountryName:String? = null
}

@DataContract(Name="ConsultantGdsSegmentPerformance", Namespace="schemas.agentivity.com/types")
open class ConsultantsGdsSegmentPerformanceResponseReport : Report<ConsultantsGdsSegmentPerformanceItemResponse, ConsultantGdsSegmentPerformance>()
{
}

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

Kotlin ConsultantsGdsSegmentPerformance DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /ConsultantsGdsSegmentPerformance HTTP/1.1 
Host: api.agentivity.com 
Accept: text/jsonl
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":{"OwningConsultantID":"String","OwningConsultant":"String","OwningAgencyLocationID":"String","AirCount":0,"AirCountOnline":0,"HotelCount":0,"HotelCountOnline":0,"CarCount":0,"CarCountOnline":0,"PassiveHotelCount":0,"PassiveHotelCountOnline":0,"PassiveCarCount":0,"PassiveCarCountOnline":0,"TURCount":0,"TURCountOnline":0,"OtherCount":0,"OtherCountOnline":0,"TotalBookings":0,"OwningAgencyLocationCountryCode":"String","OwningAgencyLocationCountryName":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}