PlanWebService.CreatePlan Method 

Creates 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[] evaluationModulesIds,
   string[] hostsIds,
   string[] families,
   string defaultFamily,
   bool isPublishingSettingsEditable,
   bool isFtpPublishAvailable,
   bool isXcopyPublishAvailable,
   bool isVpsPublishAvailable,
   bool isAdditionalSiteContentAllowed,
   string additionalSiteContent,
   bool isUserManagementAllowed,
   bool isSiteManagementAllowed
);

Parameters

name
Plan name.
description
Plan description.
maxPagesNumber
Maximum number of pages.
maxPagesRootLevel
Maximum number of root level pages.
maxPagesLevel
Maximum number of levels.
maxSitesNumber
Maximum number of sites.
maxAccountsNumber
Maximum number of accounts.
maxHostsNumber
Maximum number of hosts.
isPersonal
If true, the plan is be marked as a personal plan.
isAnonymous
If true, the plan is set as default plan for trial sites.
trialLifeTime
Limit for trial sites life-time.
trialLifeType
Type of life-time LifeTimeType.
templatesIds
List of template IDs.
pagesetsIds
List of page set IDs.
modulesIds
List of module IDs.
evaluationModulesIds
The list of the evaluation module IDs. This list should be a sublist of modulesIds. If the parameter value is null, then the "evaluation" flag for all modules will be set to false.
hostsIds
List of host IDs.
families
List of site family IDs.
defaultFamily
Default site family ID.
isPublishingSettingsEditable
If true, editing of publishing settings is allowed.
isFtpPublishAvailable
If true, FTP publish mode is allowed.
isXcopyPublishAvailable
If true, XCopy publish mode is allowed.
isVpsPublishAvailable
If true, VPS publish mode is allowed.
isAdditionalSiteContentAllowed
If true , resellers are allowed to place additional content specified by additionalSiteContent on sites of their users.
additionalSiteContent
Additional site content (see isAdditionalSiteContentAllowed).
isUserManagementAllowed
If true, the user management is allowed.
isSiteManagementAllowed
If true, the site management is allowed.

Return Value

Value objects represent a new plan.

Example SOAP 1.1

Request
POST /sbw_trunk/ServiceFacade/4.5/PlanWebService.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://swsoft.com/webservices/sb/4.5/PlanService/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/webservices/sb/4.5/PlanService">
      <Login>string</Login>
      <Password>string</Password>
    </CredentialsSoapHeader>
  </soap:Header>
  <soap:Body>
    <CreatePlan xmlns="http://swsoft.com/webservices/sb/4.5/PlanService">
      <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>
      <evaluationModulesIds>
        <string>string</string>
        <string>string</string>
      </evaluationModulesIds>
      <hostsIds>
        <string>string</string>
        <string>string</string>
      </hostsIds>
      <families>
        <string>string</string>
        <string>string</string>
      </families>
      <defaultFamily>string</defaultFamily>
      <isPublishingSettingsEditable>boolean</isPublishingSettingsEditable>
      <isFtpPublishAvailable>boolean</isFtpPublishAvailable>
      <isXcopyPublishAvailable>boolean</isXcopyPublishAvailable>
      <isVpsPublishAvailable>boolean</isVpsPublishAvailable>
      <isAdditionalSiteContentAllowed>boolean</isAdditionalSiteContentAllowed>
      <additionalSiteContent>string</additionalSiteContent>
      <isUserManagementAllowed>boolean</isUserManagementAllowed>
      <isSiteManagementAllowed>boolean</isSiteManagementAllowed>
    </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/webservices/sb/4.5/PlanService">
      <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>
        <EvaluationModules>
          <string>string</string>
          <string>string</string>
        </EvaluationModules>
        <SiteFamilies>
          <string>string</string>
          <string>string</string>
        </SiteFamilies>
        <DefaultSiteFamilyId>string</DefaultSiteFamilyId>
        <IsUserManagementAllowed>boolean</IsUserManagementAllowed>
        <IsSiteManagementAllowed>boolean</IsSiteManagementAllowed>
        <IsPublishingSettingsEditable>boolean</IsPublishingSettingsEditable>
        <IsFtpPublishAvailable>boolean</IsFtpPublishAvailable>
        <IsXcopyPublishAvailable>boolean</IsXcopyPublishAvailable>
        <IsVpsPublishAvailable>boolean</IsVpsPublishAvailable>
        <IsAdditionalSiteContentAllowed>boolean</IsAdditionalSiteContentAllowed>
        <AdditionalSiteContent>string</AdditionalSiteContent>
      </CreatePlanResult>
    </CreatePlanResponse>
  </soap:Body>
</soap:Envelope>

See Also

PlanWebService Web Service | Web services