Agentivity API

GetCompanyTicketRevenuePerAirline

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

**GetCompanyTicketRevenuePerAirline** Parameters:
Name	Parameter	Data Type	Required	Description
TravelAgentID	query	integer	No	ID of a travel agent
PlatingCarrier	query	integer	Yes	Code for Plating Carrier
DepartureDateStart	query	string	Yes	Date in format YYYYMMDD
DepartureDateEnd	query	string	Yes	Date in format YYYYMMDD
FlightCouponStatus	query	string	Yes	One letter code for flight coupon status
UserName	query	string	Yes	UserName in form of an email address
AirlineCode	query	string	No	Two letter airline code

**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)

**ItemResponse<TItem, TReport>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	TReport	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

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

**AirlineTicketRevenue** Parameters:
Name	Parameter	Data Type	Required
PlatingCarrier	form	string	No
AirlineShortName	form	string	No
TotalFares	form	decimal?	No
TotalTax	form	decimal?	No
TotalBaseRevenue	form	decimal?	No
FormattedCarrierPlatingName	form	string	No
PrintedCurrency	form	string	No
FormattedTotalFares	form	string	No
FormattedTotalTax	form	string	No
FormattedTotalBaseRevenue	form	string	No

**Report<TItemResponse, TItem>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TItem	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 //AirlineTicketRevenues 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>
    <Item>
      <PlatingCarrier>String</PlatingCarrier>
      <AirlineShortName>String</AirlineShortName>
      <TotalFares>0</TotalFares>
      <TotalTax>0</TotalTax>
      <TotalBaseRevenue>0</TotalBaseRevenue>
      <FormattedCarrierPlatingName>String</FormattedCarrierPlatingName>
      <PrintedCurrency>String</PrintedCurrency>
      <FormattedTotalFares>String</FormattedTotalFares>
      <FormattedTotalTax>String</FormattedTotalTax>
      <FormattedTotalBaseRevenue>String</FormattedTotalBaseRevenue>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>