Domain APIs

Domain list

OVERVIEW

Get a domain list in an organisation within Collaborate

This API call is used to get list of domains in an organisation object in the system.

 

HTTP Request

GET    /api/4/domains?orgid=<ORGID>&search=divyang&ordertype=domainname&orderby=desc

 

URL Parameters

Parameter

Format

Description

ORGID

Number

The ID of the organisation

search (Optional) String  
ordertype (Optional) String  
orderby (Optional) String  

 

HTTP Response

Success

HTTP response 200

Error

See  API Error messages 

Example

GET   http://example.com/context/api/4/domains?ordid=<ORGID>&search=divyang&ordertype=domain&orderby=desc
 

XML format response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<domains>
    <total>3</total>
    <totalCount>3</totalCount>
    <domain>
        <domainID>172</domainID>
        <name>charan1231Divyangnananana3131313.com</name>
        <status>Active</status>
    </domain>
    <domain>
        <domainID>184</domainID>
        <name>demo</name>
        <status>Active</status>
    </domain>
    <domain>
        <domainID>186</domainID>
        <name>highqShivani.com</name>
        <status>Active</status>
    </domain>
</domains>

 

JSON format response

{
    "total": 3,
    "totalCount": 3,
    "domain": [
        {
            "domainID": 172,
            "name": "charan1231Divyangnananana3131313.com",
            "status": "Active"
        },
        {
            "domainID": 184,
            "name": "demo",
            "status": "Active"
        },
        {
            "domainID": 186,
            "name": "highqShivani.com",
            "status": "Active"
        }
    ]
}

 

Error messages

 

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

The Organisation id is invalid

260 N/A

The given domain id is invalid

263 N/A

The organisation id does not match with the domain id

264 N/A

The ordertype is Invalid.

289 N/A

The orderby value is invalid. Please use either asc or desc

290 N/A

 

Comments


0 Comments

Last Updated: Jun 10,2023