Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleColor#FFFFFF
titleBGColor#E44313
titleTable of Contents

Table of Contents
outlinetrue
stylenone

Function

The DomainCancelationCreate 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 Cancelation Status Constants page.

SP Tabs group
dispositionhorizontal
SP Tab pane
anchor2286824
nameJSON

Route: POST /domain/{name}/cancelation

Code Block
titleRequest
linenumberstrue
collapsetrue
{
   "domain": "example.com",
   "disconnect": false,
   "type": "DELETE",
   "execution": "EXPIRE"
}
Code Block
titleResponse
linenumberstrue
collapsetrue
{
    "stid": "20190701-app3-dev-9689",
    "messages": [
        {
            "text": "The task will be executed at domain expiration.",
            "code": "MSG010315",
            "status": "NOTICE"
        }
    ],
    "status": {
        "code": "S0103101N0103101",
        "text": "Domain cancelation hastask beenwas created successfullytransmitted.",
        "type": "SUCCESSNOTIFY"
    },
    "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"
        }
    ]
}
SP Tab pane
anchor87031
nameXML

Task code: 0103101
Uses Cancelation object.

Code Block
languagexml
titleRequest
linenumberstrue
collapsetrue
<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>
Code Block
titleResponse
linenumberstrue
collapsetrue
<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>