SystemWebService.FindSiteFamilies Method

Find Site Families

[C#]
public TotalListOfSiteFamilyValue FindSiteFamilies(
   string criteria,
   int pos,
   int count,
   SelectType select,
   SiteFamilyFields sortType,
   SortDirection sortDirection,
   string language
);

Parameters

criteria: Search criterion
pos: Position in search results list. The returned list of Site Families will start from the Site Family at this position
count: Maximum number of records to return (no more then PAGE_SIZE_MAX)
select: Selection type
sortType: Sort type
sortDirection: Sort direction
language: Language code. The language of returned Site Family presentation (if the required localization does not exist, the default language is used)

Return Value

A TotalList`1 of SiteFamilyValue that contains found Site Families

Example SOAP 1.1

Request
POST /ServiceFacade/version_3_2/SystemWebService.asmx HTTP/1.1 Host: sitebuilder.swsoft.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://swsoft.com/SiteBuilder/SystemService/v_3_2/FindSiteFamilies" <?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/SystemService/v_3_2"> <Login>string</Login> <Password>string</Password> </CredentialsSoapHeader> </soap:Header> <soap:Body> <FindSiteFamilies xmlns="http://swsoft.com/SiteBuilder/SystemService/v_3_2"> <criteria>string</criteria> <pos>int</pos> <count>int</count> <select>All or MyOnly</select> <sortType>Code or DefaultPageset or DefaultTemplateCategory or Title</sortType> <sortDirection>Ascending or Descending</sortDirection> <language>string</language> </FindSiteFamilies> </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> <FindSiteFamiliesResponse xmlns="http://swsoft.com/SiteBuilder/SystemService/v_3_2"> <FindSiteFamiliesResult> <TotalCount>int</TotalCount> <Items> <SiteFamilyValue> <Id>string</Id> <Code>string</Code> <DefaultPageset>string</DefaultPageset> <DefaultTemplateCategory>string</DefaultTemplateCategory> <IsBuiltIn>boolean</IsBuiltIn> <Presentation xsi:nil="true" /> </SiteFamilyValue> <SiteFamilyValue> <Id>string</Id> <Code>string</Code> <DefaultPageset>string</DefaultPageset> <DefaultTemplateCategory>string</DefaultTemplateCategory> <IsBuiltIn>boolean</IsBuiltIn> <Presentation xsi:nil="true" /> </SiteFamilyValue> </Items> </FindSiteFamiliesResult> </FindSiteFamiliesResponse> </soap:Body> </soap:Envelope>

Request

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

<?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/SystemService/v_3_2">
      <Login>string</Login>
      <Password>string</Password>
    </CredentialsSoapHeader>
  </soap:Header>
  <soap:Body>
    <FindSiteFamilies xmlns="http://swsoft.com/SiteBuilder/SystemService/v_3_2">
      <criteria>string</criteria>
      <pos>int</pos>
      <count>int</count>
      <select>All or MyOnly</select>
      <sortType>Code or DefaultPageset or DefaultTemplateCategory or Title</sortType>
      <sortDirection>Ascending or Descending</sortDirection>
      <language>string</language>
    </FindSiteFamilies>
  </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>
    <FindSiteFamiliesResponse xmlns="http://swsoft.com/SiteBuilder/SystemService/v_3_2">
      <FindSiteFamiliesResult>
        <TotalCount>int</TotalCount>
        <Items>
          <SiteFamilyValue>
            <Id>string</Id>
            <Code>string</Code>
            <DefaultPageset>string</DefaultPageset>
            <DefaultTemplateCategory>string</DefaultTemplateCategory>
            <IsBuiltIn>boolean</IsBuiltIn>
            <Presentation xsi:nil="true" />
          </SiteFamilyValue>
          <SiteFamilyValue>
            <Id>string</Id>
            <Code>string</Code>
            <DefaultPageset>string</DefaultPageset>
            <DefaultTemplateCategory>string</DefaultTemplateCategory>
            <IsBuiltIn>boolean</IsBuiltIn>
            <Presentation xsi:nil="true" />
          </SiteFamilyValue>
        </Items>
      </FindSiteFamiliesResult>
    </FindSiteFamiliesResponse>
  </soap:Body>
</soap:Envelope>

SystemWebService.FindSiteFamilies Method

Parameters

Return Value

Example SOAP 1.1

See Also