| GET | /EventBookings |
|---|
"use strict";
export class PagingMetadata {
/** @param {{Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Starting Record */
Offset;
/**
* @type {string}
* @description Number of records to return (PageSize) */
Limit;
/**
* @type {number}
* @description Total Number of Records in a Full Reponse (if no paging) */
TotalRecords;
/**
* @type {number}
* @description Total Number of Records in this Reponse (on this page) */
ResponseRecords;
}
export class ItinerarySegment {
/** @param {{SegmentType?:string,SegmentNbr?:number,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}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
SegmentType;
/** @type {number} */
SegmentNbr;
/** @type {string} */
BoardPoint;
/** @type {string} */
OffPoint;
/** @type {string} */
OperatorCode;
/** @type {string} */
OperatorService;
/** @type {string} */
SegmentStatus;
/** @type {string} */
DepartureTimeFormatted;
/** @type {string} */
ArrivalTimeFormatted;
/** @type {string} */
ChangeOfDayFormatted;
/** @type {string} */
ServiceCode;
/** @type {string} */
StartDate;
/** @type {string} */
EndDate;
/** @type {string} */
TicketNumber;
/**
* @type {string}
* @description Comma separated list of vendor locators */
VendorLocators;
/** @type {string} */
EquipmentCode;
/** @type {string} */
Equipment;
}
export class ItinerarySegmentsCollection extends Array {
constructor(init) { super(init); Object.assign(this, init) }
}
export class EventBooking {
/** @param {{RecordLocator?:string,PNRCreationDate?:string,PaxList?:string,PaxCount?:number,InboundAirline?:string,InboundFlightNumber?:string,InboundArrivalCity?:string,InboundArrivalDate?:string,InboundArrivalTime?:string,OutboundAirline?:string,OutboundFlightNumber?:string,OutboundDepartureCity?:string,OutboundDepartureDate?:string,OutboundDepartureTime?:string,Notes?:string,Emails?:string,Mobile?:string,TotalTicketedValue?:string,AgentivityRef?:number,ItineraryFormatted?:string,Itinerary?:ItinerarySegmentsCollection}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RecordLocator;
/** @type {string} */
PNRCreationDate;
/** @type {string} */
PaxList;
/** @type {number} */
PaxCount;
/** @type {string} */
InboundAirline;
/** @type {string} */
InboundFlightNumber;
/** @type {string} */
InboundArrivalCity;
/** @type {?string} */
InboundArrivalDate;
/** @type {string} */
InboundArrivalTime;
/** @type {string} */
OutboundAirline;
/** @type {string} */
OutboundFlightNumber;
/** @type {string} */
OutboundDepartureCity;
/** @type {?string} */
OutboundDepartureDate;
/** @type {string} */
OutboundDepartureTime;
/** @type {string} */
Notes;
/** @type {string} */
Emails;
/** @type {string} */
Mobile;
/** @type {string} */
TotalTicketedValue;
/** @type {number} */
AgentivityRef;
/** @type {string} */
ItineraryFormatted;
/** @type {ItinerarySegmentsCollection} */
Itinerary;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class EventBookingsResponseReport extends Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class CacheMetadata {
/** @param {{CachedAt?:string,CacheExpiresAt?:string,IsFromCache?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CachedAt;
/** @type {string} */
CacheExpiresAt;
/** @type {boolean} */
IsFromCache;
}
export class ResponseMetadata {
/** @param {{Success?:boolean,HasCache?:boolean,HasPaging?:boolean,CacheMetadata?:CacheMetadata,PagingMetadata?:PagingMetadata}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Success;
/** @type {boolean} */
HasCache;
/** @type {boolean} */
HasPaging;
/** @type {CacheMetadata} */
CacheMetadata;
/** @type {PagingMetadata} */
PagingMetadata;
}
export class AgentivityError {
/** @param {{ErrorCode?:string,Message?:string,StatusCode?:string,VerboseMessage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ErrorCode;
/** @type {string} */
Message;
/** @type {string} */
StatusCode;
/** @type {string} */
VerboseMessage;
}
/** @typedef TItem {any} */
/** @typedef TReport {any} */
export class ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseMetadata} */
ResponseMetadata;
/** @type {TReport} */
ResponseReport;
/** @type {AgentivityError} */
ResponseError;
}
export class EventBookingsItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class EventBookingsRequest extends PagingMetadata {
/** @param {{UserName?:string,EventCode?:string,SplitMultiplePassengers?:boolean,IncludeNotes?:boolean,IncludeArrivalDepartures?:boolean,FormattingStyle?:number,ItinerarySegmentsToShow?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description UserName in form of an email address */
UserName;
/**
* @type {string}
* @description Event code */
EventCode;
/**
* @type {boolean}
* @description Split multiple passengers */
SplitMultiplePassengers;
/**
* @type {boolean}
* @description Include notes in the response */
IncludeNotes;
/**
* @type {boolean}
* @description Include arrival departures */
IncludeArrivalDepartures;
/**
* @type {number}
* @description Indicate the required formatting: 0=None(Default), 1=Html, 2=Chart */
FormattingStyle;
/**
* @type {string}
* @description Itinerary segments to show */
ItinerarySegmentsToShow;
}
JavaScript EventBookingsRequest DTOs
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 /EventBookings 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>
<RecordLocator>String</RecordLocator>
<PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
<PaxList>String</PaxList>
<PaxCount>0</PaxCount>
<AgentivityRef>0</AgentivityRef>
<ItineraryFormatted>String</ItineraryFormatted>
<Itinerary>
<ItinerarySegment>
<ArrivalTimeFormatted>String</ArrivalTimeFormatted>
<BoardPoint>String</BoardPoint>
<ChangeOfDayFormatted>String</ChangeOfDayFormatted>
<DepartureTimeFormatted>String</DepartureTimeFormatted>
<EndDate>String</EndDate>
<Equipment>String</Equipment>
<EquipmentCode>String</EquipmentCode>
<OffPoint>String</OffPoint>
<OperatorCode>String</OperatorCode>
<OperatorService>String</OperatorService>
<SegmentNbr>0</SegmentNbr>
<SegmentStatus>String</SegmentStatus>
<SegmentType>String</SegmentType>
<ServiceCode>String</ServiceCode>
<StartDate>String</StartDate>
<TicketNumber>String</TicketNumber>
<VendorLocators>String</VendorLocators>
</ItinerarySegment>
</Itinerary>
<InboundAirline>String</InboundAirline>
<InboundFlightNumber>String</InboundFlightNumber>
<InboundArrivalCity>String</InboundArrivalCity>
<InboundArrivalDate>0001-01-01T00:00:00</InboundArrivalDate>
<InboundArrivalTime>String</InboundArrivalTime>
<OutboundAirline>String</OutboundAirline>
<OutboundFlightNumber>String</OutboundFlightNumber>
<OutboundDepartureCity>String</OutboundDepartureCity>
<OutboundDepartureDate>0001-01-01T00:00:00</OutboundDepartureDate>
<OutboundDepartureTime>String</OutboundDepartureTime>
<Notes>String</Notes>
<Emails>String</Emails>
<Mobile>String</Mobile>
<TotalTicketedValue>String</TotalTicketedValue>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>