SWsoft SiteBuilder Integration API v3.2 Reference

PlanWebService.FindPlans2 Method 

 [This is preliminary documentation and subject to change.]

The same as for FindPlans. This function is obsolete and remains only for compatibility.

[C#]
public TotalListOfPlanValue FindPlans2(
   string criteria,
   int startPos,
   int count,
   PlanFields sortField,
   SortDirection sortDirection,
   bool showPersonal
);

Parameters

criteria
Search criteria
startPos
Start position
count
Maximum number of records to return
sortField
Field/expression to sort by (PlanFields)
sortDirection
Sort direction (SortDirection)
showPersonal
true - personal only, false - regular only

Return Value

A TotalList`1 of PlanValue with found Plans

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

<?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>
    <FindPlans2 xmlns="http://swsoft.com/SiteBuilder/PlanService/v_3_2">
      <criteria>string</criteria>
      <startPos>int</startPos>
      <count>int</count>
      <sortField>Name or Description or CreationDate or MaxPagesNumber or MaxPagesLevel or MaxSitesNumber or MaxAccountsNumber or MaxHostsNumber or IsPersonal or IsDefault or IsAnonymous or IsActive or PersonFullName or AssignedAccountsNumber</sortField>
      <sortDirection>Ascending or Descending</sortDirection>
      <showPersonal>boolean</showPersonal>
    </FindPlans2>
  </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>
    <FindPlans2Response xmlns="http://swsoft.com/SiteBuilder/PlanService/v_3_2">
      <FindPlans2Result>
        <TotalCount>int</TotalCount>
        <Items>
          <PlanValue>
            <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 xsi:nil="true" />
            <Pagesets xsi:nil="true" />
            <Hosts xsi:nil="true" />
            <Modules xsi:nil="true" />
            <SiteFamilies xsi:nil="true" />
            <DefaultSiteFamilyId>string</DefaultSiteFamilyId>
          </PlanValue>
          <PlanValue>
            <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 xsi:nil="true" />
            <Pagesets xsi:nil="true" />
            <Hosts xsi:nil="true" />
            <Modules xsi:nil="true" />
            <SiteFamilies xsi:nil="true" />
            <DefaultSiteFamilyId>string</DefaultSiteFamilyId>
          </PlanValue>
        </Items>
      </FindPlans2Result>
    </FindPlans2Response>
  </soap:Body>
</soap:Envelope>

See Also

PlanWebService Web Service | Web services