Agentivity API

<back to all web services

GetCancelledHotelSegments

"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 CancelledHotelSegment {
    /** @param {{RecordLocator?:string,PNRCreationDate?:string,OwningAgencyLocationID?:string,Account?:string,OwningConsultantID?:string,OwningConsultant?:string,StatusCode?:string,ArrivalDate?:string,DepartureDate?:string,PropertyName?:string,Chain?:string,City?:string,Passenger?:string,ConfirmationNbr?:string,Currency?:string,Rate?:string,RoomBookingCode?:string,NbrNights?:number,MultiLevelRateCode?:string,NbrRooms?:number,BookedInName?:string,ServiceInformation?:string,CancellationDate?:string,CancellationRemark?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RecordLocator;
    /** @type {?string} */
    PNRCreationDate;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    Account;
    /** @type {string} */
    OwningConsultantID;
    /** @type {string} */
    OwningConsultant;
    /** @type {string} */
    StatusCode;
    /** @type {?string} */
    ArrivalDate;
    /** @type {?string} */
    DepartureDate;
    /** @type {string} */
    PropertyName;
    /** @type {string} */
    Chain;
    /** @type {string} */
    City;
    /** @type {string} */
    Passenger;
    /** @type {string} */
    ConfirmationNbr;
    /** @type {string} */
    Currency;
    /** @type {string} */
    Rate;
    /** @type {string} */
    RoomBookingCode;
    /** @type {?number} */
    NbrNights;
    /** @type {string} */
    MultiLevelRateCode;
    /** @type {?number} */
    NbrRooms;
    /** @type {string} */
    BookedInName;
    /** @type {string} */
    ServiceInformation;
    /** @type {?string} */
    CancellationDate;
    /** @type {string} */
    CancellationRemark;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class GetCancelledHotelSegmentsResponseReport 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 GetCancelledHotelSegmentsItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetCancelledHotelSegments extends CompanyLevelRequestBase {
    /** @param {{CancelledDateStart?:string,CancelledDateEnd?:string,OwningAgencyCountryCode?:string[],HasCancellationRemark?:boolean,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 */
    CancelledDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    CancelledDateEnd;
    /**
     * @type {string[]}
     * @description Comma Delimited List of CountryCodes */
    OwningAgencyCountryCode;
    /**
     * @type {?boolean}
     * @description Return only PNRs with/without an Cancellation Reference */
    HasCancellationRemark;
}

JavaScript GetCancelledHotelSegments DTOs

GET /CancelledHotelSegments 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>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <StatusCode>String</StatusCode>
      <ArrivalDate>0001-01-01T00:00:00</ArrivalDate>
      <DepartureDate>0001-01-01T00:00:00</DepartureDate>
      <PropertyName>String</PropertyName>
      <Chain>String</Chain>
      <City>String</City>
      <Passenger>String</Passenger>
      <ConfirmationNbr>String</ConfirmationNbr>
      <Currency>String</Currency>
      <Rate>String</Rate>
      <RoomBookingCode>String</RoomBookingCode>
      <NbrNights>0</NbrNights>
      <MultiLevelRateCode>String</MultiLevelRateCode>
      <NbrRooms>0</NbrRooms>
      <BookedInName>String</BookedInName>
      <ServiceInformation>String</ServiceInformation>
      <CancellationDate>0001-01-01T00:00:00</CancellationDate>
      <CancellationRemark>String</CancellationRemark>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>