NAME

Broadworks::OCIP::Response - A Broadworks OCI-P Response Message

VERSION

version 0.09

SYNOPSIS

use Broadworks::OCIP::Response;

my $res = Broadworks::OCIP::Response->new(
  xml => string,
  expected => 'SuccessResponse' );
$res->status_ok;

DESCRIPTION

Unpacks an XML document sent as a reply and allows its manipulation.

Required Parameters

xml

The XML document returned. This should be a perl string - not encoded.

expected

The response type we are expecting. This is used to populate status_ok. If die_on_error is set an exception will be thrown if the received document is not of this type.

die_on_error

Whether we throw toys out of pram on unexpected input.

hash

A perl hash representation of the XML.

type

The type of the returned XML.

status_ok

Is this the expected return type.

payload

The hash payload of the XML document.

tables

Any tables that are in the returned data. This returns a hash of tables named by the table name.

Each table is an array of rows, each of which is a hash.

table

Returns the content of a single named table, as a list

BUILD

Build the object - throw an error if this is an unexpected type.

list

Return a result from the payload as a list (empty if not defined).

AUTHOR

Nigel Metheringham <Nigel.Metheringham@redcentricplc.com>

COPYRIGHT

Copyright 2014-2020 Recentric Solutions Limited. All rights reserved.

AUTHOR

Nigel Metheringham <nigelm@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020 by Nigel Metheringham.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.