| GET | /BookingsTravellingV2 |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
class PagingMetadata implements IConvertible
{
/**
* Starting Record
*/
// @DataMember
// @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
String? Offset;
/**
* Number of records to return (PageSize)
*/
// @DataMember
// @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
String? Limit;
/**
* 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")
int? TotalRecords;
/**
* 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")
int? ResponseRecords;
PagingMetadata({this.Offset,this.Limit,this.TotalRecords,this.ResponseRecords});
PagingMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Offset = json['Offset'];
Limit = json['Limit'];
TotalRecords = json['TotalRecords'];
ResponseRecords = json['ResponseRecords'];
return this;
}
Map<String, dynamic> toJson() => {
'Offset': Offset,
'Limit': Limit,
'TotalRecords': TotalRecords,
'ResponseRecords': ResponseRecords
};
getTypeName() => "PagingMetadata";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
abstract class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
/**
* Comma Delimited List of Owning Company Codes
*/
// @DataMember
List<String>? OwningCompanyCode;
/**
* UserName in form of an email address
*/
// @DataMember
String? UserName;
CompanyLevelRequestBase({this.OwningCompanyCode,this.UserName});
CompanyLevelRequestBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
OwningCompanyCode = JsonConverters.fromJson(json['OwningCompanyCode'],'List<String>',context!);
UserName = json['UserName'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'OwningCompanyCode': JsonConverters.toJson(OwningCompanyCode,'List<String>',context!),
'UserName': UserName
});
getTypeName() => "CompanyLevelRequestBase";
TypeContext? context = _ctx;
}
// @DataContract(Name="Booking", Namespace="schemas.agentivity.com/types")
class BookingTravellingV2 implements IBookingItinerary, IConvertible
{
// @DataMember(Order=20)
String? RecordLocator;
// @DataMember(Order=25)
String? OwningAgencyLocationID;
// @DataMember(Order=30)
DateTime? PNRCreationDate;
// @DataMember(Order=40)
String? Passengers;
// @DataMember(Order=50)
String? OwningConsultant;
// @DataMember(Order=60)
String? Account;
// @DataMember(Order=70)
DateTime? TravelDate;
// @DataMember(Order=80)
String? Mobile;
// @DataMember(Order=90)
String? Emails;
// @DataMember(Order=100)
String? PNRTicketed;
// @DataMember(Order=110)
int? DestinationCount;
// @DataMember(Order=100)
String? CTCM;
// @DataMember(Order=110)
String? CTCE;
// @DataMember(Order=10)
int? AgentivityRef;
// @DataMember(Order=120)
String? ParkingOfferID;
// @DataMember(Order=130)
double? ParkingOfferTotalPrice;
// @DataMember(Order=140)
DateTime? ParkingOfferArrivalDateTime;
// @DataMember(Order=150)
DateTime? ParkingOfferDepartureDateTime;
// @DataMember(Order=160)
String? ParkingOfferAirportCode;
// @DataMember(Order=300)
String? ItineraryFormatted;
BookingTravellingV2({this.RecordLocator,this.OwningAgencyLocationID,this.PNRCreationDate,this.Passengers,this.OwningConsultant,this.Account,this.TravelDate,this.Mobile,this.Emails,this.PNRTicketed,this.DestinationCount,this.CTCM,this.CTCE,this.AgentivityRef,this.ParkingOfferID,this.ParkingOfferTotalPrice,this.ParkingOfferArrivalDateTime,this.ParkingOfferDepartureDateTime,this.ParkingOfferAirportCode,this.ItineraryFormatted});
BookingTravellingV2.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
RecordLocator = json['RecordLocator'];
OwningAgencyLocationID = json['OwningAgencyLocationID'];
PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
Passengers = json['Passengers'];
OwningConsultant = json['OwningConsultant'];
Account = json['Account'];
TravelDate = JsonConverters.fromJson(json['TravelDate'],'DateTime',context!);
Mobile = json['Mobile'];
Emails = json['Emails'];
PNRTicketed = json['PNRTicketed'];
DestinationCount = json['DestinationCount'];
CTCM = json['CTCM'];
CTCE = json['CTCE'];
AgentivityRef = json['AgentivityRef'];
ParkingOfferID = json['ParkingOfferID'];
ParkingOfferTotalPrice = JsonConverters.toDouble(json['ParkingOfferTotalPrice']);
ParkingOfferArrivalDateTime = JsonConverters.fromJson(json['ParkingOfferArrivalDateTime'],'DateTime',context!);
ParkingOfferDepartureDateTime = JsonConverters.fromJson(json['ParkingOfferDepartureDateTime'],'DateTime',context!);
ParkingOfferAirportCode = json['ParkingOfferAirportCode'];
ItineraryFormatted = json['ItineraryFormatted'];
return this;
}
Map<String, dynamic> toJson() => {
'RecordLocator': RecordLocator,
'OwningAgencyLocationID': OwningAgencyLocationID,
'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
'Passengers': Passengers,
'OwningConsultant': OwningConsultant,
'Account': Account,
'TravelDate': JsonConverters.toJson(TravelDate,'DateTime',context!),
'Mobile': Mobile,
'Emails': Emails,
'PNRTicketed': PNRTicketed,
'DestinationCount': DestinationCount,
'CTCM': CTCM,
'CTCE': CTCE,
'AgentivityRef': AgentivityRef,
'ParkingOfferID': ParkingOfferID,
'ParkingOfferTotalPrice': ParkingOfferTotalPrice,
'ParkingOfferArrivalDateTime': JsonConverters.toJson(ParkingOfferArrivalDateTime,'DateTime',context!),
'ParkingOfferDepartureDateTime': JsonConverters.toJson(ParkingOfferDepartureDateTime,'DateTime',context!),
'ParkingOfferAirportCode': ParkingOfferAirportCode,
'ItineraryFormatted': ItineraryFormatted
};
getTypeName() => "BookingTravellingV2";
TypeContext? context = _ctx;
}
// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
class CacheMetadata implements IConvertible
{
// @DataMember(Order=1)
DateTime? CachedAt;
// @DataMember(Order=2)
DateTime? CacheExpiresAt;
// @DataMember(Order=0)
bool? IsFromCache;
CacheMetadata({this.CachedAt,this.CacheExpiresAt,this.IsFromCache});
CacheMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CachedAt = JsonConverters.fromJson(json['CachedAt'],'DateTime',context!);
CacheExpiresAt = JsonConverters.fromJson(json['CacheExpiresAt'],'DateTime',context!);
IsFromCache = json['IsFromCache'];
return this;
}
Map<String, dynamic> toJson() => {
'CachedAt': JsonConverters.toJson(CachedAt,'DateTime',context!),
'CacheExpiresAt': JsonConverters.toJson(CacheExpiresAt,'DateTime',context!),
'IsFromCache': IsFromCache
};
getTypeName() => "CacheMetadata";
TypeContext? context = _ctx;
}
// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class ResponseMetadata implements IConvertible
{
// @DataMember(Order=0)
bool? Success;
// @DataMember(Order=1)
bool? HasCache;
// @DataMember(Order=2)
bool? HasPaging;
// @DataMember(Order=3, EmitDefaultValue=false)
CacheMetadata? CacheMetadata;
// @DataMember(Order=4, EmitDefaultValue=false)
PagingMetadata? PagingMetadata;
ResponseMetadata({this.Success,this.HasCache,this.HasPaging,this.CacheMetadata,this.PagingMetadata});
ResponseMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Success = json['Success'];
HasCache = json['HasCache'];
HasPaging = json['HasPaging'];
CacheMetadata = JsonConverters.fromJson(json['CacheMetadata'],'CacheMetadata',context!);
PagingMetadata = JsonConverters.fromJson(json['PagingMetadata'],'PagingMetadata',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Success': Success,
'HasCache': HasCache,
'HasPaging': HasPaging,
'CacheMetadata': JsonConverters.toJson(CacheMetadata,'CacheMetadata',context!),
'PagingMetadata': JsonConverters.toJson(PagingMetadata,'PagingMetadata',context!)
};
getTypeName() => "ResponseMetadata";
TypeContext? context = _ctx;
}
// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
class ApiRequestPerHour implements IConvertible
{
// @DataMember(Order=10)
DateTime? RequestDate;
// @DataMember(Order=100)
int? Hour0;
// @DataMember(Order=110)
int? Hour1;
// @DataMember(Order=120)
int? Hour2;
// @DataMember(Order=130)
int? Hour3;
// @DataMember(Order=140)
int? Hour4;
// @DataMember(Order=150)
int? Hour5;
// @DataMember(Order=160)
int? Hour6;
// @DataMember(Order=170)
int? Hour7;
// @DataMember(Order=180)
int? Hour8;
// @DataMember(Order=190)
int? Hour9;
// @DataMember(Order=200)
int? Hour10;
// @DataMember(Order=210)
int? Hour11;
// @DataMember(Order=220)
int? Hour12;
// @DataMember(Order=230)
int? Hour13;
// @DataMember(Order=240)
int? Hour14;
// @DataMember(Order=250)
int? Hour15;
// @DataMember(Order=260)
int? Hour16;
// @DataMember(Order=270)
int? Hour17;
// @DataMember(Order=280)
int? Hour18;
// @DataMember(Order=290)
int? Hour19;
// @DataMember(Order=300)
int? Hour20;
// @DataMember(Order=310)
int? Hour21;
// @DataMember(Order=320)
int? Hour22;
// @DataMember(Order=330)
int? Hour23;
ApiRequestPerHour({this.RequestDate,this.Hour0,this.Hour1,this.Hour2,this.Hour3,this.Hour4,this.Hour5,this.Hour6,this.Hour7,this.Hour8,this.Hour9,this.Hour10,this.Hour11,this.Hour12,this.Hour13,this.Hour14,this.Hour15,this.Hour16,this.Hour17,this.Hour18,this.Hour19,this.Hour20,this.Hour21,this.Hour22,this.Hour23});
ApiRequestPerHour.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
RequestDate = JsonConverters.fromJson(json['RequestDate'],'DateTime',context!);
Hour0 = json['Hour0'];
Hour1 = json['Hour1'];
Hour2 = json['Hour2'];
Hour3 = json['Hour3'];
Hour4 = json['Hour4'];
Hour5 = json['Hour5'];
Hour6 = json['Hour6'];
Hour7 = json['Hour7'];
Hour8 = json['Hour8'];
Hour9 = json['Hour9'];
Hour10 = json['Hour10'];
Hour11 = json['Hour11'];
Hour12 = json['Hour12'];
Hour13 = json['Hour13'];
Hour14 = json['Hour14'];
Hour15 = json['Hour15'];
Hour16 = json['Hour16'];
Hour17 = json['Hour17'];
Hour18 = json['Hour18'];
Hour19 = json['Hour19'];
Hour20 = json['Hour20'];
Hour21 = json['Hour21'];
Hour22 = json['Hour22'];
Hour23 = json['Hour23'];
return this;
}
Map<String, dynamic> toJson() => {
'RequestDate': JsonConverters.toJson(RequestDate,'DateTime',context!),
'Hour0': Hour0,
'Hour1': Hour1,
'Hour2': Hour2,
'Hour3': Hour3,
'Hour4': Hour4,
'Hour5': Hour5,
'Hour6': Hour6,
'Hour7': Hour7,
'Hour8': Hour8,
'Hour9': Hour9,
'Hour10': Hour10,
'Hour11': Hour11,
'Hour12': Hour12,
'Hour13': Hour13,
'Hour14': Hour14,
'Hour15': Hour15,
'Hour16': Hour16,
'Hour17': Hour17,
'Hour18': Hour18,
'Hour19': Hour19,
'Hour20': Hour20,
'Hour21': Hour21,
'Hour22': Hour22,
'Hour23': Hour23
};
getTypeName() => "ApiRequestPerHour";
TypeContext? context = _ctx;
}
// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
class AgentivityError implements IConvertible
{
// @DataMember
String? ErrorCode;
// @DataMember
String? Message;
// @DataMember
String? StatusCode;
// @DataMember
String? VerboseMessage;
AgentivityError({this.ErrorCode,this.Message,this.StatusCode,this.VerboseMessage});
AgentivityError.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ErrorCode = json['ErrorCode'];
Message = json['Message'];
StatusCode = json['StatusCode'];
VerboseMessage = json['VerboseMessage'];
return this;
}
Map<String, dynamic> toJson() => {
'ErrorCode': ErrorCode,
'Message': Message,
'StatusCode': StatusCode,
'VerboseMessage': VerboseMessage
};
getTypeName() => "AgentivityError";
TypeContext? context = _ctx;
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class CollectionResponse<TItem> implements IConvertible
{
// @DataMember(Order=1)
ResponseMetadata? ResponseMetadata;
// @DataMember(Order=2, EmitDefaultValue=false)
List<ApiRequestPerHour>? ResponseReport;
// @DataMember(Order=3, EmitDefaultValue=false)
AgentivityError? ResponseError;
CollectionResponse({this.ResponseMetadata,this.ResponseReport,this.ResponseError});
CollectionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ResponseMetadata = JsonConverters.fromJson(json['ResponseMetadata'],'ResponseMetadata',context!);
ResponseReport = JsonConverters.fromJson(json['ResponseReport'],'List<ApiRequestPerHour>',context!);
ResponseError = JsonConverters.fromJson(json['ResponseError'],'AgentivityError',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ResponseMetadata': JsonConverters.toJson(ResponseMetadata,'ResponseMetadata',context!),
'ResponseReport': JsonConverters.toJson(ResponseReport,'List<ApiRequestPerHour>',context!),
'ResponseError': JsonConverters.toJson(ResponseError,'AgentivityError',context!)
};
getTypeName() => "CollectionResponse<$TItem>";
TypeContext? context = _ctx;
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class BookingsTravellingV2Response extends CollectionResponse<BookingTravellingV2> implements IConvertible
{
BookingsTravellingV2Response();
BookingsTravellingV2Response.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "BookingsTravellingV2Response";
TypeContext? context = _ctx;
}
// @Flags()
class FormattingStyle
{
static const FormattingStyle None = const FormattingStyle._(0);
static const FormattingStyle Html = const FormattingStyle._(1);
static const FormattingStyle Charting = const FormattingStyle._(2);
final int _value;
const FormattingStyle._(this._value);
int get value => _value;
static List<FormattingStyle> get values => const [None,Html,Charting];
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class GetBookingsTravellingV2 extends CompanyLevelRequestBase implements IConvertible
{
/**
* Comma Delimited List of Accounts
*/
// @DataMember
List<String>? Account;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? TravelDateStart;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? TravelDateEnd;
/**
* Return only PNRs with/without a mobile number
*/
// @DataMember
bool? HasMobile;
/**
* Return only PNRs with/without an email address
*/
// @DataMember
bool? HasEmail;
/**
* Return only PNRs with/without an email address OR a mobile number
*/
// @DataMember
bool? MissingEmailOrPhone;
/**
* Return only PNRs with/without a hotel
*/
// @DataMember
bool? HasHotel;
/**
* Return only PNRs with/without an account
*/
// @DataMember
bool? HasAccount;
/**
* Include Itinerary in the response
*/
// @DataMember
bool? IncludeItinerary;
/**
* Include Parking Offer in the response
*/
// @DataMember
bool? IncludeParkingOffer;
/**
* Return only PNRs that equal or exceed a certain number of segments
*/
// @DataMember
int? MinSegments;
/**
* Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
*/
// @DataMember
FormattingStyle? ItineraryFormatting;
GetBookingsTravellingV2({this.Account,this.TravelDateStart,this.TravelDateEnd,this.HasMobile,this.HasEmail,this.MissingEmailOrPhone,this.HasHotel,this.HasAccount,this.IncludeItinerary,this.IncludeParkingOffer,this.MinSegments,this.ItineraryFormatting});
GetBookingsTravellingV2.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Account = JsonConverters.fromJson(json['Account'],'List<String>',context!);
TravelDateStart = json['TravelDateStart'];
TravelDateEnd = json['TravelDateEnd'];
HasMobile = json['HasMobile'];
HasEmail = json['HasEmail'];
MissingEmailOrPhone = json['MissingEmailOrPhone'];
HasHotel = json['HasHotel'];
HasAccount = json['HasAccount'];
IncludeItinerary = json['IncludeItinerary'];
IncludeParkingOffer = json['IncludeParkingOffer'];
MinSegments = json['MinSegments'];
ItineraryFormatting = JsonConverters.fromJson(json['ItineraryFormatting'],'FormattingStyle',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Account': JsonConverters.toJson(Account,'List<String>',context!),
'TravelDateStart': TravelDateStart,
'TravelDateEnd': TravelDateEnd,
'HasMobile': HasMobile,
'HasEmail': HasEmail,
'MissingEmailOrPhone': MissingEmailOrPhone,
'HasHotel': HasHotel,
'HasAccount': HasAccount,
'IncludeItinerary': IncludeItinerary,
'IncludeParkingOffer': IncludeParkingOffer,
'MinSegments': MinSegments,
'ItineraryFormatting': JsonConverters.toJson(ItineraryFormatting,'FormattingStyle',context!)
});
getTypeName() => "GetBookingsTravellingV2";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
'BookingTravellingV2': TypeInfo(TypeOf.Class, create:() => BookingTravellingV2()),
'CacheMetadata': TypeInfo(TypeOf.Class, create:() => CacheMetadata()),
'ResponseMetadata': TypeInfo(TypeOf.Class, create:() => ResponseMetadata()),
'ApiRequestPerHour': TypeInfo(TypeOf.Class, create:() => ApiRequestPerHour()),
'AgentivityError': TypeInfo(TypeOf.Class, create:() => AgentivityError()),
'CollectionResponse<TItem>': TypeInfo(TypeOf.Class, create:() => CollectionResponse<TItem>()),
'List<ApiRequestPerHour>': TypeInfo(TypeOf.Class, create:() => <ApiRequestPerHour>[]),
'BookingsTravellingV2Response': TypeInfo(TypeOf.Class, create:() => BookingsTravellingV2Response()),
'FormattingStyle': TypeInfo(TypeOf.Enum, enumValues:FormattingStyle.values),
'GetBookingsTravellingV2': TypeInfo(TypeOf.Class, create:() => GetBookingsTravellingV2()),
});
Dart GetBookingsTravellingV2 DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /BookingsTravellingV2 HTTP/1.1 Host: api.agentivity.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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":[{"AgentivityRef":0,"RecordLocator":"String","OwningAgencyLocationID":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","Passengers":"String","OwningConsultant":"String","Account":"String","TravelDate":"\/Date(-62135596800000-0000)\/","Mobile":"String","Emails":"String","PNRTicketed":"String","CTCM":"String","DestinationCount":0,"CTCE":"String","ParkingOfferID":"String","ParkingOfferTotalPrice":0,"ParkingOfferArrivalDateTime":"\/Date(-62135596800000-0000)\/","ParkingOfferDepartureDateTime":"\/Date(-62135596800000-0000)\/","ParkingOfferAirportCode":"String","ItineraryFormatted":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}