Agentivity API

<back to all web services

AgencyReviews

The following routes are available for this service:
GET/AgencyReviews
AgencyReviews Parameters:
NameParameterData TypeRequiredDescription
AccountquerystringNoAccount
PNRCreationDateStartquerystringYesDate in format YYYYMMDD
PNRCreationDateEndquerystringYesDate in format YYYYMMDD
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
LoadOptionsquerystringNoLoad options
AirlineSupportFormatStylequerystringNoAirline support format style
CarSupportFormatStylequerystringNoCar support format style
HotelSupportFormatStylequerystringNoHotel support format style
ExcludedCarrierCodequerystringNoExcluded carrier code
ModequeryintegerNoMode
TopCarItemsqueryintegerNoTop car items
TopHotelItemsqueryintegerNoTop hotel items
IncludeAfterHoursServicingFieldsquerystringNoIncludes AfterHours Servicing in results
RequestConsultantIDquerystringNoRequest Consultant ID (sign on)
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<TItem>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
AgencyReview Parameters:
NameParameterData TypeRequiredDescription
SummaryformAgencyReviewSummaryNo
AirlineSupportformAirlineSupportNo
CarSupportformCarSupportNo
HotelSupportformHotelSupportNo
AgencyReviewSummary Parameters:
NameParameterData TypeRequiredDescription
TicketedBookingsformintNo
LCCTktBookingsformintNo
AssumedTicketedBookingsformintNo
NonTicketedBookingsformintNo
TicketedBookingsPercformintNo
NonTicketedBookingsPercformintNo
OnlineBookingsformintNo
OfflineBookingsformintNo
CxlBookingsformintNo
OffLineHtlBookingsformintNo
BookingsWithHotelSegmentsformintNo
BookingsWithCarSegmentsformintNo
NonAirBookingsformintNo
TotalBookingsformintNo
AeroTouchesformint?No
AeroTouchesAutoformintNo
AverageItineraryChangesformdecimalNo
AverageAccountBookingToTravelTimeformdecimalNo
TotalItineraryChangesBeforeTicketingformint?No
TotalItineraryChangesAfterTicketingformint?No
TotalItineraryChangesformdecimalNo
BookingsWithNdcContentformintNo
CarbonEmissionValueformdouble?No
CarbonEmissionUnitIdformshort?No
CarbonTonnageformdouble?No
AirlineSupport Parameters:
NameParameterData TypeRequiredDescription
AirlinesStatsformList<AirlineStats>No
TotalSegmentsformintNo
FormattedAirlineSupportformstringNo
AirlineStats Parameters:
NameParameterData TypeRequiredDescription
CarrierCodeformstringNo
CarrierformstringNo
TotalSegmentsformintNo
CarSupport Parameters:
NameParameterData TypeRequiredDescription
StatsformList<CarStats>No
TotalSegmentsformintNo
FormattedCarSupportformstringNo
CarStats Parameters:
NameParameterData TypeRequiredDescription
VendorCodeformstringNo
VendorNameformstringNo
TotalSegmentsformintNo
HotelSupport Parameters:
NameParameterData TypeRequiredDescription
StatsformList<HotelStats>No
TotalSegmentsformintNo
FormattedHotelSupportformstringNo
HotelStats Parameters:
NameParameterData TypeRequiredDescription
VendorCodeformstringNo
VendorNameformstringNo
TotalSegmentsformintNo
TotalNightsformintNo

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: api.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>