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

HTTP + XML

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

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

<SitesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <IncludeCount>false</IncludeCount>
  <IncludeData>false</IncludeData>
  <MyOnly>false</MyOnly>
  <OrderBy>String</OrderBy>
  <ParentableOnly>false</ParentableOnly>
  <PerPage>0</PerPage>
  <StartIndex>0</StartIndex>
</SitesRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SitesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common">
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bitpub.Api.Auth.Common" xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Common">
    <d2p1:SiteOverview>
      <d2p1:DatacenterID>0</d2p1:DatacenterID>
      <d2p1:Domain>String</d2p1:Domain>
      <d2p1:DomainAliases>String</d2p1:DomainAliases>
      <d2p1:FileRootID>0</d2p1:FileRootID>
      <d2p1:HasFiles>false</d2p1:HasFiles>
      <d2p1:HasMail>false</d2p1:HasMail>
      <d2p1:HostingStatus>0</d2p1:HostingStatus>
      <d2p1:LanguageID>String</d2p1:LanguageID>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PubNodeDc>String</d2p1:PubNodeDc>
      <d2p1:PubNodeID>0</d2p1:PubNodeID>
      <d2p1:SiteID>0</d2p1:SiteID>
      <d2p1:SiteType>0</d2p1:SiteType>
    </d2p1:SiteOverview>
  </Items>
  <TotalCount xmlns="http://schemas.datacontract.org/2004/07/Bitpub.Api.Common">0</TotalCount>
</SitesResponse>