> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_buildingsitemapping.md).

# stayntouch\_BuildingSiteMapping

{% hint style="info" %}
Generated from the staging database schema, with descriptions drafted by agents ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/db/tables/stayntouch_BuildingSiteMapping.md).
{% endhint %}

## Description

The Stayntouch connection of one building: auth and connect URLs, client ID and secret, hotel ID and webhook key.

<details>

<summary><strong>Table Definition</strong></summary>

```sql
CREATE TABLE `stayntouch_BuildingSiteMapping` (
  `id` int NOT NULL AUTO_INCREMENT,
  `uuid` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `uuid_tBuilding` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `auth_url` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `client_id` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `client_secret` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `api_version` varchar(10) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `connect_url` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `hotel_id` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `pms_customerName` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `webhook_apikey` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `fInActive` tinyint DEFAULT '0',
  `fDeleted` tinyint DEFAULT '0',
  `fCreatedTs` bigint DEFAULT NULL,
  `fModifiedTs` bigint DEFAULT NULL,
  `fDeletedTs` bigint DEFAULT NULL,
  `fServerTs` bigint DEFAULT NULL,
  `uuid_tUser_CreatedBy` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `uuid_tUser_ModifiedBy` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  `uuid_tUser_DeletedBy` varchar(255) CHARACTER SET latin1 COLLATE latin1_swedish_ci DEFAULT NULL,
  PRIMARY KEY (`id`) USING BTREE,
  UNIQUE KEY `uuid` (`uuid`) USING BTREE,
  KEY `fk_stayntouch_BuildingSiteMapping_uuid_tBuilding` (`uuid_tBuilding`) USING BTREE,
  CONSTRAINT `fk_stayntouch_BuildingSiteMapping_uuid_tBuilding` FOREIGN KEY (`uuid_tBuilding`) REFERENCES `tPri_Building` (`uuid`) ON DELETE RESTRICT ON UPDATE RESTRICT
) ENGINE=InnoDB DEFAULT CHARSET=latin1 ROW_FORMAT=DYNAMIC
```

</details>

## Columns

| Name                    | Type         | Default | Nullable | Extra Definition | Parents                                                                                     | Comment                                                                                                                                                         |
| ----------------------- | ------------ | ------- | -------- | ---------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                      | int          |         | false    | auto\_increment  |                                                                                             |                                                                                                                                                                 |
| uuid                    | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| uuid\_tBuilding         | varchar(255) |         | true     |                  | [tPri\_Building](https://docs.snapfix.com/engineering-reference/db/tables/tpri_building.md) |                                                                                                                                                                 |
| auth\_url               | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| client\_id              | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| client\_secret          | varchar(255) |         | true     |                  |                                                                                             | Stayntouch client secret, sent in the auth request and stored as plain text.                                                                                    |
| api\_version            | varchar(10)  |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| connect\_url            | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| hotel\_id               | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| pms\_customerName       | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| webhook\_apikey         | varchar(255) |         | true     |                  |                                                                                             | Key that identifies the building on the service's inbound and outbound endpoints and is the Basic-auth password of the internal API call; stored as plain text. |
| fInActive               | tinyint      | 0       | true     |                  |                                                                                             |                                                                                                                                                                 |
| fDeleted                | tinyint      | 0       | true     |                  |                                                                                             |                                                                                                                                                                 |
| fCreatedTs              | bigint       |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| fModifiedTs             | bigint       |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| fDeletedTs              | bigint       |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| fServerTs               | bigint       |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| uuid\_tUser\_CreatedBy  | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| uuid\_tUser\_ModifiedBy | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |
| uuid\_tUser\_DeletedBy  | varchar(255) |         | true     |                  |                                                                                             |                                                                                                                                                                 |

## Viewpoints

| Name                                                                                     | Definition                                                                                                                                                               |
| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [integrations](https://docs.snapfix.com/engineering-reference/db/tables/viewpoint-14.md) | Property management system (PMS) integrations (mappings, room statuses, inbound and outbound queues, webhooks), Deputy, and the keys of the Open API and the vendor API. |

## Constraints

| Name                                                 | Type        | Definition                                                     |
| ---------------------------------------------------- | ----------- | -------------------------------------------------------------- |
| fk\_stayntouch\_BuildingSiteMapping\_uuid\_tBuilding | FOREIGN KEY | FOREIGN KEY (uuid\_tBuilding) REFERENCES tPri\_Building (uuid) |
| PRIMARY                                              | PRIMARY KEY | PRIMARY KEY (id)                                               |
| uuid                                                 | UNIQUE      | UNIQUE KEY uuid (uuid)                                         |

## Indexes

| Name                                                 | Definition                                                                             |
| ---------------------------------------------------- | -------------------------------------------------------------------------------------- |
| fk\_stayntouch\_BuildingSiteMapping\_uuid\_tBuilding | KEY fk\_stayntouch\_BuildingSiteMapping\_uuid\_tBuilding (uuid\_tBuilding) USING BTREE |
| PRIMARY                                              | PRIMARY KEY (id) USING BTREE                                                           |
| uuid                                                 | UNIQUE KEY uuid (uuid) USING BTREE                                                     |

## Relations

```mermaid
erDiagram

"stayntouch_BuildingSiteMapping" }o--o| "tPri_Building" : "FOREIGN KEY (uuid_tBuilding) REFERENCES tPri_Building (uuid)"

"stayntouch_BuildingSiteMapping" {
  int id PK
  varchar_255_ uuid_tBuilding FK
}
"tPri_Building" {
  int id PK
  varchar_255_ uuid
  varchar_255_ uuid_tParent FK
  varchar_255_ uuid_tUser_CreatedBy FK
}
```

***

> Generated by [tbls](https://github.com/k1LoW/tbls)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/engineering-reference/db/tables/stayntouch_buildingsitemapping.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
