.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::EPP::ResponseCodes 3pm"
.TH Net::EPP::ResponseCodes 3pm 2024-04-27 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::EPP::ResponseCodes \- a module to export some constants that correspond to
EPP response codes.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    use Net::EPP::ResponseCodes;
\&    use Net::EPP::Simple;
\&    use strict;
\&
\&    my $epp = Net::EPP::Simple\->new(
\&        host    => \*(Aqepp.nic.tld\*(Aq,
\&        user    => \*(Aqmy\-id\*(Aq,
\&        pass    => \*(Aqmy\-password\*(Aq,
\&    );
\&
\&    my $result = $epp\->domain_transfer_request(\*(Aqexample.tld\*(Aq, \*(Aqfoobar\*(Aq, 1);
\&
\&    if ($result) {
\&        print "Transfer initiated OK\en";
\&
\&    } else {
\&        if ($Net::EPP::Simple::Code == OBJECT_PENDING_TRANSFER) {
\&            print "Error: domain is already pending transfer\en";
\&
\&        } elsif ($Net::EPP::Simple::Code == INVALID_AUTH_INFO) {
\&            print "Error: invalid authcode provided\en";
\&
\&        } elsif ($Net::EPP::Simple::Code == OBJECT_DOES_NOT_EXIST) {
\&            print "Error: domain not found\en";
\&
\&        } elsif ($Net::EPP::Simple::Code == STATUS_PROHIBITS_OP) {
\&            print "Error: domain cannot be transferred\en";
\&
\&        } else {
\&            print "Error code $Net::EPP::Simple::Code\en";
\&
\&        }
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Every response sent to the client by an EPP server contains at least one
\&\f(CW\*(C`<result>\*(C'\fR element that has a \f(CW\*(C`code\*(C'\fR attribute. This is a four-digit
numeric code that describes the result of the request. This module exports a set
of constants that provide handy mnemonics for each of the defined codes.
.SH EXPORTS
.IX Header "EXPORTS"
\&\f(CW\*(C`Net::EPP::ResponseCodes\*(C'\fR exports the following constants. The number in
brackets is the integer value associated with the constant.
.SS "Successful command completion responses (1nnn)"
.IX Subsection "Successful command completion responses (1nnn)"
.IP "OK (1000)" 4
.IX Item "OK (1000)"
.PD 0
.IP "OK_PENDING (1001)" 4
.IX Item "OK_PENDING (1001)"
.IP "OK_NO_MESSAGES (1300)" 4
.IX Item "OK_NO_MESSAGES (1300)"
.IP "OK_MESSAGES (1301)" 4
.IX Item "OK_MESSAGES (1301)"
.IP "OK_BYE (1500)" 4
.IX Item "OK_BYE (1500)"
.PD
.SS "Command error responses (2nnn)"
.IX Subsection "Command error responses (2nnn)"
\fIProtocol Syntax\fR
.IX Subsection "Protocol Syntax"
.IP "UNKNOWN_COMMAND (2000)" 4
.IX Item "UNKNOWN_COMMAND (2000)"
.PD 0
.IP "SYNTAX_ERROR (2001)" 4
.IX Item "SYNTAX_ERROR (2001)"
.IP "USE_ERROR (2002)" 4
.IX Item "USE_ERROR (2002)"
.IP "MISSING_PARAM (2003)" 4
.IX Item "MISSING_PARAM (2003)"
.IP "PARAM_RANGE_ERROR (2004)" 4
.IX Item "PARAM_RANGE_ERROR (2004)"
.IP "PARAM_SYNTAX_ERROR (2005)" 4
.IX Item "PARAM_SYNTAX_ERROR (2005)"
.PD
.PP
\fIImplementation-specific Rules\fR
.IX Subsection "Implementation-specific Rules"
.IP "UNIMPLEMENTED_VERSION (2100)" 4
.IX Item "UNIMPLEMENTED_VERSION (2100)"
.PD 0
.IP "UNIMPLEMENTED_COMMAND (2101)" 4
.IX Item "UNIMPLEMENTED_COMMAND (2101)"
.IP "UNIMPLEMENTED_OPTION (2102)" 4
.IX Item "UNIMPLEMENTED_OPTION (2102)"
.IP "UNIMPLEMENTED_EXTENSION (2103)" 4
.IX Item "UNIMPLEMENTED_EXTENSION (2103)"
.IP "BILLING_FAILURE (2104)" 4
.IX Item "BILLING_FAILURE (2104)"
.IP "NOT_RENEWABLE (2105)" 4
.IX Item "NOT_RENEWABLE (2105)"
.IP "NOT_TRANSFERRABLE (2106)" 4
.IX Item "NOT_TRANSFERRABLE (2106)"
.PD
.PP
\fISecurity (22nn)\fR
.IX Subsection "Security (22nn)"
.IP "AUTHENTICATION_ERROR (2200)" 4
.IX Item "AUTHENTICATION_ERROR (2200)"
.PD 0
.IP "AUTHORISATION_ERROR (2201)" 4
.IX Item "AUTHORISATION_ERROR (2201)"
.IP "AUTHORIZATION_ERROR (2201)" 4
.IX Item "AUTHORIZATION_ERROR (2201)"
.IP "INVALID_AUTH_INFO (2202)" 4
.IX Item "INVALID_AUTH_INFO (2202)"
.PD
.PP
\fIData Management (23nn)\fR
.IX Subsection "Data Management (23nn)"
.IP "OBJECT_PENDING_TRANSFER (2300)" 4
.IX Item "OBJECT_PENDING_TRANSFER (2300)"
.PD 0
.IP "OBJECT_NOT_PENDING_TRANSFER (2301)" 4
.IX Item "OBJECT_NOT_PENDING_TRANSFER (2301)"
.IP "OBJECT_EXISTS (2302)" 4
.IX Item "OBJECT_EXISTS (2302)"
.IP "OBJECT_DOES_NOT_EXIST (2303)" 4
.IX Item "OBJECT_DOES_NOT_EXIST (2303)"
.IP "STATUS_PROHIBITS_OP (2304)" 4
.IX Item "STATUS_PROHIBITS_OP (2304)"
.IP "ASSOC_PROHIBITS_OP (2305)" 4
.IX Item "ASSOC_PROHIBITS_OP (2305)"
.IP "PARAM_POLICY_ERROR (2306)" 4
.IX Item "PARAM_POLICY_ERROR (2306)"
.IP "UNIMPLEMENTED_OBJECT_SERVICE (2307)" 4
.IX Item "UNIMPLEMENTED_OBJECT_SERVICE (2307)"
.IP "DATA_MGMT_POLICY_VIOLATION (2308)" 4
.IX Item "DATA_MGMT_POLICY_VIOLATION (2308)"
.PD
.PP
\fIServer System (24nn)\fR
.IX Subsection "Server System (24nn)"
.IP "COMMAND_FAILED (2400)" 4
.IX Item "COMMAND_FAILED (2400)"
.PP
\fIConnection Management (25nn)\fR
.IX Subsection "Connection Management (25nn)"
.IP "COMMAND_FAILED_BYE (2500)" 4
.IX Item "COMMAND_FAILED_BYE (2500)"
.PD 0
.IP "AUTH_FAILED_BYE (2501)" 4
.IX Item "AUTH_FAILED_BYE (2501)"
.IP "SESSION_LIMIT_EXCEEDED_BYE (2502)" 4
.IX Item "SESSION_LIMIT_EXCEEDED_BYE (2502)"
.PD
.SH COPYRIGHT
.IX Header "COPYRIGHT"
This module is (c) 2008 \- 2023 CentralNic Ltd and 2024 Gavin Brown. This module
is free software; you can redistribute it and/or modify it under the same terms
as Perl itself.