Domain APIs

Get Domain

OVERVIEW

Get a domain to an organisation within Collaborate

This API call is used to get a domain to an organisation object in the system.

 

HTTP Request 

GET   /api/4/domains/<DOMAINID>

 

URL Parameters

 

Parameter Description
DOMAINID The ID of the domain

 

HTTP Response 

Success

HTTP response 200

Error

See  API Error messages 

Example

GET   http://example.com/context/api/4/domains/23

 

XML format response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<domain>
    <domainID>186</domainID>
    <name>highqShivani.com</name>
    <status>ACTIVE</status>
</domain>

 

JSON format response

{
    "domainID": 186,
    "name": "highqShivani.com",
    "status": "ACTIVE"
}

 

Error messages

 

Summary Ref Code (V4) Ref Code (before V4)

The given domain id is invalid

263 N/A

 

 

Comments


0 Comments

Last Updated: Jun 10,2023