Agentivity API

<back to all web services

ConsultantsGdsSegmentPerformance

"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 ConsultantGdsSegmentPerformance {
    /** @param {{OwningConsultantID?:string,OwningConsultant?:string,OwningAgencyLocationID?:string,AirCount?:number,AirCountOnline?:number,HotelCount?:number,HotelCountOnline?:number,CarCount?:number,CarCountOnline?:number,PassiveHotelCount?:number,PassiveHotelCountOnline?:number,PassiveCarCount?:number,PassiveCarCountOnline?:number,TURCount?:number,TURCountOnline?:number,OtherCount?:number,OtherCountOnline?:number,TotalBookings?:number,OwningAgencyLocationCountryCode?:string,OwningAgencyLocationCountryName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    OwningConsultantID;
    /** @type {string} */
    OwningConsultant;
    /** @type {string} */
    OwningAgencyLocationID;
    /** @type {number} */
    AirCount;
    /** @type {number} */
    AirCountOnline;
    /** @type {number} */
    HotelCount;
    /** @type {number} */
    HotelCountOnline;
    /** @type {number} */
    CarCount;
    /** @type {number} */
    CarCountOnline;
    /** @type {number} */
    PassiveHotelCount;
    /** @type {number} */
    PassiveHotelCountOnline;
    /** @type {number} */
    PassiveCarCount;
    /** @type {number} */
    PassiveCarCountOnline;
    /** @type {number} */
    TURCount;
    /** @type {number} */
    TURCountOnline;
    /** @type {number} */
    OtherCount;
    /** @type {number} */
    OtherCountOnline;
    /** @type {number} */
    TotalBookings;
    /** @type {string} */
    OwningAgencyLocationCountryCode;
    /** @type {string} */
    OwningAgencyLocationCountryName;
}
/** @typedef TItemResponse {any} */
/** @typedef  TItem {any} */
export class Report {
    /** @param {{Item?:TItem}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TItem} */
    Item;
}
export class ConsultantsGdsSegmentPerformanceResponseReport 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 ConsultantsGdsSegmentPerformanceItemResponse extends ItemResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:TReport,ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class ConsultantsGdsSegmentPerformance extends CompanyLevelRequestBase {
    /** @param {{PNRCreationDateStart?:string,PNRCreationDateEnd?:string,OwningAgencyLocationID?: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 */
    PNRCreationDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    PNRCreationDateEnd;
    /**
     * @type {string[]}
     * @description Comma Delimited List of PCCs */
    OwningAgencyLocationID = [];
}

JavaScript ConsultantsGdsSegmentPerformance DTOs

GET /ConsultantsGdsSegmentPerformance HTTP/1.1 
Host: servicestack.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>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <AirCount>0</AirCount>
      <AirCountOnline>0</AirCountOnline>
      <HotelCount>0</HotelCount>
      <HotelCountOnline>0</HotelCountOnline>
      <CarCount>0</CarCount>
      <CarCountOnline>0</CarCountOnline>
      <PassiveHotelCount>0</PassiveHotelCount>
      <PassiveHotelCountOnline>0</PassiveHotelCountOnline>
      <PassiveCarCount>0</PassiveCarCount>
      <PassiveCarCountOnline>0</PassiveCarCountOnline>
      <TURCount>0</TURCount>
      <TURCountOnline>0</TURCountOnline>
      <OtherCount>0</OtherCount>
      <OtherCountOnline>0</OtherCountOnline>
      <TotalBookings>0</TotalBookings>
      <OwningAgencyLocationCountryCode>String</OwningAgencyLocationCountryCode>
      <OwningAgencyLocationCountryName>String</OwningAgencyLocationCountryName>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>