Add exception domain

Exception domain APIs

OVERVIEW

This API call is used to add a new exception domain to an organisation object in the system.

HTTP Request

POST /api/4/exceptiondomains

Example HTTP Request & Response

POST http://example.com/context/api/4/exceptiondomains

XML Request Example

<?xml version="1.0" encoding="UTF-8" ?>

<domain>

<url>exceptionaldomain.com</url>

<status>ACTIVE/PENDING/ARCHIVE</status>

</domain>

JSON Request Example

{

"url": "divyangupdate1Yashsadasdsdfsdfsdfu.com.us",

"status" : "active"

}

HTTP Response

Success

HTTP response 201

Error

See API Error messages

XML Success Response

<?xml version="1.0" encoding="UTF-8" ?>

<domain>

   <domainID>3</domainID>

   <name>exceptionaldomain</name>

   <link>https://divyanghp.local.com/divyang_4_live/api/4/exceptiondomains/3</link>

</domain>

XML Error Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<error>

<ref>403</ref>

<summary>The domain name 'divyangupdate1Yashsadasdsdfsdfsdfu.com.us' already exists in the system</summary>

</error>

Error messages

Summary	Ref Code (V4)	Ref Code (before V4)
A domain name is required	265	N/A
The domain name formatting is incorrect	266	N/A
The domain status is required	267	N/A
The domain status is invalid. It must either be active or pending	268	N/A
The domain name 'domainname.com' already exists	314	N/A

Comments

0 Comments

Last Updated: Jun 09,2023