| GET | /AgencyReviews |
|---|
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="AgencyReviewSummary", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgencyReviewSummary() =
[<DataMember(Order=10)>]
member val TicketedBookings:Int32 = new Int32() with get,set
[<DataMember(Order=20)>]
member val LCCTktBookings:Int32 = new Int32() with get,set
[<DataMember(Order=25)>]
member val AssumedTicketedBookings:Int32 = new Int32() with get,set
[<DataMember(Order=30)>]
member val NonTicketedBookings:Int32 = new Int32() with get,set
[<DataMember(Order=40)>]
member val TicketedBookingsPerc:Int32 = new Int32() with get,set
[<DataMember(Order=50)>]
member val NonTicketedBookingsPerc:Int32 = new Int32() with get,set
[<DataMember(Order=60)>]
member val OnlineBookings:Int32 = new Int32() with get,set
[<DataMember(Order=70)>]
member val OfflineBookings:Int32 = new Int32() with get,set
[<DataMember(Order=80)>]
member val CxlBookings:Int32 = new Int32() with get,set
[<DataMember(Order=90)>]
member val OffLineHtlBookings:Int32 = new Int32() with get,set
[<DataMember(Order=100)>]
member val BookingsWithHotelSegments:Int32 = new Int32() with get,set
[<DataMember(Order=110)>]
member val BookingsWithCarSegments:Int32 = new Int32() with get,set
[<DataMember(Order=120)>]
member val NonAirBookings:Int32 = new Int32() with get,set
[<DataMember(Order=130)>]
member val TotalBookings:Int32 = new Int32() with get,set
[<DataMember(Order=140)>]
member val AeroTouches:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=145)>]
member val AeroTouchesAuto:Int32 = new Int32() with get,set
[<DataMember(Order=150)>]
member val AverageItineraryChanges:Decimal = new Decimal() with get,set
[<DataMember(Order=160)>]
member val AverageAccountBookingToTravelTime:Decimal = new Decimal() with get,set
[<DataMember(Order=170)>]
member val TotalItineraryChangesBeforeTicketing:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=180)>]
member val TotalItineraryChangesAfterTicketing:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=190)>]
member val TotalItineraryChanges:Decimal = new Decimal() with get,set
[<DataMember(Order=230)>]
member val BookingsWithNdcContent:Int32 = new Int32() with get,set
[<DataMember(Order=210)>]
member val CarbonEmissionValue:Nullable<Double> = new Nullable<Double>() with get,set
[<DataMember(Order=220)>]
member val CarbonEmissionUnitId:Nullable<Int16> = new Nullable<Int16>() with get,set
[<DataMember(Order=200)>]
member val CarbonTonnage:Nullable<Double> = new Nullable<Double>() with get,set
[<DataContract(Name="AirlineStats", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AirlineStats() =
[<DataMember(Order=10)>]
member val CarrierCode:String = null with get,set
[<DataMember(Order=20)>]
member val Carrier:String = null with get,set
[<DataMember(Order=30)>]
member val TotalSegments:Int32 = new Int32() with get,set
[<DataContract(Name="AirlineSupport", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AirlineSupport() =
[<DataMember(Order=10)>]
member val AirlinesStats:ResizeArray<AirlineStats> = null with get,set
[<DataMember(Order=20)>]
member val TotalSegments:Int32 = new Int32() with get,set
[<DataMember(Order=30)>]
member val FormattedAirlineSupport:String = null with get,set
[<DataContract(Name="CarStats", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CarStats() =
[<DataMember(Order=10)>]
member val VendorCode:String = null with get,set
[<DataMember(Order=20)>]
member val VendorName:String = null with get,set
[<DataMember(Order=30)>]
member val TotalSegments:Int32 = new Int32() with get,set
[<DataContract(Name="CarSupport", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type CarSupport() =
[<DataMember(Order=10)>]
member val Stats:ResizeArray<CarStats> = null with get,set
[<DataMember(Order=20)>]
member val TotalSegments:Int32 = new Int32() with get,set
[<DataMember(Order=30)>]
member val FormattedCarSupport:String = null with get,set
[<DataContract(Name="HotelStats", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type HotelStats() =
[<DataMember(Order=10)>]
member val VendorCode:String = null with get,set
[<DataMember(Order=20)>]
member val VendorName:String = null with get,set
[<DataMember(Order=30)>]
member val TotalSegments:Int32 = new Int32() with get,set
[<DataMember(Order=40)>]
member val TotalNights:Int32 = new Int32() with get,set
[<DataContract(Name="HotelSupport", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type HotelSupport() =
[<DataMember(Order=10)>]
member val Stats:ResizeArray<HotelStats> = null with get,set
[<DataMember(Order=20)>]
member val TotalSegments:Int32 = new Int32() with get,set
[<DataMember(Order=30)>]
member val FormattedHotelSupport:String = null with get,set
[<DataContract(Name="AgencyReview", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgencyReview() =
[<DataMember(Order=10)>]
member val Summary:AgencyReviewSummary = null with get,set
[<DataMember(Order=20)>]
member val AirlineSupport:AirlineSupport = null with get,set
[<DataMember(Order=30)>]
member val CarSupport:CarSupport = null with get,set
[<DataMember(Order=40)>]
member val HotelSupport:HotelSupport = null with get,set
[<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="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type ApiRequestPerHour() =
[<DataMember(Order=10)>]
member val RequestDate:DateTime = new DateTime() with get,set
[<DataMember(Order=100)>]
member val Hour0:Int32 = new Int32() with get,set
[<DataMember(Order=110)>]
member val Hour1:Int32 = new Int32() with get,set
[<DataMember(Order=120)>]
member val Hour2:Int32 = new Int32() with get,set
[<DataMember(Order=130)>]
member val Hour3:Int32 = new Int32() with get,set
[<DataMember(Order=140)>]
member val Hour4:Int32 = new Int32() with get,set
[<DataMember(Order=150)>]
member val Hour5:Int32 = new Int32() with get,set
[<DataMember(Order=160)>]
member val Hour6:Int32 = new Int32() with get,set
[<DataMember(Order=170)>]
member val Hour7:Int32 = new Int32() with get,set
[<DataMember(Order=180)>]
member val Hour8:Int32 = new Int32() with get,set
[<DataMember(Order=190)>]
member val Hour9:Int32 = new Int32() with get,set
[<DataMember(Order=200)>]
member val Hour10:Int32 = new Int32() with get,set
[<DataMember(Order=210)>]
member val Hour11:Int32 = new Int32() with get,set
[<DataMember(Order=220)>]
member val Hour12:Int32 = new Int32() with get,set
[<DataMember(Order=230)>]
member val Hour13:Int32 = new Int32() with get,set
[<DataMember(Order=240)>]
member val Hour14:Int32 = new Int32() with get,set
[<DataMember(Order=250)>]
member val Hour15:Int32 = new Int32() with get,set
[<DataMember(Order=260)>]
member val Hour16:Int32 = new Int32() with get,set
[<DataMember(Order=270)>]
member val Hour17:Int32 = new Int32() with get,set
[<DataMember(Order=280)>]
member val Hour18:Int32 = new Int32() with get,set
[<DataMember(Order=290)>]
member val Hour19:Int32 = new Int32() with get,set
[<DataMember(Order=300)>]
member val Hour20:Int32 = new Int32() with get,set
[<DataMember(Order=310)>]
member val Hour21:Int32 = new Int32() with get,set
[<DataMember(Order=320)>]
member val Hour22:Int32 = new Int32() with get,set
[<DataMember(Order=330)>]
member val Hour23:Int32 = new Int32() 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 CollectionResponse<TItem>() =
[<DataMember(Order=1)>]
member val ResponseMetadata:ResponseMetadata = null with get,set
[<DataMember(Order=2, EmitDefaultValue=false)>]
member val ResponseReport:ResizeArray<ApiRequestPerHour> = 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 AgencyReviewsResponse() =
inherit CollectionResponse<AgencyReview>()
[<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
[<Flags>]
type AgencyReviewOptions =
| None = 0
| Summary = 1
| AirlineSupport = 2
| SummaryAirlineSupport = 3
| CarSupport = 4
| HotelSupport = 8
| All = 15
[<Flags>]
type FormattingStyle =
| None = 0
| Html = 1
| Charting = 2
[<Flags>]
type AgencyReviewMode =
| Account = 0
| Pcc = 1
[<DataContract(Namespace="schemas.agentivity.com/types")>]
[<AllowNullLiteral>]
type AgencyReviews() =
inherit CompanyLevelRequestBase()
///<summary>
///Account
///</summary>
[<DataMember>]
member val Account:String = null with get,set
///<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
///<summary>
///Load options
///</summary>
[<DataMember>]
member val LoadOptions:AgencyReviewOptions = new AgencyReviewOptions() with get,set
///<summary>
///Airline support format style
///</summary>
[<DataMember>]
member val AirlineSupportFormatStyle:FormattingStyle = new FormattingStyle() with get,set
///<summary>
///Car support format style
///</summary>
[<DataMember>]
member val CarSupportFormatStyle:FormattingStyle = new FormattingStyle() with get,set
///<summary>
///Hotel support format style
///</summary>
[<DataMember>]
member val HotelSupportFormatStyle:FormattingStyle = new FormattingStyle() with get,set
///<summary>
///Excluded carrier code
///</summary>
[<DataMember>]
member val ExcludedCarrierCode:String = null with get,set
///<summary>
///Mode
///</summary>
[<DataMember>]
member val Mode:AgencyReviewMode = new AgencyReviewMode() with get,set
///<summary>
///Top car items
///</summary>
[<DataMember>]
member val TopCarItems:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Top hotel items
///</summary>
[<DataMember>]
member val TopHotelItems:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Includes AfterHours Servicing in results
///</summary>
[<DataMember>]
member val IncludeAfterHoursServicingFields:Boolean = new Boolean() with get,set
///<summary>
///Request Consultant ID (sign on)
///</summary>
[<DataMember>]
member val RequestConsultantID:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/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>
<AgencyReview>
<Summary>
<TicketedBookings>0</TicketedBookings>
<LCCTktBookings>0</LCCTktBookings>
<AssumedTicketedBookings>0</AssumedTicketedBookings>
<NonTicketedBookings>0</NonTicketedBookings>
<TicketedBookingsPerc>0</TicketedBookingsPerc>
<NonTicketedBookingsPerc>0</NonTicketedBookingsPerc>
<OnlineBookings>0</OnlineBookings>
<OfflineBookings>0</OfflineBookings>
<CxlBookings>0</CxlBookings>
<OffLineHtlBookings>0</OffLineHtlBookings>
<BookingsWithHotelSegments>0</BookingsWithHotelSegments>
<BookingsWithCarSegments>0</BookingsWithCarSegments>
<NonAirBookings>0</NonAirBookings>
<TotalBookings>0</TotalBookings>
<AeroTouches>0</AeroTouches>
<AeroTouchesAuto>0</AeroTouchesAuto>
<AverageItineraryChanges>0</AverageItineraryChanges>
<AverageAccountBookingToTravelTime>0</AverageAccountBookingToTravelTime>
<TotalItineraryChangesBeforeTicketing>0</TotalItineraryChangesBeforeTicketing>
<TotalItineraryChangesAfterTicketing>0</TotalItineraryChangesAfterTicketing>
<TotalItineraryChanges>0</TotalItineraryChanges>
<CarbonTonnage>0</CarbonTonnage>
<CarbonEmissionValue>0</CarbonEmissionValue>
<CarbonEmissionUnitId>0</CarbonEmissionUnitId>
<BookingsWithNdcContent>0</BookingsWithNdcContent>
</Summary>
<AirlineSupport>
<AirlinesStats>
<AirlineStats>
<CarrierCode>String</CarrierCode>
<Carrier>String</Carrier>
<TotalSegments>0</TotalSegments>
</AirlineStats>
</AirlinesStats>
<TotalSegments>0</TotalSegments>
<FormattedAirlineSupport>String</FormattedAirlineSupport>
</AirlineSupport>
<CarSupport>
<Stats>
<CarStats>
<VendorCode>String</VendorCode>
<VendorName>String</VendorName>
<TotalSegments>0</TotalSegments>
</CarStats>
</Stats>
<TotalSegments>0</TotalSegments>
<FormattedCarSupport>String</FormattedCarSupport>
</CarSupport>
<HotelSupport>
<Stats>
<HotelStats>
<VendorCode>String</VendorCode>
<VendorName>String</VendorName>
<TotalSegments>0</TotalSegments>
<TotalNights>0</TotalNights>
</HotelStats>
</Stats>
<TotalSegments>0</TotalSegments>
<FormattedHotelSupport>String</FormattedHotelSupport>
</HotelSupport>
</AgencyReview>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>