SWsoft SiteBuilder Integration API v3.2 Reference

PlanWebService.GetPlanBySite Method 

 [This is preliminary documentation and subject to change.]

Get Plan by site ID

[C#]
public PlanValue GetPlanBySite(
   string siteId
);

Parameters

siteId
Site ID

Return Value

PlanValue that represents current Plan for a specified site

Example SOAP 1.1

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

<?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/PlanService/v_3_2">
      <Login>string</Login>
      <Password>string</Password>
    </CredentialsSoapHeader>
  </soap:Header>
  <soap:Body>
    <GetPlanBySite xmlns="http://swsoft.com/SiteBuilder/PlanService/v_3_2">
      <siteId>string</siteId>
    </GetPlanBySite>
  </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>
    <GetPlanBySiteResponse xmlns="http://swsoft.com/SiteBuilder/PlanService/v_3_2">
      <GetPlanBySiteResult>
        <OwnerId>string</OwnerId>
        <PlanId>string</PlanId>
        <CreationDate>dateTime</CreationDate>
        <Name>string</Name>
        <Description>string</Description>
        <MaxPagesNumber>int</MaxPagesNumber>
        <MaxPagesRootLevel>int</MaxPagesRootLevel>
        <MaxPagesLevel>int</MaxPagesLevel>
        <MaxSitesNumber>int</MaxSitesNumber>
        <MaxAccountsNumber>int</MaxAccountsNumber>
        <MaxHostsNumber>int</MaxHostsNumber>
        <IsPersonal>boolean</IsPersonal>
        <IsAnonymous>boolean</IsAnonymous>
        <IsActive>boolean</IsActive>
        <PersonFullName>string</PersonFullName>
        <AssignedAccountsNumber>int</AssignedAccountsNumber>
        <TrialLifeTime>int</TrialLifeTime>
        <TrialLifeType>Days or Hours</TrialLifeType>
        <Templates>
          <string>string</string>
          <string>string</string>
        </Templates>
        <Pagesets>
          <string>string</string>
          <string>string</string>
        </Pagesets>
        <Hosts>
          <string>string</string>
          <string>string</string>
        </Hosts>
        <Modules>
          <string>string</string>
          <string>string</string>
        </Modules>
        <SiteFamilies>
          <string>string</string>
          <string>string</string>
        </SiteFamilies>
        <DefaultSiteFamilyId>string</DefaultSiteFamilyId>
      </GetPlanBySiteResult>
    </GetPlanBySiteResponse>
  </soap:Body>
</soap:Envelope>

See Also

PlanWebService Web Service | Web services