| GET | /CancelledHotelSegments |
|---|
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="Segment", Namespace="schemas.agentivity.com/types")
class CancelledHotelSegment implements IConvertible
{
// @DataMember(Order=10)
String? RecordLocator;
// @DataMember(Order=20)
DateTime? PNRCreationDate;
// @DataMember(Order=30)
String? OwningAgencyLocationID;
// @DataMember(Order=40)
String? Account;
// @DataMember(Order=50)
String? OwningConsultantID;
// @DataMember(Order=60)
String? OwningConsultant;
// @DataMember(Order=70)
String? StatusCode;
// @DataMember(Order=80)
DateTime? ArrivalDate;
// @DataMember(Order=90)
DateTime? DepartureDate;
// @DataMember(Order=100)
String? PropertyName;
// @DataMember(Order=110)
String? Chain;
// @DataMember(Order=120)
String? City;
// @DataMember(Order=130)
String? Passenger;
// @DataMember(Order=140)
String? ConfirmationNbr;
// @DataMember(Order=150)
String? Currency;
// @DataMember(Order=160)
String? Rate;
// @DataMember(Order=170)
String? RoomBookingCode;
// @DataMember(Order=180)
int? NbrNights;
// @DataMember(Order=190)
String? MultiLevelRateCode;
// @DataMember(Order=200)
int? NbrRooms;
// @DataMember(Order=210)
String? BookedInName;
// @DataMember(Order=220)
String? ServiceInformation;
// @DataMember(Order=230)
DateTime? CancellationDate;
// @DataMember(Order=240)
String? CancellationRemark;
CancelledHotelSegment({this.RecordLocator,this.PNRCreationDate,this.OwningAgencyLocationID,this.Account,this.OwningConsultantID,this.OwningConsultant,this.StatusCode,this.ArrivalDate,this.DepartureDate,this.PropertyName,this.Chain,this.City,this.Passenger,this.ConfirmationNbr,this.Currency,this.Rate,this.RoomBookingCode,this.NbrNights,this.MultiLevelRateCode,this.NbrRooms,this.BookedInName,this.ServiceInformation,this.CancellationDate,this.CancellationRemark});
CancelledHotelSegment.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
RecordLocator = json['RecordLocator'];
PNRCreationDate = JsonConverters.fromJson(json['PNRCreationDate'],'DateTime',context!);
OwningAgencyLocationID = json['OwningAgencyLocationID'];
Account = json['Account'];
OwningConsultantID = json['OwningConsultantID'];
OwningConsultant = json['OwningConsultant'];
StatusCode = json['StatusCode'];
ArrivalDate = JsonConverters.fromJson(json['ArrivalDate'],'DateTime',context!);
DepartureDate = JsonConverters.fromJson(json['DepartureDate'],'DateTime',context!);
PropertyName = json['PropertyName'];
Chain = json['Chain'];
City = json['City'];
Passenger = json['Passenger'];
ConfirmationNbr = json['ConfirmationNbr'];
Currency = json['Currency'];
Rate = json['Rate'];
RoomBookingCode = json['RoomBookingCode'];
NbrNights = json['NbrNights'];
MultiLevelRateCode = json['MultiLevelRateCode'];
NbrRooms = json['NbrRooms'];
BookedInName = json['BookedInName'];
ServiceInformation = json['ServiceInformation'];
CancellationDate = JsonConverters.fromJson(json['CancellationDate'],'DateTime',context!);
CancellationRemark = json['CancellationRemark'];
return this;
}
Map<String, dynamic> toJson() => {
'RecordLocator': RecordLocator,
'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
'OwningAgencyLocationID': OwningAgencyLocationID,
'Account': Account,
'OwningConsultantID': OwningConsultantID,
'OwningConsultant': OwningConsultant,
'StatusCode': StatusCode,
'ArrivalDate': JsonConverters.toJson(ArrivalDate,'DateTime',context!),
'DepartureDate': JsonConverters.toJson(DepartureDate,'DateTime',context!),
'PropertyName': PropertyName,
'Chain': Chain,
'City': City,
'Passenger': Passenger,
'ConfirmationNbr': ConfirmationNbr,
'Currency': Currency,
'Rate': Rate,
'RoomBookingCode': RoomBookingCode,
'NbrNights': NbrNights,
'MultiLevelRateCode': MultiLevelRateCode,
'NbrRooms': NbrRooms,
'BookedInName': BookedInName,
'ServiceInformation': ServiceInformation,
'CancellationDate': JsonConverters.toJson(CancellationDate,'DateTime',context!),
'CancellationRemark': CancellationRemark
};
getTypeName() => "CancelledHotelSegment";
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="CancelledHotelSegment", Namespace="schemas.agentivity.com/types")
class GetCancelledHotelSegmentsResponseReport extends Report<GetCancelledHotelSegmentsItemResponse,CancelledHotelSegment> implements IConvertible
{
GetCancelledHotelSegmentsResponseReport();
GetCancelledHotelSegmentsResponseReport.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() => "GetCancelledHotelSegmentsResponseReport";
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 GetCancelledHotelSegmentsItemResponse extends ItemResponse<CancelledHotelSegment,GetCancelledHotelSegmentsResponseReport> implements IConvertible
{
GetCancelledHotelSegmentsItemResponse();
GetCancelledHotelSegmentsItemResponse.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() => "GetCancelledHotelSegmentsItemResponse";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class GetCancelledHotelSegments extends CompanyLevelRequestBase implements IConvertible
{
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? CancelledDateStart;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? CancelledDateEnd;
/**
* Comma Delimited List of CountryCodes
*/
// @DataMember
List<String>? OwningAgencyCountryCode;
/**
* Return only PNRs with/without an Cancellation Reference
*/
// @DataMember
bool? HasCancellationRemark;
GetCancelledHotelSegments({this.CancelledDateStart,this.CancelledDateEnd,this.OwningAgencyCountryCode,this.HasCancellationRemark});
GetCancelledHotelSegments.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
CancelledDateStart = json['CancelledDateStart'];
CancelledDateEnd = json['CancelledDateEnd'];
OwningAgencyCountryCode = JsonConverters.fromJson(json['OwningAgencyCountryCode'],'List<String>',context!);
HasCancellationRemark = json['HasCancellationRemark'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'CancelledDateStart': CancelledDateStart,
'CancelledDateEnd': CancelledDateEnd,
'OwningAgencyCountryCode': JsonConverters.toJson(OwningAgencyCountryCode,'List<String>',context!),
'HasCancellationRemark': HasCancellationRemark
});
getTypeName() => "GetCancelledHotelSegments";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
'CancelledHotelSegment': TypeInfo(TypeOf.Class, create:() => CancelledHotelSegment()),
'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
'GetCancelledHotelSegmentsResponseReport': TypeInfo(TypeOf.Class, create:() => GetCancelledHotelSegmentsResponseReport()),
'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()),
'GetCancelledHotelSegmentsItemResponse': TypeInfo(TypeOf.Class, create:() => GetCancelledHotelSegmentsItemResponse()),
'GetCancelledHotelSegments': TypeInfo(TypeOf.Class, create:() => GetCancelledHotelSegments()),
});
Dart GetCancelledHotelSegments 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 /CancelledHotelSegments 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":{"Item":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","OwningAgencyLocationID":"String","Account":"String","OwningConsultantID":"String","OwningConsultant":"String","StatusCode":"String","ArrivalDate":"\/Date(-62135596800000-0000)\/","DepartureDate":"\/Date(-62135596800000-0000)\/","PropertyName":"String","Chain":"String","City":"String","Passenger":"String","ConfirmationNbr":"String","Currency":"String","Rate":"String","RoomBookingCode":"String","NbrNights":0,"MultiLevelRateCode":"String","NbrRooms":0,"BookedInName":"String","ServiceInformation":"String","CancellationDate":"\/Date(-62135596800000-0000)\/","CancellationRemark":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}