SiteMesh | Developers

The Person schema represents an individual user or contact in the SiteMesh system. It defines the structure of person records and the API endpoints for interacting with them.

Columns

Column ID	Type	Key	Filter	Options	Description
PersonID	TEXT	Yes	EQUALS	-	Unique identifier
PersonName	TEXT	No	LIKE	-	Full name
PersonGivenName	TEXT	No	LIKE	-	First/given name
PersonFamilyName	TEXT	No	LIKE	-	Last/family name
PersonEmail	TEXT	No	LIKE	-	Email address
PersonPhone	TEXT	No	EQUALS	-	Phone number
PersonStreet1	TEXT	No	LIKE	-	Address line 1
PersonStreet2	TEXT	No	LIKE	-	Address line 2
PersonCity	TEXT	No	EQUALS	-	City
PersonState	TEXT	No	EQUALS	-	State
PersonCountry	TEXT	No	EQUALS	-	Country
PersonPostCode	TEXT	No	EQUALS	-	Postal code
PersonRoles	TEXT	No	-	-	Roles (e.g., [admin])
PersonMarketing	TEXT	No	EQUALS	SUBSCRIBED, UNSUBSCRIBED	Marketing status
PersonActivity	TIMESTAMP	No	-	-	Last activity timestamp
PersonCreated	TIMESTAMP	No	-	-	Creation timestamp
PersonUpdated	TIMESTAMP	No	-	-	Last update timestamp
PersonDeleted	TIMESTAMP	No	EQUALS	-	Deletion timestamp

Columns with Key = Yes are unique identifiers.
Columns with Filter can be used in API queries for filtering results.
PersonMarketing accepts only: REQUESTED, SUBSCRIBED, UNSUBSCRIBED.

API Endpoints

All endpoints require a valid authentication token. Only users with [admin] role or the owner of the PersonID can access or modify their own record.

POST /person/count
Returns the count of person records matching the provided filters.
Body: JSON object with filter parameters (optional).
Permissions: [admin] or self.
Response: Number (as string).
POST /person/list
Returns a list of person records matching the provided filters.
Body: JSON object with filter parameters (optional).
Permissions: [admin] or self.
Response: JSON array of person objects.
POST /person/get
Retrieves a single person record by PersonID.
Body: { "PersonID": "<id>" }
Permissions: [admin] or self.
Response: JSON object of the person, or null if not found.
POST /person/save
Creates or updates a person record.
Body: JSON object with person fields.
Permissions: [admin] or self. Only admins can edit PersonRoles.
Response: JSON object of the saved person.

Security & Permissions

All endpoints require a valid token (TokenID and not expired).
Only [admin] users can access all records and edit roles.
Non-admins can only access or modify their own record and cannot change roles.

Sorting

Default sort: PersonName ascending.