Suche in diesem Bereich

Skip to end of metadata
Go to start of metadata


Table of Contents

Function

The CancelationCreate task creates a domain cancelation.

Description

The keyword description of the domain element can be found on the Cancelation Object page.
The  description of the cancelation status can be found on CancelationStatusConstants page.


Route: POST /domain/{name}/cancelation

Request
{
   "domain": "example.com",
   "disconnect": false,
   "type": "DELETE",
   "execution": "EXPIRE"
}
Response
{
    "stid": "20190701-app3-dev-9689",
    "messages": [
        {
            "text": "The task will be executed at domain expiration.",
            "code": "MSG010315",
            "status": "NOTICE"
        }
    ],
    "status": {
        "code": "S0103101",
        "text": "Domain cancelation has been created successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "DomainCancelation",
        "value": "example.com"
    },
    "data": [
        {
            "created": "2019-07-01T10:44:26.000+0200",
            "updated": "2019-07-01T10:44:26.000+0200",
            "owner": {
                "context": 4,
                "user": "exampleuser"
            },
            "updater": {
                "context": 4,
                "user": "exampleuser"
            },
            "domain": "example.com",
            "registryWhen": "2019-08-17T14:27:31.000+0200",
            "disconnect": false,
            "logId": 245139,
            "type": "DELETE",
            "execution": "EXPIRE"
        }
    ]
}

Task code: 0103101
Uses Cancelation object.

Request
<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context>4</context>
	</auth>
	<task>
		<code>0103101</code>
		<cancelation>
			<domain>example.com</domain>
			<type>delete</type>
			<execdate>expire</execdate>
			<disconnect>1</disconnect>
			<gaining_registrar></gaining_registrar>
		</cancelation>
		<reply_to>customer@example.com</reply_to>
	</task>
</request>
Response
<response>
	<result>
		<data>
			<cancelation>
				<execdate>now</execdate>
				<changed>2018-02-13 15:19:45</changed>
				<domain>example.com</domain>
				<type>DELETE</type>
				<registry_when_date>2018-02-13 15:19:44</registry_when_date>
				<log_id>186467</log_id>
				<created>2018-02-13 15:19:44</created>
			</cancelation>
			<domain_job>
				<job>
					<id>4295210830</id>
				</job>
			</domain_job>
		</data>
		<status>
			<code>N0103</code>
			<text>Domain deletion has been started successfully.</text>
			<type>notify</type>
			<object>
				<type>domain</type>
				<value>example.com</value>
			</object>
		</status>
	</result>
	<stid>20180213-app1-6072</stid>
</response>

Possible Error Messages

  • EF01030 An identical task is already being processed.
  • EF0103101 For this domain a cancelation request already exists.
  • EF0103106 Cancelation request type is missing.
  • EF01132 A renew request is currently processed..
  • EF01133 A restore request is currently in process.
  • MSG010311 The cancelation period was not kept. Execution is scheduled for the next period.
  • MSG010313 The specified execution date is not possible for this domain. It will be executed on expiration.
  • MSG010314 The domain will be returned to the registry (TRANSIT).
  • MSG010317 The domain can now be transferred away from the current registrar for the next 30 days (PREACK).