eBay::API::XML::Call::GetAdFormatLeads::GetAdFormatLeadsRequestType - eBay::API::XML::Call::GetAdFormatLeads::GetAdFormatLeadsRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetAdFormatLeads::GetAdFormatLeadsRequestType

DESCRIPTION

Top

Retrieves sales lead information for a lead generation listing. GetAdFormatLeadsRequest returns the number of leads for an ad and any contact information that the prospective buyer submitted.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetAdFormatLeads::GetAdFormatLeadsRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setEndCreationTime()

Used with StartCreationTime to limit the returned leads for a user to only those with a creation date less than or equal to the specified date and time.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

getEndCreationTime()

# Returns: 'xs:dateTime'

setIncludeMemberMessages()

Boolean which indicates whether to return mail messages for this lead in a MemberMessage node.

  RequiredInput: No
#    Argument: 'xs:boolean'

isIncludeMemberMessages()

# Returns: 'xs:boolean'

setItemID()

The unique identifier of an item listed on the eBay site. Returned by eBay when the item is created. This ID must correspond to an ad format item.

MaxLength: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits)

  RequiredInput: No
#    Argument: 'ns:ItemIDType'

getItemID()

# Returns: 'ns:ItemIDType'

setStartCreationTime()

Used with EndCreationTime to limit the returned leads for a user to only those with a creation date greater than or equal to the specified date and time.

  RequiredInput: Conditionally
#    Argument: 'xs:dateTime'

getStartCreationTime()

# Returns: 'xs:dateTime'

setStatus()

Filters the leads based on their status.

  RequiredInput: No
#    Argument: 'ns:MessageStatusTypeCodeType'

getStatus()

# Returns: 'ns:MessageStatusTypeCodeType'

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

package eBay::API::XML::Call::GetAdFormatLeads::GetAdFormatLeadsRequestType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::ItemIDType;
use eBay::API::XML::DataType::Enum::MessageStatusTypeCodeType;


my @gaProperties = ( [ 'EndCreationTime', 'xs:dateTime', '', '', '' ]
	, [ 'IncludeMemberMessages', 'xs:boolean', '', '', '' ]
	, [ 'ItemID', 'ns:ItemIDType', ''
	     ,'eBay::API::XML::DataType::ItemIDType', '1' ]
	, [ 'StartCreationTime', 'xs:dateTime', '', '', '' ]
	, [ 'Status', 'ns:MessageStatusTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::MessageStatusTypeCodeType', '' ]
                    );
push @gaProperties, @{eBay::API::XML::RequestDataType::getPropertiesList()};

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


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

sub isScalar {
   return 0; 
}




sub setEndCreationTime {
  my $self = shift;
  $self->{'EndCreationTime'} = shift
}


sub getEndCreationTime {
  my $self = shift;
  return $self->{'EndCreationTime'};
}



sub setIncludeMemberMessages {
  my $self = shift;
  $self->{'IncludeMemberMessages'} = shift
}


sub isIncludeMemberMessages {
  my $self = shift;
  return $self->{'IncludeMemberMessages'};
}



sub setItemID {
  my $self = shift;
  $self->{'ItemID'} = shift
}


sub getItemID {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ItemID'
		,'eBay::API::XML::DataType::ItemIDType');
}



sub setStartCreationTime {
  my $self = shift;
  $self->{'StartCreationTime'} = shift
}


sub getStartCreationTime {
  my $self = shift;
  return $self->{'StartCreationTime'};
}



sub setStatus {
  my $self = shift;
  $self->{'Status'} = shift
}


sub getStatus {
  my $self = shift;
  return $self->{'Status'};
}





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

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



1;