Exception domain APIs

Exception domain list

OVERVIEW

 

Overview

This API call is used to get list of exception domain objects in the system.

 

HTTP Request

GET /api/5/exceptiondomains?search=divyang&ordertype=domainname&orderby=desc

 

URL Query Parameters

Parameter

Format

Description

search (optional)

String

This returns list of DOMAINS whose domain name like given in the parameter.

ordertype (optional)

String

This returns a list of domains on a specified sort type. The default sort type is domain name.

Possible fields: domainname

orderby (optional)

String

This sorts the result on ordertype. The default value of orderby is asc.

Possible Values: asc and desc

 

HTTP Response

Success

HTTP response 200

Error

See API Error messages

Example

GET http://example.com/context/api/5/exceptiondomains?search=divyang&ordertype=domainname&orderby=desc

 

XML format

<domains>
	<total>74</total>
	<totalCount>70</totalCount>
	<domain>
		<domainID>1</domainID>
		<name>highq.com</name>
		<status>ARCHIVE</status>
	</domain>
</domains>

 

JSON format

 {
	"total": "74",
	"totalCount": "70",
	"domain": {
		"domainID": "1",
		"name": "highq.com",
		"status": "ARCHIVE"
	}
}

 

Error messages

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

The given domain id is invalid

 263 N/A

The ordertype is invalid.

 289 N/A

The orderby value is invalid. Please use either ascending or descending

 290 N/A

Comments


0 Comments

Last Updated: Jun 10,2023