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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"startIndex":0,"perPage":0,"orderBy":"String","includeCount":false,"includeData":false,"parentableOnly":false,"myOnly":false}
HTTP/1.1 200 OK
Content-Type: application/json
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}