DomainRegistrationInfo

A resource implementing this type contains registration data of a domain.

Schema

The considered APS type (download) extends the Resource APS type(s) and looks as follows:

{
  "name": "DomainRegistrationInfo",
  "id": "http://parallels.com/aps/types/pa/dns/zoneinfo/1.0",
  "apsVersion": "2.0",
  "implements": [
    "http://aps-standard.org/types/core/resource/1.0"
  ],
  "relations": {
    "admin": {
      "type": "http://parallels.com/aps/types/pa/user/1.2"
    },
    "owner": {
      "type": "http://parallels.com/aps/types/pa/user/1.2"
    },
    "billing": {
      "type": "http://parallels.com/aps/types/pa/user/1.2"
    },
    "tech": {
      "type": "http://parallels.com/aps/types/pa/user/1.2"
    },
    "zone": {
      "type": "http://aps-standard.org/types/dns/zone/1.0",
      "required": true
    }
  },
  "properties": {
    "registrarStatus": {
      "type": "string",
      "description": "Registrar Status",
      "enum": [
        "Registering",
        "Registered",
        "Expired",
        "Transfering",
        "Canceling",
        "Canceled",
        "Terminating",
        "Terminated"
      ]
    },
    "creationDate": {
      "type": "string",
      "description": "Creation Date",
      "format": "date-time"
    },
    "updatedDate": {
      "type": "string",
      "description": "Updated Date",
      "format": "date-time"
    },
    "registrarExpirationDate": {
      "type": "string",
      "description": "Expiration Date",
      "format": "date-time"
    },
    "isFree": {
      "type": "boolean",
      "description": "Is domain free"
    },
    "nameServers": {
      "type": "array",
      "description": "Name Servers",
      "items": {
        "type": "string"
      }
    },
    "isRegistrarLock": {
      "type": "boolean",
      "description": "Registrar Lock"
    },
    "isWhoisPrivacy": {
      "type": "boolean",
      "description": "Whois Privacy"
    },
    "subscriptionId": {
      "type": "integer",
      "description": "Subscription ID"
    }
  },
  "operations": {
    "update": {
      "path": "update",
      "verb": "PUT",
      "response": {
        "type": "DomainRegistrationInfo"
      },
      "errorResponse": {
        "type": "object"
      },
      "parameters": {
        "updateRegInfo": {
          "kind": "body",
          "type": "UpdateDomainRegistrationInfo"
        }
      }
    },
    "getEPPCode": {
      "path": "transferout",
      "verb": "GET",
      "response": {
        "type": "EPPCode"
      },
      "errorResponse": {
        "type": "object"
      }
    },
    "features": {
      "path": "features",
      "verb": "GET",
      "response": {
        "type": "DomainRegistrationInfoFeatures"
      },
      "errorResponse": {
        "type": "object"
      }
    }
  },
  "structures": {
    "DomainRegistrationInfoContact": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "phoneCountryCode": {
          "type": "string"
        },
        "phoneAreaCode": {
          "type": "string"
        },
        "phoneNumber": {
          "type": "string"
        },
        "phoneExtension": {
          "type": "string"
        },
        "company": {
          "type": "string"
        },
        "country": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "address1": {
          "type": "string"
        },
        "address2": {
          "type": "string"
        },
        "zipCode": {
          "type": "string"
        }
      }
    },
    "UpdateDomainRegistrationInfo": {
      "type": "object",
      "properties": {
        "nameServers": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ownerUid": {
          "type": "string"
        },
        "adminUid": {
          "type": "string"
        },
        "billingUid": {
          "type": "string"
        },
        "techUid": {
          "type": "string"
        },
        "owner": {
          "type": "DomainRegistrationInfoContact"
        },
        "admin": {
          "type": "DomainRegistrationInfoContact"
        },
        "billing": {
          "type": "DomainRegistrationInfoContact"
        },
        "tech": {
          "type": "DomainRegistrationInfoContact"
        },
        "isRegistrarLock": {
          "type": "boolean"
        },
        "isWhoisPrivacy": {
          "type": "boolean"
        },
        "subscriptionId": {
          "type": "integer"
        }
      }
    },
    "EPPCode": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string"
        },
        "isPending": {
          "type": "boolean"
        }
      }
    },
    "DomainRegistrationInfoFeatures": {
      "type": "object",
      "properties": {
        "supportsTransfer": {
          "type": "string",
          "required": true,
          "default": "OS_AUTO",
          "enum": [
            "OS_AUTO",
            "OS_NOT_SUPPORTED"
          ]
        },
        "supportsCancellation": {
          "type": "string",
          "required": true,
          "default": "OS_AUTO",
          "enum": [
            "OS_AUTO",
            "OS_NOT_SUPPORTED"
          ]
        },
        "transferKeyRequired": {
          "type": "boolean"
        },
        "freeTransferSupported": {
          "type": "boolean"
        },
        "editNameServers": {
          "type": "boolean"
        },
        "contactManagementSupported": {
          "type": "string",
          "required": true,
          "default": "UCOS_AUTO",
          "enum": [
            "UCOS_AUTO",
            "UCOS_NOT_SUPPORTED"
          ]
        },
        "idnAllowed": {
          "type": "boolean"
        },
        "registrarLockSupported": {
          "type": "boolean"
        },
        "transferOutSupported": {
          "type": "boolean"
        }
      }
    }
  }
}

Properties

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
creationDate	String	Not Required		Date of the domain registration.
isFree	Boolean	Not Required		Specifies if the domain is free (true). A subdomain of a provider’s domain is normally free for customers.
isRegistrarLock	Boolean	Not Required		If true, the domain is locked to the current registrar.
isWhoisPrivacy	Boolean	Not Required		If true, the domain registration contacts are hidden from public whois requests.
nameServers	String array	Not Required		A list of name servers the domain is hosted on.
registrarExpirationDate	String	Not Required		Expiration date of the domain registration.
registrarStatus	String	Not Required		Shows one of the registration states of the domain: “Registering”, “Registered”, etc.
subscriptionId	Integer	Not Required		The platform internal subscription ID.
updatedDate	String	Not Required		Date of the latest domain registration update.

Relationship

NAME	TYPE	REQUIRED	DESCRIPTION
admin	PAUser	No	The contact registered as the Administrator of the domain.
billing	PAUser	No	The contact registered as the Billing contact of the domain.
owner	PAUser	No	The contact registered as the Owner/Holder/Registrant of the domain.
tech	PAUser	No	The contact registered as the Technical contact of the domain.
zone	HostedDomain	Yes	DNS zone that is used to host the domain.

Custom Operations

OPERATION	VERB	PATH	RETURNS	Description
features	GET	features	The DomainRegistrationInfoFeatures structure	Get the domain registration data in the format of the DomainRegistrationInfoFeatures structure.
getEPPCode	GET	transferout	EPPcode	Get the EPP code (from the current registrar). This is normally used to transfer the domain to another registrar.
update	PUT	update	If successful, this method returns the 200 OK standard status code.	Update the domain registration information.

features

HTTP Request

GET /aps/2/resources/{aps-id}/features

Description

Get the domain registration data in the format of the DomainRegistrationInfoFeatures structure.

Returns

The DomainRegistrationInfoFeatures structure

getEPPCode

HTTP Request

GET /aps/2/resources/{aps-id}/transferout

Description

Get the EPP code (from the current registrar). This is normally used to transfer the domain to another registrar.

Returns

EPPcode

update

HTTP Request

PUT /aps/2/resources/{aps-id}/update

Description

Update the domain registration information.

Parameters

PARAMETER	TYPE	DESCRIPTION
updateRegInfo	UpdateDomainRegistrationInfo	UpdateDomainRegistrationInfo

Returns

If successful, this method returns the 200 OK standard status code.

Structures

DomainRegistrationInfoContact

Domain registration contact with the personal information.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
address1	String	Not Required		Address 1.
address2	String	Not Required		Address 2.
city	String	Not Required		City.
company	String	Not Required		Company name.
country	String	Not Required		Country.
email	String	Not Required		Email address.
firstName	String	Not Required		First name.
lastName	String	Not Required		Last name.
phoneAreaCode	String	Not Required		Country area code on the phone number.
phoneCountryCode	String	Not Required		Country code in the phone number.
phoneExtension	String	Not Required		Phone number extension.
phoneNumber	String	Not Required		Phone number.
state	String	Not Required		State.
zipCode	String	Not Required		Zip code.

DomainRegistrationInfoFeatures

A set of features available for a registered domain.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
contactManagementSupported	String	Required	UCOS_AUTO	Contact management
editNameServers	Boolean	Not Required		Edit name servers
freeTransferSupported	Boolean	Not Required		Free transfer supported
idnAllowed	Boolean	Not Required		Idn allowed
registrarLockSupported	Boolean	Not Required		Registrar lock supported
supportsCancellation	String	Required	OS_AUTO	Supports cancellation
supportsTransfer	String	Required	OS_AUTO	Supports transfer
transferKeyRequired	Boolean	Not Required		Transfer key required
transferOutSupported	Boolean	Not Required		Transferout supported

EPPCode

EPP code structure that contains the code itself and indicates if the code retrieval is completed.

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
code	String	Not Required		EPP code.
isPending	Boolean	Not Required		Is Pending - field is used to specify whether EPPCode retrieval operation is finished (false) or not (true).

UpdateDomainRegistrationInfo

Update domain registration info

NAME	TYPE	ATTRIBUTES	DEFAULT	DESCRIPTION
admin	DomainRegistrationInfoContact	Not Required		Administrative contact.
adminUid	String	Not Required		Administrative contact UID.
billing	DomainRegistrationInfoContact	Not Required		Billing contact.
billingUid	String	Not Required		Billing contact UID.
isRegistrarLock	Boolean	Not Required		Specifies if the registrar locked the domain modifications.
isWhoisPrivacy	Boolean	Not Required		Specifies if the privacy data is protected.
nameServers	String array	Not Required		List of Name servers.
owner	DomainRegistrationInfoContact	Not Required		Owner contact.
ownerUid	String	Not Required		Owner contact UID.
subscriptionId	Integer	Not Required		Subscription ID.
tech	DomainRegistrationInfoContact	Not Required		Technical contact.
techUid	String	Not Required		Technical contact UID.

Examples

Please find general description of create-read-update-delete (CRUD) operations with resources, properties, and structures respectively at:

• Provisioning Resources
• Getting Resource List
• Resource Configuration
• Unprovisioning Resources

Since the considered APS type contains custom operations, refer to Custom Operations for the general explanation of their structure and examples of operation calls.

← DomainManagement

DomainService →