Organisation APIs

Get Organisation Domain

OVERVIEW

Overview

Get an organisation domain from Publisher.  This API call is used to retrieve an organisation domain details from the system.

Since v5.0

HTTP Request

GET  /api/2/organisations/<ID>/domains/<DOMAIN>

OR

GET  /api/2/organisations/<ID>/domains/<DOMAINID>

URL Parameters
Parameter Description
ID The ID of the organisation to get the domain from
DOMAIN The domain name to be retrieved
DOMAINID The domain ID to be retrieved

 

HTTP Request Object

Domain object, either in JSON or XML format.

 

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

(Example below)

 

Error

See API Error messages

 

Example HTTP Request & Response

Change domain "highqsolutions.com" to "highq.com"

GET http://example.com/context/api/2/organisations/3/domains/highqsolutions.com

OR

GET http://example.com/context/api/2/organisations/3/domains/11

 

JSON Response

{

    "domain": {

        "id": 11,

        "url": "highqsolutions.com",

        "status": "Active"

    }

}

 

 

Comments


0 Comments

Last Updated: Nov 08,2024