Agentivity API

<back to all web services

TicketRevenueByCompany

The following routes are available for this service:
GET/TicketRevenue/Company
namespace AgentivityAPI.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract(Name="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type TicketRevenue() = 
        [<DataMember>]
        member val TktNumber:String = null with get,set

        [<DataMember>]
        member val PlatingCarrier:String = null with get,set

        [<DataMember>]
        member val RecordLocator:String = null with get,set

        [<DataMember>]
        member val Consultant:String = null with get,set

        [<DataMember>]
        member val Account:String = null with get,set

        [<DataMember>]
        member val FOP:String = null with get,set

        [<DataMember>]
        member val PrintedCurrency:String = null with get,set

        [<DataMember>]
        member val FirstName:String = null with get,set

        [<DataMember>]
        member val LastName:String = null with get,set

        [<DataMember>]
        member val PCC:String = null with get,set

        [<DataMember>]
        member val TicketIssueDate:String = null with get,set

        [<DataMember>]
        member val IATA:String = null with get,set

        [<DataMember>]
        member val Revenue:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val TicketTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val TicketBaseFare:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val Tax1Code:String = null with get,set

        [<DataMember>]
        member val Tax1Amt:String = null with get,set

        [<DataMember>]
        member val Tax2Code:String = null with get,set

        [<DataMember>]
        member val Tax2Amt:String = null with get,set

        [<DataMember>]
        member val Tax3Code:String = null with get,set

        [<DataMember>]
        member val Tax3Amt:String = null with get,set

        [<DataMember>]
        member val Tax4Code:String = null with get,set

        [<DataMember>]
        member val Tax4Amt:String = null with get,set

        [<DataMember>]
        member val Tax5Code:String = null with get,set

        [<DataMember>]
        member val Tax5Amt:String = null with get,set

        [<DataMember>]
        member val Passenger:String = null with get,set

    [<DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CacheMetadata() = 
        [<DataMember(Order=1)>]
        member val CachedAt:DateTime = new DateTime() with get,set

        [<DataMember(Order=2)>]
        member val CacheExpiresAt:DateTime = new DateTime() with get,set

        [<DataMember(Order=0)>]
        member val IsFromCache:Boolean = new Boolean() with get,set

    [<DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type PagingMetadata() = 
        ///<summary>
        ///Starting Record
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")>]
        member val Offset:String = null with get,set

        ///<summary>
        ///Number of records to return (PageSize)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")>]
        member val Limit:String = null with get,set

        ///<summary>
        ///Total Number of Records in a Full Reponse (if no paging)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")>]
        member val TotalRecords:Int32 = new Int32() with get,set

        ///<summary>
        ///Total Number of Records in this Reponse (on this page)
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")>]
        member val ResponseRecords:Int32 = new Int32() with get,set

    [<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ResponseMetadata() = 
        [<DataMember(Order=0)>]
        member val Success:Boolean = new Boolean() with get,set

        [<DataMember(Order=1)>]
        member val HasCache:Boolean = new Boolean() with get,set

        [<DataMember(Order=2)>]
        member val HasPaging:Boolean = new Boolean() with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val CacheMetadata:CacheMetadata = null with get,set

        [<DataMember(Order=4, EmitDefaultValue=false)>]
        member val PagingMetadata:PagingMetadata = null with get,set

    [<DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type ApiRequestPerHour() = 
        [<DataMember(Order=10)>]
        member val RequestDate:DateTime = new DateTime() with get,set

        [<DataMember(Order=100)>]
        member val Hour0:Int32 = new Int32() with get,set

        [<DataMember(Order=110)>]
        member val Hour1:Int32 = new Int32() with get,set

        [<DataMember(Order=120)>]
        member val Hour2:Int32 = new Int32() with get,set

        [<DataMember(Order=130)>]
        member val Hour3:Int32 = new Int32() with get,set

        [<DataMember(Order=140)>]
        member val Hour4:Int32 = new Int32() with get,set

        [<DataMember(Order=150)>]
        member val Hour5:Int32 = new Int32() with get,set

        [<DataMember(Order=160)>]
        member val Hour6:Int32 = new Int32() with get,set

        [<DataMember(Order=170)>]
        member val Hour7:Int32 = new Int32() with get,set

        [<DataMember(Order=180)>]
        member val Hour8:Int32 = new Int32() with get,set

        [<DataMember(Order=190)>]
        member val Hour9:Int32 = new Int32() with get,set

        [<DataMember(Order=200)>]
        member val Hour10:Int32 = new Int32() with get,set

        [<DataMember(Order=210)>]
        member val Hour11:Int32 = new Int32() with get,set

        [<DataMember(Order=220)>]
        member val Hour12:Int32 = new Int32() with get,set

        [<DataMember(Order=230)>]
        member val Hour13:Int32 = new Int32() with get,set

        [<DataMember(Order=240)>]
        member val Hour14:Int32 = new Int32() with get,set

        [<DataMember(Order=250)>]
        member val Hour15:Int32 = new Int32() with get,set

        [<DataMember(Order=260)>]
        member val Hour16:Int32 = new Int32() with get,set

        [<DataMember(Order=270)>]
        member val Hour17:Int32 = new Int32() with get,set

        [<DataMember(Order=280)>]
        member val Hour18:Int32 = new Int32() with get,set

        [<DataMember(Order=290)>]
        member val Hour19:Int32 = new Int32() with get,set

        [<DataMember(Order=300)>]
        member val Hour20:Int32 = new Int32() with get,set

        [<DataMember(Order=310)>]
        member val Hour21:Int32 = new Int32() with get,set

        [<DataMember(Order=320)>]
        member val Hour22:Int32 = new Int32() with get,set

        [<DataMember(Order=330)>]
        member val Hour23:Int32 = new Int32() with get,set

    [<DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type AgentivityError() = 
        [<DataMember>]
        member val ErrorCode:String = null with get,set

        [<DataMember>]
        member val Message:String = null with get,set

        [<DataMember>]
        member val StatusCode:String = null with get,set

        [<DataMember>]
        member val VerboseMessage:String = null with get,set

    [<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type CollectionResponse<TItem>() = 
        [<DataMember(Order=1)>]
        member val ResponseMetadata:ResponseMetadata = null with get,set

        [<DataMember(Order=2, EmitDefaultValue=false)>]
        member val ResponseReport:ResizeArray<ApiRequestPerHour> = null with get,set

        [<DataMember(Order=3, EmitDefaultValue=false)>]
        member val ResponseError:AgentivityError = null with get,set

    [<DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type TicketRevenueByCompanyResponse() = 
        inherit CollectionResponse<TicketRevenue>()

    [<DataContract(Namespace="schemas.agentivity.com/types")>]
    [<AllowNullLiteral>]
    type TicketRevenueByCompany() = 
        inherit PagingMetadata()
        [<DataMember>]
        member val CompanyID:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val TravelAgentID:String = null with get,set

        [<DataMember>]
        member val PlatingCarrier:String = null with get,set

        [<DataMember>]
        member val DepartureDateStart:String = null with get,set

        [<DataMember>]
        member val DepartureDateEnd:String = null with get,set

        [<DataMember>]
        member val FlightCouponStatus:String = null with get,set

        [<DataMember>]
        member val AirlineCode:String = null with get,set

F# TicketRevenueByCompany DTOs

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>