| GET | /AgencyReviews |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AgentivityAPI.ServiceModel.Types
Imports AgentivityAPI.ServiceModel.Base
Imports AgentivityAPI.ServiceModel
Namespace Global
Namespace AgentivityAPI.ServiceModel
<DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CollectionResponse(Of TItem)
<DataMember(Order:=1)>
Public Overridable Property ResponseMetadata As ResponseMetadata
<DataMember(Order:=2, EmitDefaultValue:=false)>
Public Overridable Property ResponseReport As List(Of ApiRequestPerHour)
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property ResponseError As AgentivityError
End Class
End Namespace
Namespace AgentivityAPI.ServiceModel.Base
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class CompanyLevelRequestBase
Inherits PagingMetadata
Implements IMemberUsername
Implements IMemberOwningCompanyCode
'''<Summary>
'''Comma Delimited List of Owning Company Codes
'''</Summary>
<DataMember>
Public Overridable Property OwningCompanyCode As String() Implements IMemberOwningCompanyCode.OwningCompanyCode
'''<Summary>
'''UserName in form of an email address
'''</Summary>
<DataMember>
Public Overridable Property UserName As String Implements IMemberUsername.UserName
End Class
End Namespace
Namespace AgentivityAPI.ServiceModel.Types
<DataContract(Name:="AgencyReview", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AgencyReview
<DataMember(Order:=10)>
Public Overridable Property Summary As AgencyReviewSummary
<DataMember(Order:=20)>
Public Overridable Property AirlineSupport As AirlineSupport
<DataMember(Order:=30)>
Public Overridable Property CarSupport As CarSupport
<DataMember(Order:=40)>
Public Overridable Property HotelSupport As HotelSupport
End Class
<Flags>
Public Enum AgencyReviewMode
Account = 0
Pcc = 1
End Enum
<Flags>
Public Enum AgencyReviewOptions
None = 0
Summary = 1
AirlineSupport = 2
SummaryAirlineSupport = 3
CarSupport = 4
HotelSupport = 8
All = 15
End Enum
<DataContract(Namespace:="schemas.agentivity.com/types")>
Public Partial Class AgencyReviews
Inherits CompanyLevelRequestBase
Implements IRequestConsultantID
'''<Summary>
'''Account
'''</Summary>
<DataMember>
Public Overridable Property Account As String
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property PNRCreationDateStart As String
'''<Summary>
'''Date in format YYYYMMDD
'''</Summary>
<DataMember>
Public Overridable Property PNRCreationDateEnd As String
'''<Summary>
'''Comma Delimited List of PCCs
'''</Summary>
<DataMember>
Public Overridable Property OwningAgencyLocationID As String()
'''<Summary>
'''Load options
'''</Summary>
<DataMember>
Public Overridable Property LoadOptions As AgencyReviewOptions
'''<Summary>
'''Airline support format style
'''</Summary>
<DataMember>
Public Overridable Property AirlineSupportFormatStyle As FormattingStyle
'''<Summary>
'''Car support format style
'''</Summary>
<DataMember>
Public Overridable Property CarSupportFormatStyle As FormattingStyle
'''<Summary>
'''Hotel support format style
'''</Summary>
<DataMember>
Public Overridable Property HotelSupportFormatStyle As FormattingStyle
'''<Summary>
'''Excluded carrier code
'''</Summary>
<DataMember>
Public Overridable Property ExcludedCarrierCode As String
'''<Summary>
'''Mode
'''</Summary>
<DataMember>
Public Overridable Property Mode As AgencyReviewMode
'''<Summary>
'''Top car items
'''</Summary>
<DataMember>
Public Overridable Property TopCarItems As Integer?
'''<Summary>
'''Top hotel items
'''</Summary>
<DataMember>
Public Overridable Property TopHotelItems As Integer?
'''<Summary>
'''Includes AfterHours Servicing in results
'''</Summary>
<DataMember>
Public Overridable Property IncludeAfterHoursServicingFields As Boolean
'''<Summary>
'''Request Consultant ID (sign on)
'''</Summary>
<DataMember>
Public Overridable Property RequestConsultantID As String Implements IRequestConsultantID.RequestConsultantID
End Class
<DataContract(Name:="AgentivityResponse", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AgencyReviewsResponse
Inherits CollectionResponse(Of AgencyReview)
End Class
<DataContract(Name:="AgencyReviewSummary", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AgencyReviewSummary
Implements ICarbonTonnage
Implements ICarbonEmissionDto
<DataMember(Order:=10)>
Public Overridable Property TicketedBookings As Integer
<DataMember(Order:=20)>
Public Overridable Property LCCTktBookings As Integer
<DataMember(Order:=25)>
Public Overridable Property AssumedTicketedBookings As Integer
<DataMember(Order:=30)>
Public Overridable Property NonTicketedBookings As Integer
<DataMember(Order:=40)>
Public Overridable Property TicketedBookingsPerc As Integer
<DataMember(Order:=50)>
Public Overridable Property NonTicketedBookingsPerc As Integer
<DataMember(Order:=60)>
Public Overridable Property OnlineBookings As Integer
<DataMember(Order:=70)>
Public Overridable Property OfflineBookings As Integer
<DataMember(Order:=80)>
Public Overridable Property CxlBookings As Integer
<DataMember(Order:=90)>
Public Overridable Property OffLineHtlBookings As Integer
<DataMember(Order:=100)>
Public Overridable Property BookingsWithHotelSegments As Integer
<DataMember(Order:=110)>
Public Overridable Property BookingsWithCarSegments As Integer
<DataMember(Order:=120)>
Public Overridable Property NonAirBookings As Integer
<DataMember(Order:=130)>
Public Overridable Property TotalBookings As Integer
<DataMember(Order:=140)>
Public Overridable Property AeroTouches As Integer?
<DataMember(Order:=145)>
Public Overridable Property AeroTouchesAuto As Integer
<DataMember(Order:=150)>
Public Overridable Property AverageItineraryChanges As Decimal
<DataMember(Order:=160)>
Public Overridable Property AverageAccountBookingToTravelTime As Decimal
<DataMember(Order:=170)>
Public Overridable Property TotalItineraryChangesBeforeTicketing As Integer?
<DataMember(Order:=180)>
Public Overridable Property TotalItineraryChangesAfterTicketing As Integer?
<DataMember(Order:=190)>
Public Overridable Property TotalItineraryChanges As Decimal
<DataMember(Order:=230)>
Public Overridable Property BookingsWithNdcContent As Integer
<DataMember(Order:=210)>
Public Overridable Property CarbonEmissionValue As Double? Implements ICarbonEmissionDto.CarbonEmissionValue
<DataMember(Order:=220)>
Public Overridable Property CarbonEmissionUnitId As Short? Implements ICarbonEmissionDto.CarbonEmissionUnitId
<DataMember(Order:=200)>
Public Overridable Property CarbonTonnage As Double? Implements ICarbonTonnage.CarbonTonnage
End Class
<DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AgentivityError
<DataMember>
Public Overridable Property ErrorCode As String
<DataMember>
Public Overridable Property Message As String
<DataMember>
Public Overridable Property StatusCode As String
<DataMember>
Public Overridable Property VerboseMessage As String
End Class
<DataContract(Name:="AirlineStats", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AirlineStats
<DataMember(Order:=10)>
Public Overridable Property CarrierCode As String
<DataMember(Order:=20)>
Public Overridable Property Carrier As String
<DataMember(Order:=30)>
Public Overridable Property TotalSegments As Integer
End Class
<DataContract(Name:="AirlineSupport", Namespace:="schemas.agentivity.com/types")>
Public Partial Class AirlineSupport
<DataMember(Order:=10)>
Public Overridable Property AirlinesStats As List(Of AirlineStats)
<DataMember(Order:=20)>
Public Overridable Property TotalSegments As Integer
<DataMember(Order:=30)>
Public Overridable Property FormattedAirlineSupport As String
End Class
<DataContract(Name:="ApiRequestPerHour", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ApiRequestPerHour
<DataMember(Order:=10)>
Public Overridable Property RequestDate As Date
<DataMember(Order:=100)>
Public Overridable Property Hour0 As Integer
<DataMember(Order:=110)>
Public Overridable Property Hour1 As Integer
<DataMember(Order:=120)>
Public Overridable Property Hour2 As Integer
<DataMember(Order:=130)>
Public Overridable Property Hour3 As Integer
<DataMember(Order:=140)>
Public Overridable Property Hour4 As Integer
<DataMember(Order:=150)>
Public Overridable Property Hour5 As Integer
<DataMember(Order:=160)>
Public Overridable Property Hour6 As Integer
<DataMember(Order:=170)>
Public Overridable Property Hour7 As Integer
<DataMember(Order:=180)>
Public Overridable Property Hour8 As Integer
<DataMember(Order:=190)>
Public Overridable Property Hour9 As Integer
<DataMember(Order:=200)>
Public Overridable Property Hour10 As Integer
<DataMember(Order:=210)>
Public Overridable Property Hour11 As Integer
<DataMember(Order:=220)>
Public Overridable Property Hour12 As Integer
<DataMember(Order:=230)>
Public Overridable Property Hour13 As Integer
<DataMember(Order:=240)>
Public Overridable Property Hour14 As Integer
<DataMember(Order:=250)>
Public Overridable Property Hour15 As Integer
<DataMember(Order:=260)>
Public Overridable Property Hour16 As Integer
<DataMember(Order:=270)>
Public Overridable Property Hour17 As Integer
<DataMember(Order:=280)>
Public Overridable Property Hour18 As Integer
<DataMember(Order:=290)>
Public Overridable Property Hour19 As Integer
<DataMember(Order:=300)>
Public Overridable Property Hour20 As Integer
<DataMember(Order:=310)>
Public Overridable Property Hour21 As Integer
<DataMember(Order:=320)>
Public Overridable Property Hour22 As Integer
<DataMember(Order:=330)>
Public Overridable Property Hour23 As Integer
End Class
<DataContract(Name:="CacheMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CacheMetadata
<DataMember(Order:=1)>
Public Overridable Property CachedAt As Date
<DataMember(Order:=2)>
Public Overridable Property CacheExpiresAt As Date
<DataMember(Order:=0)>
Public Overridable Property IsFromCache As Boolean
End Class
<DataContract(Name:="CarStats", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CarStats
<DataMember(Order:=10)>
Public Overridable Property VendorCode As String
<DataMember(Order:=20)>
Public Overridable Property VendorName As String
<DataMember(Order:=30)>
Public Overridable Property TotalSegments As Integer
End Class
<DataContract(Name:="CarSupport", Namespace:="schemas.agentivity.com/types")>
Public Partial Class CarSupport
<DataMember(Order:=10)>
Public Overridable Property Stats As List(Of CarStats)
<DataMember(Order:=20)>
Public Overridable Property TotalSegments As Integer
<DataMember(Order:=30)>
Public Overridable Property FormattedCarSupport As String
End Class
<Flags>
Public Enum FormattingStyle
None = 0
Html = 1
Charting = 2
End Enum
<DataContract(Name:="HotelStats", Namespace:="schemas.agentivity.com/types")>
Public Partial Class HotelStats
<DataMember(Order:=10)>
Public Overridable Property VendorCode As String
<DataMember(Order:=20)>
Public Overridable Property VendorName As String
<DataMember(Order:=30)>
Public Overridable Property TotalSegments As Integer
<DataMember(Order:=40)>
Public Overridable Property TotalNights As Integer
End Class
<DataContract(Name:="HotelSupport", Namespace:="schemas.agentivity.com/types")>
Public Partial Class HotelSupport
<DataMember(Order:=10)>
Public Overridable Property Stats As List(Of HotelStats)
<DataMember(Order:=20)>
Public Overridable Property TotalSegments As Integer
<DataMember(Order:=30)>
Public Overridable Property FormattedHotelSupport As String
End Class
<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 Overridable Property Offset As String
'''<Summary>
'''Number of records to return (PageSize)
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Number of records to return (PageSize)", Name:="Limit", ParameterType:="query")>
Public Overridable Property Limit As String
'''<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 Overridable Property TotalRecords As Integer
'''<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 Overridable Property ResponseRecords As Integer
End Class
<DataContract(Name:="ResponseMetadata", Namespace:="schemas.agentivity.com/types")>
Public Partial Class ResponseMetadata
<DataMember(Order:=0)>
Public Overridable Property Success As Boolean
<DataMember(Order:=1)>
Public Overridable Property HasCache As Boolean
<DataMember(Order:=2)>
Public Overridable Property HasPaging As Boolean
<DataMember(Order:=3, EmitDefaultValue:=false)>
Public Overridable Property CacheMetadata As CacheMetadata
<DataMember(Order:=4, EmitDefaultValue:=false)>
Public Overridable Property PagingMetadata As PagingMetadata
End Class
End Namespace
End Namespace
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>