Server.getHostingCustomerList (Method)
Returns one or more structures, each containing basic information about hosting customers configured for this server.
Returns:
GetHostingCustomerList_results (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CustomizationMapping | PlainText | If not empty, the ColdFusion mapping usable to access customer-specific command customizations. |
| DateAdded | Datetime | The date and time at which CommonSpot created the customer record. |
| DefaultContributorType | NonNegativeInteger | An integer representing the contributor type to which CommonSpot assigns new users. |
| Description | PlainText_2000 | The hosting customer's description. |
| DomainName | PlainText_255 | The name of the domain against which authentication is performed if NT Authentication is enabled; otherwise this is an empty string. |
| ForeignKeyName | PlainText_255 | If this is a replication target server, this is the key name of the master server that initialized the replication. If it is not a replication target, this field is an empty string. |
| ID | CurrentCustomerID | The ID of the hosting customer record. |
| IsReadOnly | Boolean | Boolean flag which when set to true indicates that the customer is on a read-only server. |
| KeyName | PlainText_255 | The name of this customer's customer key. |
| Name | PlainText_NonNull_255 | The hosting customer's name. |
| NTSecurityServerName | PlainText_255 | The name of the server that authenticates this customer's users. |
| RecordType | Integer | If this hosting customer is a replication target, this field's value is 2; otherwise it is 0. |
| UseNTAuthentication | Boolean | Boolean flag which when set to true indicates that NT Authentication is enabled. |
| UsersDataSource | PlainText_NonNull_255 | The name of the data source pointing to this customer's 'users' database. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| customerID | CustomerID_0_NEG1 | Required | ID of customer to return information for, or -1 to return information for all configured customers. |
Context:
| License Requirements | None |
| Permission Requirements | server:ManageCustomers |
| 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