Agentivity API

<back to all web services

ConsultantsGdsSegmentPerformance

The following routes are available for this service:
GET/ConsultantsGdsSegmentPerformance
namespace AgentivityAPI.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract(Name="ConsultantGdsSegmentPerformance", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ConsultantGdsSegmentPerformance() = 
        [<DataMember(Order=10)>]
        member val OwningConsultantID:String = null with get,set

        [<DataMember(Order=20)>]
        member val OwningConsultant:String = null with get,set

        [<DataMember(Order=30)>]
        member val OwningAgencyLocationID:String = null with get,set

        [<DataMember(Order=40)>]
        member val AirCount:Int32 = new Int32() with get,set

        [<DataMember(Order=42)>]
        member val AirCountOnline:Int32 = new Int32() with get,set

        [<DataMember(Order=50)>]
        member val HotelCount:Int32 = new Int32() with get,set

        [<DataMember(Order=52)>]
        member val HotelCountOnline:Int32 = new Int32() with get,set

        [<DataMember(Order=60)>]
        member val CarCount:Int32 = new Int32() with get,set

        [<DataMember(Order=62)>]
        member val CarCountOnline:Int32 = new Int32() with get,set

        [<DataMember(Order=70)>]
        member val PassiveHotelCount:Int32 = new Int32() with get,set

        [<DataMember(Order=72)>]
        member val PassiveHotelCountOnline:Int32 = new Int32() with get,set

        [<DataMember(Order=80)>]
        member val PassiveCarCount:Int32 = new Int32() with get,set

        [<DataMember(Order=82)>]
        member val PassiveCarCountOnline:Int32 = new Int32() with get,set

        [<DataMember(Order=90)>]
        member val TURCount:Int32 = new Int32() with get,set

        [<DataMember(Order=92)>]
        member val TURCountOnline:Int32 = new Int32() with get,set

        [<DataMember(Order=100)>]
        member val OtherCount:Int32 = new Int32() with get,set

        [<DataMember(Order=102)>]
        member val OtherCountOnline:Int32 = new Int32() with get,set

        [<DataMember(Order=110)>]
        member val TotalBookings:Int32 = new Int32() with get,set

        [<DataMember(Order=120)>]
        member val OwningAgencyLocationCountryCode:String = null with get,set

        [<DataMember(Order=130)>]
        member val OwningAgencyLocationCountryName:String = null with get,set

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type Report<TItemResponse, TItem>() = 
        [<DataMember(Order=1, EmitDefaultValue=false)>]
        member val Item:TItem = null with get,set

    [<DataContract(Name="ConsultantGdsSegmentPerformance", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ConsultantsGdsSegmentPerformanceResponseReport() = 
        inherit Report<ConsultantsGdsSegmentPerformanceItemResponse, ConsultantGdsSegmentPerformance>()

    [<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CacheMetadata() = 
        [<DataMember(Order=1)>]
        member val CachedAt:DateTime = new DateTime() with get,set

        [<DataMember(Order=2)>]
        member val CacheExpiresAt:DateTime = new DateTime() with get,set

        [<DataMember(Order=0)>]
        member val IsFromCache:Boolean = new Boolean() with get,set

    [<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type PagingMetadata() = 
        ///<summary>
        ///Starting Record
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
        member val Offset:String = null with 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")>]
        member val Limit:String = null with 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")>]
        member val TotalRecords:Int32 = new Int32() with 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")>]
        member val ResponseRecords:Int32 = new Int32() with get,set

    [<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ResponseMetadata() = 
        [<DataMember(Order=0)>]
        member val Success:Boolean = new Boolean() with get,set

        [<DataMember(Order=1)>]
        member val HasCache:Boolean = new Boolean() with get,set

        [<DataMember(Order=2)>]
        member val HasPaging:Boolean = new Boolean() with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val CacheMetadata:CacheMetadata = null with get,set

        [<DataMember(Order=4, EmitDefaultValue=false)>]
        member val PagingMetadata:PagingMetadata = null with get,set

    [<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type AgentivityError() = 
        [<DataMember>]
        member val ErrorCode:String = null with get,set

        [<DataMember>]
        member val Message:String = null with get,set

        [<DataMember>]
        member val StatusCode:String = null with get,set

        [<DataMember>]
        member val VerboseMessage:String = null with get,set

    [<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ItemResponse<TItem, TReport>() = 
        [<DataMember(Order=1)>]
        member val ResponseMetadata:ResponseMetadata = null with get,set

        [<DataMember(Order=2, EmitDefaultValue=false)>]
        member val ResponseReport:TReport = null with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val ResponseError:AgentivityError = null with get,set

    [<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ConsultantsGdsSegmentPerformanceItemResponse() = 
        inherit ItemResponse<ConsultantGdsSegmentPerformance, ConsultantsGdsSegmentPerformanceResponseReport>()

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CompanyLevelRequestBase() = 
        inherit PagingMetadata()
        ///<summary>
        ///Comma Delimited List of Owning Company Codes
        ///</summary>
        [<DataMember>]
        member val OwningCompanyCode:String[] = null with get,set

        ///<summary>
        ///UserName in form of an email address
        ///</summary>
        [<DataMember>]
        member val UserName:String = null with get,set

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ConsultantsGdsSegmentPerformance() = 
        inherit CompanyLevelRequestBase()
        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val PNRCreationDateStart:String = null with get,set

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [<DataMember>]
        member val PNRCreationDateEnd:String = null with get,set

        ///<summary>
        ///Comma Delimited List of PCCs
        ///</summary>
        [<DataMember>]
        member val OwningAgencyLocationID:String[] = null with get,set

F# ConsultantsGdsSegmentPerformance DTOs

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

HTTP + XML

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: 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>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <AirCount>0</AirCount>
      <AirCountOnline>0</AirCountOnline>
      <HotelCount>0</HotelCount>
      <HotelCountOnline>0</HotelCountOnline>
      <CarCount>0</CarCount>
      <CarCountOnline>0</CarCountOnline>
      <PassiveHotelCount>0</PassiveHotelCount>
      <PassiveHotelCountOnline>0</PassiveHotelCountOnline>
      <PassiveCarCount>0</PassiveCarCount>
      <PassiveCarCountOnline>0</PassiveCarCountOnline>
      <TURCount>0</TURCount>
      <TURCountOnline>0</TURCountOnline>
      <OtherCount>0</OtherCount>
      <OtherCountOnline>0</OtherCountOnline>
      <TotalBookings>0</TotalBookings>
      <OwningAgencyLocationCountryCode>String</OwningAgencyLocationCountryCode>
      <OwningAgencyLocationCountryName>String</OwningAgencyLocationCountryName>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>