Class IsnicApiConstants

Description

Possible return codes from API server functions.

Those return codes are a subset of EPP (RFC 4930) Result Codes, with the addition of WARNING_PROCESS_WAITING message.
IsnicApiConstants contains result code constants used in IsnicApiMessage.
1yzz command finished successfully
2yzz command finished with error
9yzz command warning messages
x0zz Protocol Syntax x1zz Implementation-specific Rules x2zz Security x3zz Data Management x4zz Server System x5zz Connection Management

Located in /Shared/IsnicApiConstants.php (line 43)


	
			
Class Constant Summary
Class Constants
ERROR_AUTHENTICATION = 2200 (line 136)

Authentication error This response code is returned when a server notes an error when validating client credentials.

ERROR_AUTHORIZATION = 2201 (line 145)

Authorization error This response code is returned when a server notes a client authorization error when executing a command.

This error is used to note that a client lacks privileges to execute the requested command.

ERROR_BILLING_FAILURE = 2104 (line 113)

Billing failure This response code is returned if client tries attempts to execute a billable operation and the command cannot be completed due to a client billing failure.

ERROR_COMMAND_USE_ERROR = 2002 (line 100)
ERROR_INVALID_AUTH_INFORMATION = 2202 (line 158)

Invalid authorization information

This response code is returned when a server receives invalid command authorization information required to confirm authorization to execute a command. This error is used to note that a client has the privileges required to execute the requested command, but the authorization information provided by the client does not match the authorization information archived by the server.

ERROR_OBJECT_DOESNT_EXISTS = 2303 (line 184)

Object does not exist

This response code is returned when a server receives a command to query or transform an object that does not exist in the repository.

ERROR_OBJECT_EXISTS = 2302 (line 175)

Object exists

This response code is returned when a server receives a command to create an object that already exists.

ERROR_OBJECT_STATUS_DOESNT_PROHIBITS_OPERATION = 2304 (line 186)
ERROR_PARAMETER_POLICY = 2306 (line 194)

Parameter value policy error This response code is returned when a server receives a command containing a parameter value that is syntactically valid, but semantically invalid due to local policy.

ERROR_PENDING_TRANSFER = 2300 (line 167)

Object pending transfer

This response code is returned when a server receives a command to transfer of an object that is pending transfer due to an earlier transfer request.

ERROR_RENEWAL_NOT_POSSIBLE = 2105 (line 121)

Object is not eligible for renewal This response code is returned when a client attempts to renew a domain that's not possible to renew according to server policy.

ERROR_REQUIRED_PARAMETER_MISSING = 2003 (line 105)

Required parameter/s missing

ERROR_SERVER_ERROR = 2400 (line 203)

Command failed This response code is returned when a server is unable to execute a command due to an internal server error that is not related to the protocol. The failure can be transient.

Session is kept active.

ERROR_SESSION_LIMIT_EXCEEDED = 2502 (line 214)

Session limit exceeded

This response code is returned when a server receives a login() call, and the command cannot be completed because the client has exceeded a system-defined limit on the number of sessions that the client can establish. It might be possible to establish a session by ending existing unused sessions and closing inactive connections.

ERROR_TRANSFER_NOT_POSSIBLE = 2106 (line 129)

Object is not eligible for transfer This response code is returned when a client attempts to transfer a domain that is is not eligible for transfer in accordance with server policy.

ERROR_UNIMPLEMENTED_OPTION = 2102 (line 99)
SUCCESS_DEQUEUE = 1301 (line 89)

Command completed successfully; ack to dequeue This response code is returned when responding to a ServerApi::pollMessages() command and the messages have been sent to the API user.

SUCCESS_DONE = 1000 (line 62)

Command completed successfully This is the usual response code for a successfully completed command.

SUCCESS_LOGOUT = 1500 (line 96)

Command completed successfully; ending session This response code is returned when responding to a successful ServerApi::logout() command.

SUCCESS_NO_MSG = 1300 (line 81)

Command completed successfully; no messages This response code is returned when responding to a ServerApi::pollMessages() command and the server message queue is empty.

SUCCESS_PENDING = 1001 (line 73)

Command completed successfully; action pending This response code is returned when responding to a command that requires offline activity before the requested

Note that this does not mean that the action will be successful when processed by the server, it could end up sending a error message.

WARNING_PROCESS_WAITING = 9301 (line 55)

The command can not be completed until errors are resolved.

More detaild error message is included in the IsnicApiMessage::$msg part of the message
This result code is only used for pending messages, and doesn't terminate them. They will still get a SUCCESS_DONE or ERROR_* as as final message.
In general this only happens in unusual cases, but it requires human interaction if it does.

Documentation generated on Wed, 11 Nov 2015 11:35:23 +0000 by phpDocumentor 1.4.4