Agentivity API

<back to all web services

GetConsultantWorkUpcomingPaxDepartures

"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 ItinerarySegment {
    /** @param {{SegmentType?:string,SegmentNbr?:number,BoardPoint?:string,OffPoint?:string,OperatorCode?:string,OperatorService?:string,SegmentStatus?:string,DepartureTimeFormatted?:string,ArrivalTimeFormatted?:string,ChangeOfDayFormatted?:string,ServiceCode?:string,StartDate?:string,EndDate?:string,TicketNumber?:string,VendorLocators?:string,EquipmentCode?:string,Equipment?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SegmentType;
    /** @type {number} */
    SegmentNbr;
    /** @type {string} */
    BoardPoint;
    /** @type {string} */
    OffPoint;
    /** @type {string} */
    OperatorCode;
    /** @type {string} */
    OperatorService;
    /** @type {string} */
    SegmentStatus;
    /** @type {string} */
    DepartureTimeFormatted;
    /** @type {string} */
    ArrivalTimeFormatted;
    /** @type {string} */
    ChangeOfDayFormatted;
    /** @type {string} */
    ServiceCode;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
    /** @type {string} */
    TicketNumber;
    /**
     * @type {string}
     * @description Comma separated list of vendor locators */
    VendorLocators;
    /** @type {string} */
    EquipmentCode;
    /** @type {string} */
    Equipment;
}
export class ItinerarySegmentsCollection extends Array {
    constructor(init) { super(init); Object.assign(this, init) }
}
export class PassengerDeparture {
    /** @param {{AgentivityRef?:number,RecordLocator?:string,OwningAgencyLocationID?:string,OwningConsultant?:string,OwningConsultantID?:string,GdsCode?:string,Passenger?:string,Account?:string,TravelDate?:string,TicketedStatusCode?:string,TicketedStatus?:string,SupplierReference?:string,SMS?:string,Vouchers?:string,Transfers?:string,IsVip?:boolean,PhoneNbr?:string,EmailAddress?:string,DestinationCities?:string,DestinationCountries?:string,Connections?:string,Itinerary?:ItinerarySegmentsCollection,ItineraryFormatted?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentivityRef;
    /** @type {string} */
    RecordLocator;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {string} */
    OwningConsultant;
    /** @type {string} */
    OwningConsultantID;
    /** @type {string} */
    GdsCode;
    /** @type {string} */
    Passenger;
    /** @type {string} */
    Account;
    /** @type {?string} */
    TravelDate;
    /** @type {string} */
    TicketedStatusCode;
    /** @type {string} */
    TicketedStatus;
    /** @type {string} */
    SupplierReference;
    /** @type {string} */
    SMS;
    /** @type {string} */
    Vouchers;
    /** @type {string} */
    Transfers;
    /** @type {boolean} */
    IsVip;
    /** @type {string} */
    PhoneNbr;
    /** @type {string} */
    EmailAddress;
    /** @type {string} */
    DestinationCities;
    /** @type {string} */
    DestinationCountries;
    /** @type {string} */
    Connections;
    /** @type {ItinerarySegmentsCollection} */
    Itinerary;
    /** @type {string} */
    ItineraryFormatted;
}
export class ConsultantUpcomingPaxDeparture extends PassengerDeparture {
    /** @param {{AgentivityRef?:number,RecordLocator?:string,OwningAgencyLocationID?:string,OwningConsultant?:string,OwningConsultantID?:string,GdsCode?:string,Passenger?:string,Account?:string,TravelDate?:string,TicketedStatusCode?:string,TicketedStatus?:string,SupplierReference?:string,SMS?:string,Vouchers?:string,Transfers?:string,IsVip?:boolean,PhoneNbr?:string,EmailAddress?:string,DestinationCities?:string,DestinationCountries?:string,Connections?:string,Itinerary?:ItinerarySegmentsCollection,ItineraryFormatted?:string}} [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 ApiRequestPerHour {
    /** @param {{RequestDate?:string,Hour0?:number,Hour1?:number,Hour2?:number,Hour3?:number,Hour4?:number,Hour5?:number,Hour6?:number,Hour7?:number,Hour8?:number,Hour9?:number,Hour10?:number,Hour11?:number,Hour12?:number,Hour13?:number,Hour14?:number,Hour15?:number,Hour16?:number,Hour17?:number,Hour18?:number,Hour19?:number,Hour20?:number,Hour21?:number,Hour22?:number,Hour23?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RequestDate;
    /** @type {number} */
    Hour0;
    /** @type {number} */
    Hour1;
    /** @type {number} */
    Hour2;
    /** @type {number} */
    Hour3;
    /** @type {number} */
    Hour4;
    /** @type {number} */
    Hour5;
    /** @type {number} */
    Hour6;
    /** @type {number} */
    Hour7;
    /** @type {number} */
    Hour8;
    /** @type {number} */
    Hour9;
    /** @type {number} */
    Hour10;
    /** @type {number} */
    Hour11;
    /** @type {number} */
    Hour12;
    /** @type {number} */
    Hour13;
    /** @type {number} */
    Hour14;
    /** @type {number} */
    Hour15;
    /** @type {number} */
    Hour16;
    /** @type {number} */
    Hour17;
    /** @type {number} */
    Hour18;
    /** @type {number} */
    Hour19;
    /** @type {number} */
    Hour20;
    /** @type {number} */
    Hour21;
    /** @type {number} */
    Hour22;
    /** @type {number} */
    Hour23;
}
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} */
export class CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseMetadata} */
    ResponseMetadata;
    /** @type {ApiRequestPerHour[]} */
    ResponseReport;
    /** @type {AgentivityError} */
    ResponseError;
}
export class GetConsultantWorkUpcomingPaxDeparturesResponse extends CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {number} */
export var FormattingStyle;
(function (FormattingStyle) {
    FormattingStyle[FormattingStyle["None"] = 0] = "None"
    FormattingStyle[FormattingStyle["Html"] = 1] = "Html"
    FormattingStyle[FormattingStyle["Charting"] = 2] = "Charting"
})(FormattingStyle || (FormattingStyle = {}));
export class GetConsultantWorkUpcomingPaxDepartures extends CompanyLevelRequestBase {
    /** @param {{TravelDateStart?:string,TravelDateEnd?:string,Account?:string[],IncludeItinerary?:boolean,ItineraryFormatting?:FormattingStyle,OwningConsultantID?:string[],RequestConsultantID?: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 */
    TravelDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    TravelDateEnd;
    /**
     * @type {string[]}
     * @description Comma Delimited List of Accounts */
    Account;
    /**
     * @type {boolean}
     * @description Include Itinerary in the response */
    IncludeItinerary;
    /**
     * @type {FormattingStyle}
     * @description Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart */
    ItineraryFormatting;
    /**
     * @type {string[]}
     * @description Comma delimited list of owning consultants ids */
    OwningConsultantID = [];
    /**
     * @type {string}
     * @description Request Consultant ID (sign on) */
    RequestConsultantID;
}

JavaScript GetConsultantWorkUpcomingPaxDepartures DTOs

POST /ConsultantWorkUpcomingPaxDepartures HTTP/1.1 
Host: servicestack.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetConsultantWorkUpcomingPaxDepartures xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <Account xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Account>
  <IncludeItinerary>false</IncludeItinerary>
  <ItineraryFormatting>None</ItineraryFormatting>
  <OwningConsultantID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningConsultantID>
  <RequestConsultantID>String</RequestConsultantID>
  <TravelDateEnd>String</TravelDateEnd>
  <TravelDateStart>String</TravelDateStart>
</GetConsultantWorkUpcomingPaxDepartures>

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>
    <ConsultantUpcomingPaxDeparture>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <OwningConsultantID>String</OwningConsultantID>
      <GdsCode>String</GdsCode>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <TicketedStatusCode>String</TicketedStatusCode>
      <TicketedStatus>String</TicketedStatus>
      <SupplierReference>String</SupplierReference>
      <SMS>String</SMS>
      <Vouchers>String</Vouchers>
      <Transfers>String</Transfers>
      <IsVip>false</IsVip>
      <PhoneNbr>String</PhoneNbr>
      <EmailAddress>String</EmailAddress>
      <DestinationCities>String</DestinationCities>
      <DestinationCountries>String</DestinationCountries>
      <Connections>String</Connections>
      <Itinerary>
        <ItinerarySegment>
          <ArrivalTimeFormatted>String</ArrivalTimeFormatted>
          <BoardPoint>String</BoardPoint>
          <ChangeOfDayFormatted>String</ChangeOfDayFormatted>
          <DepartureTimeFormatted>String</DepartureTimeFormatted>
          <EndDate>String</EndDate>
          <Equipment>String</Equipment>
          <EquipmentCode>String</EquipmentCode>
          <OffPoint>String</OffPoint>
          <OperatorCode>String</OperatorCode>
          <OperatorService>String</OperatorService>
          <SegmentNbr>0</SegmentNbr>
          <SegmentStatus>String</SegmentStatus>
          <SegmentType>String</SegmentType>
          <ServiceCode>String</ServiceCode>
          <StartDate>String</StartDate>
          <TicketNumber>String</TicketNumber>
          <VendorLocators>String</VendorLocators>
        </ItinerarySegment>
      </Itinerary>
      <ItineraryFormatted>String</ItineraryFormatted>
    </ConsultantUpcomingPaxDeparture>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>