NAME

WebService::HMRC::Response - Response object for the UK HMRC MTD API

VERSION

Version 0.02

SYNOPSIS

    use WebService::HMRC::HelloWorld;  # inherits this module
    my $hmrc = WebService::HMRC::HelloWorld->new();

    # Hello World endpoint requires no authorisation
    # It returns a WebService::HMRC::Response object reference
    my $hmrc_response = $hmrc->hello_world()

    print "success\n" if $hmrc_response->is_success();

    my $status_code  = $hmrc_response->http->code;
    my $message      = $hmrc_response->data->{message};
    my $content_type = $hmrc_response->header('content-type');

DESCRIPTION

This is part of the WebService::HMRC suite of Perl modules for interacting with the UK's HMRC Making Tax Digital APIs.

This class represents the response from an api call. It is inherited by other classes which implement bindings to HMRC APIs rather than being used directly.

INSTALLATION AND TESTING

See documentation for WebService::HMRC.

PROPERTIES

data

Reference to a perl hash representing an api call's json response.

This property is updated on object creation when the http property is set.

If an api call returns no valid json response, this property is populated with a dummy response, in the same format as the standard HRMC error response, with code 'INVALID_RESPONSE'. This facilitates consistent error parsing by the calling application.

http

The raw HTTP::Response object resulting from an api call. See documentation for HTTP::Response.

METHODS

is_success()

Shortcut to the HTTP::Response is_success method.

header($header_name)

Returns the value of the specified response header, or undef if it does not exist. Shortcut to the HTTP::Response header method.

AUTHOR

Nick Prater <nick@npbroadcast.com>

BUGS

Please report any bugs or feature requests to bug-webservice-hmrc-helloworld@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-HMRC. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc WebService::HMRC::Response

You can also look for information at:

ACKNOWLEDGEMENTS

This module was originally developed for use as part of the LedgerSMB open source accounting software.

LICENCE AND COPYRIGHT

Copyright 2018 Nick Prater, NP Broadcast Limited.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.