Checks if the specified name is available to create a portal.
Name | Description | Type | Example |
portalName*
sent in Query
|
Portal name | string | "example" |
The response will contain the following information:
Name | Description | Type | Example |
error |
If the portal name is already taken or some other error occurred during the request, the response object will have the error key with one of the following values:
|
string | "portalNameEmpty" |
message | If the portal name is available, the response object message key will have the "portalNameReadyToRegister" value, otherwise the error description will be included into the message value. | string | "portalNameReadyToRegister" |
variants | In case error is equal to "portalNameExist", the response will also have a list of all the existing potal names starting with the name from the request. | array of string | ["example", "example2014"] |
{ message = "portalNameReadyToRegister" }
{ "error": "portalNameExist", "message": "Portal already exists", "variants": [ "example", "example2014" ] }