Exception Domain APIs

Get Exception Domain

OVERVIEW

Overview

Get an Exception Domain from Publisher.  This API call is used to retrieve an Exception Domain from the system. The exception domain identifier is either it's id or else the domain itself.

Since v5.0

HTTP Request

GET  /api/2/exceptiondomains/<ID>

OR

GET  /api/2/exceptiondomains/<DOMAIN>

URL Parameters
Parameter Description
ID The ID of the exception domain to retrieve
DOMAIN The exception domain to retrieve

 

HTTP Headers
HTTP Request Header Description Example
Authorization The API Authorisation token "Bearer XXXXXXXXXXXXX"
Accept

The format of the expected response

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the default response given.

 "application/xml"
Content-Type

The format of the provided content

  • "application/json"
  • "application/xml"

If no parameter is set, JSON is the expected content by default.

 "application/json"

 

HTTP Response

Success

HTTP response 200 with Exception Domain object 

(Example below)

 

Domain doesn't exist Error

If the requested Exception Domain does not exist:

HTTP response 404

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error>
    <link>https://example.com/context/api/2/error/8928</link>
    <ref>149</ref>
    <summary>The requested exception domain does not exist</summary>
</error>

 

Example HTTP Request & Response

GET http://example.com/context/api/2/exceptiondomains/3

OR

GET http://example.com/context/api/2/exceptiondomains/unknown.com

 

JSON Response

{

    "domain": {

        "id": 3,

        "url": "unknown.com",

        "status": "Archive"

    }

}

 

 

Comments


0 Comments

Last Updated: Nov 08,2024