GET | /MissedHotelOpportunities |
---|
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="MissedHotelOpportunity", Namespace="schemas.agentivity.com/types")
class MissedHotelOpportunity implements IConvertible
{
// @DataMember(Order=10)
int? AgentivityRef;
// @DataMember(Order=20)
String? RecordLocator;
// @DataMember(Order=30)
DateTime? PNRCreationDate;
// @DataMember(Order=40)
String? CityCode;
// @DataMember(Order=44)
String? CityName;
// @DataMember(Order=45)
String? CountryCode;
// @DataMember(Order=50)
String? Account;
// @DataMember(Order=60)
String? Passengers;
// @DataMember(Order=70)
String? OwningConsultant;
// @DataMember(Order=75)
String? OwningConsultantID;
// @DataMember(Order=80)
String? GdsCode;
// @DataMember(Order=90)
DateTime? From;
// @DataMember(Order=100)
DateTime? To;
// @DataMember(Order=110)
int? NightsNumber;
// @DataMember(Order=120)
String? NoHotelReason;
MissedHotelOpportunity({this.AgentivityRef,this.RecordLocator,this.PNRCreationDate,this.CityCode,this.CityName,this.CountryCode,this.Account,this.Passengers,this.OwningConsultant,this.OwningConsultantID,this.GdsCode,this.From,this.To,this.NightsNumber,this.NoHotelReason});
MissedHotelOpportunity.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!);
CityCode = json['CityCode'];
CityName = json['CityName'];
CountryCode = json['CountryCode'];
Account = json['Account'];
Passengers = json['Passengers'];
OwningConsultant = json['OwningConsultant'];
OwningConsultantID = json['OwningConsultantID'];
GdsCode = json['GdsCode'];
From = JsonConverters.fromJson(json['From'],'DateTime',context!);
To = JsonConverters.fromJson(json['To'],'DateTime',context!);
NightsNumber = json['NightsNumber'];
NoHotelReason = json['NoHotelReason'];
return this;
}
Map<String, dynamic> toJson() => {
'AgentivityRef': AgentivityRef,
'RecordLocator': RecordLocator,
'PNRCreationDate': JsonConverters.toJson(PNRCreationDate,'DateTime',context!),
'CityCode': CityCode,
'CityName': CityName,
'CountryCode': CountryCode,
'Account': Account,
'Passengers': Passengers,
'OwningConsultant': OwningConsultant,
'OwningConsultantID': OwningConsultantID,
'GdsCode': GdsCode,
'From': JsonConverters.toJson(From,'DateTime',context!),
'To': JsonConverters.toJson(To,'DateTime',context!),
'NightsNumber': NightsNumber,
'NoHotelReason': NoHotelReason
};
getTypeName() => "MissedHotelOpportunity";
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="MissedHotelOpportunity", Namespace="schemas.agentivity.com/types")
class MissedHotelOpportunitiesByCityResponseReport extends Report<MissedHotelOpportunitiesByCityItemResponse,MissedHotelOpportunity> implements IConvertible
{
MissedHotelOpportunitiesByCityResponseReport();
MissedHotelOpportunitiesByCityResponseReport.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() => "MissedHotelOpportunitiesByCityResponseReport";
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 MissedHotelOpportunitiesByCityItemResponse extends ItemResponse<MissedHotelOpportunity,MissedHotelOpportunitiesByCityResponseReport> implements IConvertible
{
MissedHotelOpportunitiesByCityItemResponse();
MissedHotelOpportunitiesByCityItemResponse.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() => "MissedHotelOpportunitiesByCityItemResponse";
TypeContext? context = _ctx;
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class GetMissedHotelOpportunitiesByCity extends CompanyLevelRequestBase implements IConvertible
{
/**
* Account
*/
// @DataMember
String? Account;
/**
* 3 letter city code
*/
// @DataMember
String? CityCode;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? TravelDateStart;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? TravelDateEnd;
/**
* Return only PNRs with/without a NoHotelReason specified
*/
// @DataMember
bool? HasNoHotelReason;
GetMissedHotelOpportunitiesByCity({this.Account,this.CityCode,this.TravelDateStart,this.TravelDateEnd,this.HasNoHotelReason});
GetMissedHotelOpportunitiesByCity.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Account = json['Account'];
CityCode = json['CityCode'];
TravelDateStart = json['TravelDateStart'];
TravelDateEnd = json['TravelDateEnd'];
HasNoHotelReason = json['HasNoHotelReason'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Account': Account,
'CityCode': CityCode,
'TravelDateStart': TravelDateStart,
'TravelDateEnd': TravelDateEnd,
'HasNoHotelReason': HasNoHotelReason
});
getTypeName() => "GetMissedHotelOpportunitiesByCity";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
'MissedHotelOpportunity': TypeInfo(TypeOf.Class, create:() => MissedHotelOpportunity()),
'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
'MissedHotelOpportunitiesByCityResponseReport': TypeInfo(TypeOf.Class, create:() => MissedHotelOpportunitiesByCityResponseReport()),
'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()),
'MissedHotelOpportunitiesByCityItemResponse': TypeInfo(TypeOf.Class, create:() => MissedHotelOpportunitiesByCityItemResponse()),
'GetMissedHotelOpportunitiesByCity': TypeInfo(TypeOf.Class, create:() => GetMissedHotelOpportunitiesByCity()),
});
Dart GetMissedHotelOpportunitiesByCity 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 /MissedHotelOpportunities 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":{"AgentivityRef":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","CityCode":"String","CityName":"String","CountryCode":"String","Account":"String","Passengers":"String","OwningConsultant":"String","OwningConsultantID":"String","GdsCode":"String","From":"\/Date(-62135596800000-0000)\/","To":"\/Date(-62135596800000-0000)\/","NightsNumber":0,"NoHotelReason":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}