Exception Domain APIs

Get Exception Domain List

OVERVIEW

Overview

Get a list of Exception Domains from Publisher.  This API call is used to retrieve a list of Exception Domains from the system.

Since v5.0

HTTP Request

GET  /api/2/exceptiondomains?{parameters}

 

URL Parameters
Parameter Format Description
search String Will search exception domain name fields for a matching string. This should be the same search in system
status  String

Filter for exception domains with a specific status

Status:  active | archive | pending
sort String

Allow ascending and descending sorting of a single field. 

GET /api/2/exceptiondomains?sort=-created

This returns a list of exception domains sorted by descending created date.

possible fields: created, status, url
limit String

Limits the number of exception domain returned. 

GET /api/2/exceptiondomains?offset=10&limit=5

Default: 200
offset String

Allows paging of exception domain. 

GET /api/2/exceptiondomains?offset=10&limit=5

Default: 0

 

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 a list of Exception Domain Summary Objects

(Example below)

 

Error

See  API Error messages 

 

Example HTTP Request & Response

Query String:  (search== gm AND (status == (Archive OR Pending)

GET http://example.com/context/api/2/exceptiondomains?search=gm&status=archive,pending

 

JSON Response

{

    "totalcount": 161,

    "total": 2,

    "currentpage": 0,

    "domains": [

        {

            "id": 76,

            "url": "gmail.com",

            "status": "Archive"

        },

        {

            "id": 121,

            "url": "gm.com",

            "status": "Pending"

        }

    ]

}

 

 

Comments


0 Comments

Last Updated: Nov 08,2024