Agentivity API

<back to all web services

GetDistributorBookingsTravellingByAirlineClass

The following routes are available for this service:
GET/DistributorBookingsByAirlineClass
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class GetDistributorBookingsTravellingByAirlineClass extends PagingMetadata
    {
        /**
        * ID of Distributor
        */
        @DataMember
        public Integer DistributorID = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String IssueDateStart = null;

        /**
        * Date in format YYYYMMDD
        */
        @DataMember
        public String IssueDateEnd = null;

        /**
        * Two letter code for carrier
        */
        @DataMember
        public String PlatingCarrier = null;

        /**
        * Booking Class Name
        */
        @DataMember
        public String BookingClassName = null;

        /**
        * BoardPoint CountryCode
        */
        @DataMember
        public String BoardPointCountryCode = null;

        /**
        * Include Itinerary in the response
        */
        @DataMember
        public Boolean IncludeItinerary = null;

        /**
        * Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
        */
        @DataMember
        public FormattingStyle ItineraryFormatting = null;
        
        public Integer getDistributorID() { return DistributorID; }
        public GetDistributorBookingsTravellingByAirlineClass setDistributorID(Integer value) { this.DistributorID = value; return this; }
        public String getIssueDateStart() { return IssueDateStart; }
        public GetDistributorBookingsTravellingByAirlineClass setIssueDateStart(String value) { this.IssueDateStart = value; return this; }
        public String getIssueDateEnd() { return IssueDateEnd; }
        public GetDistributorBookingsTravellingByAirlineClass setIssueDateEnd(String value) { this.IssueDateEnd = value; return this; }
        public String getPlatingCarrier() { return PlatingCarrier; }
        public GetDistributorBookingsTravellingByAirlineClass setPlatingCarrier(String value) { this.PlatingCarrier = value; return this; }
        public String getBookingClassName() { return BookingClassName; }
        public GetDistributorBookingsTravellingByAirlineClass setBookingClassName(String value) { this.BookingClassName = value; return this; }
        public String getBoardPointCountryCode() { return BoardPointCountryCode; }
        public GetDistributorBookingsTravellingByAirlineClass setBoardPointCountryCode(String value) { this.BoardPointCountryCode = value; return this; }
        public Boolean isIncludeItinerary() { return IncludeItinerary; }
        public GetDistributorBookingsTravellingByAirlineClass setIncludeItinerary(Boolean value) { this.IncludeItinerary = value; return this; }
        public FormattingStyle getItineraryFormatting() { return ItineraryFormatting; }
        public GetDistributorBookingsTravellingByAirlineClass setItineraryFormatting(FormattingStyle value) { this.ItineraryFormatting = value; return this; }
    }

    @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
    public static class PagingMetadata
    {
        /**
        * Starting Record
        */
        @DataMember
        @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
        public String Offset = null;

        /**
        * Number of records to return (PageSize)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
        public String Limit = 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")
        public Integer TotalRecords = 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")
        public Integer ResponseRecords = null;
        
        public String getOffset() { return Offset; }
        public PagingMetadata setOffset(String value) { this.Offset = value; return this; }
        public String getLimit() { return Limit; }
        public PagingMetadata setLimit(String value) { this.Limit = value; return this; }
        public Integer getTotalRecords() { return TotalRecords; }
        public PagingMetadata setTotalRecords(Integer value) { this.TotalRecords = value; return this; }
        public Integer getResponseRecords() { return ResponseRecords; }
        public PagingMetadata setResponseRecords(Integer value) { this.ResponseRecords = value; return this; }
    }

    @Flags()
    public static enum FormattingStyle
    {
        @SerializedName("0") None(0),
        @SerializedName("1") Html(1),
        @SerializedName("2") Charting(2);

        private final int value;
        FormattingStyle(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
    public static class DistributorBookingsByAirlineClassItemResponse extends ItemResponse<BookingByAirlineWithClassSupport, BookingsByAirlineWithClassSupportResponseReport>
    {
        
    }

    @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
    public static class ItemResponse<TItem, TReport>
    {
        @DataMember(Order=1)
        public ResponseMetadata ResponseMetadata = null;

        @DataMember(Order=2, EmitDefaultValue=false)
        public TReport ResponseReport = null;

        @DataMember(Order=3, EmitDefaultValue=false)
        public AgentivityError ResponseError = null;
        
        public ResponseMetadata getResponseMetadata() { return ResponseMetadata; }
        public ItemResponse<TItem, TReport> setResponseMetadata(ResponseMetadata value) { this.ResponseMetadata = value; return this; }
        public TReport getResponseReport() { return ResponseReport; }
        public ItemResponse<TItem, TReport> setResponseReport(TReport value) { this.ResponseReport = value; return this; }
        public AgentivityError getResponseError() { return ResponseError; }
        public ItemResponse<TItem, TReport> setResponseError(AgentivityError value) { this.ResponseError = value; return this; }
    }

    @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
    public static class ResponseMetadata
    {
        @DataMember(Order=0)
        public Boolean Success = null;

        @DataMember(Order=1)
        public Boolean HasCache = null;

        @DataMember(Order=2)
        public Boolean HasPaging = null;

        @DataMember(Order=3, EmitDefaultValue=false)
        public CacheMetadata CacheMetadata = null;

        @DataMember(Order=4, EmitDefaultValue=false)
        public PagingMetadata PagingMetadata = null;
        
        public Boolean isSuccess() { return Success; }
        public ResponseMetadata setSuccess(Boolean value) { this.Success = value; return this; }
        public Boolean isHasCache() { return HasCache; }
        public ResponseMetadata setHasCache(Boolean value) { this.HasCache = value; return this; }
        public Boolean isHasPaging() { return HasPaging; }
        public ResponseMetadata setHasPaging(Boolean value) { this.HasPaging = value; return this; }
        public CacheMetadata getCacheMetadata() { return CacheMetadata; }
        public ResponseMetadata setCacheMetadata(CacheMetadata value) { this.CacheMetadata = value; return this; }
        public PagingMetadata getPagingMetadata() { return PagingMetadata; }
        public ResponseMetadata setPagingMetadata(PagingMetadata value) { this.PagingMetadata = value; return this; }
    }

    @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
    public static class CacheMetadata
    {
        @DataMember(Order=1)
        public Date CachedAt = null;

        @DataMember(Order=2)
        public Date CacheExpiresAt = null;

        @DataMember(Order=0)
        public Boolean IsFromCache = null;
        
        public Date getCachedAt() { return CachedAt; }
        public CacheMetadata setCachedAt(Date value) { this.CachedAt = value; return this; }
        public Date getCacheExpiresAt() { return CacheExpiresAt; }
        public CacheMetadata setCacheExpiresAt(Date value) { this.CacheExpiresAt = value; return this; }
        public Boolean getIsFromCache() { return IsFromCache; }
        public CacheMetadata setIsFromCache(Boolean value) { this.IsFromCache = value; return this; }
    }

    @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
    public static class AgentivityError
    {
        @DataMember
        public String ErrorCode = null;

        @DataMember
        public String Message = null;

        @DataMember
        public String StatusCode = null;

        @DataMember
        public String VerboseMessage = null;
        
        public String getErrorCode() { return ErrorCode; }
        public AgentivityError setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getMessage() { return Message; }
        public AgentivityError setMessage(String value) { this.Message = value; return this; }
        public String getStatusCode() { return StatusCode; }
        public AgentivityError setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getVerboseMessage() { return VerboseMessage; }
        public AgentivityError setVerboseMessage(String value) { this.VerboseMessage = value; return this; }
    }

    @DataContract(Name="BookingByAirlineWithClassSupport", Namespace="schemas.agentivity.com/types")
    public static class BookingByAirlineWithClassSupport
    {
        @DataMember(Order=10)
        public Integer AgentivityRef = null;

        @DataMember(Order=20)
        public String RecordLocator = null;

        @DataMember(Order=30)
        public Date PNRCreationDate = null;

        @DataMember(Order=40)
        public String Account = null;

        @DataMember(Order=50)
        public String OwningConsultant = null;

        @DataMember(Order=55)
        public String TicketedStatusCode = null;

        @DataMember(Order=60)
        public String TicketedStatus = null;

        @DataMember(Order=70)
        public String BookingCodesBooked = null;

        @DataMember(Order=80)
        public String FlightNumbers = null;

        @DataMember(Order=90)
        public String Routing = null;

        @DataMember(Order=100)
        public String TrackingCode = null;

        @DataMember(Order=110)
        public String TktTourCode = null;
        
        public Integer getAgentivityRef() { return AgentivityRef; }
        public BookingByAirlineWithClassSupport setAgentivityRef(Integer value) { this.AgentivityRef = value; return this; }
        public String getRecordLocator() { return RecordLocator; }
        public BookingByAirlineWithClassSupport setRecordLocator(String value) { this.RecordLocator = value; return this; }
        public Date getPnrCreationDate() { return PNRCreationDate; }
        public BookingByAirlineWithClassSupport setPnrCreationDate(Date value) { this.PNRCreationDate = value; return this; }
        public String getAccount() { return Account; }
        public BookingByAirlineWithClassSupport setAccount(String value) { this.Account = value; return this; }
        public String getOwningConsultant() { return OwningConsultant; }
        public BookingByAirlineWithClassSupport setOwningConsultant(String value) { this.OwningConsultant = value; return this; }
        public String getTicketedStatusCode() { return TicketedStatusCode; }
        public BookingByAirlineWithClassSupport setTicketedStatusCode(String value) { this.TicketedStatusCode = value; return this; }
        public String getTicketedStatus() { return TicketedStatus; }
        public BookingByAirlineWithClassSupport setTicketedStatus(String value) { this.TicketedStatus = value; return this; }
        public String getBookingCodesBooked() { return BookingCodesBooked; }
        public BookingByAirlineWithClassSupport setBookingCodesBooked(String value) { this.BookingCodesBooked = value; return this; }
        public String getFlightNumbers() { return FlightNumbers; }
        public BookingByAirlineWithClassSupport setFlightNumbers(String value) { this.FlightNumbers = value; return this; }
        public String getRouting() { return Routing; }
        public BookingByAirlineWithClassSupport setRouting(String value) { this.Routing = value; return this; }
        public String getTrackingCode() { return TrackingCode; }
        public BookingByAirlineWithClassSupport setTrackingCode(String value) { this.TrackingCode = value; return this; }
        public String getTktTourCode() { return TktTourCode; }
        public BookingByAirlineWithClassSupport setTktTourCode(String value) { this.TktTourCode = value; return this; }
    }

    @DataContract(Name="BookingByAirlineWithClassSupport", Namespace="schemas.agentivity.com/types")
    public static class BookingsByAirlineWithClassSupportResponseReport extends Report<BookingsByAirlineWithClassSupportItemResponse, BookingByAirlineWithClassSupport>
    {
        
    }

    @DataContract(Namespace="schemas.agentivity.com/types")
    public static class Report<TItemResponse, TItem>
    {
        @DataMember(Order=1, EmitDefaultValue=false)
        public TItem Item = null;
        
        public TItem getItem() { return Item; }
        public Report<TItemResponse, TItem> setItem(TItem value) { this.Item = value; return this; }
    }

    @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
    public static class BookingsByAirlineWithClassSupportItemResponse extends ItemResponse<BookingByAirlineWithClassSupport, BookingsByAirlineWithClassSupportResponseReport>
    {
        
    }

}

Java GetDistributorBookingsTravellingByAirlineClass 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 /DistributorBookingsByAirlineClass 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>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <Account>String</Account>
      <OwningConsultant>String</OwningConsultant>
      <TicketedStatusCode>String</TicketedStatusCode>
      <TicketedStatus>String</TicketedStatus>
      <BookingCodesBooked>String</BookingCodesBooked>
      <FlightNumbers>String</FlightNumbers>
      <Routing>String</Routing>
      <TrackingCode>String</TrackingCode>
      <TktTourCode>String</TktTourCode>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>