| GET | /PassiveSegments |
|---|
"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 PassiveSegmentWithOwningInformation {
/** @param {{AgentivityRef?:number,OwningAgencyLocationID?:string,RecordLocator?:string,OwningConsultantID?:string,OwningConsultant?:string,Account?:string,SegmentStatus?:string,StartDate?:string,DepartureDate?:string,NbrNights?:string,VendorCode?:string,CityCode?:string,SegmentType?:string,Text?:string,Passenger?:string,Address?:string,BookingReasonCode?:string,BookingSource?:string,CommissionInformation?:string,ConfirmationNumber?:string,RateCode?:string,RateQuoted?:string,RateAccessCode?:string,PropertyName?:string,PropertyNumber?:string,ServiceInformation?:string,TotalAirSegs?:string,HotelCommission?:string,CountryName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
AgentivityRef;
/** @type {string} */
OwningAgencyLocationID;
/** @type {string} */
RecordLocator;
/** @type {string} */
OwningConsultantID;
/** @type {string} */
OwningConsultant;
/** @type {string} */
Account;
/** @type {string} */
SegmentStatus;
/** @type {string} */
StartDate;
/** @type {string} */
DepartureDate;
/** @type {string} */
NbrNights;
/** @type {string} */
VendorCode;
/** @type {string} */
CityCode;
/** @type {string} */
SegmentType;
/** @type {string} */
Text;
/** @type {string} */
Passenger;
/** @type {string} */
Address;
/** @type {string} */
BookingReasonCode;
/** @type {string} */
BookingSource;
/** @type {string} */
CommissionInformation;
/** @type {string} */
ConfirmationNumber;
/** @type {string} */
RateCode;
/** @type {string} */
RateQuoted;
/** @type {string} */
RateAccessCode;
/** @type {string} */
PropertyName;
/** @type {string} */
PropertyNumber;
/** @type {string} */
ServiceInformation;
/** @type {string} */
TotalAirSegs;
/** @type {string} */
HotelCommission;
/** @type {string} */
CountryName;
}
/** @typedef TItemResponse {any} */
/** @typedef TItem {any} */
export class Report {
/** @param {{Item?:TItem}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {TItem} */
Item;
}
export class PassiveSegmentsByUserResponseReport 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 PassiveSegmentsResponse extends ItemResponse {
/** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class PassiveSegmentsByUser extends CompanyLevelRequestBase {
/** @param {{ArrivalDateEnd?:string,ArrivalDateStart?:string,SegmentType?:string,Account?:string,CityCode?: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 {string}
* @description Date in format YYYYMMDD */
ArrivalDateEnd;
/**
* @type {string}
* @description Date in format YYYYMMDD */
ArrivalDateStart;
/**
* @type {string}
* @description Type of segment */
SegmentType;
/**
* @type {string}
* @description Account */
Account;
/**
* @type {string}
* @description 3 letter city code */
CityCode;
/**
* @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 PassiveSegmentsByUser 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 /PassiveSegments 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>
<Address>String</Address>
<AgentivityRef>0</AgentivityRef>
<BookingReasonCode>String</BookingReasonCode>
<BookingSource>String</BookingSource>
<CityCode>String</CityCode>
<CommissionInformation>String</CommissionInformation>
<ConfirmationNumber>String</ConfirmationNumber>
<CountryName>String</CountryName>
<HotelCommission>String</HotelCommission>
<NbrNights>String</NbrNights>
<OwningConsultantID>String</OwningConsultantID>
<PropertyName>String</PropertyName>
<PropertyNumber>String</PropertyNumber>
<RateAccessCode>String</RateAccessCode>
<RateCode>String</RateCode>
<RateQuoted>String</RateQuoted>
<SegmentType>String</SegmentType>
<ServiceInformation>String</ServiceInformation>
<StartDate>String</StartDate>
<Text>String</Text>
<TotalAirSegs>String</TotalAirSegs>
<VendorCode>String</VendorCode>
<RecordLocator>String</RecordLocator>
<OwningAgencyLocationID>String</OwningAgencyLocationID>
<OwningConsultant>String</OwningConsultant>
<Account>String</Account>
<Passenger>String</Passenger>
<DepartureDate>String</DepartureDate>
<SegmentStatus>String</SegmentStatus>
</Item>
</ResponseReport>
<ResponseError>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StatusCode>String</StatusCode>
<VerboseMessage>String</VerboseMessage>
</ResponseError>
</AgentivityResponse>