API Error Codes

Your application should check for error code responses from our API - do not assume that a query was successful. Error codes could be produced by using incorrect username and password details, leaving out required extra parameters, providing incorrectly formatted values or an internal API error.

Below we have provided a list of all possible error codes, what they mean and their solutions.

Note: The error message can vary between API functions, while error codes stay consistent.

2XX - Internal Error

• Error Code 200 - Internal Error

  			<errors>
  			<error code="200" error="Internal error" />
  			</errors>
  			

  Meaning: Indicates an internal error. This could be caused by our servers being overloaded or scheduled maintenance.

  Solution: Try again in a few minutes. If you continue to receive this error, please contact us.

3XX - Authentication Error

• Error Code 300 - Username or password invalid

  			<errors>
  			<error code="300" error="Username or password invalid" />
  			</errors>
  			

  Meaning: You have not included your username and/or password or the username and password provided are incorrect.

  Solution: Make sure you have included your username and password in the query and that the values are correctly URL encoded (particularly if your username is an e-mail address).




• Error Code 301 - API Key Invalid

  			<errors>
  			<error code="301" error="API key invalid" />
  			</errors>
  			

  Meaning: Username and password provided are correct, but the API key provided was invalid.

  Solution: Make sure you are including your API key in your query. If you do not have an API key, contact us to obtain one.

4XX - Invalid Input

• Error Code 400 - Invalid mode parameter

  			<errors>
  			<error code="400" error="Valid modes are: add_domains, delete_domains, list_domains, add_folder, delete_folder, edit_folder, list_folders, 
  			 fetch, report, domainreport, reportlist, list_parking_providers, add_account, delete_account, edit_account, list_accounts, list_conflicts, claim_domains, referrers, 
  			 searchterms, pages" />
  			</errors>
  			

  Meaning: You have not included a valid mode value. Valid modes are: add_domains, delete_domains, list_domains, add_folder, delete_folder, edit_folder, list_folders, fetch, report, domainreport, reportlist, list_parking_providers, add_account, delete_account, edit_account and list_accounts.

  Solution: If you have included the mode attribute, check the spelling of the value. You may have added an 's' to the end or something may be incorrectly spelt.

41X - Missing Parameter

• Error Code 410 - Domain is missing or invalid

  			<errors>
  			<error code="410" error="No domain or domains parameter passed" />
  			</errors>
  			

  Meaning: The domains parameter is missing or the domain or domains you have specified are invalid.

  Solution: Make sure domains are comma separated, for example: "domain1.com,domain2.com,domain3.com". Also check the spelling of "domains".




• Error Code 411 - Report ID is Missing or Invalid / Job id is a required argument / Job was not found

  			<errors>
  			<error code="411" error="Report id is a required argument" />
  			</errors>
  			

  Meaning: You have not included the reportid or jobid parameter or the report /job id cannot be found, which is required for the selected mode.

  Solution: Include the reportid or parameter jobid in your query. If you have included it, check the spelling of "reportid" or "jobid" and check the value is a valid reportid / jobid.




• Error Code 412 - Period, from_date and to_date combination or value is invalid

  			<errors>
  			<error code="412" error="Date must be specified in YYYY-MM-DD format" />
  			</errors>
  			

  Meaning: You are using the incorrect combination of period, from_date and to_date.

  Solution: You can include either a period or from_date and to_date in a report query. Dates must be in the format YYYY-MM-DD. Accepted values for period are "today", "yesterday", or a specified number of days or months such as "7 days" or "3 months".




• Error Code 413 - Folder Not Found / No folder id parameter passed / The (Trash) and (Default) folders may not be deleted or edited / Improper JSON string provided for services

  			<errors>
  			<error code="413" error="Folder not found" />
  			</errors>
  			

  Meaning: The specified folder does not exists, you have not specified a folder or you are trying to delete the (Trash) or (Default) folders.

  Solution: Make sure the folder exists in your account and that you have correctly URL encoded the value of folder.




• Error Code 414 - Service Not Found / park_id is required for (function)

  			<errors>
  			<error code="414" error="Service not found" />
  			</errors>
  			

  Meaning: The specified service does not exists or the parking service ID specified does not exist (park_id=1234).

  Solution: Make sure the service exists in your account and that you have correctly URL encoded the value of service or the parking service ID specified exists (park_id. A list of parking services and their IDs can be retrieved using the List Parking Providers API function.




• Error Code 415 - Groupby invalid

  			<errors>
  			<error code="415" error="Groupby invalid" />
  			</errors>
  			

  Meaning: The groupby value was invalid.

  Solution: Check your groupby value is valid. Accepted values are "domain", "day", "month" or "folder".




• Error Code 416 - Account id not found or missing

  			<errors>
  			<error code="416" error="account_id is required for edit_account" />
  			</errors>
  			

  Meaning: The account_id value was invalid or the specified account ID does not exist in your account.

  Solution: Check your account_id value is valid and that the specified account ID exists in your account. A list of parking service accounts and their IDs can be retrieved using the List Accounts API function.




• Error Code 417 - Force Disable not found or missing

  			<errors>
  			<error code="417" error="force_disable is required to disable account with domains" />
  			</errors>
  			

  Meaning: The force_disable value was not provided.

  Solution:Set a force_disable value along with the disable request to disable the account. This extra step is to ensure that users do not disbale an account with domains resulting in such domains becoming unservable.




• Error Code 420 - Must set redirect for custom

  			<errors>
  			<error code="420" error="Must set redirect for custom" />
  			</errors>
  			

  Meaning: You have changed a folder to use a custom page (custom=1), but you have not specified a value for redirect.

  Solution: Make sure you have included a value for redirect and that it is a valid URL.




• Error Code 421 - acc_username/acc_password is required for add_account

  			<errors>
  			<error code="421" error="acc_username/acc_password is required for add_account" />
  			</errors>
  			

  Meaning: You are adding a new parking service account, but have not specified acc_username and/or acc_password.

  Solution: Make sure to include values for both acc_username and acc_password and that values are correctly URL encoded.




• Error Code 422 - Please enter valid currency for SEDO using signkey for API access

  			<errors>
  			<error code="422" error="Please enter valid currency for SEDO using signkey for API access />
  			</errors>
  			

  Meaning: You have added an API key (sdo_signkey) for the SEDO service and have not specified the currency (currency).

  Solution: Make sure that you specify EURO or USD currency (currency=EURO or currency=USD) when adding a SEDO API key (sdo_signkey).




• Error Code 425 - Please enter API key

  			<errors>
  			<error code="425" error="Please enter API key" />
  			</errors>
  			

  Meaning: You have not entered an API key which is required for ParkingCrew (pkc_api_key) and DomainApps (dap_apikey) accounts.

  Solution: Make sure to include the API Key for the parking service and that values are correctly URL encoded.




• Error Code 426 - GUID must be 36 characters long / API key may only contain letter and numbers, and must be 32 characters in length / API key may only contain letters and numbers / API key may only contain letters from A to F, and numbers, and must be 32 characters in length

  			<errors>
  			<error code="426" error="GUID must be 36 characters long" />
  			</errors>
  			

  Meaning: The API key you have entered is too short/long or has special characters or has letters from G to Z which are not accepted.

  Solution: Make sure the API key has been entered correctly and that values are correctly URL encoded.

• Error Code 427 - Partner ID must be a number

  			<errors>
  			<error code="427" error="Partner ID must be a number" />
  			</errors>
  			

  Meaning: The SEDO partner ID (sdo_partnerid) you have entered contains letters or special characters which are not accepted.

  Solution: Make sure the SEDO partner ID (sdo_partnerid) only contains numbers and that values are correctly URL encoded.




• Error Code 430 - Must provide valid percentage value for each service

  			<errors>
  			<error code="430" error="Must provide valid percentage value for each service" />
  			</errors>
  			

  Meaning: A redirect percentage for value has not been entered or is not numeric or has a decimal.

  Solution: Make sure the percentage values for park_id, blank=1 and for_sale redirect settings do not have decimals, are numeric and are correctly URL encoded.




• Error Code 431 - Must provide existing service

  	<errors>
  	<error code="431" error="Must provide existing service" />
  	</errors>
  	

  Meaning: An account for the parking service (park_id) does not exist in your account.

  Solution: Make sure the ID number for the park_id is correct and that values are correctly URL encoded.




• Error Code 433 - Total percentage must be 100

  	<errors>
  	<error code="433" error="Total percentage must be 100" />
  	</errors>
  	

  Meaning: The total percentage of redirect settings (park_id, blank=1 and for_sale) does not equal 100.

  Solution: Make sure values for park_id, blank=1 and for_sale total 100 and that values are correctly URL encoded.




• Error Code 435 - Invalid format value. Options are CSV or XML

  	<errors>
  	<error code="435" error="Invalid format value. Options are CSV or XML" />
  	</errors>
  	

  Meaning: You have entered an incorrect format for the parameter.

  Solution: Make sure that you use either (&format=csv) or (&format=xml) for the format.




5XX - Request could not be completed / Job failed

• Error Code 500 - Requested report could not be generated / Account addition failed: NOTICE: (reason) / Job failed. Please contact support if problems persist

  	<errors>
  	<error code="500" error="Requested report could not be generated" />
  	</errors>
  	

  Meaning: The requested report or job could not be generated or the parking service account could not be added.

  Solution: Try again. If requesting the report or job again fails, please contact support. If you are adding an account, make sure an account with that username does not already exist or take note on the reason returned.