Agentivity API

<back to all web services

GetDistributorBookingsTravellingByAirlineClass

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

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description 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 TotalRecords: number;

    /** @description 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 ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=20)
    public RecordLocator: string;

    // @DataMember(Order=30)
    public PNRCreationDate?: string;

    // @DataMember(Order=40)
    public Account: string;

    // @DataMember(Order=50)
    public OwningConsultant: string;

    // @DataMember(Order=55)
    public TicketedStatusCode: string;

    // @DataMember(Order=60)
    public TicketedStatus: string;

    // @DataMember(Order=70)
    public BookingCodesBooked: string;

    // @DataMember(Order=80)
    public FlightNumbers: string;

    // @DataMember(Order=90)
    public Routing: string;

    // @DataMember(Order=100)
    public TrackingCode: string;

    // @DataMember(Order=110)
    public TktTourCode: string;

    public constructor(init?: Partial<BookingByAirlineWithClassSupport>) { (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

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

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

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

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

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

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

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<ItemResponse<TItem, TReport>>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<BookingsByAirlineWithClassSupportItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class Report<TItemResponse, TItem>
{
    // @DataMember(Order=1, EmitDefaultValue=false)
    public Item: TItem;

    public constructor(init?: Partial<Report<TItemResponse, TItem>>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<BookingsByAirlineWithClassSupportResponseReport>) { super(init); (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<DistributorBookingsByAirlineClassItemResponse>) { super(init); (Object as any).assign(this, init); }
}

// @Flags()
export enum FormattingStyle
{
    None = 0,
    Html = 1,
    Charting = 2,
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class GetDistributorBookingsTravellingByAirlineClass extends PagingMetadata
{
    /** @description ID of Distributor */
    // @DataMember
    public DistributorID: number;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public IssueDateStart: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public IssueDateEnd: string;

    /** @description Two letter code for carrier */
    // @DataMember
    public PlatingCarrier: string;

    /** @description Booking Class Name */
    // @DataMember
    public BookingClassName: string;

    /** @description BoardPoint CountryCode */
    // @DataMember
    public BoardPointCountryCode: string;

    /** @description Include Itinerary in the response */
    // @DataMember
    public IncludeItinerary: boolean;

    /** @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
    // @DataMember
    public ItineraryFormatting: FormattingStyle;

    public constructor(init?: Partial<GetDistributorBookingsTravellingByAirlineClass>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetDistributorBookingsTravellingByAirlineClass DTOs

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>