SWsoft SiteBuilder Integration API v3.2 Reference

PlanWebService.CreatePlan Method 

 [This is preliminary documentation and subject to change.]

Create a Plan 

[C#]
public PlanValue CreatePlan(
   string name,
   string description,
   int maxPagesNumber,
   int maxPagesRootLevel,
   int maxPagesLevel,
   int maxSitesNumber,
   int maxAccountsNumber,
   int maxHostsNumber,
   bool isPersonal,
   bool isAnonymous,
   int trialLifeTime,
   LifeTimeType trialLifeType,
   string[] templatesIds,
   string[] pagesetsIds,
   string[] modulesIds,
   string[] hostsIds,
   string[] families,
   string defaultFamily
);

Parameters

name
Plan name
description
Plan description
maxPagesNumber
Limit for maximum number of pages
maxPagesRootLevel
Limit for maximum number of root level pages
maxPagesLevel
Limit for maximum number of levels
maxSitesNumber
Limit for max number of sites
maxAccountsNumber
Limit for maximum number of accounts
maxHostsNumber
Limit for maximum number of hosts
isPersonal
If true Plan will be marked as a personal Plan
isAnonymous
If true Plan will be set as a default Plan for trial sites
trialLifeTime
Limit for trial sites life-time
trialLifeType
Type of life-time LifeTimeType
templatesIds
List of templates IDs
pagesetsIds
List of Page Sets IDs
modulesIds
List of modules IDs
hostsIds
List of hosts IDs
families
List of Site Families IDs
defaultFamily
Default Site Family ID

Return Value

Value objects represent a new Plan

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/CreatePlan"

<?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>
    <CreatePlan xmlns="http://swsoft.com/SiteBuilder/PlanService/v_3_2">
      <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>
      <trialLifeTime>int</trialLifeTime>
      <trialLifeType>Days or Hours</trialLifeType>
      <templatesIds>
        <string>string</string>
        <string>string</string>
      </templatesIds>
      <pagesetsIds>
        <string>string</string>
        <string>string</string>
      </pagesetsIds>
      <modulesIds>
        <string>string</string>
        <string>string</string>
      </modulesIds>
      <hostsIds>
        <string>string</string>
        <string>string</string>
      </hostsIds>
      <families>
        <string>string</string>
        <string>string</string>
      </families>
      <defaultFamily>string</defaultFamily>
    </CreatePlan>
  </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>
    <CreatePlanResponse xmlns="http://swsoft.com/SiteBuilder/PlanService/v_3_2">
      <CreatePlanResult>
        <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>
      </CreatePlanResult>
    </CreatePlanResponse>
  </soap:Body>
</soap:Envelope>

See Also

PlanWebService Web Service | Web services

Documentation version 3.2.0.