Agentivity API

<back to all web services

TicketRevenueByCompany

The following routes are available for this service:
GET/TicketRevenue/Company
TicketRevenueByCompany Parameters:
NameParameterData TypeRequiredDescription
CompanyIDqueryint?No
TravelAgentIDquerystringNo
PlatingCarrierquerystringNo
DepartureDateStartquerystringNo
DepartureDateEndquerystringNo
FlightCouponStatusquerystringNo
AirlineCodequerystringNo
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
TicketRevenue Parameters:
NameParameterData TypeRequiredDescription
TktNumberformstringNo
PlatingCarrierformstringNo
RecordLocatorformstringNo
ConsultantformstringNo
AccountformstringNo
FOPformstringNo
PrintedCurrencyformstringNo
FirstNameformstringNo
LastNameformstringNo
PCCformstringNo
TicketIssueDateformstringNo
IATAformstringNo
Revenueformdecimal?No
TicketTaxformdecimal?No
TicketBaseFareformdecimal?No
Tax1CodeformstringNo
Tax1AmtformstringNo
Tax2CodeformstringNo
Tax2AmtformstringNo
Tax3CodeformstringNo
Tax3AmtformstringNo
Tax4CodeformstringNo
Tax4AmtformstringNo
Tax5CodeformstringNo
Tax5AmtformstringNo
PassengerformstringNo

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 //TicketRevenue/Company 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>
    <AirlineTicketRevenue>
      <Account>String</Account>
      <Consultant>String</Consultant>
      <FOP>String</FOP>
      <FirstName>String</FirstName>
      <IATA>String</IATA>
      <LastName>String</LastName>
      <PCC>String</PCC>
      <Passenger>String</Passenger>
      <PlatingCarrier>String</PlatingCarrier>
      <PrintedCurrency>String</PrintedCurrency>
      <RecordLocator>String</RecordLocator>
      <Revenue>0</Revenue>
      <Tax1Amt>String</Tax1Amt>
      <Tax1Code>String</Tax1Code>
      <Tax2Amt>String</Tax2Amt>
      <Tax2Code>String</Tax2Code>
      <Tax3Amt>String</Tax3Amt>
      <Tax3Code>String</Tax3Code>
      <Tax4Amt>String</Tax4Amt>
      <Tax4Code>String</Tax4Code>
      <Tax5Amt>String</Tax5Amt>
      <Tax5Code>String</Tax5Code>
      <TicketBaseFare>0</TicketBaseFare>
      <TicketIssueDate>String</TicketIssueDate>
      <TicketTax>0</TicketTax>
      <TktNumber>String</TktNumber>
    </AirlineTicketRevenue>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>