Agentivity API

<back to all web services

GetAgencyReviewPerAccount

"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 AccountSummaryReview {
    /** @param {{Account?:string,TicketedBookings?:number,LCCTktBookings?:number,AssumedTicketedBookings?:number,NonTicketedBookings?:number,CxlBookings?:number,NonAirBookings?:number,TotalBookings?:number,OnlineBookings?:number,AverageItineraryChanges?:number,TotalItineraryChanges?:number,TotalItineraryChangesBeforeTicketing?:number,TotalItineraryChangesAfterTicketing?:number,CarbonTonnage?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Account;
    /** @type {number} */
    TicketedBookings;
    /** @type {number} */
    LCCTktBookings;
    /** @type {number} */
    AssumedTicketedBookings;
    /** @type {number} */
    NonTicketedBookings;
    /** @type {number} */
    CxlBookings;
    /** @type {number} */
    NonAirBookings;
    /** @type {number} */
    TotalBookings;
    /** @type {number} */
    OnlineBookings;
    /** @type {number} */
    AverageItineraryChanges;
    /** @type {number} */
    TotalItineraryChanges;
    /** @type {number} */
    TotalItineraryChangesBeforeTicketing;
    /** @type {number} */
    TotalItineraryChangesAfterTicketing;
    /** @type {?number} */
    CarbonTonnage;
}
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 GetAgencyReviewPerAccountResponse extends CollectionResponse {
    /** @param {{ResponseMetadata?:ResponseMetadata,ResponseReport?:ApiRequestPerHour[],ResponseError?:AgentivityError}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
export class GetAgencyReviewPerAccount extends CompanyLevelRequestBase {
    /** @param {{PNRCreationDateStart?:string,PNRCreationDateEnd?:string,OwningAgencyLocationID?:string[],IncludeAfterHoursServicingFields?: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 */
    PNRCreationDateStart;
    /**
     * @type {string}
     * @description Date in format YYYYMMDD */
    PNRCreationDateEnd;
    /**
     * @type {string[]}
     * @description Comma Delimited List of PCCs */
    OwningAgencyLocationID;
    /**
     * @type {boolean}
     * @description Includes AfterHours Servicing in results */
    IncludeAfterHoursServicingFields;
}

JavaScript GetAgencyReviewPerAccount DTOs

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

<GetAgencyReviewPerAccount 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>
  <IncludeAfterHoursServicingFields>false</IncludeAfterHoursServicingFields>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
  <PNRCreationDateEnd>String</PNRCreationDateEnd>
  <PNRCreationDateStart>String</PNRCreationDateStart>
</GetAgencyReviewPerAccount>

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>
    <AccountSummary>
      <Account>String</Account>
      <TicketedBookings>0</TicketedBookings>
      <LCCTktBookings>0</LCCTktBookings>
      <AssumedTicketedBookings>0</AssumedTicketedBookings>
      <NonTicketedBookings>0</NonTicketedBookings>
      <CxlBookings>0</CxlBookings>
      <NonAirBookings>0</NonAirBookings>
      <TotalBookings>0</TotalBookings>
      <OnlineBookings>0</OnlineBookings>
      <AverageItineraryChanges>0</AverageItineraryChanges>
      <TotalItineraryChanges>0</TotalItineraryChanges>
      <TotalItineraryChangesBeforeTicketing>0</TotalItineraryChangesBeforeTicketing>
      <TotalItineraryChangesAfterTicketing>0</TotalItineraryChangesAfterTicketing>
      <CarbonTonnage>0</CarbonTonnage>
    </AccountSummary>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>