Agentivity API

<back to all web services

AgencyReviews

The following routes are available for this service:
GET/AgencyReviews

// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description Total Number of Records in a Full Reponse (if no paging) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public TotalRecords: number;

    /** @description Total Number of Records in this Reponse (on this page) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class CompanyLevelRequestBase extends PagingMetadata implements IMemberUsername, IMemberOwningCompanyCode
{
    /** @description Comma Delimited List of Owning Company Codes */
    // @DataMember
    public OwningCompanyCode: string[];

    /** @description UserName in form of an email address */
    // @DataMember
    public UserName: string;

    public constructor(init?: Partial<CompanyLevelRequestBase>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="AgencyReviewSummary", Namespace="schemas.agentivity.com/types")
export class AgencyReviewSummary implements ICarbonTonnage, ICarbonEmissionDto
{
    // @DataMember(Order=10)
    public TicketedBookings: number;

    // @DataMember(Order=20)
    public LCCTktBookings: number;

    // @DataMember(Order=25)
    public AssumedTicketedBookings: number;

    // @DataMember(Order=30)
    public NonTicketedBookings: number;

    // @DataMember(Order=40)
    public TicketedBookingsPerc: number;

    // @DataMember(Order=50)
    public NonTicketedBookingsPerc: number;

    // @DataMember(Order=60)
    public OnlineBookings: number;

    // @DataMember(Order=70)
    public OfflineBookings: number;

    // @DataMember(Order=80)
    public CxlBookings: number;

    // @DataMember(Order=90)
    public OffLineHtlBookings: number;

    // @DataMember(Order=100)
    public BookingsWithHotelSegments: number;

    // @DataMember(Order=110)
    public BookingsWithCarSegments: number;

    // @DataMember(Order=120)
    public NonAirBookings: number;

    // @DataMember(Order=130)
    public TotalBookings: number;

    // @DataMember(Order=140)
    public AeroTouches?: number;

    // @DataMember(Order=145)
    public AeroTouchesAuto: number;

    // @DataMember(Order=150)
    public AverageItineraryChanges: number;

    // @DataMember(Order=160)
    public AverageAccountBookingToTravelTime: number;

    // @DataMember(Order=170)
    public TotalItineraryChangesBeforeTicketing?: number;

    // @DataMember(Order=180)
    public TotalItineraryChangesAfterTicketing?: number;

    // @DataMember(Order=190)
    public TotalItineraryChanges: number;

    // @DataMember(Order=230)
    public BookingsWithNdcContent: number;

    // @DataMember(Order=210)
    public CarbonEmissionValue?: number;

    // @DataMember(Order=220)
    public CarbonEmissionUnitId?: number;

    // @DataMember(Order=200)
    public CarbonTonnage?: number;

    public constructor(init?: Partial<AgencyReviewSummary>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AirlineStats", Namespace="schemas.agentivity.com/types")
export class AirlineStats
{
    // @DataMember(Order=10)
    public CarrierCode: string;

    // @DataMember(Order=20)
    public Carrier: string;

    // @DataMember(Order=30)
    public TotalSegments: number;

    public constructor(init?: Partial<AirlineStats>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AirlineSupport", Namespace="schemas.agentivity.com/types")
export class AirlineSupport
{
    // @DataMember(Order=10)
    public AirlinesStats: AirlineStats[];

    // @DataMember(Order=20)
    public TotalSegments: number;

    // @DataMember(Order=30)
    public FormattedAirlineSupport: string;

    public constructor(init?: Partial<AirlineSupport>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CarStats", Namespace="schemas.agentivity.com/types")
export class CarStats
{
    // @DataMember(Order=10)
    public VendorCode: string;

    // @DataMember(Order=20)
    public VendorName: string;

    // @DataMember(Order=30)
    public TotalSegments: number;

    public constructor(init?: Partial<CarStats>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CarSupport", Namespace="schemas.agentivity.com/types")
export class CarSupport
{
    // @DataMember(Order=10)
    public Stats: CarStats[];

    // @DataMember(Order=20)
    public TotalSegments: number;

    // @DataMember(Order=30)
    public FormattedCarSupport: string;

    public constructor(init?: Partial<CarSupport>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="HotelStats", Namespace="schemas.agentivity.com/types")
export class HotelStats
{
    // @DataMember(Order=10)
    public VendorCode: string;

    // @DataMember(Order=20)
    public VendorName: string;

    // @DataMember(Order=30)
    public TotalSegments: number;

    // @DataMember(Order=40)
    public TotalNights: number;

    public constructor(init?: Partial<HotelStats>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="HotelSupport", Namespace="schemas.agentivity.com/types")
export class HotelSupport
{
    // @DataMember(Order=10)
    public Stats: HotelStats[];

    // @DataMember(Order=20)
    public TotalSegments: number;

    // @DataMember(Order=30)
    public FormattedHotelSupport: string;

    public constructor(init?: Partial<HotelSupport>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgencyReview", Namespace="schemas.agentivity.com/types")
export class AgencyReview
{
    // @DataMember(Order=10)
    public Summary: AgencyReviewSummary;

    // @DataMember(Order=20)
    public AirlineSupport: AirlineSupport;

    // @DataMember(Order=30)
    public CarSupport: CarSupport;

    // @DataMember(Order=40)
    public HotelSupport: HotelSupport;

    public constructor(init?: Partial<AgencyReview>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
export class ApiRequestPerHour
{
    // @DataMember(Order=10)
    public RequestDate: string;

    // @DataMember(Order=100)
    public Hour0: number;

    // @DataMember(Order=110)
    public Hour1: number;

    // @DataMember(Order=120)
    public Hour2: number;

    // @DataMember(Order=130)
    public Hour3: number;

    // @DataMember(Order=140)
    public Hour4: number;

    // @DataMember(Order=150)
    public Hour5: number;

    // @DataMember(Order=160)
    public Hour6: number;

    // @DataMember(Order=170)
    public Hour7: number;

    // @DataMember(Order=180)
    public Hour8: number;

    // @DataMember(Order=190)
    public Hour9: number;

    // @DataMember(Order=200)
    public Hour10: number;

    // @DataMember(Order=210)
    public Hour11: number;

    // @DataMember(Order=220)
    public Hour12: number;

    // @DataMember(Order=230)
    public Hour13: number;

    // @DataMember(Order=240)
    public Hour14: number;

    // @DataMember(Order=250)
    public Hour15: number;

    // @DataMember(Order=260)
    public Hour16: number;

    // @DataMember(Order=270)
    public Hour17: number;

    // @DataMember(Order=280)
    public Hour18: number;

    // @DataMember(Order=290)
    public Hour19: number;

    // @DataMember(Order=300)
    public Hour20: number;

    // @DataMember(Order=310)
    public Hour21: number;

    // @DataMember(Order=320)
    public Hour22: number;

    // @DataMember(Order=330)
    public Hour23: number;

    public constructor(init?: Partial<ApiRequestPerHour>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class CollectionResponse<TItem>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: ApiRequestPerHour[];

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<CollectionResponse<TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class AgencyReviewsResponse extends CollectionResponse<AgencyReview>
{

    public constructor(init?: Partial<AgencyReviewsResponse>) { super(init); (Object as any).assign(this, init); }
}

// @Flags()
export enum AgencyReviewOptions
{
    None = 0,
    Summary = 1,
    AirlineSupport = 2,
    SummaryAirlineSupport = 3,
    CarSupport = 4,
    HotelSupport = 8,
    All = 15,
}

// @Flags()
export enum FormattingStyle
{
    None = 0,
    Html = 1,
    Charting = 2,
}

// @Flags()
export enum AgencyReviewMode
{
    Account = 0,
    Pcc = 1,
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class AgencyReviews extends CompanyLevelRequestBase implements IRequestConsultantID
{
    /** @description Account */
    // @DataMember
    public Account: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public PNRCreationDateStart: string;

    /** @description Date in format YYYYMMDD */
    // @DataMember
    public PNRCreationDateEnd: string;

    /** @description Comma Delimited List of PCCs */
    // @DataMember
    public OwningAgencyLocationID: string[];

    /** @description Load options */
    // @DataMember
    public LoadOptions: AgencyReviewOptions;

    /** @description Airline support format style */
    // @DataMember
    public AirlineSupportFormatStyle: FormattingStyle;

    /** @description Car support format style */
    // @DataMember
    public CarSupportFormatStyle: FormattingStyle;

    /** @description Hotel support format style */
    // @DataMember
    public HotelSupportFormatStyle: FormattingStyle;

    /** @description Excluded carrier code */
    // @DataMember
    public ExcludedCarrierCode: string;

    /** @description Mode */
    // @DataMember
    public Mode: AgencyReviewMode;

    /** @description Top car items */
    // @DataMember
    public TopCarItems?: number;

    /** @description Top hotel items */
    // @DataMember
    public TopHotelItems?: number;

    /** @description Includes AfterHours Servicing in results */
    // @DataMember
    public IncludeAfterHoursServicingFields: boolean;

    /** @description Request Consultant ID (sign on) */
    // @DataMember
    public RequestConsultantID: string;

    public constructor(init?: Partial<AgencyReviews>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AgencyReviews DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /AgencyReviews HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":[{"Summary":{"TicketedBookings":0,"LCCTktBookings":0,"AssumedTicketedBookings":0,"NonTicketedBookings":0,"TicketedBookingsPerc":0,"NonTicketedBookingsPerc":0,"OnlineBookings":0,"OfflineBookings":0,"CxlBookings":0,"OffLineHtlBookings":0,"BookingsWithHotelSegments":0,"BookingsWithCarSegments":0,"NonAirBookings":0,"TotalBookings":0,"AeroTouches":0,"AeroTouchesAuto":0,"AverageItineraryChanges":0,"AverageAccountBookingToTravelTime":0,"TotalItineraryChangesBeforeTicketing":0,"TotalItineraryChangesAfterTicketing":0,"TotalItineraryChanges":0,"CarbonTonnage":0,"CarbonEmissionValue":0,"CarbonEmissionUnitId":0,"BookingsWithNdcContent":0},"AirlineSupport":{"AirlinesStats":[{"CarrierCode":"String","Carrier":"String","TotalSegments":0}],"TotalSegments":0,"FormattedAirlineSupport":"String"},"CarSupport":{"Stats":[{"VendorCode":"String","VendorName":"String","TotalSegments":0}],"TotalSegments":0,"FormattedCarSupport":"String"},"HotelSupport":{"Stats":[{"VendorCode":"String","VendorName":"String","TotalSegments":0,"TotalNights":0}],"TotalSegments":0,"FormattedHotelSupport":"String"}}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}