| GET | /BookingsByTraveller |
|---|
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="ItinerarySegment", Namespace="schemas.agentivity.com/types")
class ItinerarySegment implements IConvertible
{
// @DataMember
String? SegmentType;
// @DataMember
int? SegmentNbr;
// @DataMember
String? BoardPoint;
// @DataMember
String? OffPoint;
// @DataMember
String? OperatorCode;
// @DataMember
String? OperatorService;
// @DataMember
String? SegmentStatus;
// @DataMember
String? DepartureTimeFormatted;
// @DataMember
String? ArrivalTimeFormatted;
// @DataMember
String? ChangeOfDayFormatted;
// @DataMember
String? ServiceCode;
// @DataMember
String? StartDate;
// @DataMember
String? EndDate;
// @DataMember
String? TicketNumber;
/**
* Comma separated list of vendor locators
*/
// @DataMember
String? VendorLocators;
// @DataMember
String? EquipmentCode;
// @DataMember
String? Equipment;
ItinerarySegment({this.SegmentType,this.SegmentNbr,this.BoardPoint,this.OffPoint,this.OperatorCode,this.OperatorService,this.SegmentStatus,this.DepartureTimeFormatted,this.ArrivalTimeFormatted,this.ChangeOfDayFormatted,this.ServiceCode,this.StartDate,this.EndDate,this.TicketNumber,this.VendorLocators,this.EquipmentCode,this.Equipment});
ItinerarySegment.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SegmentType = json['SegmentType'];
SegmentNbr = json['SegmentNbr'];
BoardPoint = json['BoardPoint'];
OffPoint = json['OffPoint'];
OperatorCode = json['OperatorCode'];
OperatorService = json['OperatorService'];
SegmentStatus = json['SegmentStatus'];
DepartureTimeFormatted = json['DepartureTimeFormatted'];
ArrivalTimeFormatted = json['ArrivalTimeFormatted'];
ChangeOfDayFormatted = json['ChangeOfDayFormatted'];
ServiceCode = json['ServiceCode'];
StartDate = json['StartDate'];
EndDate = json['EndDate'];
TicketNumber = json['TicketNumber'];
VendorLocators = json['VendorLocators'];
EquipmentCode = json['EquipmentCode'];
Equipment = json['Equipment'];
return this;
}
Map<String, dynamic> toJson() => {
'SegmentType': SegmentType,
'SegmentNbr': SegmentNbr,
'BoardPoint': BoardPoint,
'OffPoint': OffPoint,
'OperatorCode': OperatorCode,
'OperatorService': OperatorService,
'SegmentStatus': SegmentStatus,
'DepartureTimeFormatted': DepartureTimeFormatted,
'ArrivalTimeFormatted': ArrivalTimeFormatted,
'ChangeOfDayFormatted': ChangeOfDayFormatted,
'ServiceCode': ServiceCode,
'StartDate': StartDate,
'EndDate': EndDate,
'TicketNumber': TicketNumber,
'VendorLocators': VendorLocators,
'EquipmentCode': EquipmentCode,
'Equipment': Equipment
};
getTypeName() => "ItinerarySegment";
TypeContext? context = _ctx;
}
class ItinerarySegmentsCollection extends ListBase<ItinerarySegment> implements IConvertible
{
final List<ItinerarySegment> l = [];
set length(int newLength) { l.length = newLength; }
int get length => l.length;
ItinerarySegment operator [](int index) => l[index];
void operator []=(int index, ItinerarySegment value) { l[index] = value; }
ItinerarySegmentsCollection();
ItinerarySegmentsCollection.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "ItinerarySegmentsCollection";
TypeContext? context = _ctx;
}
// @DataContract(Name="BookingByTraveller", Namespace="schemas.agentivity.com/types")
class BookingByTraveller implements IBookingItinerary, IConvertible
{
// @DataMember(Order=20)
String? RecordLocator;
// @DataMember(Order=25)
DateTime? PNRCreationDate;
// @DataMember(Order=30)
String? LastName;
// @DataMember(Order=40)
String? FirstName;
// @DataMember(Order=50)
String? Account;
// @DataMember(Order=60)
String? AccountName;
// @DataMember(Order=70)
String? OwningConsultant;
// @DataMember(Order=80)
DateTime? TravelDate;
// @DataMember(Order=90)
String? PNRCancelled;
// @DataMember(Order=100)
String? PNRTicketed;
// @DataMember(Order=110)
String? Passenger;
// @DataMember(Order=10)
int? AgentivityRef;
// @DataMember(Order=500)
ItinerarySegmentsCollection? Itinerary;
// @DataMember(Order=510)
String? ItineraryFormatted;
BookingByTraveller({this.RecordLocator,this.PNRCreationDate,this.LastName,this.FirstName,this.Account,this.AccountName,this.OwningConsultant,this.TravelDate,this.PNRCancelled,this.PNRTicketed,this.Passenger,this.AgentivityRef,this.Itinerary,this.ItineraryFormatted});
BookingByTraveller.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
RecordLocator = json['RecordLocator'];
PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
LastName = json['LastName'];
FirstName = json['FirstName'];
Account = json['Account'];
AccountName = json['AccountName'];
OwningConsultant = json['OwningConsultant'];
TravelDate = JsonConverters.fromJson(json['TravelDate'],'DateTime',context!);
PNRCancelled = json['PNRCancelled'];
PNRTicketed = json['PNRTicketed'];
Passenger = json['Passenger'];
AgentivityRef = json['AgentivityRef'];
Itinerary = JsonConverters.fromJson(json['Itinerary'],'ItinerarySegmentsCollection',context!);
ItineraryFormatted = json['ItineraryFormatted'];
return this;
}
Map<String, dynamic> toJson() => {
'RecordLocator': RecordLocator,
'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
'LastName': LastName,
'FirstName': FirstName,
'Account': Account,
'AccountName': AccountName,
'OwningConsultant': OwningConsultant,
'TravelDate': JsonConverters.toJson(TravelDate,'DateTime',context!),
'PNRCancelled': PNRCancelled,
'PNRTicketed': PNRTicketed,
'Passenger': Passenger,
'AgentivityRef': AgentivityRef,
'Itinerary': JsonConverters.toJson(Itinerary,'ItinerarySegmentsCollection',context!),
'ItineraryFormatted': ItineraryFormatted
};
getTypeName() => "BookingByTraveller";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class Report<TItemResponse,TItem> implements IConvertible
{
// @DataMember(Order=1, EmitDefaultValue=false)
TItem? Item;
Report({this.Item});
Report.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Item = JsonConverters.fromJson(json['Item'],'TItem',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Item': JsonConverters.toJson(Item,'TItem',context!)
};
getTypeName() => "Report<$TItemResponse,$TItem>";
TypeContext? context = _ctx;
}
// @DataContract(Name="BookingByTraveller", Namespace="schemas.agentivity.com/types")
class BookingsByTravellerResponseReport extends Report<BookingsByTravellerItemResponse,BookingByTraveller> implements IConvertible
{
BookingsByTravellerResponseReport();
BookingsByTravellerResponseReport.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() => "BookingsByTravellerResponseReport";
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="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 ItemResponse<TItem,TReport> implements IConvertible
{
// @DataMember(Order=1)
ResponseMetadata? ResponseMetadata;
// @DataMember(Order=2, EmitDefaultValue=false)
TReport? ResponseReport;
// @DataMember(Order=3, EmitDefaultValue=false)
AgentivityError? ResponseError;
ItemResponse({this.ResponseMetadata,this.ResponseReport,this.ResponseError});
ItemResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ResponseMetadata = JsonConverters.fromJson(json['ResponseMetadata'],'ResponseMetadata',context!);
ResponseReport = JsonConverters.fromJson(json['ResponseReport'],'TReport',context!);
ResponseError = JsonConverters.fromJson(json['ResponseError'],'AgentivityError',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ResponseMetadata': JsonConverters.toJson(ResponseMetadata,'ResponseMetadata',context!),
'ResponseReport': JsonConverters.toJson(ResponseReport,'TReport',context!),
'ResponseError': JsonConverters.toJson(ResponseError,'AgentivityError',context!)
};
getTypeName() => "ItemResponse<$TItem,$TReport>";
TypeContext? context = _ctx;
}
// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
class BookingsByTravellerItemResponse extends ItemResponse<BookingByTraveller,BookingsByTravellerResponseReport> implements IConvertible
{
BookingsByTravellerItemResponse();
BookingsByTravellerItemResponse.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() => "BookingsByTravellerItemResponse";
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 GetBookingsByTraveller extends CompanyLevelRequestBase implements IConvertible
{
/**
* Traveller CRM ID or reference
*/
// @DataMember
String? TravellerReference;
/**
* Agentivity Traveller GUID
*/
// @DataMember
String? TravellerGUID;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? TravelDateStart;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? TravelDateEnd;
/**
* Last name
*/
// @DataMember
String? LastName;
/**
* First name
*/
// @DataMember
String? FirstName;
/**
* Include Itinerary in the response
*/
// @DataMember
bool? IncludeItinerary;
/**
* Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
*/
// @DataMember
FormattingStyle? ItineraryFormatting;
/**
* Itinerary segments to show
*/
// @DataMember
String? ItinerarySegmentsToShow;
/**
* CRM System Name used by Agency
*/
// @DataMember
String? CRM;
GetBookingsByTraveller({this.TravellerReference,this.TravellerGUID,this.TravelDateStart,this.TravelDateEnd,this.LastName,this.FirstName,this.IncludeItinerary,this.ItineraryFormatting,this.ItinerarySegmentsToShow,this.CRM});
GetBookingsByTraveller.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
TravellerReference = json['TravellerReference'];
TravellerGUID = json['TravellerGUID'];
TravelDateStart = json['TravelDateStart'];
TravelDateEnd = json['TravelDateEnd'];
LastName = json['LastName'];
FirstName = json['FirstName'];
IncludeItinerary = json['IncludeItinerary'];
ItineraryFormatting = JsonConverters.fromJson(json['ItineraryFormatting'],'FormattingStyle',context!);
ItinerarySegmentsToShow = json['ItinerarySegmentsToShow'];
CRM = json['CRM'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'TravellerReference': TravellerReference,
'TravellerGUID': TravellerGUID,
'TravelDateStart': TravelDateStart,
'TravelDateEnd': TravelDateEnd,
'LastName': LastName,
'FirstName': FirstName,
'IncludeItinerary': IncludeItinerary,
'ItineraryFormatting': JsonConverters.toJson(ItineraryFormatting,'FormattingStyle',context!),
'ItinerarySegmentsToShow': ItinerarySegmentsToShow,
'CRM': CRM
});
getTypeName() => "GetBookingsByTraveller";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
'ItinerarySegment': TypeInfo(TypeOf.Class, create:() => ItinerarySegment()),
'ItinerarySegmentsCollection': TypeInfo(TypeOf.Class, create:() => ItinerarySegmentsCollection()),
'BookingByTraveller': TypeInfo(TypeOf.Class, create:() => BookingByTraveller()),
'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
'BookingsByTravellerResponseReport': TypeInfo(TypeOf.Class, create:() => BookingsByTravellerResponseReport()),
'CacheMetadata': TypeInfo(TypeOf.Class, create:() => CacheMetadata()),
'ResponseMetadata': TypeInfo(TypeOf.Class, create:() => ResponseMetadata()),
'AgentivityError': TypeInfo(TypeOf.Class, create:() => AgentivityError()),
'ItemResponse<TItem,TReport>': TypeInfo(TypeOf.GenericDef,create:() => ItemResponse()),
'BookingsByTravellerItemResponse': TypeInfo(TypeOf.Class, create:() => BookingsByTravellerItemResponse()),
'FormattingStyle': TypeInfo(TypeOf.Enum, enumValues:FormattingStyle.values),
'GetBookingsByTraveller': TypeInfo(TypeOf.Class, create:() => GetBookingsByTraveller()),
});
Dart GetBookingsByTraveller DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /BookingsByTraveller HTTP/1.1 Host: api.agentivity.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","LastName":"String","FirstName":"String","Account":"String","AccountName":"String","OwningConsultant":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PNRCancelled":"String","PNRTicketed":"String","Passenger":"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"}],"ItineraryFormatted":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}