| GET | /CarSegmentsByDate |
|---|
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="CarSegmentByDate", Namespace="schemas.agentivity.com/types")
class CarSegmentByDate implements IConvertible
{
// @DataMember(Order=10)
String? AgentivityRef;
// @DataMember(Order=20)
String? RecordLocator;
// @DataMember(Order=30)
String? OwningAgencyLocationID;
// @DataMember(Order=40)
String? OwningConsultant;
// @DataMember(Order=50)
String? Account;
// @DataMember(Order=55)
String? Passengers;
// @DataMember(Order=60)
DateTime? PickUpDate;
// @DataMember(Order=70)
DateTime? DropOffDate;
// @DataMember(Order=80)
String? CarVendorCode;
// @DataMember(Order=90)
String? VendorName;
// @DataMember(Order=100)
String? SegmentStatus;
// @DataMember(Order=110)
String? AirportCode;
// @DataMember(Order=120)
String? ConfirmationNbr;
// @DataMember(Order=130)
String? CurrencyCode;
// @DataMember(Order=140)
String? RateAmount;
// @DataMember(Order=150)
String? NbrOfCars;
// @DataMember(Order=160)
String? CarType;
// @DataMember(Order=180)
String? ServiceInformation;
// @DataMember(Order=190)
String? BRInformation;
// @DataMember(Order=200)
String? CarSegmentType;
// @DataMember(Order=210)
String? CreatingAgencyIata;
// @DataMember(Order=220)
String? CityCode;
// @DataMember(Order=230)
String? Text;
// @DataMember(Order=240)
String? Vouchers;
// @DataMember(Order=250)
String? CarRateCode;
CarSegmentByDate({this.AgentivityRef,this.RecordLocator,this.OwningAgencyLocationID,this.OwningConsultant,this.Account,this.Passengers,this.PickUpDate,this.DropOffDate,this.CarVendorCode,this.VendorName,this.SegmentStatus,this.AirportCode,this.ConfirmationNbr,this.CurrencyCode,this.RateAmount,this.NbrOfCars,this.CarType,this.ServiceInformation,this.BRInformation,this.CarSegmentType,this.CreatingAgencyIata,this.CityCode,this.Text,this.Vouchers,this.CarRateCode});
CarSegmentByDate.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
AgentivityRef = json['AgentivityRef'];
RecordLocator = json['RecordLocator'];
OwningAgencyLocationID = json['OwningAgencyLocationID'];
OwningConsultant = json['OwningConsultant'];
Account = json['Account'];
Passengers = json['Passengers'];
PickUpDate = JsonConverters.fromJson(json['PickUpDate'],'DateTime',context!);
DropOffDate = JsonConverters.fromJson(json['DropOffDate'],'DateTime',context!);
CarVendorCode = json['CarVendorCode'];
VendorName = json['VendorName'];
SegmentStatus = json['SegmentStatus'];
AirportCode = json['AirportCode'];
ConfirmationNbr = json['ConfirmationNbr'];
CurrencyCode = json['CurrencyCode'];
RateAmount = json['RateAmount'];
NbrOfCars = json['NbrOfCars'];
CarType = json['CarType'];
ServiceInformation = json['ServiceInformation'];
BRInformation = json['BRInformation'];
CarSegmentType = json['CarSegmentType'];
CreatingAgencyIata = json['CreatingAgencyIata'];
CityCode = json['CityCode'];
Text = json['Text'];
Vouchers = json['Vouchers'];
CarRateCode = json['CarRateCode'];
return this;
}
Map<String, dynamic> toJson() => {
'AgentivityRef': AgentivityRef,
'RecordLocator': RecordLocator,
'OwningAgencyLocationID': OwningAgencyLocationID,
'OwningConsultant': OwningConsultant,
'Account': Account,
'Passengers': Passengers,
'PickUpDate': JsonConverters.toJson(PickUpDate,'DateTime',context!),
'DropOffDate': JsonConverters.toJson(DropOffDate,'DateTime',context!),
'CarVendorCode': CarVendorCode,
'VendorName': VendorName,
'SegmentStatus': SegmentStatus,
'AirportCode': AirportCode,
'ConfirmationNbr': ConfirmationNbr,
'CurrencyCode': CurrencyCode,
'RateAmount': RateAmount,
'NbrOfCars': NbrOfCars,
'CarType': CarType,
'ServiceInformation': ServiceInformation,
'BRInformation': BRInformation,
'CarSegmentType': CarSegmentType,
'CreatingAgencyIata': CreatingAgencyIata,
'CityCode': CityCode,
'Text': Text,
'Vouchers': Vouchers,
'CarRateCode': CarRateCode
};
getTypeName() => "CarSegmentByDate";
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="CarSegmentByDate", Namespace="schemas.agentivity.com/types")
class CarSegmentsByDateResponseReport extends Report<CarSegmentsByDateItemResponse,CarSegmentByDate> implements IConvertible
{
CarSegmentsByDateResponseReport();
CarSegmentsByDateResponseReport.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() => "CarSegmentsByDateResponseReport";
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 CarSegmentsByDateItemResponse extends ItemResponse<CarSegmentByDate,CarSegmentsByDateResponseReport> implements IConvertible
{
CarSegmentsByDateItemResponse();
CarSegmentsByDateItemResponse.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() => "CarSegmentsByDateItemResponse";
TypeContext? context = _ctx;
}
enum CarSegmentType
{
Active,
Passive,
All,
}
// @DataContract(Namespace="schemas.agentivity.com/types")
class CarSegmentsByDate extends CompanyLevelRequestBase implements IConvertible
{
/**
* Type of segment
*/
// @DataMember
CarSegmentType? SegmentType;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? DateStart;
/**
* Date in format YYYYMMDD
*/
// @DataMember
String? DateEnd;
/**
* Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
*/
// @DataMember
String? DateSearchType;
CarSegmentsByDate({this.SegmentType,this.DateStart,this.DateEnd,this.DateSearchType});
CarSegmentsByDate.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
SegmentType = JsonConverters.fromJson(json['SegmentType'],'CarSegmentType',context!);
DateStart = json['DateStart'];
DateEnd = json['DateEnd'];
DateSearchType = json['DateSearchType'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'SegmentType': JsonConverters.toJson(SegmentType,'CarSegmentType',context!),
'DateStart': DateStart,
'DateEnd': DateEnd,
'DateSearchType': DateSearchType
});
getTypeName() => "CarSegmentsByDate";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.agentivity.com', types: <String, TypeInfo> {
'PagingMetadata': TypeInfo(TypeOf.Class, create:() => PagingMetadata()),
'CompanyLevelRequestBase': TypeInfo(TypeOf.AbstractClass),
'CarSegmentByDate': TypeInfo(TypeOf.Class, create:() => CarSegmentByDate()),
'Report<TItemResponse,TItem>': TypeInfo(TypeOf.GenericDef,create:() => Report()),
'CarSegmentsByDateResponseReport': TypeInfo(TypeOf.Class, create:() => CarSegmentsByDateResponseReport()),
'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()),
'CarSegmentsByDateItemResponse': TypeInfo(TypeOf.Class, create:() => CarSegmentsByDateItemResponse()),
'CarSegmentType': TypeInfo(TypeOf.Enum, enumValues:CarSegmentType.values),
'CarSegmentsByDate': TypeInfo(TypeOf.Class, create:() => CarSegmentsByDate()),
});
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 /CarSegmentsByDate 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":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passengers":"String","PickUpDate":"\/Date(-62135596800000-0000)\/","DropOffDate":"\/Date(-62135596800000-0000)\/","CarVendorCode":"String","VendorName":"String","SegmentStatus":"String","AirportCode":"String","ConfirmationNbr":"String","CurrencyCode":"String","RateAmount":"String","NbrOfCars":"String","CarType":"String","ServiceInformation":"String","BRInformation":"String","CarSegmentType":"String","CreatingAgencyIata":"String","CityCode":"String","Text":"String","Vouchers":"String","CarRateCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}