eBay::API::XML::Call::GetUserDisputes::GetUserDisputesRequestType - eBay::API::XML::Call::GetUserDisputes::GetUserDisputesRequestType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetUserDisputes::GetUserDisputesRequestType

DESCRIPTION

Top

Requests a list of disputes the requester is involved in as buyer or seller. The list includes both Unpaid Item and Item Not Received disputes and can be filtered according to DisputeFilterType. Use a DetailLevel of ReturnAll to return all data about each dispute, including DisputeResolution and DisputeMessage elements.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetUserDisputes::GetUserDisputesRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

Top

setDisputeFilterType()

A filter that specifies a subset of disputes to return. The return list includes both Item Not Received and Unpaid Item disputes.

  RequiredInput: No
#    Argument: 'ns:DisputeFilterTypeCodeType'

getDisputeFilterType()

# Returns: 'ns:DisputeFilterTypeCodeType'

setDisputeSortType()

The value and sequence to use to sort the returned disputes.

  RequiredInput: No
#    Argument: 'ns:DisputeSortTypeCodeType'

getDisputeSortType()

# Returns: 'ns:DisputeSortTypeCodeType'

setModTimeFrom()

A filter that retrieves disputes whose DisputeModifiedTime is later than or equal to this value. Specify the time value in GMT. See the eBay Web Services documentation for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify ModTimeTo. Otherwise, the end of the date range is the present time. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned.

  RequiredInput: No
#    Argument: 'xs:dateTime'

getModTimeFrom()

# Returns: 'xs:dateTime'

setModTimeTo()

A filter that retrieves disputes whose DisputeModifiedTime is earlier than or equal to this value. Specify the time value in GMT. See the eBay Web Services documentation for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify ModTimeFrom. Otherwise, all available disputes modified prior to the ModTimeTo value are returned. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned.

  RequiredInput: No
#    Argument: 'xs:dateTime'

getModTimeTo()

# Returns: 'xs:dateTime'

setPagination()

The virtual page number of the result set to display. A result set has a number of disputes divided into virtual pages, with 200 disputes per page. The response can only display one page. The first page in the result set is number 1. Required. If not specified, a warning is returned and Pagination.PageNumber is set to 1 by default.

  RequiredInput: Yes
#    Argument: 'ns:PaginationType'

getPagination()

# Returns: 'ns:PaginationType'

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

package eBay::API::XML::Call::GetUserDisputes::GetUserDisputesRequestType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. GetUserDisputesRequestType.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::PaginationType;
use eBay::API::XML::DataType::Enum::DisputeFilterTypeCodeType;
use eBay::API::XML::DataType::Enum::DisputeSortTypeCodeType;


my @gaProperties = ( [ 'DisputeFilterType', 'ns:DisputeFilterTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeFilterTypeCodeType', '' ]
	, [ 'DisputeSortType', 'ns:DisputeSortTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DisputeSortTypeCodeType', '' ]
	, [ 'ModTimeFrom', 'xs:dateTime', '', '', '' ]
	, [ 'ModTimeTo', 'xs:dateTime', '', '', '' ]
	, [ 'Pagination', 'ns:PaginationType', ''
	     ,'eBay::API::XML::DataType::PaginationType', '1' ]
                    );
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 setDisputeFilterType {
  my $self = shift;
  $self->{'DisputeFilterType'} = shift
}


sub getDisputeFilterType {
  my $self = shift;
  return $self->{'DisputeFilterType'};
}



sub setDisputeSortType {
  my $self = shift;
  $self->{'DisputeSortType'} = shift
}


sub getDisputeSortType {
  my $self = shift;
  return $self->{'DisputeSortType'};
}



sub setModTimeFrom {
  my $self = shift;
  $self->{'ModTimeFrom'} = shift
}


sub getModTimeFrom {
  my $self = shift;
  return $self->{'ModTimeFrom'};
}



sub setModTimeTo {
  my $self = shift;
  $self->{'ModTimeTo'} = shift
}


sub getModTimeTo {
  my $self = shift;
  return $self->{'ModTimeTo'};
}



sub setPagination {
  my $self = shift;
  $self->{'Pagination'} = shift
}


sub getPagination {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Pagination'
		,'eBay::API::XML::DataType::PaginationType');
}





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

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



1;