| GET | /AgencyReviews |
|---|
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="AgencyReview", Namespace="schemas.agentivity.com/types")]
public partial class AgencyReview
{
[DataMember(Order=10)]
public virtual AgencyReviewSummary Summary { get; set; }
[DataMember(Order=20)]
public virtual AirlineSupport AirlineSupport { get; set; }
[DataMember(Order=30)]
public virtual CarSupport CarSupport { get; set; }
[DataMember(Order=40)]
public virtual HotelSupport HotelSupport { get; set; }
}
[Flags]
public enum AgencyReviewMode
{
Account = 0,
Pcc = 1,
}
[Flags]
public enum AgencyReviewOptions
{
None = 0,
Summary = 1,
AirlineSupport = 2,
SummaryAirlineSupport = 3,
CarSupport = 4,
HotelSupport = 8,
All = 15,
}
[DataContract(Namespace="schemas.agentivity.com/types")]
public partial class AgencyReviews
: CompanyLevelRequestBase, IRequestConsultantID
{
///<summary>
///Account
///</summary>
[DataMember]
public virtual string Account { get; set; }
///<summary>
///Date in format YYYYMMDD
///</summary>
[DataMember]
public virtual string PNRCreationDateStart { get; set; }
///<summary>
///Date in format YYYYMMDD
///</summary>
[DataMember]
public virtual string PNRCreationDateEnd { get; set; }
///<summary>
///Comma Delimited List of PCCs
///</summary>
[DataMember]
public virtual string[] OwningAgencyLocationID { get; set; }
///<summary>
///Load options
///</summary>
[DataMember]
public virtual AgencyReviewOptions LoadOptions { get; set; }
///<summary>
///Airline support format style
///</summary>
[DataMember]
public virtual FormattingStyle AirlineSupportFormatStyle { get; set; }
///<summary>
///Car support format style
///</summary>
[DataMember]
public virtual FormattingStyle CarSupportFormatStyle { get; set; }
///<summary>
///Hotel support format style
///</summary>
[DataMember]
public virtual FormattingStyle HotelSupportFormatStyle { get; set; }
///<summary>
///Excluded carrier code
///</summary>
[DataMember]
public virtual string ExcludedCarrierCode { get; set; }
///<summary>
///Mode
///</summary>
[DataMember]
public virtual AgencyReviewMode Mode { get; set; }
///<summary>
///Top car items
///</summary>
[DataMember]
public virtual int? TopCarItems { get; set; }
///<summary>
///Top hotel items
///</summary>
[DataMember]
public virtual int? TopHotelItems { get; set; }
///<summary>
///Includes AfterHours Servicing in results
///</summary>
[DataMember]
public virtual bool IncludeAfterHoursServicingFields { get; set; }
///<summary>
///Request Consultant ID (sign on)
///</summary>
[DataMember]
public virtual string RequestConsultantID { get; set; }
}
[DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")]
public partial class AgencyReviewsResponse
: CollectionResponse<AgencyReview>
{
}
[DataContract(Name="AgencyReviewSummary", Namespace="schemas.agentivity.com/types")]
public partial class AgencyReviewSummary
: ICarbonTonnage, ICarbonEmissionDto
{
[DataMember(Order=10)]
public virtual int TicketedBookings { get; set; }
[DataMember(Order=20)]
public virtual int LCCTktBookings { get; set; }
[DataMember(Order=25)]
public virtual int AssumedTicketedBookings { get; set; }
[DataMember(Order=30)]
public virtual int NonTicketedBookings { get; set; }
[DataMember(Order=40)]
public virtual int TicketedBookingsPerc { get; set; }
[DataMember(Order=50)]
public virtual int NonTicketedBookingsPerc { get; set; }
[DataMember(Order=60)]
public virtual int OnlineBookings { get; set; }
[DataMember(Order=70)]
public virtual int OfflineBookings { get; set; }
[DataMember(Order=80)]
public virtual int CxlBookings { get; set; }
[DataMember(Order=90)]
public virtual int OffLineHtlBookings { get; set; }
[DataMember(Order=100)]
public virtual int BookingsWithHotelSegments { get; set; }
[DataMember(Order=110)]
public virtual int BookingsWithCarSegments { get; set; }
[DataMember(Order=120)]
public virtual int NonAirBookings { get; set; }
[DataMember(Order=130)]
public virtual int TotalBookings { get; set; }
[DataMember(Order=140)]
public virtual int? AeroTouches { get; set; }
[DataMember(Order=145)]
public virtual int AeroTouchesAuto { get; set; }
[DataMember(Order=150)]
public virtual decimal AverageItineraryChanges { get; set; }
[DataMember(Order=160)]
public virtual decimal AverageAccountBookingToTravelTime { get; set; }
[DataMember(Order=170)]
public virtual int? TotalItineraryChangesBeforeTicketing { get; set; }
[DataMember(Order=180)]
public virtual int? TotalItineraryChangesAfterTicketing { get; set; }
[DataMember(Order=190)]
public virtual decimal TotalItineraryChanges { get; set; }
[DataMember(Order=230)]
public virtual int BookingsWithNdcContent { get; set; }
[DataMember(Order=210)]
public virtual double? CarbonEmissionValue { get; set; }
[DataMember(Order=220)]
public virtual short? CarbonEmissionUnitId { get; set; }
[DataMember(Order=200)]
public virtual double? CarbonTonnage { get; set; }
}
[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="AirlineStats", Namespace="schemas.agentivity.com/types")]
public partial class AirlineStats
{
[DataMember(Order=10)]
public virtual string CarrierCode { get; set; }
[DataMember(Order=20)]
public virtual string Carrier { get; set; }
[DataMember(Order=30)]
public virtual int TotalSegments { get; set; }
}
[DataContract(Name="AirlineSupport", Namespace="schemas.agentivity.com/types")]
public partial class AirlineSupport
{
[DataMember(Order=10)]
public virtual List<AirlineStats> AirlinesStats { get; set; }
[DataMember(Order=20)]
public virtual int TotalSegments { get; set; }
[DataMember(Order=30)]
public virtual string FormattedAirlineSupport { 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="CarStats", Namespace="schemas.agentivity.com/types")]
public partial class CarStats
{
[DataMember(Order=10)]
public virtual string VendorCode { get; set; }
[DataMember(Order=20)]
public virtual string VendorName { get; set; }
[DataMember(Order=30)]
public virtual int TotalSegments { get; set; }
}
[DataContract(Name="CarSupport", Namespace="schemas.agentivity.com/types")]
public partial class CarSupport
{
[DataMember(Order=10)]
public virtual List<CarStats> Stats { get; set; }
[DataMember(Order=20)]
public virtual int TotalSegments { get; set; }
[DataMember(Order=30)]
public virtual string FormattedCarSupport { get; set; }
}
[Flags]
public enum FormattingStyle
{
None = 0,
Html = 1,
Charting = 2,
}
[DataContract(Name="HotelStats", Namespace="schemas.agentivity.com/types")]
public partial class HotelStats
{
[DataMember(Order=10)]
public virtual string VendorCode { get; set; }
[DataMember(Order=20)]
public virtual string VendorName { get; set; }
[DataMember(Order=30)]
public virtual int TotalSegments { get; set; }
[DataMember(Order=40)]
public virtual int TotalNights { get; set; }
}
[DataContract(Name="HotelSupport", Namespace="schemas.agentivity.com/types")]
public partial class HotelSupport
{
[DataMember(Order=10)]
public virtual List<HotelStats> Stats { get; set; }
[DataMember(Order=20)]
public virtual int TotalSegments { get; set; }
[DataMember(Order=30)]
public virtual string FormattedHotelSupport { 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; }
}
}
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 /AgencyReviews 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":[{"Summary":{"TicketedBookings":0,"LCCTktBookings":0,"AssumedTicketedBookings":0,"NonTicketedBookings":0,"TicketedBookingsPerc":0,"NonTicketedBookingsPerc":0,"OnlineBookings":0,"OfflineBookings":0,"CxlBookings":0,"OffLineHtlBookings":0,"BookingsWithHotelSegments":0,"BookingsWithCarSegments":0,"NonAirBookings":0,"TotalBookings":0,"AeroTouches":0,"AeroTouchesAuto":0,"AverageItineraryChanges":0,"AverageAccountBookingToTravelTime":0,"TotalItineraryChangesBeforeTicketing":0,"TotalItineraryChangesAfterTicketing":0,"TotalItineraryChanges":0,"CarbonTonnage":0,"CarbonEmissionValue":0,"CarbonEmissionUnitId":0,"BookingsWithNdcContent":0},"AirlineSupport":{"AirlinesStats":[{"CarrierCode":"String","Carrier":"String","TotalSegments":0}],"TotalSegments":0,"FormattedAirlineSupport":"String"},"CarSupport":{"Stats":[{"VendorCode":"String","VendorName":"String","TotalSegments":0}],"TotalSegments":0,"FormattedCarSupport":"String"},"HotelSupport":{"Stats":[{"VendorCode":"String","VendorName":"String","TotalSegments":0,"TotalNights":0}],"TotalSegments":0,"FormattedHotelSupport":"String"}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}