.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 "2021-01-09" "perl v5.32.0" "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" \&\s-1EPP\s0 is the Extensible Provisioning Protocol. \s-1EPP\s0 (defined in \s-1RFC 4930\s0) is an application layer client-server protocol for the provisioning and management of objects stored in a shared central repository. Specified in \s-1XML,\s0 the protocol defines generic object management operations and an extensible framework that maps protocol operations to objects. As of writing, its only well-developed application is the provisioning of Internet domain names, hosts, and related contact details. .PP Every response sent to the client by an \s-1EPP\s0 server contains a \f(CW\*(C`\*(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 "\s-1OK\s0 (1000)" 4 .IX Item "OK (1000)" .PD 0 .IP "\s-1OK_PENDING\s0 (1001)" 4 .IX Item "OK_PENDING (1001)" .IP "\s-1OK_NO_MESSAGES\s0 (1300)" 4 .IX Item "OK_NO_MESSAGES (1300)" .IP "\s-1OK_MESSAGES\s0 (1301)" 4 .IX Item "OK_MESSAGES (1301)" .IP "\s-1OK_BYE\s0 (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 "\s-1UNKNOWN_COMMAND\s0 (2011)" 4 .IX Item "UNKNOWN_COMMAND (2011)" .PD 0 .IP "\s-1SYNTAX_ERROR\s0 (2011)" 4 .IX Item "SYNTAX_ERROR (2011)" .IP "\s-1USE_ERROR\s0 (2011)" 4 .IX Item "USE_ERROR (2011)" .IP "\s-1MISSING_PARAM\s0 (2011)" 4 .IX Item "MISSING_PARAM (2011)" .IP "\s-1PARAM_RANGE_ERROR\s0 (2011)" 4 .IX Item "PARAM_RANGE_ERROR (2011)" .IP "\s-1PARAM_SYNTAX_ERROR\s0 (2011)" 4 .IX Item "PARAM_SYNTAX_ERROR (2011)" .PD .PP \fIImplementation-specific Rules\fR .IX Subsection "Implementation-specific Rules" .IP "\s-1UNIMPLEMENTED_VERSION\s0 (2100)" 4 .IX Item "UNIMPLEMENTED_VERSION (2100)" .PD 0 .IP "\s-1UNIMPLEMENTED_COMMAND\s0 (2101)" 4 .IX Item "UNIMPLEMENTED_COMMAND (2101)" .IP "\s-1UNIMPLEMENTED_OPTION\s0 (2102)" 4 .IX Item "UNIMPLEMENTED_OPTION (2102)" .IP "\s-1UNIMPLEMENTED_EXTENSION\s0 (2103)" 4 .IX Item "UNIMPLEMENTED_EXTENSION (2103)" .IP "\s-1BILLING_FAILURE\s0 (2104)" 4 .IX Item "BILLING_FAILURE (2104)" .IP "\s-1NOT_RENEWABLE\s0 (2105)" 4 .IX Item "NOT_RENEWABLE (2105)" .IP "\s-1NOT_TRANSFERRABLE\s0 (2106)" 4 .IX Item "NOT_TRANSFERRABLE (2106)" .PD .PP \fISecurity (22nn)\fR .IX Subsection "Security (22nn)" .IP "\s-1AUTHENTICATION_ERROR\s0 (2200)" 4 .IX Item "AUTHENTICATION_ERROR (2200)" .PD 0 .IP "\s-1AUTHORISATION_ERROR\s0 (2201)" 4 .IX Item "AUTHORISATION_ERROR (2201)" .IP "\s-1AUTHORIZATION_ERROR\s0 (2201)" 4 .IX Item "AUTHORIZATION_ERROR (2201)" .IP "\s-1INVALID_AUTH_INFO\s0 (2202)" 4 .IX Item "INVALID_AUTH_INFO (2202)" .PD .PP \fIData Management (23nn)\fR .IX Subsection "Data Management (23nn)" .IP "\s-1OBJECT_PENDING_TRANSFER\s0 (2300)" 4 .IX Item "OBJECT_PENDING_TRANSFER (2300)" .PD 0 .IP "\s-1OBJECT_NOT_PENDING_TRANSFER\s0 (2301)" 4 .IX Item "OBJECT_NOT_PENDING_TRANSFER (2301)" .IP "\s-1OBJECT_EXISTS\s0 (2302)" 4 .IX Item "OBJECT_EXISTS (2302)" .IP "\s-1OBJECT_DOES_NOT_EXIST\s0 (2303)" 4 .IX Item "OBJECT_DOES_NOT_EXIST (2303)" .IP "\s-1STATUS_PROHIBITS_OP\s0 (2304)" 4 .IX Item "STATUS_PROHIBITS_OP (2304)" .IP "\s-1ASSOC_PROHIBITS_OP\s0 (2305)" 4 .IX Item "ASSOC_PROHIBITS_OP (2305)" .IP "\s-1PARAM_POLICY_ERROR\s0 (2306)" 4 .IX Item "PARAM_POLICY_ERROR (2306)" .IP "\s-1UNIMPLEMENTED_OBJECT_SERVICE\s0 (2307)" 4 .IX Item "UNIMPLEMENTED_OBJECT_SERVICE (2307)" .IP "\s-1DATA_MGMT_POLICY_VIOLATION\s0 (2308)" 4 .IX Item "DATA_MGMT_POLICY_VIOLATION (2308)" .PD .PP \fIServer System (24nn)\fR .IX Subsection "Server System (24nn)" .IP "\s-1COMMAND_FAILED\s0 (2400)" 4 .IX Item "COMMAND_FAILED (2400)" .PP \fIConnection Management (25nn)\fR .IX Subsection "Connection Management (25nn)" .IP "\s-1COMMAND_FAILED_BYE\s0 (2500)" 4 .IX Item "COMMAND_FAILED_BYE (2500)" .PD 0 .IP "\s-1AUTH_FAILED_BYE\s0 (2501)" 4 .IX Item "AUTH_FAILED_BYE (2501)" .IP "\s-1SESSION_LIMIT_EXCEEDED_BYE\s0 (2502)" 4 .IX Item "SESSION_LIMIT_EXCEEDED_BYE (2502)" .PD .SH "AUTHOR" .IX Header "AUTHOR" CentralNic Ltd (). .SH "COPYRIGHT" .IX Header "COPYRIGHT" This module is (c) 2016 CentralNic Ltd. This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 Net::EPP::Client .IP "\(bu" 4 Net::EPP::Frame .IP "\(bu" 4 Net::EPP::Proxy .IP "\(bu" 4 RFCs 4930 and \s-1RFC 4934,\s0 available from . .IP "\(bu" 4 The CentralNic \s-1EPP\s0 site at .