GET api/Domain/Availability?domain={domain}

Determin if a domain is available

Request Information

URI Parameters

Name	Description	Type	Additional information
domain	domain name	string	Required

Body Parameters

None.

Response Information

Resource Description

A DomainAvailability object with stautus and domain name Return codes
200 - ok
400 - bad request
500 - internal server error

DomainAvailability

Name	Description	Type	Additional information
Name	Domain name - transformed if necessary	string	None.
Status	Status of check	string	None.
Notices	Comma seperated string of notices	string	None.
AvailabilityResponse	Availablity respose object	AvailabilityResponse	None.
Catchable	When domain is UnAvailableInDropZone, this indiactes if the domain is catchable	boolean	None.
CatchableTld	When domain is UnAvailableInDropZone, this indiactes if the tld is catchable	boolean	None.
Error	Error message in case of failure	string	None.
Forbidden	Domain is forbidden	boolean	None.
Reserved	Domain is reserved	boolean	None.
ForbiddenReason	Reason when domain is forbidden	string	None.
ReservedReason	Reason when domain is reserved	string	None.

Response Formats

application/json

Sample:

{
    "code": -4,
    "notices": 1
}

text/json

Sample:

{
  "Forbidden": true,
  "Reserved": true,
  "ForbiddenReason": "sample string 3",
  "ReservedReason": "sample string 4",
  "Name": "sample string 1",
  "Status": "sample string 2",
  "Notices": "sample string 3",
  "AvailabilityResponse": {
    "code": 0,
    "notices": 1
  },
  "Catchable": true,
  "CatchableTld": true,
  "Error": "sample string 6"
}

application/xml, text/xml

Sample:

<DomainAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models.Domain">
  <AvailabilityResponse>
    <code>None</code>
    <notices>none</notices>
  </AvailabilityResponse>
  <Catchable>true</Catchable>
  <CatchableTld>true</CatchableTld>
  <Error>sample string 6</Error>
  <Forbidden>true</Forbidden>
  <ForbiddenReason>sample string 3</ForbiddenReason>
  <Name>sample string 1</Name>
  <Notices>sample string 3</Notices>
  <Reserved>true</Reserved>
  <ReservedReason>sample string 4</ReservedReason>
  <Status>sample string 2</Status>
</DomainAvailability>