api_auth

<back to all web services

SitesRequest

SitesRequest Parameters:
NameParameterData TypeRequiredDescription
StartIndexqueryintNo
PerPagequeryintNo
OrderByquerystringNo
IncludeCountqueryboolNo
IncludeDataqueryboolNo
ParentableOnlyqueryboolNo
MyOnlyqueryboolNo
PagedListResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ItemsformT[]No
TotalCountformint?No
SiteOverview Parameters:
NameParameterData TypeRequiredDescription
SiteIDformlongNo
NameformstringNo
DomainformstringNo
DomainAliasesformstringNo
HasMailformboolNo
HasFilesformboolNo
DatacenterIDformbyte?No
SiteTypeformbyteNo
HostingStatusformbyteNo
PubNodeDcformstringNo
PubNodeIDformshort?No
FileRootIDformlong?No
LanguageIDformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/SitesRequest HTTP/1.1 
Host: 1.hyper.id 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	startIndex: 0,
	perPage: 0,
	orderBy: String,
	includeCount: False,
	includeData: False,
	parentableOnly: False,
	myOnly: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	items: 
	[
		{
			siteID: 0,
			name: String,
			domain: String,
			domainAliases: String,
			hasMail: False,
			hasFiles: False,
			datacenterID: 0,
			siteType: 0,
			hostingStatus: 0,
			pubNodeDc: String,
			pubNodeID: 0,
			fileRootID: 0,
			languageID: String
		}
	],
	totalCount: 0
}