| GET | /AgencyReviews |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@DataContract(Namespace="schemas.agentivity.com/types")
open class AgencyReviews : CompanyLevelRequestBase(), IRequestConsultantID
{
/**
* Account
*/
@DataMember
open var Account:String? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
open var PNRCreationDateStart:String? = null
/**
* Date in format YYYYMMDD
*/
@DataMember
open var PNRCreationDateEnd:String? = null
/**
* Comma Delimited List of PCCs
*/
@DataMember
open var OwningAgencyLocationID:ArrayList<String>? = null
/**
* Load options
*/
@DataMember
open var LoadOptions:AgencyReviewOptions? = null
/**
* Airline support format style
*/
@DataMember
open var AirlineSupportFormatStyle:FormattingStyle? = null
/**
* Car support format style
*/
@DataMember
open var CarSupportFormatStyle:FormattingStyle? = null
/**
* Hotel support format style
*/
@DataMember
open var HotelSupportFormatStyle:FormattingStyle? = null
/**
* Excluded carrier code
*/
@DataMember
open var ExcludedCarrierCode:String? = null
/**
* Mode
*/
@DataMember
open var Mode:AgencyReviewMode? = null
/**
* Top car items
*/
@DataMember
open var TopCarItems:Int? = null
/**
* Top hotel items
*/
@DataMember
open var TopHotelItems:Int? = null
/**
* Includes AfterHours Servicing in results
*/
@DataMember
open var IncludeAfterHoursServicingFields:Boolean? = null
/**
* Request Consultant ID (sign on)
*/
@DataMember
override var RequestConsultantID:String? = null
}
@DataContract(Namespace="schemas.agentivity.com/types")
open class CompanyLevelRequestBase : PagingMetadata(), IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
@DataMember
override var OwningCompanyCode:ArrayList<String>? = null
/**
* UserName in form of an email address
*/
@DataMember
override var UserName:String? = null
}
@DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
open class PagingMetadata
{
/**
* Starting Record
*/
@DataMember
@ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
open var Offset:String? = null
/**
* Number of records to return (PageSize)
*/
@DataMember
@ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
open var Limit:String? = null
/**
* Total Number of Records in a Full Reponse (if no paging)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
open var TotalRecords:Int? = null
/**
* Total Number of Records in this Reponse (on this page)
*/
@DataMember
@ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
open var ResponseRecords:Int? = null
}
@Flags()
enum class AgencyReviewOptions(val value:Int)
{
@SerializedName("0") None(0),
@SerializedName("1") Summary(1),
@SerializedName("2") AirlineSupport(2),
@SerializedName("3") SummaryAirlineSupport(3),
@SerializedName("4") CarSupport(4),
@SerializedName("8") HotelSupport(8),
@SerializedName("15") All(15),
}
@Flags()
enum class FormattingStyle(val value:Int)
{
@SerializedName("0") None(0),
@SerializedName("1") Html(1),
@SerializedName("2") Charting(2),
}
@Flags()
enum class AgencyReviewMode(val value:Int)
{
@SerializedName("0") Account(0),
@SerializedName("1") Pcc(1),
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class AgencyReviewsResponse : CollectionResponse<AgencyReview>()
{
}
@DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
open class CollectionResponse<TItem>
{
@DataMember(Order=1)
open var ResponseMetadata:ResponseMetadata? = null
@DataMember(Order=2, EmitDefaultValue=false)
open var ResponseReport:ArrayList<ApiRequestPerHour>? = null
@DataMember(Order=3, EmitDefaultValue=false)
open var ResponseError:AgentivityError? = null
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class ResponseMetadata
{
@DataMember(Order=0)
open var Success:Boolean? = null
@DataMember(Order=1)
open var HasCache:Boolean? = null
@DataMember(Order=2)
open var HasPaging:Boolean? = null
@DataMember(Order=3, EmitDefaultValue=false)
open var CacheMetadata:CacheMetadata? = null
@DataMember(Order=4, EmitDefaultValue=false)
open var PagingMetadata:PagingMetadata? = null
}
@DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
open class CacheMetadata
{
@DataMember(Order=1)
open var CachedAt:Date? = null
@DataMember(Order=2)
open var CacheExpiresAt:Date? = null
@DataMember(Order=0)
open var IsFromCache:Boolean? = null
}
@DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
open class ApiRequestPerHour
{
@DataMember(Order=10)
open var RequestDate:Date? = null
@DataMember(Order=100)
open var Hour0:Int? = null
@DataMember(Order=110)
open var Hour1:Int? = null
@DataMember(Order=120)
open var Hour2:Int? = null
@DataMember(Order=130)
open var Hour3:Int? = null
@DataMember(Order=140)
open var Hour4:Int? = null
@DataMember(Order=150)
open var Hour5:Int? = null
@DataMember(Order=160)
open var Hour6:Int? = null
@DataMember(Order=170)
open var Hour7:Int? = null
@DataMember(Order=180)
open var Hour8:Int? = null
@DataMember(Order=190)
open var Hour9:Int? = null
@DataMember(Order=200)
open var Hour10:Int? = null
@DataMember(Order=210)
open var Hour11:Int? = null
@DataMember(Order=220)
open var Hour12:Int? = null
@DataMember(Order=230)
open var Hour13:Int? = null
@DataMember(Order=240)
open var Hour14:Int? = null
@DataMember(Order=250)
open var Hour15:Int? = null
@DataMember(Order=260)
open var Hour16:Int? = null
@DataMember(Order=270)
open var Hour17:Int? = null
@DataMember(Order=280)
open var Hour18:Int? = null
@DataMember(Order=290)
open var Hour19:Int? = null
@DataMember(Order=300)
open var Hour20:Int? = null
@DataMember(Order=310)
open var Hour21:Int? = null
@DataMember(Order=320)
open var Hour22:Int? = null
@DataMember(Order=330)
open var Hour23:Int? = null
}
@DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
open class AgentivityError
{
@DataMember
open var ErrorCode:String? = null
@DataMember
open var Message:String? = null
@DataMember
open var StatusCode:String? = null
@DataMember
open var VerboseMessage:String? = null
}
@DataContract(Name="AgencyReview", Namespace="schemas.agentivity.com/types")
open class AgencyReview
{
@DataMember(Order=10)
open var Summary:AgencyReviewSummary? = null
@DataMember(Order=20)
open var AirlineSupport:AirlineSupport? = null
@DataMember(Order=30)
open var CarSupport:CarSupport? = null
@DataMember(Order=40)
open var HotelSupport:HotelSupport? = null
}
@DataContract(Name="AgencyReviewSummary", Namespace="schemas.agentivity.com/types")
open class AgencyReviewSummary : ICarbonTonnage, ICarbonEmissionDto
{
@DataMember(Order=10)
open var TicketedBookings:Int? = null
@DataMember(Order=20)
open var LCCTktBookings:Int? = null
@DataMember(Order=25)
open var AssumedTicketedBookings:Int? = null
@DataMember(Order=30)
open var NonTicketedBookings:Int? = null
@DataMember(Order=40)
open var TicketedBookingsPerc:Int? = null
@DataMember(Order=50)
open var NonTicketedBookingsPerc:Int? = null
@DataMember(Order=60)
open var OnlineBookings:Int? = null
@DataMember(Order=70)
open var OfflineBookings:Int? = null
@DataMember(Order=80)
open var CxlBookings:Int? = null
@DataMember(Order=90)
open var OffLineHtlBookings:Int? = null
@DataMember(Order=100)
open var BookingsWithHotelSegments:Int? = null
@DataMember(Order=110)
open var BookingsWithCarSegments:Int? = null
@DataMember(Order=120)
open var NonAirBookings:Int? = null
@DataMember(Order=130)
open var TotalBookings:Int? = null
@DataMember(Order=140)
open var AeroTouches:Int? = null
@DataMember(Order=145)
open var AeroTouchesAuto:Int? = null
@DataMember(Order=150)
open var AverageItineraryChanges:BigDecimal? = null
@DataMember(Order=160)
open var AverageAccountBookingToTravelTime:BigDecimal? = null
@DataMember(Order=170)
open var TotalItineraryChangesBeforeTicketing:Int? = null
@DataMember(Order=180)
open var TotalItineraryChangesAfterTicketing:Int? = null
@DataMember(Order=190)
open var TotalItineraryChanges:BigDecimal? = null
@DataMember(Order=230)
open var BookingsWithNdcContent:Int? = null
@DataMember(Order=210)
override var CarbonEmissionValue:Double? = null
@DataMember(Order=220)
override var CarbonEmissionUnitId:Short? = null
@DataMember(Order=200)
override var CarbonTonnage:Double? = null
}
@DataContract(Name="AirlineSupport", Namespace="schemas.agentivity.com/types")
open class AirlineSupport
{
@DataMember(Order=10)
open var AirlinesStats:ArrayList<AirlineStats>? = null
@DataMember(Order=20)
open var TotalSegments:Int? = null
@DataMember(Order=30)
open var FormattedAirlineSupport:String? = null
}
@DataContract(Name="AirlineStats", Namespace="schemas.agentivity.com/types")
open class AirlineStats
{
@DataMember(Order=10)
open var CarrierCode:String? = null
@DataMember(Order=20)
open var Carrier:String? = null
@DataMember(Order=30)
open var TotalSegments:Int? = null
}
@DataContract(Name="CarSupport", Namespace="schemas.agentivity.com/types")
open class CarSupport
{
@DataMember(Order=10)
open var Stats:ArrayList<CarStats>? = null
@DataMember(Order=20)
open var TotalSegments:Int? = null
@DataMember(Order=30)
open var FormattedCarSupport:String? = null
}
@DataContract(Name="CarStats", Namespace="schemas.agentivity.com/types")
open class CarStats
{
@DataMember(Order=10)
open var VendorCode:String? = null
@DataMember(Order=20)
open var VendorName:String? = null
@DataMember(Order=30)
open var TotalSegments:Int? = null
}
@DataContract(Name="HotelSupport", Namespace="schemas.agentivity.com/types")
open class HotelSupport
{
@DataMember(Order=10)
open var Stats:ArrayList<HotelStats>? = null
@DataMember(Order=20)
open var TotalSegments:Int? = null
@DataMember(Order=30)
open var FormattedHotelSupport:String? = null
}
@DataContract(Name="HotelStats", Namespace="schemas.agentivity.com/types")
open class HotelStats
{
@DataMember(Order=10)
open var VendorCode:String? = null
@DataMember(Order=20)
open var VendorName:String? = null
@DataMember(Order=30)
open var TotalSegments:Int? = null
@DataMember(Order=40)
open var TotalNights:Int? = null
}
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>