Agentivity API

AgencyReviews

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

**AgencyReviews** Parameters:
Name	Parameter	Data Type	Required	Description
Account	query	string	No	Account
PNRCreationDateStart	query	string	Yes	Date in format YYYYMMDD
PNRCreationDateEnd	query	string	Yes	Date in format YYYYMMDD
OwningAgencyLocationID	query	string	No	Comma Delimited List of PCCs
LoadOptions	query	string	No	Load options
AirlineSupportFormatStyle	query	string	No	Airline support format style
CarSupportFormatStyle	query	string	No	Car support format style
HotelSupportFormatStyle	query	string	No	Hotel support format style
ExcludedCarrierCode	query	string	No	Excluded carrier code
Mode	query	integer	No	Mode
TopCarItems	query	integer	No	Top car items
TopHotelItems	query	integer	No	Top hotel items
IncludeAfterHoursServicingFields	query	string	No	Includes AfterHours Servicing in results
RequestConsultantID	query	string	No	Request Consultant ID (sign on)

**CompanyLevelRequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
OwningCompanyCode	query	string	No	Comma Delimited List of Owning Company Codes
UserName	query	string	No	UserName in form of an email address

**PagingMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	query	string	No	Starting Record
Limit	query	string	No	Number of records to return (PageSize)
TotalRecords	query	string	No	Total Number of Records in a Full Reponse (if no paging)
ResponseRecords	query	string	No	Total Number of Records in this Reponse (on this page)

**AgencyReviewOptions** Enum:
Name	Value
None	0
Summary	1
AirlineSupport	2
SummaryAirlineSupport	3
CarSupport	4
HotelSupport	8
All	15

**FormattingStyle** Enum:
Name	Value
None	0
Html	1
Charting	2

**AgencyReviewMode** Enum:
Name	Value
Account	0
Pcc	1

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<ApiRequestPerHour>	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**ApiRequestPerHour** Parameters:
Name	Parameter	Data Type	Required
RequestDate	form	DateTime	No
Hour0	form	int	No
Hour1	form	int	No
Hour2	form	int	No
Hour3	form	int	No
Hour4	form	int	No
Hour5	form	int	No
Hour6	form	int	No
Hour7	form	int	No
Hour8	form	int	No
Hour9	form	int	No
Hour10	form	int	No
Hour11	form	int	No
Hour12	form	int	No
Hour13	form	int	No
Hour14	form	int	No
Hour15	form	int	No
Hour16	form	int	No
Hour17	form	int	No
Hour18	form	int	No
Hour19	form	int	No
Hour20	form	int	No
Hour21	form	int	No
Hour22	form	int	No
Hour23	form	int	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**AgencyReview** Parameters:
Name	Parameter	Data Type	Required
Summary	form	AgencyReviewSummary	No
AirlineSupport	form	AirlineSupport	No
CarSupport	form	CarSupport	No
HotelSupport	form	HotelSupport	No

**AgencyReviewSummary** Parameters:
Name	Parameter	Data Type	Required
TicketedBookings	form	int	No
LCCTktBookings	form	int	No
AssumedTicketedBookings	form	int	No
NonTicketedBookings	form	int	No
TicketedBookingsPerc	form	int	No
NonTicketedBookingsPerc	form	int	No
OnlineBookings	form	int	No
OfflineBookings	form	int	No
CxlBookings	form	int	No
OffLineHtlBookings	form	int	No
BookingsWithHotelSegments	form	int	No
BookingsWithCarSegments	form	int	No
NonAirBookings	form	int	No
TotalBookings	form	int	No
AeroTouches	form	int?	No
AeroTouchesAuto	form	int	No
AverageItineraryChanges	form	decimal	No
AverageAccountBookingToTravelTime	form	decimal	No
TotalItineraryChangesBeforeTicketing	form	int?	No
TotalItineraryChangesAfterTicketing	form	int?	No
TotalItineraryChanges	form	decimal	No
BookingsWithNdcContent	form	int	No
CarbonEmissionValue	form	double?	No
CarbonEmissionUnitId	form	short?	No
CarbonTonnage	form	double?	No

**AirlineSupport** Parameters:
Name	Parameter	Data Type	Required
AirlinesStats	form	List<AirlineStats>	No
TotalSegments	form	int	No
FormattedAirlineSupport	form	string	No

**AirlineStats** Parameters:
Name	Parameter	Data Type	Required
CarrierCode	form	string	No
Carrier	form	string	No
TotalSegments	form	int	No

**CarSupport** Parameters:
Name	Parameter	Data Type	Required
Stats	form	List<CarStats>	No
TotalSegments	form	int	No
FormattedCarSupport	form	string	No

**CarStats** Parameters:
Name	Parameter	Data Type	Required
VendorCode	form	string	No
VendorName	form	string	No
TotalSegments	form	int	No

**HotelSupport** Parameters:
Name	Parameter	Data Type	Required
Stats	form	List<HotelStats>	No
TotalSegments	form	int	No
FormattedHotelSupport	form	string	No

**HotelStats** Parameters:
Name	Parameter	Data Type	Required
VendorCode	form	string	No
VendorName	form	string	No
TotalSegments	form	int	No
TotalNights	form	int	No

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

HTTP + XML

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

GET /AgencyReviews 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>
    <AgencyReview>
      <Summary>
        <TicketedBookings>0</TicketedBookings>
        <LCCTktBookings>0</LCCTktBookings>
        <AssumedTicketedBookings>0</AssumedTicketedBookings>
        <NonTicketedBookings>0</NonTicketedBookings>
        <TicketedBookingsPerc>0</TicketedBookingsPerc>
        <NonTicketedBookingsPerc>0</NonTicketedBookingsPerc>
        <OnlineBookings>0</OnlineBookings>
        <OfflineBookings>0</OfflineBookings>
        <CxlBookings>0</CxlBookings>
        <OffLineHtlBookings>0</OffLineHtlBookings>
        <BookingsWithHotelSegments>0</BookingsWithHotelSegments>
        <BookingsWithCarSegments>0</BookingsWithCarSegments>
        <NonAirBookings>0</NonAirBookings>
        <TotalBookings>0</TotalBookings>
        <AeroTouches>0</AeroTouches>
        <AeroTouchesAuto>0</AeroTouchesAuto>
        <AverageItineraryChanges>0</AverageItineraryChanges>
        <AverageAccountBookingToTravelTime>0</AverageAccountBookingToTravelTime>
        <TotalItineraryChangesBeforeTicketing>0</TotalItineraryChangesBeforeTicketing>
        <TotalItineraryChangesAfterTicketing>0</TotalItineraryChangesAfterTicketing>
        <TotalItineraryChanges>0</TotalItineraryChanges>
        <CarbonTonnage>0</CarbonTonnage>
        <CarbonEmissionValue>0</CarbonEmissionValue>
        <CarbonEmissionUnitId>0</CarbonEmissionUnitId>
        <BookingsWithNdcContent>0</BookingsWithNdcContent>
      </Summary>
      <AirlineSupport>
        <AirlinesStats>
          <AirlineStats>
            <CarrierCode>String</CarrierCode>
            <Carrier>String</Carrier>
            <TotalSegments>0</TotalSegments>
          </AirlineStats>
        </AirlinesStats>
        <TotalSegments>0</TotalSegments>
        <FormattedAirlineSupport>String</FormattedAirlineSupport>
      </AirlineSupport>
      <CarSupport>
        <Stats>
          <CarStats>
            <VendorCode>String</VendorCode>
            <VendorName>String</VendorName>
            <TotalSegments>0</TotalSegments>
          </CarStats>
        </Stats>
        <TotalSegments>0</TotalSegments>
        <FormattedCarSupport>String</FormattedCarSupport>
      </CarSupport>
      <HotelSupport>
        <Stats>
          <HotelStats>
            <VendorCode>String</VendorCode>
            <VendorName>String</VendorName>
            <TotalSegments>0</TotalSegments>
            <TotalNights>0</TotalNights>
          </HotelStats>
        </Stats>
        <TotalSegments>0</TotalSegments>
        <FormattedHotelSupport>String</FormattedHotelSupport>
      </HotelSupport>
    </AgencyReview>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>