Agentivity API

TicketRevenueByCompany

The following routes are available for this service:
GET	/TicketRevenue/Company


// @DataContract(Name="Metadata", Namespace="schemas.agentivity.com/types")
export class PagingMetadata
{
    /** @description Starting Record */
    // @DataMember
    // @ApiMember(DataType="string", Description="Starting Record", Name="Offset", ParameterType="query")
    public Offset: string;

    /** @description Number of records to return (PageSize) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Number of records to return (PageSize)", Name="Limit", ParameterType="query")
    public Limit: string;

    /** @description Total Number of Records in a Full Reponse (if no paging) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in a Full Reponse (if no paging)", Name="TotalRecords", ParameterType="query")
    public TotalRecords: number;

    /** @description Total Number of Records in this Reponse (on this page) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Total Number of Records in this Reponse (on this page)", Name="ResponseRecords", ParameterType="query")
    public ResponseRecords: number;

    public constructor(init?: Partial<PagingMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AirlineTicketRevenue", Namespace="schemas.agentivity.com/types")
export class TicketRevenue
{
    // @DataMember
    public TktNumber: string;

    // @DataMember
    public PlatingCarrier: string;

    // @DataMember
    public RecordLocator: string;

    // @DataMember
    public Consultant: string;

    // @DataMember
    public Account: string;

    // @DataMember
    public FOP: string;

    // @DataMember
    public PrintedCurrency: string;

    // @DataMember
    public FirstName: string;

    // @DataMember
    public LastName: string;

    // @DataMember
    public PCC: string;

    // @DataMember
    public TicketIssueDate: string;

    // @DataMember
    public IATA: string;

    // @DataMember
    public Revenue?: number;

    // @DataMember
    public TicketTax?: number;

    // @DataMember
    public TicketBaseFare?: number;

    // @DataMember
    public Tax1Code: string;

    // @DataMember
    public Tax1Amt: string;

    // @DataMember
    public Tax2Code: string;

    // @DataMember
    public Tax2Amt: string;

    // @DataMember
    public Tax3Code: string;

    // @DataMember
    public Tax3Amt: string;

    // @DataMember
    public Tax4Code: string;

    // @DataMember
    public Tax4Amt: string;

    // @DataMember
    public Tax5Code: string;

    // @DataMember
    public Tax5Amt: string;

    // @DataMember
    public Passenger: string;

    public constructor(init?: Partial<TicketRevenue>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CacheMetadata", Namespace="schemas.agentivity.com/types")
export class CacheMetadata
{
    // @DataMember(Order=1)
    public CachedAt: string;

    // @DataMember(Order=2)
    public CacheExpiresAt: string;

    // @DataMember(Order=0)
    public IsFromCache: boolean;

    public constructor(init?: Partial<CacheMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class ResponseMetadata
{
    // @DataMember(Order=0)
    public Success: boolean;

    // @DataMember(Order=1)
    public HasCache: boolean;

    // @DataMember(Order=2)
    public HasPaging: boolean;

    // @DataMember(Order=3, EmitDefaultValue=false)
    public CacheMetadata: CacheMetadata;

    // @DataMember(Order=4, EmitDefaultValue=false)
    public PagingMetadata: PagingMetadata;

    public constructor(init?: Partial<ResponseMetadata>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ApiRequestPerHour", Namespace="schemas.agentivity.com/types")
export class ApiRequestPerHour
{
    // @DataMember(Order=10)
    public RequestDate: string;

    // @DataMember(Order=100)
    public Hour0: number;

    // @DataMember(Order=110)
    public Hour1: number;

    // @DataMember(Order=120)
    public Hour2: number;

    // @DataMember(Order=130)
    public Hour3: number;

    // @DataMember(Order=140)
    public Hour4: number;

    // @DataMember(Order=150)
    public Hour5: number;

    // @DataMember(Order=160)
    public Hour6: number;

    // @DataMember(Order=170)
    public Hour7: number;

    // @DataMember(Order=180)
    public Hour8: number;

    // @DataMember(Order=190)
    public Hour9: number;

    // @DataMember(Order=200)
    public Hour10: number;

    // @DataMember(Order=210)
    public Hour11: number;

    // @DataMember(Order=220)
    public Hour12: number;

    // @DataMember(Order=230)
    public Hour13: number;

    // @DataMember(Order=240)
    public Hour14: number;

    // @DataMember(Order=250)
    public Hour15: number;

    // @DataMember(Order=260)
    public Hour16: number;

    // @DataMember(Order=270)
    public Hour17: number;

    // @DataMember(Order=280)
    public Hour18: number;

    // @DataMember(Order=290)
    public Hour19: number;

    // @DataMember(Order=300)
    public Hour20: number;

    // @DataMember(Order=310)
    public Hour21: number;

    // @DataMember(Order=320)
    public Hour22: number;

    // @DataMember(Order=330)
    public Hour23: number;

    public constructor(init?: Partial<ApiRequestPerHour>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="ResponseMetadata", Namespace="schemas.agentivity.com/types")
export class AgentivityError
{
    // @DataMember
    public ErrorCode: string;

    // @DataMember
    public Message: string;

    // @DataMember
    public StatusCode: string;

    // @DataMember
    public VerboseMessage: string;

    public constructor(init?: Partial<AgentivityError>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class CollectionResponse<TItem>
{
    // @DataMember(Order=1)
    public ResponseMetadata: ResponseMetadata;

    // @DataMember(Order=2, EmitDefaultValue=false)
    public ResponseReport: ApiRequestPerHour[];

    // @DataMember(Order=3, EmitDefaultValue=false)
    public ResponseError: AgentivityError;

    public constructor(init?: Partial<CollectionResponse<TItem>>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="AgentivityResponse", Namespace="schemas.agentivity.com/types")
export class TicketRevenueByCompanyResponse extends CollectionResponse<TicketRevenue>
{

    public constructor(init?: Partial<TicketRevenueByCompanyResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Namespace="schemas.agentivity.com/types")
export class TicketRevenueByCompany extends PagingMetadata
{
    // @DataMember
    public CompanyID?: number;

    // @DataMember
    public TravelAgentID: string;

    // @DataMember
    public PlatingCarrier: string;

    // @DataMember
    public DepartureDateStart: string;

    // @DataMember
    public DepartureDateEnd: string;

    // @DataMember
    public FlightCouponStatus: string;

    // @DataMember
    public AirlineCode: string;

    public constructor(init?: Partial<TicketRevenueByCompany>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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: 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>
    <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>