| GET | /CarSegmentsByDate |
|---|
"use strict";
export class PagingMetadata {
/** @param {{Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Starting Record */
Offset;
/**
* @type {string}
* @description Number of records to return (PageSize) */
Limit;
/**
* @type {number}
* @description Total Number of Records in a Full Reponse (if no paging) */
TotalRecords;
/**
* @type {number}
* @description Total Number of Records in this Reponse (on this page) */
ResponseRecords;
}
export class CompanyLevelRequestBase extends PagingMetadata {
/** @param {{OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string[]}
* @description Comma Delimited List of Owning Company Codes */
OwningCompanyCode;
/**
* @type {string}
* @description UserName in form of an email address */
UserName;
}
export class CarSegmentByDate {
/** @param {{AgentivityRef?:string,RecordLocator?:string,OwningAgencyLocationID?:string,OwningConsultant?:string,Account?:string,Passengers?:string,PickUpDate?:string,DropOffDate?:string,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}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
AgentivityRef;
/** @type {string} */
RecordLocator;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
OwningConsultant;
/** @type {string} */
Account;
/** @type {string} */
Passengers;
/** @type {?string} */
PickUpDate;
/** @type {?string} */
DropOffDate;
/** @type {string} */
CarVendorCode;
/** @type {string} */
VendorName;
/** @type {string} */
SegmentStatus;
/** @type {string} */
AirportCode;
/** @type {string} */
ConfirmationNbr;
/** @type {string} */
CurrencyCode;
/** @type {string} */
RateAmount;
/** @type {string} */
NbrOfCars;
/** @type {string} */
CarType;
/** @type {string} */
ServiceInformation;
/** @type {string} */
BRInformation;
/** @type {string} */
CarSegmentType;
/** @type {string} */
CreatingAgencyIata;
/** @type {string} */
CityCode;
/** @type {string} */
Text;
/** @type {string} */
Vouchers;
/** @type {string} */
CarRateCode;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class CarSegmentsByDateResponseReport extends Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class CacheMetadata {
/** @param {{CachedAt?:string,CacheExpiresAt?:string,IsFromCache?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CachedAt;
/** @type {string} */
CacheExpiresAt;
/** @type {boolean} */
IsFromCache;
}
export class ResponseMetadata {
/** @param {{Success?:boolean,HasCache?:boolean,HasPaging?:boolean,CacheMetadata?:CacheMetadata,PagingMetadata?:PagingMetadata}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Success;
/** @type {boolean} */
HasCache;
/** @type {boolean} */
HasPaging;
/** @type {CacheMetadata} */
CacheMetadata;
/** @type {PagingMetadata} */
PagingMetadata;
}
export class AgentivityError {
/** @param {{ErrorCode?:string,Message?:string,StatusCode?:string,VerboseMessage?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ErrorCode;
/** @type {string} */
Message;
/** @type {string} */
StatusCode;
/** @type {string} */
VerboseMessage;
}
/** @typedef TItem {any} */
/** @typedef TReport {any} */
export class ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseMetadata} */
ResponseMetadata;
/** @type {TReport} */
ResponseReport;
/** @type {AgentivityError} */
ResponseError;
}
export class CarSegmentsByDateItemResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {'Active'|'Passive'|'All'} */
export var CarSegmentType;
(function (CarSegmentType) {
CarSegmentType["Active"] = "Active"
CarSegmentType["Passive"] = "Passive"
CarSegmentType["All"] = "All"
})(CarSegmentType || (CarSegmentType = {}));
export class CarSegmentsByDate extends CompanyLevelRequestBase {
/** @param {{SegmentType?:CarSegmentType,DateStart?:string,DateEnd?:string,DateSearchType?:string,OwningCompanyCode?:string[],UserName?:string,Offset?:string,Limit?:string,TotalRecords?:number,ResponseRecords?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {CarSegmentType}
* @description Type of segment */
SegmentType;
/**
* @type {string}
* @description Date in format YYYYMMDD */
DateStart;
/**
* @type {string}
* @description Date in format YYYYMMDD */
DateEnd;
/**
* @type {string}
* @description Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates). */
DateSearchType;
}
JavaScript CarSegmentsByDate DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
<ResponseMetadata>
<Success>false</Success>
<HasCache>false</HasCache>
<HasPaging>false</HasPaging>
<CacheMetadata>
<IsFromCache>false</IsFromCache>
<CachedAt>0001-01-01T00:00:00</CachedAt>
<CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
</CacheMetadata>
<PagingMetadata>
<Limit>String</Limit>
<Offset>String</Offset>
<ResponseRecords>0</ResponseRecords>
<TotalRecords>0</TotalRecords>
</PagingMetadata>
</ResponseMetadata>
<ResponseReport>
<Item>
<AgentivityRef>String</AgentivityRef>
<RecordLocator>String</RecordLocator>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<Passengers>String</Passengers>
<PickUpDate>0001-01-01T00:00:00</PickUpDate>
<DropOffDate>0001-01-01T00:00:00</DropOffDate>
<CarVendorCode>String</CarVendorCode>
<VendorName>String</VendorName>
<SegmentStatus>String</SegmentStatus>
<AirportCode>String</AirportCode>
<ConfirmationNbr>String</ConfirmationNbr>
<CurrencyCode>String</CurrencyCode>
<RateAmount>String</RateAmount>
<NbrOfCars>String</NbrOfCars>
<CarType>String</CarType>
<ServiceInformation>String</ServiceInformation>
<BRInformation>String</BRInformation>
<CarSegmentType>String</CarSegmentType>
<CreatingAgencyIata>String</CreatingAgencyIata>
<CityCode>String</CityCode>
<Text>String</Text>
<Vouchers>String</Vouchers>
<CarRateCode>String</CarRateCode>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>