eBay::API::XML::DataType::TicketDetailsType - eBay::API::XML::DataType::TicketDetailsType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::TicketDetailsType

DESCRIPTION

Top

Defines supported fields for searching in ticket categories.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::TicketDetailsType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

setCityName()

The city in which the event venue is located. Specify the full name of the city. Use the canonical spelling, such as "Los Angeles" (not "LA"). When you search for tickets, if eBay doesn't recognize the city, eBay drops CityName and returns results that match other fields in the request. For the eBay US site, eBay only searches by CityName if you also specify StateOrProvince.<br> <br> <span class="tablenote"><b>Note:</b> If your application needs to provide users with a predefined list of city names that eBay recognizes, you can call GetProductFinder to find all the cities that the ticket finder currently supports. GetProductFinder is a more complex call.</span>

  Calls: GetSearchResults
  RequiredInput: No
  MaxLength: 60

# Argument: 'xs:string'

getCityName()

# Returns: 'xs:string'

setEventDate()

The date of the event. If specified, the results only include listings that specify this date in their Item Specifics.<br> <br> When you search for tickets, we support these combinations:<br> - Year (matches any ticket in the specified year)<br> - Month (matches any day in the specified month, in any year)<br> - Year and Month (matches any day in the specified year and month)<br> - Month and Day (matches the specified month and day in any year)<br> - Year, Month, and Day (matches the specified year, month, and day)

  Calls: GetSearchResults
  RequiredInput: No

# Argument: 'ns:DateType'

getEventDate()

# Returns: 'ns:DateType'

setEventType()

The type of event, such as a concert or a sporting event. The eBay US, UK, and Germany sites support different values.

  Calls: GetSearchResults
  RequiredInput: Conditionally
  Default: Any

# Argument: 'ns:TicketEventTypeCodeType'

getEventType()

# Returns: 'ns:TicketEventTypeCodeType'

setStateOrProvince()

The state or province where the event venue is located. Applicable to eBay US searches only. Use the full name, such as "California" (not "CA"). If StateOrProvince isn't specified or no match is found in the product finder, eBay ignores CityName (if it is also specified).

  Calls: GetSearchResults
  RequiredInput: No
  MaxLength: 60

# Argument: 'xs:string'

getStateOrProvince()

# Returns: 'xs:string'

setTicketQuantity()

The number of tickets available in the listing, as defined in the listing's Item Specifics. (This is not the same as LotSize or Quantity.)<br> <br> - For the US site, specify a value from 1 to 10.<br> - For the UK site, specify a value from 1 to 10.<br> - For the DE site, specify a value from 1 to 4.<br> <br> To search for any quantity (or to include other quantities in the results), do not specify TicketQuantity at all.

  Calls: GetSearchResults
  RequiredInput: No
  Max: 10
  Min: 1

# Argument: 'xs:int'

getTicketQuantity()

# Returns: 'xs:int'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::TicketDetailsType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. TicketDetailsType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::BaseDataType;
our @ISA = ("eBay::API::XML::BaseDataType");

use eBay::API::XML::DataType::DateType;
use eBay::API::XML::DataType::Enum::TicketEventTypeCodeType;


my @gaProperties = ( [ 'CityName', 'xs:string', '', '', '' ]
	, [ 'EventDate', 'ns:DateType', ''
	     ,'eBay::API::XML::DataType::DateType', '1' ]
	, [ 'EventType', 'ns:TicketEventTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::TicketEventTypeCodeType', '' ]
	, [ 'StateOrProvince', 'xs:string', '', '', '' ]
	, [ 'TicketQuantity', 'xs:int', '', '', '' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setCityName {
  my $self = shift;
  $self->{'CityName'} = shift
}


sub getCityName {
  my $self = shift;
  return $self->{'CityName'};
}



sub setEventDate {
  my $self = shift;
  $self->{'EventDate'} = shift
}


sub getEventDate {
  my $self = shift;
  return $self->_getDataTypeInstance( 'EventDate'
		,'eBay::API::XML::DataType::DateType');
}



sub setEventType {
  my $self = shift;
  $self->{'EventType'} = shift
}


sub getEventType {
  my $self = shift;
  return $self->{'EventType'};
}



sub setStateOrProvince {
  my $self = shift;
  $self->{'StateOrProvince'} = shift
}


sub getStateOrProvince {
  my $self = shift;
  return $self->{'StateOrProvince'};
}



sub setTicketQuantity {
  my $self = shift;
  $self->{'TicketQuantity'} = shift
}


sub getTicketQuantity {
  my $self = shift;
  return $self->{'TicketQuantity'};
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;