| GET | /TravelHistorySummary/Traveller |
|---|
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="TravellerHistory", Namespace="schemas.agentivity.com/types")
class TravelHistorySummaryV3 implements IConvertible
{
// @DataMember
double? AverageItineraryChanges;
// @DataMember
int? BookingsMade;
// @DataMember
String? CountriesVisited;
// @DataMember
String? TripClasses;
// @DataMember
int? BookingsCancelled;
// @DataMember
String? AirSuppliersUsed;
// @DataMember
int? Ticketed;
// @DataMember
String? HotelChainsUsed;
// @DataMember
int? AdvancePurchaseAverageDays;
// @DataMember
String? CarSuppliersUsed;
// @DataMember(Order=100)
String? TopAirSupplierSupport;
// @DataMember(Order=110)
String? TopDepartureAirports;
TravelHistorySummaryV3({this.AverageItineraryChanges,this.BookingsMade,this.CountriesVisited,this.TripClasses,this.BookingsCancelled,this.AirSuppliersUsed,this.Ticketed,this.HotelChainsUsed,this.AdvancePurchaseAverageDays,this.CarSuppliersUsed,this.TopAirSupplierSupport,this.TopDepartureAirports});
TravelHistorySummaryV3.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
AverageItineraryChanges = JsonConverters.toDouble(json['AverageItineraryChanges']);
BookingsMade = json['BookingsMade'];
CountriesVisited = json['CountriesVisited'];
TripClasses = json['TripClasses'];
BookingsCancelled = json['BookingsCancelled'];
AirSuppliersUsed = json['AirSuppliersUsed'];
Ticketed = json['Ticketed'];
HotelChainsUsed = json['HotelChainsUsed'];
AdvancePurchaseAverageDays = json['AdvancePurchaseAverageDays'];
CarSuppliersUsed = json['CarSuppliersUsed'];
TopAirSupplierSupport = json['TopAirSupplierSupport'];
TopDepartureAirports = json['TopDepartureAirports'];
return this;
}
Map<String, dynamic> toJson() => {
'AverageItineraryChanges': AverageItineraryChanges,
'BookingsMade': BookingsMade,
'CountriesVisited': CountriesVisited,
'TripClasses': TripClasses,
'BookingsCancelled': BookingsCancelled,
'AirSuppliersUsed': AirSuppliersUsed,
'Ticketed': Ticketed,
'HotelChainsUsed': HotelChainsUsed,
'AdvancePurchaseAverageDays': AdvancePurchaseAverageDays,
'CarSuppliersUsed': CarSuppliersUsed,
'TopAirSupplierSupport': TopAirSupplierSupport,
'TopDepartureAirports': TopDepartureAirports
};
getTypeName() => "TravelHistorySummaryV3";
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 TravellerHistoryResponse extends CollectionResponse<TravelHistorySummaryV3> implements IConvertible
{
TravellerHistoryResponse();
TravellerHistoryResponse.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() => "TravellerHistoryResponse";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class GetTravelHistorySummaryByTraveller extends CompanyLevelRequestBase implements IRequestConsultantID, IConvertible
{
/**
* Return only PNRs that are ticketed/all
*/
// @DataMember
String? PNRTicketed;
/**
* Traveller CRM ID or reference
*/
// @DataMember
String? TravellerReference;
/**
* Agentivity Traveller GUID
*/
// @DataMember
String? TravellerGUID;
/**
* An email of a traveller
*/
// @DataMember
String? TravellerEmail;
/**
* Traveller phone number
*/
// @DataMember
String? TravellerPhoneNbr;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? TravelDateStart;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? TravelDateEnd;
/**
* CRM System Name used by Agency
*/
// @DataMember
String? CRM;
/**
* Request Consultant ID (sign on)
*/
// @DataMember
String? RequestConsultantID;
GetTravelHistorySummaryByTraveller({this.PNRTicketed,this.TravellerReference,this.TravellerGUID,this.TravellerEmail,this.TravellerPhoneNbr,this.TravelDateStart,this.TravelDateEnd,this.CRM,this.RequestConsultantID});
GetTravelHistorySummaryByTraveller.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
PNRTicketed = json['PNRTicketed'];
TravellerReference = json['TravellerReference'];
TravellerGUID = json['TravellerGUID'];
TravellerEmail = json['TravellerEmail'];
TravellerPhoneNbr = json['TravellerPhoneNbr'];
TravelDateStart = json['TravelDateStart'];
TravelDateEnd = json['TravelDateEnd'];
CRM = json['CRM'];
RequestConsultantID = json['RequestConsultantID'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'PNRTicketed': PNRTicketed,
'TravellerReference': TravellerReference,
'TravellerGUID': TravellerGUID,
'TravellerEmail': TravellerEmail,
'TravellerPhoneNbr': TravellerPhoneNbr,
'TravelDateStart': TravelDateStart,
'TravelDateEnd': TravelDateEnd,
'CRM': CRM,
'RequestConsultantID': RequestConsultantID
});
getTypeName() => "GetTravelHistorySummaryByTraveller";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
'TravelHistorySummaryV3': TypeInfo(TypeOf.Class, create:() => TravelHistorySummaryV3()),
'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>[]),
'TravellerHistoryResponse': TypeInfo(TypeOf.Class, create:() => TravellerHistoryResponse()),
'GetTravelHistorySummaryByTraveller': TypeInfo(TypeOf.Class, create:() => GetTravelHistorySummaryByTraveller()),
});
Dart GetTravelHistorySummaryByTraveller 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 /TravelHistorySummary/Traveller 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":[{"AverageItineraryChanges":0,"BookingsMade":0,"CountriesVisited":"String","TripClasses":"String","BookingsCancelled":0,"AirSuppliersUsed":"String","Ticketed":0,"HotelChainsUsed":"String","AdvancePurchaseAverageDays":0,"CarSuppliersUsed":"String","TopAirSupplierSupport":"String","TopDepartureAirports":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}