Agentivity API

<back to all web services

EventBookingsRequest

The following routes are available for this service:
GET/EventBookings

// @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="ItinerarySegment", Namespace="schemas.agentivity.com/types")
export class ItinerarySegment
{
    // @DataMember
    public SegmentType: string;

    // @DataMember
    public SegmentNbr: number;

    // @DataMember
    public BoardPoint: string;

    // @DataMember
    public OffPoint: string;

    // @DataMember
    public OperatorCode: string;

    // @DataMember
    public OperatorService: string;

    // @DataMember
    public SegmentStatus: string;

    // @DataMember
    public DepartureTimeFormatted: string;

    // @DataMember
    public ArrivalTimeFormatted: string;

    // @DataMember
    public ChangeOfDayFormatted: string;

    // @DataMember
    public ServiceCode: string;

    // @DataMember
    public StartDate: string;

    // @DataMember
    public EndDate: string;

    // @DataMember
    public TicketNumber: string;

    /** @description Comma separated list of vendor locators */
    // @DataMember
    public VendorLocators: string;

    // @DataMember
    public EquipmentCode: string;

    // @DataMember
    public Equipment: string;

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

export class ItinerarySegmentsCollection extends Array<ItinerarySegment>
{

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

// @DataContract(Name="EventBooking", Namespace="schemas.agentivity.com/types")
export class EventBooking implements IBookingItinerary
{
    // @DataMember(Order=10)
    public RecordLocator: string;

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

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

    // @DataMember(Order=35)
    public PaxCount: number;

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

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

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

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

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

    // @DataMember(Order=120)
    public OutboundAirline: string;

    // @DataMember(Order=130)
    public OutboundFlightNumber: string;

    // @DataMember(Order=140)
    public OutboundDepartureCity: string;

    // @DataMember(Order=150)
    public OutboundDepartureDate?: string;

    // @DataMember(Order=160)
    public OutboundDepartureTime: string;

    // @DataMember(Order=170)
    public Notes: string;

    // @DataMember(Order=180)
    public Emails: string;

    // @DataMember(Order=190)
    public Mobile: string;

    // @DataMember(Order=200)
    public TotalTicketedValue: string;

    // @DataMember(Order=40)
    public AgentivityRef: number;

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

    // @DataMember(Order=60)
    public Itinerary: ItinerarySegmentsCollection;

    public constructor(init?: Partial<EventBooking>) { (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="EventBooking", Namespace="schemas.agentivity.com/types")
export class EventBookingsResponseReport extends Report<EventBookingsItemResponse, EventBooking>
{

    public constructor(init?: Partial<EventBookingsResponseReport>) { super(init); (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 EventBookingsItemResponse extends ItemResponse<EventBooking, EventBookingsResponseReport>
{

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

// @DataContract(Namespace="schemas.agentivity.com/types")
export class EventBookingsRequest extends PagingMetadata
{
    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    /** @description Event code */
    // @DataMember
    public EventCode: string;

    /** @description Split multiple passengers */
    // @DataMember
    public SplitMultiplePassengers: boolean;

    /** @description Include notes in the response */
    // @DataMember
    public IncludeNotes: boolean;

    /** @description Include arrival departures */
    // @DataMember
    public IncludeArrivalDepartures: boolean;

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

    /** @description Itinerary segments to show */
    // @DataMember
    public ItinerarySegmentsToShow: string;

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

TypeScript EventBookingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /EventBookings HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PaxList":"String","PaxCount":0,"AgentivityRef":0,"ItineraryFormatted":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"InboundAirline":"String","InboundFlightNumber":"String","InboundArrivalCity":"String","InboundArrivalDate":"\/Date(-62135596800000-0000)\/","InboundArrivalTime":"String","OutboundAirline":"String","OutboundFlightNumber":"String","OutboundDepartureCity":"String","OutboundDepartureDate":"\/Date(-62135596800000-0000)\/","OutboundDepartureTime":"String","Notes":"String","Emails":"String","Mobile":"String","TotalTicketedValue":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}