Server.getSitesList (Method)
Returns zero or more structures, each containing information about a server's sites; for example, inactive, read only, and so on.
Returns:
Server_GetSitesList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CustomerID | CurrentCustomerID | The hosting customer's ID. |
| CustomerKey | PlainText_255 | The customer key associated with this customer. |
| CustomerName | PlainText_NonNull_100 | The name of the customer under which the site has been created. |
| DataSourceName | PlainText_NonNull_255 | The name of the data source pointing to the 'sites' database. |
| Description | PlainText_NonNull_2000 | The site's description. |
| Mapping | PlainText_NonNull | The mapping to the site. |
| Name | PlainText_NonNull_50 | The site's name. |
| RootPath | PlainText_NonNull_255 | The file system path to the site's root directory. |
| RootURL | PlainText_NonNull_255 | The site's URL. |
| SiteID | AnySiteID | The site's ID. |
| SiteState | SiteState | An integer representing the site's state. Common values include 0 (Inactive), 1 (Active), and 99 (In progress). |
| UsersDataSourceName | PlainText_NonNull_255 | The name of the data source pointing to the 'users' database. |
Context:
| License Requirements | None |
| Permission Requirements | server:ShowServerAdmin |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None