| GET | /FindBookings |
|---|
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="CustomField", Namespace="schemas.agentivity.com/types")
class CustomFieldData implements IConvertible
{
// @DataMember(Order=20)
String? FieldName;
// @DataMember(Order=30)
String? FieldValue;
CustomFieldData({this.FieldName,this.FieldValue});
CustomFieldData.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
FieldName = json['FieldName'];
FieldValue = json['FieldValue'];
return this;
}
Map<String, dynamic> toJson() => {
'FieldName': FieldName,
'FieldValue': FieldValue
};
getTypeName() => "CustomFieldData";
TypeContext? context = _ctx;
}
class CustomFieldsCollection extends ListBase<CustomFieldData> implements IConvertible
{
final List<CustomFieldData> l = [];
set length(int newLength) { l.length = newLength; }
int get length => l.length;
CustomFieldData operator [](int index) => l[index];
void operator []=(int index, CustomFieldData value) { l[index] = value; }
CustomFieldsCollection();
CustomFieldsCollection.fromJson(Map<String, dynamic> json) : super();
fromMap(Map<String, dynamic> json) {
return this;
}
Map<String, dynamic> toJson() => {};
getTypeName() => "CustomFieldsCollection";
TypeContext? context = _ctx;
}
// @DataContract(Name="BookingSearchResult", Namespace="schemas.agentivity.com/types")
class BookingSearchResult implements IBookingCustomFields, IConvertible
{
// @DataMember(Order=10)
int? AgentivityRef;
// @DataMember(Order=20)
String? RecordLocator;
// @DataMember(Order=30)
DateTime? PNRCreationDate;
// @DataMember(Order=40)
String? Passengers;
// @DataMember(Order=50)
String? Account;
// @DataMember(Order=55)
String? OwningAgencyLocationID;
// @DataMember(Order=60)
String? OwningConsultant;
// @DataMember(Order=65)
String? OwningConsultantID;
// @DataMember(Order=70)
DateTime? TravelDate;
// @DataMember(Order=80)
String? PnrTicketed;
// @DataMember(Order=90)
String? PnrCancelled;
// @DataMember(Order=100)
String? AirSegBookingCodeList;
// @DataMember(Order=110)
bool? IsFrequentFlyer;
// @DataMember(Order=120)
int? ItineraryChanges;
// @DataMember(Order=130)
CustomFieldsCollection? CustomFields;
BookingSearchResult({this.AgentivityRef,this.RecordLocator,this.PNRCreationDate,this.Passengers,this.Account,this.OwningAgencyLocationID,this.OwningConsultant,this.OwningConsultantID,this.TravelDate,this.PnrTicketed,this.PnrCancelled,this.AirSegBookingCodeList,this.IsFrequentFlyer,this.ItineraryChanges,this.CustomFields});
BookingSearchResult.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
AgentivityRef = json['AgentivityRef'];
RecordLocator = json['RecordLocator'];
PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
Passengers = json['Passengers'];
Account = json['Account'];
OwningAgencyLocationID = json['OwningAgencyLocationID'];
OwningConsultant = json['OwningConsultant'];
OwningConsultantID = json['OwningConsultantID'];
TravelDate = JsonConverters.fromJson(json['TravelDate'],'DateTime',context!);
PnrTicketed = json['PnrTicketed'];
PnrCancelled = json['PnrCancelled'];
AirSegBookingCodeList = json['AirSegBookingCodeList'];
IsFrequentFlyer = json['IsFrequentFlyer'];
ItineraryChanges = json['ItineraryChanges'];
CustomFields = JsonConverters.fromJson(json['CustomFields'],'CustomFieldsCollection',context!);
return this;
}
Map<String, dynamic> toJson() => {
'AgentivityRef': AgentivityRef,
'RecordLocator': RecordLocator,
'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
'Passengers': Passengers,
'Account': Account,
'OwningAgencyLocationID': OwningAgencyLocationID,
'OwningConsultant': OwningConsultant,
'OwningConsultantID': OwningConsultantID,
'TravelDate': JsonConverters.toJson(TravelDate,'DateTime',context!),
'PnrTicketed': PnrTicketed,
'PnrCancelled': PnrCancelled,
'AirSegBookingCodeList': AirSegBookingCodeList,
'IsFrequentFlyer': IsFrequentFlyer,
'ItineraryChanges': ItineraryChanges,
'CustomFields': JsonConverters.toJson(CustomFields,'CustomFieldsCollection',context!)
};
getTypeName() => "BookingSearchResult";
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="BookingSearchResult", Namespace="schemas.agentivity.com/types")
class FindBookingsResponseReport extends Report<FindBookingsItemResponse,BookingSearchResult> implements IConvertible
{
FindBookingsResponseReport();
FindBookingsResponseReport.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() => "FindBookingsResponseReport";
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 FindBookingsItemResponse extends ItemResponse<BookingSearchResult,FindBookingsResponseReport> implements IConvertible
{
FindBookingsItemResponse();
FindBookingsItemResponse.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() => "FindBookingsItemResponse";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class FindBookings extends CompanyLevelRequestBase implements IConvertible
{
/**
* Record locator
*/
// @DataMember
String? RecordLocator;
/**
* Airline locator
*/
// @DataMember
String? AirlineLocator;
/**
* Surname
*/
// @DataMember
String? Surname;
/**
* Comma Delimited List of Custom Fields
*/
// @DataMember
List<String>? CustomField;
FindBookings({this.RecordLocator,this.AirlineLocator,this.Surname,this.CustomField});
FindBookings.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
RecordLocator = json['RecordLocator'];
AirlineLocator = json['AirlineLocator'];
Surname = json['Surname'];
CustomField = JsonConverters.fromJson(json['CustomField'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'RecordLocator': RecordLocator,
'AirlineLocator': AirlineLocator,
'Surname': Surname,
'CustomField': JsonConverters.toJson(CustomField,'List<String>',context!)
});
getTypeName() => "FindBookings";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
'CustomFieldData': TypeInfo(TypeOf.Class, create:() => CustomFieldData()),
'CustomFieldsCollection': TypeInfo(TypeOf.Class, create:() => CustomFieldsCollection()),
'BookingSearchResult': TypeInfo(TypeOf.Class, create:() => BookingSearchResult()),
'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
'FindBookingsResponseReport': TypeInfo(TypeOf.Class, create:() => FindBookingsResponseReport()),
'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()),
'FindBookingsItemResponse': TypeInfo(TypeOf.Class, create:() => FindBookingsItemResponse()),
'FindBookings': TypeInfo(TypeOf.Class, create:() => FindBookings()),
});
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 /FindBookings 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)\/","Passengers":"String","Account":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","OwningConsultantID":"String","TravelDate":"\/Date(-62135596800000-0000)\/","PnrTicketed":"String","PnrCancelled":"String","AirSegBookingCodeList":"String","IsFrequentFlyer":false,"ItineraryChanges":0,"CustomFields":[{"FieldName":"String","FieldValue":"String"}]}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}