Contacts.getList (Method)
Returns zero or more structures, each containing information on contacts assigned to a page.
Returns:
GetContacts_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
ContactTypeID | ContactTypeID | The contact type's ID. |
ContactTypeName | PlainText_NonNull | The contact type's name. |
Description | PlainText | The contact type's description. |
EmailAddress | The contact's email address. | |
FirstName | PlainText_50 | The contact's first name. |
LastName | PlainText_NonNull_50 | The contact's last name. |
MiddleName | PlainText_50 | The contact's middle name. |
Phone | PlainText_40 | The contact's phone number. |
UserID | UserID | The contact's user ID. |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
objectID | PageIDImageIDMultimediaID | Required | A CommonSpot pageID as saved in sitepages table. |
contactTypeID | ContactTypeID_0 | Optional. Defaults to '0'. | The ID of the type of contacts to be returned. If this value is 0, CommonSpot returns information for all contact types. |
userID | UserID_0 | Optional. Defaults to '0'. | The contact's user ID. If this value is 0, CommonSpot returns information for all users. |
Context:
License Requirements | None |
Permission Requirements | ContributorOrServerCode |
Deny Context | None |
Require Context | None |
Author Lock |
Error Codes:
None
Notes:
None