enom, Inc. API response codes

Transcription

1 API response codes Introduction When you run a query against the enom API, the response includes a numeric code and a corresponding text message. This allows us to standardize our responses and make them more specific; it also allows our international resellers to translate API responses to their local language. Please note that the numeric codes are the stable standard on which you should build. The catalog of numeric codes will grow, but any individual code will remain stable once it is created. You are free to create your own text messages in fact, we encourage you to do so using the tables below as a guideline. The numerical response codes are six-digit numbers that indicate the system, type of error, and parameter that are the subjects of this response. The first digit in each six-digit error code indicates the system that is generating the message. For example, error codes that begin with 4 indicate authentication errors. This first digit is referred to as the system. The second and third digits in an error code indicate the nature of the error. For example, x04xxx indicates invalid data. These digits are referred to as the error. The last three digits in an error code indicate the parameter that is failing. For example, xxx156 indicates a problem with the password. These digits are referred to as the parameter. Error code components System The first digit in each six-digit error code indicates the system that is generating the message. This first digit is referred to as the system. System 0xxxxx 1xxxxx 2xxxxx 3xxxxx 4xxxxx 5xxxxx 6xxxxx 7xxxxx An unknown error has occurred Command completed successfully Registry error Validation error Authentication error Payment error System error Policy error Error The second and third digits in an error code indicate the nature of the error. These digits are referred to as the error. Error x00xxx x01xxx Does not apply Missing 3/28/06 10

2 Error x02xxx x03xxx x04xxx x05xxx x06xxx x07xxx x08xxx x09xxx x10xxx x11xxx x12xxx x13xxx x14xxx x15xxx x16xxx x17xxx x18xxx x19xxx x20xxx x99xxx Duplicate Out of range Invalid Type mismatch Policy violation Connection failed Failed to retrieve Failed to add Failed to update Failed to delete Disabled Unauthorized Declined Not available Not found Expired Down for maintenance Failed to deduct Failed to send Unknown The last three digits in an error code indicate the parameter that is failing. These digits are referred to as the parameter. xxx000 xxx001 xxx002 xxx003 xxx004 xxx005 xxx006 xxx007 xxx008 xxx009 xxx010 xxx011 xxx012 xxx019 xxx021 xxx022 xxx023 xxx024 Does not apply First name (generic); for specific contact types see xxx019 through xxx024 Last name (generic); for specific contact types see xxx025 through xxx029 Address (generic); for specific contact types see xxx030 through xxx034 City (generic); for specific contact types see xxx040 through xxx044 State/Province (generic); for specific contact types see xxx045 through xxx049 Postal code (generic); for specific contact types see xxx050 through xxx054 Country (generic); for specific contact types see xxx055 through xxx059 Job title (generic); for specific contact types see xxx060 through xxx064 Organization (generic) Phone number (generic); for specific contact types see xxx065 through xxx069 Fax number (generic); for specific contact types see xxx070 through xxx074 (generic); for specific contact types see xxx075 through xxx079 Registrant contact first name Auxiliary Billing contact first name Technical contact first name Administrative contact first name Billing contact first name 3/28/06 11

3 xxx025 xxx026 xxx027 xxx028 Registrant contact last name Auxiliary Billing contact last name Technical contact last name Administrative contact last name xxx029 Billing contact last name xxx030 Registrant contact address, line 1 xxx031 Auxiliary Billing contact address, line 1 xxx032 Technical contact address, line 1 xxx033 Administrative contact address, line 1 xxx034 Billing contact address, line 1 xxx035 Registrant contact address, line 2 xxx036 Auxiliary Billing contact address, line 2 xxx037 Technical contact address, line 2 xxx038 Administrative contact address, line 2 xxx039 Billing contact address, line 2 xxx040 Registrant contact city xxx041 xxx042 xxx043 xxx044 xxx045 xxx046 xxx047 xxx048 xxx049 xxx050 xxx051 xxx052 xxx053 xxx054 xxx055 xxx056 xxx057 xxx058 xxx059 xxx060 xxx061 xxx062 xxx063 xxx064 xxx065 xxx066 xxx067 xxx068 xxx069 Auxiliary Billing contact city Technical contact city Administrative contact city Billing contact city Registrant contact state/province Auxiliary Billing contact state/province Technical contact state/province Administrative contact state/province Billing contact state/province Registrant contact postal code Auxiliary Billing contact postal code Technical contact postal code Administrative contact postal code Billing contact postal code Registrant contact country Auxiliary Billing contact country Technical contact country Administrative contact country Billing contact country Registrant contact job title Auxiliary Billing contact job title Technical contact job title Administrative contact job title Billing contact job title Registrant contact phone Auxiliary Billing contact phone Technical contact phone Administrative contact phone Billing contact phone 3/28/06 12

4 xxx070 xxx071 xxx072 xxx073 xxx074 xxx075 xxx076 xxx077 xxx078 xxx079 xxx144 xxx145 xxx146 xxx147 xxx148 xxx149 xxx150 xxx151 xxx152 xxx153 xxx154 xxx155 xxx156 xxx157 xxx158 xxx159 xxx160 xxx161 xxx162 xxx163 xxx164 xxx165 xxx166 xxx167 xxx168 xxx169 xxx170 xxx171 xxx172 xxx173 xxx174 xxx175 xxx176 xxx177 Registrant contact fax Auxiliary Billing contact fax Technical contact fax Administrative contact fax Billing contact fax Registrant contact Auxiliary Billing contact Technical contact Administrative contact Billing contact Party ID Registrant contact (use this when you are unable to retrieve the entire block of registrant contact information) Auxiliary Billing contact (entire block) Technical contact (entire block) Administrative contact (entire block) Billing contact (entire block) Command SLD TLD Domain name Expiration date (applies to all domains and services) Login ID Password (use this for domain name account password and domain password; xxx303 is Web hosting account password) Subaccount(s) (generic) Name server name Name server IP address End user IP address Server IP address Parking page Renewal settings Notification amount Customer preferences Connection timeout Session timeout Account type Domain count record(s) Host records(s) Forward to URL address (forwarding URL address in host records) Price(s) Queue Club Drop Reseller key 3/28/06 13

5 xxx178 xxx179 xxx180 xxx181 xxx182 xxx183 xxx184 xxx185 xxx186 xxx187 xxx188 xxx189 xxx190 xxx191 xxx192 xxx193 xxx194 xxx195 xxx196 xxx197 xxx198 xxx199 xxx200 xxx201 xxx202 xxx203 xxx204 xxx205 xxx206 xxx207 xxx208 xxx209 xxx210 xxx217 xxx218 xxx219 xxx220 xxx221 xxx222 xxx223 xxx224 xxx225 xxx226 xxx227 xxx228 Reseller pricing Retail pricing Price break Account balance Product type Quantity Reference(s) Authorization answer Order number Reference number Page Page size URL (generic, including paging) Address book Shopping cart Item ID Host name (name of a host record, not a Web hosting account) Address Month Year(s) Card type Cardholder name Cardholder address Cardholder city Cardholder state/province Cardholder postal code Cardholder country Credit card number Cardholder phone Amount Address does not match Postal code does not match Credit card verification number Date Metatag(s) Watch list Service(s) Transfer order(s) Transfer order detail(s) Web Site Builder Information Option ID Token Count Registrar Lock 3/28/06 14

6 xxx229 xxx230 xxx231 xxx232 xxx233 xxx234 xxx235 xxx236 xxx237 xxx238 xxx239 xxx240 xxx241 xxx242 xxx243 xxx244 xxx245 xxx246 xxx247 xxx248 xxx249 xxx250 xxx251 xxx252 xxx253 xxx254 xxx255 xxx256 xxx257 xxx258 xxx259 xxx260 xxx261 xxx262 xxx263 xxx264 xxx265 xxx266 xxx267 xxx268 xxx269 xxx270 xxx271 Domain name ID Credit card processing Credit card information Contact (generic) Item count Page view(s) Bundle (generic use for.name bundle, and so on) Item(s) Character limit Word(s) Status Commission balance Load parameter Order(s) RequestID Record(s) Preference(s) Time stamp Reseller API Reseller Active reseller Usage Setting(s) Request(s) Parking text User(s) Account(s) Option Order type Authorization Order ID Detail ID Action Comment(s) Display flag Object(s) Date Image(s) Preconfigure DNS Submit times Pak ID of a POP pak associated with a domain name in a domain name account. For POP units associated with a Web hosting account, see xxx314. For package IDs of products other than domain name POP paks, see xxx327. Meta base POP pak associated with a domain name in a domain name account. For POP units associated with a Web hosting account, see xxx314. 3/28/06 15

7 xxx272 xxx273 xxx274 xxx275 xxx276 xxx277 xxx278 xxx279 xxx280 xxx281 xxx282 xxx283 xxx284 xxx285 xxx286 xxx287 xxx288 xxx289 xxx290 xxx291 xxx292 xxx293 xxx294 xxx295 xxx296 xxx297 xxx298 xxx299 xxx300 xxx301 xxx302 xxx303 xxx304 xxx305 xxx306 xxx307 xxx308 xxx309 xxx310 xxx311 xxx312 xxx313 xxx314 Full name Runtime Product ID Bid Auction Site ID Location name Group name URI Time zone Start time End time Alert interval Name server(s) User name of a POP mailbox in a POP pak associated with a domain name. For a Web-hosting-account mailbox, see xxx313. Keyword (generic) Type (generic) Extended attribute Contact information (generic) Cookie MX Preference Record type Accounting transaction Account information TLD information Site processor Registrar information Database Hosts count (number of Web hosting accounts in a domain name account) Web hosting account directory Web hosting account user name Web hosting account password Web hosting host header(s) Domain header(s) File permissions Files SQL table(s) Server information Bandwidth Web hosting account ID Database storage Individual POP3 mailboxes in a Web hosting account. For POP paks associated with a domain name in a domain name account, see xxx271. POP paks (units of 10) in a Web hosting account. For POP paks associated with a domain name in a domain name account, see xxx271. 3/28/06 16

8 xxx315 xxx316 xxx317 xxx318 xxx319 xxx320 xxx321 xxx322 xxx323 xxx324 xxx325 xxx326 xxx327 xxx328 xxx329 xxx330 xxx331 xxx350 xxx351 xxx352 xxx353 xxx354 xxx355 xxx356 xxx357 xxx358 xxx359 xxx360 xxx361 xxx362 xxx363 xxx364 xxx365 xxx366 xxx367 xxx368 xxx369 xxx370 xxx371 xxx372 xxx373 Web storage Overage option Stored procedure name SQL statement Table name Index name Database column Database type Operating system type Web hosting account ID Path name Package(s) Use for all packages except POP paks associated with a domain name in a domain name account. For domain-name POP paks, see xxx271. Package ID Use for all products sold as multiple-unit packages except POP paks associated with a domain name in a domain name account. For the Pak ID of a domain-name POP pak, see xxx269. Package name Stored procedure text Stored procedure(s) Index property(s) Agreement Secret type Display name Location count Notification count ExpiredCount number of expired domain names currently in this account. DomainCount_Others ExpiredCount_Others Language code Day(s) Order status key(s) Registrar Color Fraud record(s) Fraud type Fraud value Fraud level Enable instruction(s) PayPal contract Category ID Subcategory ID Category name Subcategory name 3/28/06 17

9 xxx374 xxx375 xxx376 xxx377 xxx378 xxx379 xxx380 xxx381 xxx382 xxx383 xxx384 xxx385 xxx386 xxx387 xxx388 xxx999 Category keyword type code Filter mask Category keyword reference ID Category keyword relevance level Access control violation -- Stored procedure failure Access control violation -- Access control lock Access control violation -- Domain not under account Access control violation -- Escrow hold Access control violation -- Invalid PartyID Access control violation -- Invalid access type Invalid promotion code Adult Hard core China Web Site Creator Unknown 3/28/06 18