Agentivity API

GetTravelHistorySummaryByTraveller

The following routes are available for this service:
GET	/TravelHistorySummary/Traveller

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AgentivityAPI.ServiceModel;
using AgentivityAPI.ServiceModel.Base;
using AgentivityAPI.ServiceModel.Types;

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

    [DataContract(Namespace="schemas.agentivity.com/types")]
    public partial class GetTravelHistorySummaryByTraveller
        : CompanyLevelRequestBase, IRequestConsultantID
    {
        ///<summary>
        ///Return only PNRs that are ticketed/all
        ///</summary>
        [DataMember]
        public virtual string PNRTicketed { get; set; }

        ///<summary>
        ///Traveller CRM ID or reference
        ///</summary>
        [DataMember]
        public virtual string TravellerReference { get; set; }

        ///<summary>
        ///Agentivity Traveller GUID
        ///</summary>
        [DataMember]
        public virtual string TravellerGUID { get; set; }

        ///<summary>
        ///An email of a traveller
        ///</summary>
        [DataMember]
        public virtual string TravellerEmail { get; set; }

        ///<summary>
        ///Traveller phone number
        ///</summary>
        [DataMember]
        public virtual string TravellerPhoneNbr { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string TravelDateStart { get; set; }

        ///<summary>
        ///Date in format YYYYMMDD
        ///</summary>
        [DataMember]
        public virtual string TravelDateEnd { get; set; }

        ///<summary>
        ///CRM System Name used by Agency
        ///</summary>
        [DataMember]
        public virtual string CRM { get; set; }

        ///<summary>
        ///Request Consultant ID (sign on)
        ///</summary>
        [DataMember]
        public virtual string RequestConsultantID { get; set; }
    }

    [DataContract(Name="TravellerHistory", Namespace="schemas.agentivity.com/types")]
    public partial class TravelHistorySummaryV3
    {
        [DataMember]
        public virtual float AverageItineraryChanges { get; set; }

        [DataMember]
        public virtual int BookingsMade { get; set; }

        [DataMember]
        public virtual string CountriesVisited { get; set; }

        [DataMember]
        public virtual string TripClasses { get; set; }

        [DataMember]
        public virtual int BookingsCancelled { get; set; }

        [DataMember]
        public virtual string AirSuppliersUsed { get; set; }

        [DataMember]
        public virtual int Ticketed { get; set; }

        [DataMember]
        public virtual string HotelChainsUsed { get; set; }

        [DataMember]
        public virtual int AdvancePurchaseAverageDays { get; set; }

        [DataMember]
        public virtual string CarSuppliersUsed { get; set; }

        [DataMember(Order=100)]
        public virtual string TopAirSupplierSupport { get; set; }

        [DataMember(Order=110)]
        public virtual string TopDepartureAirports { get; set; }
    }

    [DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
    public partial class TravellerHistoryResponse
        : CollectionResponse<TravelHistorySummaryV3>
    {
    }

}

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(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="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; }
    }

}

C# GetTravelHistorySummaryByTraveller 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 /TravelHistorySummary/Traveller 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>
    <TravellerHistory>
      <AdvancePurchaseAverageDays>0</AdvancePurchaseAverageDays>
      <AirSuppliersUsed>String</AirSuppliersUsed>
      <AverageItineraryChanges>0</AverageItineraryChanges>
      <BookingsCancelled>0</BookingsCancelled>
      <BookingsMade>0</BookingsMade>
      <CarSuppliersUsed>String</CarSuppliersUsed>
      <CountriesVisited>String</CountriesVisited>
      <HotelChainsUsed>String</HotelChainsUsed>
      <Ticketed>0</Ticketed>
      <TripClasses>String</TripClasses>
      <TopAirSupplierSupport>String</TopAirSupplierSupport>
      <TopDepartureAirports>String</TopDepartureAirports>
    </TravellerHistory>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>