NAME

XML::SRS::Response - Top level SRS response class

SYNOPSIS

  my $response = XML::SRS->parse($xml);
  
  my $results = $response->results;
  

DESCRIPTION

This class represents the top level of an SRS response. If you parse an entire SRS XML response (via XML::SRS->parse()), the object returned will be an instance of this class (unless it was a top level error, in which case it will be an XML::SRS::Error). The root XML element of this class is 'NZSRSResponse'.

ATTRIBUTES

Each attribute of this class has an accessor/mutator of the same name as the attribute. Additionally, they can be passed as parameters to the constructor.

registrar_id

Optional attribute to containing the effective registrar id of the request. Maps to the RegistrarId XML attribute.

results

Required attribute. Accepts an array ref of objects that compose the XML::SRS::Result or XML::SRS::Error objects. These correspond to responses to the individual actions of the original request. For example, if a request containing two Whois transactions was sent, the 'results' array ref will contain two XML::SRS::Result objects (assuming the requests were successful).

This maps to the Response XML element. However, as this clashes with the top level 'Response' (i.e. 'NZSRSResponse' XML element), it has been renamed 'result'.

METHODS

new(%params)

Construct a new XML::SRS::Request object. %params specifies the initial values of the attributes.

COMPOSED OF

XML::SRS, XML::SRS::Node, XML::SRS::Version