SWsoft SiteBuilder Integration API v3.2 Reference

SiteWebService.GetSiteById Method 

 [This is preliminary documentation and subject to change.]

Get site with specified id

[C#]
public SiteValue GetSiteById(
   string id
);

Parameters

id
Site ID

Return Value

Value object of a site with the specified id, or null if the site with such id is not found or not in the principal's tree.

Example SOAP 1.1

Request
POST /ServiceFacade/version_3_2/SiteWebService.asmx HTTP/1.1
Host: sitebuilder.swsoft.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://swsoft.com/SiteBuilder/SiteService/v_3_2/GetSiteById"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <CredentialsSoapHeader xmlns="http://swsoft.com/SiteBuilder/SiteService/v_3_2">
      <Login>string</Login>
      <Password>string</Password>
    </CredentialsSoapHeader>
  </soap:Header>
  <soap:Body>
    <GetSiteById xmlns="http://swsoft.com/SiteBuilder/SiteService/v_3_2">
      <id>string</id>
    </GetSiteById>
  </soap:Body>
</soap:Envelope>
Response
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSiteByIdResponse xmlns="http://swsoft.com/SiteBuilder/SiteService/v_3_2">
      <GetSiteByIdResult>
        <Id>string</Id>
        <Alias>string</Alias>
        <OwnerId>string</OwnerId>
        <OwnerUserName>string</OwnerUserName>
        <IsActive>boolean</IsActive>
        <PublishingSettings>
          <Id>string</Id>
          <StandardLocation>
            <Address>string</Address>
            <UserName>string</UserName>
            <Password>string</Password>
            <WorkingDirectory>string</WorkingDirectory>
            <WebSiteUrl>string</WebSiteUrl>
            <IsAnonymous>boolean</IsAnonymous>
            <Veid>long</Veid>
            <VerifyStatus>Unverified or LocationError or UnknownError or StaticOnly or Dynamic</VerifyStatus>
            <LastVerifyAttempt>dateTime</LastVerifyAttempt>
          </StandardLocation>
          <FtpLocation>
            <Address>string</Address>
            <UserName>string</UserName>
            <Password>string</Password>
            <WorkingDirectory>string</WorkingDirectory>
            <WebSiteUrl>string</WebSiteUrl>
            <IsAnonymous>boolean</IsAnonymous>
            <Veid>long</Veid>
            <VerifyStatus>Unverified or LocationError or UnknownError or StaticOnly or Dynamic</VerifyStatus>
            <LastVerifyAttempt>dateTime</LastVerifyAttempt>
          </FtpLocation>
          <Mode>XCopy or Ftp or Vps</Mode>
          <Scenario>Standard or FreeSwsoftHosting or AnyFtp</Scenario>
        </PublishingSettings>
        <LastPublishingSettings>
          <Id>string</Id>
          <StandardLocation>
            <Address>string</Address>
            <UserName>string</UserName>
            <Password>string</Password>
            <WorkingDirectory>string</WorkingDirectory>
            <WebSiteUrl>string</WebSiteUrl>
            <IsAnonymous>boolean</IsAnonymous>
            <Veid>long</Veid>
            <VerifyStatus>Unverified or LocationError or UnknownError or StaticOnly or Dynamic</VerifyStatus>
            <LastVerifyAttempt>dateTime</LastVerifyAttempt>
          </StandardLocation>
          <FtpLocation>
            <Address>string</Address>
            <UserName>string</UserName>
            <Password>string</Password>
            <WorkingDirectory>string</WorkingDirectory>
            <WebSiteUrl>string</WebSiteUrl>
            <IsAnonymous>boolean</IsAnonymous>
            <Veid>long</Veid>
            <VerifyStatus>Unverified or LocationError or UnknownError or StaticOnly or Dynamic</VerifyStatus>
            <LastVerifyAttempt>dateTime</LastVerifyAttempt>
          </FtpLocation>
          <Mode>XCopy or Ftp or Vps</Mode>
          <Scenario>Standard or FreeSwsoftHosting or AnyFtp</Scenario>
        </LastPublishingSettings>
        <HostId>string</HostId>
        <ResellerId>string</ResellerId>
        <ResellerUserName>string</ResellerUserName>
        <CreationDate>dateTime</CreationDate>
      </GetSiteByIdResult>
    </GetSiteByIdResponse>
  </soap:Body>
</soap:Envelope>

See Also

SiteWebService Web Service | Web services