Kiosk Integration API

Weave Living · Microsoft Dynamics 365 CRM · Korea (Seoul) properties · v1.0

Introduction #

This guide documents the REST endpoints the kiosk uses to talk directly to Weave Living's Microsoft Dynamics 365 (Dataverse) CRM. The CRM holds the property booking, the guests on that booking, the room and room-readiness state, and the guests' identification records.

There is no intermediate middleware for the CRM calls: the kiosk authenticates against Microsoft Entra ID, receives an access token, and calls the Dataverse Web API directly. The API is standard OData v4, so all the usual $select, $filter, $expand and $top query options are available.

What the kiosk is expected to do

Scope

This revision is scoped to the Korea (Seoul) properties. The majority of Korea guests are international visitors, so passport capture is the primary identification path and the documentation is written around it. Korean domestic documents are supported too — see Korea / Seoul Notes.

Environments & Base URLs #

Two environments are provided. Both host the same Korea properties — only the hostname changes between them. Build against UAT first; production access is granted once UAT sign-off is complete.

All Dataverse calls in this document are relative to that base, e.g.

https://weaveuat.crm5.dynamics.com/api/data/v9.2/acwapp_propertybookings

Authentication #

Dataverse is called with an OAuth 2.0 client-credentials bearer token issued by Microsoft Entra ID. There is no user sign-in; the kiosk authenticates as an application.

Get Access Token

The token is valid for 3,599 seconds (about one hour). Cache it and refresh it before it expires — do not request a new token on every call. A simple approach is to store the token alongside its expiry timestamp and renew when fewer than five minutes remain.

Request headers

Request body (form-urlencoded)

curl -X POST "https://login.windows.net/{{tenantId}}/oauth2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id={{clientId}}" \
  -d "client_secret={{clientSecret}}" \
  -d "resource=https://weaveuat.crm5.dynamics.com"

{
  "token_type": "Bearer",
  "expires_in": "3599",
  "ext_expires_in": "3599",
  "expires_on": "1768282179",
  "not_before": "1768278279",
  "resource": "https://weaveuat.crm5.dynamics.com",
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIs..."
}

Using the token

Send the token on every subsequent CRM request:

Authorization: Bearer {{access_token}}
Content-Type: application/json; odata.metadata=minimal

{
  "error": {
    "code": "0x80048306",
    "message": "ValidateAccessToken: Invalid or expired token."
  }
}

Conventions & Gotchas #

Date and time fields

Dataverse exposes two flavours of date column. This integration uses the timezone-independent columns, which are all suffixed timezoneindependent.

Fields you will write:

Lookup (relationship) fields

Lookups are read as _<logicalname>_value and written using the @odata.bind annotation. On write you must use the schema name with its original capitalisation, and the value is the singular collection path plus the record GUID in brackets.

{
  "acwapp_Nationality@odata.bind": "/acwapp_nationalities(52ba15a5-3796-ed11-aad1-000d3a85c990)",
  "acwapp_PropertyBooking@odata.bind": "/acwapp_propertybookings(dbc67724-351c-f111-8342-70a8a50132c4)"
}

Escaping in filters

• Single quotes in a filter value must be doubled: O'Brien becomes 'O''Brien'.
• + in e-mail addresses must be percent-encoded as %2B, otherwise it is decoded as a space and the lookup silently fails. occto888+steve@gmail.com becomes occto888%2Bsteve@gmail.com.
• Use straight quotes (') in filters. Copy-pasting from a word processor can substitute curly quotes (‘ ’) and the query will fail.
• Query options are separated by & and must be percent-encoded in the request line where your HTTP client requires it.

Response envelope

Collection queries return a value array. A query that matches nothing still returns 200 OK with an empty value array — it does not return 404. Always check the array length rather than relying on the status code.

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_propertybookings",
  "value": []
}

Useful request headers

Error Handling #

Dataverse uses standard HTTP status codes. The body carries a code and a human-readable message.

Error response format

{
  "error": {
    "code": "0x80040265",
    "message": "BookingOccupantCheckExceedLimit of Error Message: \r\n \t Max Occupancy Met: Max Occupancy: 2, Booking Occupant Count: 3"
  }
}

Korea / Seoul Notes #

Everything below is specific to the Korea properties and must be handled by the kiosk.

Identification — passports first

Most Korea guests are international visitors arriving with a passport. The passport is the primary identification document and the primary way a guest finds their booking.

• Scanning a passport yields the guest's full name (and usually passport number, nationality and date of birth). Use the name to locate the booking — see Get Booking Data and Get Booking Data via View.
• Store the passport number in acwapp_idnumber on the Contact, and set the identification type to Passport (557130000) — see Get or Update Identification Type.
• Nationality is a lookup on the Contact (_acwapp_nationality_value) resolved through Get Nationality.
• Passport expiry is not stored. There is no field for it, and one is not required. Read the date if you need it for your own validation, but do not attempt to send it.
• Passport data may be captured for guests of any age, including under-18s.

Accepted identification types

The acwapp_identificationtype option set supports these values. The ones you are most likely to use at a Korea kiosk are marked.

There is no separate option for a Korean Alien Registration Card (외국인등록증). Use one of the existing values above — in practice Passport for international guests.

Time zone

Korea is UTC+9 (Asia/Seoul) with no daylight saving. All *timezoneindependent values must be written as Seoul local wall-clock time — see Conventions. The check-out date check compares the guest's acwapp_contractenddatetimezoneindependent value directly; there is no separate business-date or cut-off rule to apply.

Currency and tax

Korea amounts are in KRW and are held in the CRM as VAT inclusive. When you display an amount, read the currency from the expanded transactioncurrencyid rather than assuming — see Get Booking Data. Do not apply your own tax calculation; display the value the CRM returns.

Telephone numbers

Korean mobile numbers are 010-0000-1111. Store the country calling code 82 in acwapp_countrycallingcode and the local subscriber number in telephone1. The kiosk's "phone number, last 4 digits" lookup key is matched against the stored number.

Language

The acwapp_language option set is used for acwapp_preferredlanguage. For a Korea kiosk the two values you will set most often are 557130003 (Korean) and 557130000 (English). Full list in Option Sets.

Room readiness must be checked before check-in

Before letting a guest complete check-in, call Get Room Status and confirm the room is Vacant Clean or Vacant Inspected. If it is not, stop the flow and ask the guest to speak to a member of staff. This check is required and is easy to overlook.

Check-in Flow #

This maps each kiosk screen to the calls it needs. Screen names are the ones used in the kiosk designs.

Reserved guest

Walk-in guest

Deferred  Out of scope for the first release.

The walk-in branch reuses the same endpoints. The differences are that no booking exists yet, the guest's details are captured from scratch, and a room must be chosen from available inventory. No endpoints exist today for walk-in room availability or for creating a Property Booking from the kiosk — see Scope & Open Items.

Check-out Flow #

GETGet Booking Data #

The first call in almost every flow. It returns the Property Booking plus the identifiers of everything hanging off it — the room type, the room, the bedroom offer (contract), the lead, and the contract start/end dates.

The booking number has the format PB-251126-001, which is also what a booking QR code contains. Bookings that originated on an OTA carry a separate wvlv_ota_booking_id.

Query parameters

Filter by booking number

$filter=acwapp_contractno eq 'PB-251126-001'

Filter by OTA booking id

$filter=wvlv_ota_booking_id eq 'E54545442342'

Search both in one call

$filter=contains(acwapp_contractno,'PB-260413-021') or contains(wvlv_ota_booking_id,'E54545442342')

Full example

curl -X GET "https://weaveuat.crm5.dynamics.com/api/data/v9.2/acwapp_propertybookings?\$top=1&\$filter=acwapp_contractno%20eq%20'PB-251126-001'&\$select=elpis_stayduration,acwapp_propertybookingid,_acwapp_lead_value,_acwapp_propertyunit_value,_acwapp_roomtype_value,_acwapp_room_value,_acwapp_bedroomoffer_value,acwapp_contractstartdatetimezoneindependent,acwapp_contractenddatetimezoneindependent,elpis_hotelcollect,acwapp_dailyrentincludegst&\$expand=transactioncurrencyid(\$select=isocurrencycode)" \
  -H "Content-Type: application/json; odata.metadata=minimal" \
  -H "Authorization: Bearer {{access_token}}"

Fields returned

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_propertybookings(...)",
  "value": [
    {
      "@odata.etag": "W/\"409774077\"",
      "elpis_stayduration": false,
      "elpis_hotelcollect": false,
      "acwapp_dailyrentincludegst": 404.7500000000,
      "acwapp_propertybookingid": "d624f82c-3a0e-f111-8407-7ced8dff82c4",
      "acwapp_contractno": "PB-260220-001",
      "_acwapp_roomtype_value": "9e9861de-50d9-ef11-8ee9-00224819b8e1",
      "_acwapp_room_value": "b1071fca-58d9-ef11-8ee9-6045bd58db72",
      "_acwapp_propertyunit_value": "346bb80b-4ad9-ef11-8ee9-6045bd5897bf",
      "_acwapp_bedroomoffer_value": "1dbd7f1a-3a0e-f111-8407-7ced8dff82c4",
      "_acwapp_lead_value": "64899436-330e-f111-8407-7ced8dff83b0",
      "acwapp_contractstartdatetimezoneindependent": "2026-02-20T15:00:00Z",
      "acwapp_contractenddatetimezoneindependent": "2026-02-25T11:00:00Z",
      "transactioncurrencyid": {
        "isocurrencycode": "KRW",
        "transactioncurrencyid": "b40f206f-5245-ed11-bba3-000d3a85685d"
      }
    }
  ]
}

{
  "error": {
    "code": "0x80048306",
    "message": "ValidateAccessToken: Invalid or expired token."
  }
}

GETGet Booking Data via View #

An alternative to Get Booking Data that queries a pre-defined CRM view instead of listing columns explicitly. Useful when you want a stable, curated column set without maintaining a long $select. Dataverse resolves the view's columns for you.

Reference: Retrieve and execute predefined queries.

The view is a Shared View on the Property Booking table named "Weave Suites – Sunyu Parkside", with userQuery id ad3660e7-fed0-f111-a05b-6045bd584bf7.

Filtering within the view

$filter=wvlv_ota_booking_id eq '1128148567166155' or acwapp_contractno eq '1128148567166155'

Any column exposed by the view can then be selected. For kiosk use, only wvlv_ota_booking_id and acwapp_contractno are used as lookup keys.

{
  "@odata.context": "https://weaveliving.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_propertybookings(...)",
  "value": [
    {
      "@odata.etag": "W/\"635976614\"",
      "statecode": 0,
      "acwapp_contractno": "PB-260703-014",
      "acwapp_name": "PB-260703-014 | Yin Ling Choi",
      "wvlv_ota_booking_id": "1128148567166155",
      "wvlv_lead_source": "OTA Trip.com (SG)",
      "acwapp_contractstatus": 557130002,
      "elpis_stayduration": false,
      "elpis_hotelcollect": false,
      "acwapp_dailyrentincludegst": 0.0000000000,
      "acwapp_propertybookingid": "71571fa3-8176-f111-ab0f-002248eda67a",
      "_acwapp_lead_value": "e5e01c4e-d468-f111-ab0d-000d3a813cf7",
      "_acwapp_roomtype_value": "1eb0e0fb-5ddc-ef11-a731-6045bd569c57",
      "_acwapp_room_value": "bac8f3d2-5edc-ef11-a732-0022481a1935",
      "_acwapp_propertyunit_value": "c95aa555-ffd9-ef11-a730-00224816074b",
      "_acwapp_bedroomoffer_value": "a00a1451-d468-f111-ab0c-002248ee2bb9",
      "acwapp_contractstartdatetimezoneindependent": "2026-07-31T15:00:00Z",
      "acwapp_contractenddatetimezoneindependent": "2026-08-03T11:00:00Z",
      "createdon": "2026-07-03T01:50:59Z"
    }
  ]
}

GETGet Stay Type #

Returns whether the booking is a short stay or a long stay. The kiosk uses this to decide which flow to present.

Query parameters

$filter=acwapp_contractno eq 'PB-251126-001'&$select=elpis_stayduration,acwapp_propertybookingid&$top=1

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_propertybookings(elpis_stayduration,acwapp_propertybookingid)",
  "value": [
    {
      "@odata.etag": "W/\"358897516\"",
      "elpis_stayduration": false,
      "acwapp_propertybookingid": "3cc241de-75ca-f011-8544-6045bd568dff"
    }
  ]
}

GETGet Room Type #

Resolves the room type's selling name and maximum occupancy, for display on the Guest Information screen and for enforcing the occupancy limit.

Query parameters

$top=1&$filter=acwapp_roomtypeid eq '{{_acwapp_roomtype_value}}'&$select=acwapp_sellingname,acwapp_maximumoccupancy

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_roomtypes(acwapp_sellingname,acwapp_maximumoccupancy)",
  "value": [
    {
      "@odata.etag": "W/\"264990959\"",
      "acwapp_roomtypeid": "bc69f400-9870-ed11-81ac-000d3a85c990",
      "acwapp_maximumoccupancy": 2,
      "acwapp_sellingname": "Central West Urban Suite"
    }
  ]
}

GETGet Room Status #

Returns the housekeeping status of the room. Only Vacant Clean and Vacant Inspected may proceed to check-in. Any other status means the room is not ready and the guest should be asked to contact staff.

Query parameters

$filter=acwapp_propertyunitid eq '{{_acwapp_room_value}}'&$select=acwapp_cleaningstatus

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_propertyunits(acwapp_cleaningstatus)",
  "value": [
    {
      "@odata.etag": "W/\"437493634\"",
      "acwapp_cleaningstatus": 557130000,
      "acwapp_propertyunitid": "b1071fca-58d9-ef11-8ee9-6045bd58db72"
    }
  ]
}

Cleaning status values

GETList Booking Occupants #

Returns everyone attached to a Property Booking, with their Booking Occupant id and their Contact id. This is the bridge between a booking and the guest records.

Query parameters

$filter=wvlv_propertybookingno eq 'PB-250123-006'
$select=_acwapp_contact_value,acwapp_bookingoccupantid,acwapp_firstname,acwapp_lastname,acwapp_email,acwapp_preferredlanguage

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_bookingoccupants(...)",
  "value": [
    {
      "@odata.etag": "W/\"295609373\"",
      "acwapp_bookingoccupantid": "0ede9310-5fd9-ef11-8ee9-000d3a8289bb",
      "acwapp_firstname": "Moses",
      "acwapp_lastname": "QQQ",
      "acwapp_email": "moses1qqq@a.com",
      "acwapp_preferredlanguage": 557130001
    },
    {
      "@odata.etag": "W/\"281228086\"",
      "acwapp_bookingoccupantid": "a687ab8d-8634-f011-8c4d-6045bd565ad1",
      "acwapp_firstname": "JJ",
      "acwapp_lastname": "Lin",
      "acwapp_email": "weavelivingtesting888+jjlin@gmail.com",
      "acwapp_preferredlanguage": null
    }
  ]
}

GETCheck for an Existing Contact #

Before creating a new accompanying guest, check whether a Contact already exists with that e-mail address. Running this first keeps the Contact table clean and lets you reuse an existing guest record.

Query parameters

$filter=emailaddress1 eq 'jane.doe@example.com'&$select=contactid

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#contacts(contactid)",
  "@Microsoft.Dynamics.CRM.totalrecordcount": -1,
  "@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded": false,
  "value": [
    {
      "@odata.etag": "W/\"440821850\"",
      "contactid": "85899436-330e-f111-8407-7ced8dff83b0"
    }
  ]
}

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#contacts(contactid)",
  "value": []
}

GETGet Contact by Email #

Fetches the full Contact record for a guest so you can read their country, calling code and telephone number. Use this when the guest is identified by e-mail rather than by a scanned document.

Query parameters

$select=fullname,firstname,lastname,emailaddress1,acwapp_countrycallingcode,telephone1,_acwapp_countrylookup_value
$filter=emailaddress1 eq 'occto888%2Bstevesmith@gmail.com'
$top=1

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#contacts(...)",
  "value": [
    {
      "@odata.etag": "W/\"244886719\"",
      "contactid": "e9bd5143-b7a7-ed11-aad1-000d3a81b0d8",
      "firstname": "Steve",
      "lastname": "Smith",
      "fullname": "Steve Smith",
      "emailaddress1": "occto888+stevesmith@gmail.com",
      "acwapp_countrycallingcode": "65",
      "telephone1": "6090 1145",
      "_acwapp_countrylookup_value": "f5dad402-c96f-ed11-81ac-000d3a85685d"
    }
  ]
}

POSTCreate Booking Occupant #

Creates a Booking Occupant for a guest who does not yet exist as a Contact. Use this for the primary guest and for any accompanying guest whose e-mail is not found by Check for an Existing Contact.

Request body

{
  "acwapp_firstname": "Jane",
  "acwapp_lastname": "Doe",
  "acwapp_email": "jane.doe@example.com",
  "acwapp_preferredlanguage": 557130000,
  "acwapp_primary": false,
  "acwapp_actualstaystartdatetimezoneindependent": "2026-02-20T15:00:00.000Z",
  "acwapp_actualstayenddatetimezoneindependent": "2026-02-25T11:00:00.000Z",
  "acwapp_PropertyUnit@odata.bind": "/acwapp_propertyunits(346bb80b-4ad9-ef11-8ee9-6045bd5897bf)",
  "acwapp_BedroomOffer@odata.bind": "/acwapp_bedroomoffers(1dbd7f1a-3a0e-f111-8407-7ced8dff82c4)",
  "acwapp_RoomType@odata.bind": "/acwapp_roomtypes(9e9861de-50d9-ef11-8ee9-00224819b8e1)",
  "acwapp_Room@odata.bind": "/acwapp_propertyunits(b1071fca-58d9-ef11-8ee9-6045bd58db72)",
  "acwapp_PropertyBooking@odata.bind": "/acwapp_propertybookings(d624f82c-3a0e-f111-8407-7ced8dff82c4)"
}

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_bookingoccupants/$entity",
  "@odata.etag": "W/\"358834313\"",
  "acwapp_bookingoccupantid": "0ede9310-5fd9-ef11-8ee9-000d3a8289bb",
  "wvlv_unit_number": "2601",
  "wvlv_main_entrance_image_url": "https://wlbooking.blob.core.windows.net/guides/cw-entrance-2024-11.jpg"
}

{
  "error": {
    "code": "0x80040265",
    "message": "BookingOccupantCheckExceedLimit of Error Message: \r\n \t Max Occupancy Met: Max Occupancy: 2, Booking Occupant Count: 3"
  }
}

POSTCreate Booking Occupant (Existing Contact) #

Creates a Booking Occupant for a guest who already exists as a Contact — the branch you take when Check for an Existing Contact returns a match.

The request body is the same shape as Create Booking Occupant, with the guest's details taken from the existing Contact record.

{
  "acwapp_firstname": "Winky",
  "acwapp_lastname": "Chong",
  "acwapp_email": "winky.chong@example.com",
  "acwapp_preferredlanguage": 557130000,
  "acwapp_primary": false,
  "acwapp_actualstaystartdatetimezoneindependent": "2026-03-14T15:00:00.000Z",
  "acwapp_actualstayenddatetimezoneindependent": "2026-03-20T11:00:00.000Z",
  "acwapp_PropertyUnit@odata.bind": "/acwapp_propertyunits(346bb80b-4ad9-ef11-8ee9-6045bd5897bf)",
  "acwapp_BedroomOffer@odata.bind": "/acwapp_bedroomoffers(5923c5e4-341c-f111-8342-70a8a50132c4)",
  "acwapp_RoomType@odata.bind": "/acwapp_roomtypes(0a3dc604-4fd9-ef11-8ee9-6045bd5897bf)",
  "acwapp_Room@odata.bind": "/acwapp_propertyunits(3277fe09-5ad9-ef11-8ee9-00224819b8e1)",
  "acwapp_PropertyBooking@odata.bind": "/acwapp_propertybookings(dbc67724-351c-f111-8342-70a8a50132c4)"
}

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_bookingoccupants/$entity",
  "@odata.etag": "W/\"447792011\"",
  "acwapp_bookingoccupantid": "a687ab8d-8634-f011-8c4d-6045bd565ad1",
  "wvlv_unit_number": "1218",
  "wvlv_main_entrance_image_url": null
}

GETGet Contact Details #

Reads the full Contact record for a guest, including nationality, identity number, calling code and current living location. Take the Contact id from List Booking Occupants.

Query parameters

$filter=contactid eq '{{_acwapp_contact_value}}'
$select=firstname,lastname,emailaddress1,_acwapp_nationality_value,acwapp_idnumber,acwapp_countrycallingcode,telephone1,_acwapp_currentlivinglocation_value

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#contacts(...)",
  "@Microsoft.Dynamics.CRM.totalrecordcount": -1,
  "value": [
    {
      "@odata.etag": "W/\"438985911\"",
      "contactid": "85899436-330e-f111-8407-7ced8dff83b0",
      "firstname": "Winky",
      "lastname": "Chong",
      "emailaddress1": "winky.chong@example.com",
      "acwapp_idnumber": null,
      "acwapp_countrycallingcode": "82",
      "telephone1": "010-0000-1111",
      "_acwapp_nationality_value": "50ba15a5-3796-ed11-aad1-000d3a85c990",
      "_acwapp_nationality_value@OData.Community.Display.V1.FormattedValue": "Korea, Republic of",
      "_acwapp_nationality_value@Microsoft.Dynamics.CRM.lookuplogicalname": "acwapp_nationality",
      "_acwapp_currentlivinglocation_value": "61c104e3-c86f-ed11-81ac-000d3a85685d",
      "_acwapp_currentlivinglocation_value@OData.Community.Display.V1.FormattedValue": "Korea, Republic of",
      "_acwapp_currentlivinglocation_value@Microsoft.Dynamics.CRM.lookuplogicalname": "acwapp_country"
    }
  ]
}

PATCHUpdate Contact Details #

Writes guest edits back to the Contact record — birthdate, nationality, preferred language.

Request body

{
  "birthdate": "1990-02-28",
  "acwapp_Nationality@odata.bind": "/acwapp_nationalities(52ba15a5-3796-ed11-aad1-000d3a85c990)"
}

Including preferred language

{
  "acwapp_preferredlanguage": 557130003,
  "birthdate": "1990-02-28",
  "acwapp_Nationality@odata.bind": "/acwapp_nationalities(52ba15a5-3796-ed11-aad1-000d3a85c990)"
}

(empty body)

GETGet or Update Identification Type #

Reads or writes the guest's identity document type on the Contact record. For international guests in Korea this is almost always Passport (557130000).

Get

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#contacts(acwapp_identificationtype)",
  "value": [
    {
      "@odata.etag": "W/\"438985911\"",
      "contactid": "85899436-330e-f111-8407-7ced8dff83b0",
      "acwapp_identificationtype": 557130000
    }
  ]
}

Update

{
  "acwapp_identificationtype": 557130000
}

(empty body)

Accepted values are listed in Korea / Seoul Notes and Option Sets. Remember that there is no Alien Registration Card option today.

PATCHUpdate Purpose of Stay #

Writes the guest's reason for staying. This field lives on the Lead, not the Contact — take _acwapp_lead_value from Get Booking Data.

{
  "acwapp_noofrooms": 1,
  "wvlv_purpose_of_stay": 557130004
}

(empty body)

Values for wvlv_purpose_of_stay are in Option Sets.

PATCHUpdate Hear About Us #

Writes how the guest heard about Weave Living. Also on the Lead.

{
  "acwapp_noofrooms": 1,
  "acwapp_howdidyouhearaboutus": 557130004
}

(empty body)

Values for acwapp_howdidyouhearaboutus are in Option Sets. For Korea, 557130028 (Naver) is likely to be used often.

GETGet Country #

Resolves a country name from a country lookup value — used for the guest's country and country of residence.

Query parameters

$select=acwapp_name

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_countries(acwapp_name)/$entity",
  "@odata.etag": "W/\"13116914\"",
  "acwapp_countryid": "f5dad402-c96f-ed11-81ac-000d3a85685d",
  "acwapp_name": "Korea, Republic of"
}

{
  "error": {
    "code": "0x80040217",
    "message": "The record does not exist."
  }
}

GETGet Nationality #

Resolves a nationality. Same shape as Get Country, but the table also supports searching by name, which is useful when a passport scan returns a nationality you need to match.

By id

$filter=acwapp_nationalityid eq {{_acwapp_nationality_value}}&$select=acwapp_name

By name

$filter=contains(acwapp_name, 'Korean')&$select=acwapp_name

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_nationalities(acwapp_name)",
  "value": [
    {
      "@odata.etag": "W/\"20095678\"",
      "acwapp_nationalityid": "50ba15a5-3796-ed11-aad1-000d3a85c990",
      "acwapp_name": "Chinese (Hong Kong)"
    }
  ]
}

{
  "@odata.context": "https://weaveuat.crm5.dynamics.com/api/data/v9.2/$metadata#acwapp_nationalities(acwapp_name)",
  "value": [
    { "acwapp_name": "Chinese", "acwapp_nationalityid": "4eba15a5-3796-ed11-aad1-000d3a85c990" },
    { "acwapp_name": "Chinese (Hong Kong)", "acwapp_nationalityid": "50ba15a5-3796-ed11-aad1-000d3a85c990" },
    { "acwapp_name": "Chinese (Macau)", "acwapp_nationalityid": "52ba15a5-3796-ed11-aad1-000d3a85c990" }
  ]
}

PATCHCheck In #

Records the moment the guest checks in, against the Booking Occupant. Call this once per occupant who is present.

Request body

{
  "acwapp_checkintimetimezoneindependent": "2026-01-12T15:30:00.000Z"
}

Value format

The timestamp is the Seoul local wall-clock time with a Z suffix — not a UTC conversion. See Conventions. For a 15:30 check-in send 15:30, not 06:30.

(empty body)

{
  "error": {
    "code": "0x0",
    "message": "An unexpected error occurred while processing the request."
  }
}

PATCHAdd Comment #

Writes the guest's request into the booking's Special Request field. This is the field the Operations Team reads, so use it for anything the guest wants acted on during their stay.

Request body

{
  "acwapp_specialrequest": "No cleaning please!"
}

(empty body)

POSTSend Unit Guide Email #

Triggers the "Unit Guide" e-mail — a welcome message containing house rules, the room number and the room's Wi-Fi details. It is a Power Automate flow invoked over HTTP, so the request shape is the flow's trigger rather than a Dataverse entity.

Request body

{
  "acwapp_bookingoccupant": "{{acwapp_bookingoccupantid}}"
}

Request headers

(empty body)

PATCHUpload Registration Card #

After the guest signs the registration card and you have uploaded the image to blob storage, write the resulting URL back onto the Booking Occupant.

Request body

{
  "wvlv_registration_card_url": "https://wlbookinguat.blob.core.windows.net/kiosk/2026-04-14/registration-card-test.png"
}

(empty body)

PATCHUpload Check-in Selfie #

Writes the URL of the guest's check-in selfie onto the Contact record. Note this is the Contact, not the Booking Occupant.

Request body

{
  "wvlv_checkin_selfie_url": "https://wlbookinguat.blob.core.windows.net/kiosk/test.jpg"
}

(empty body)

PATCHCheck Out #

Records the check-out moment, against the Booking Occupant. Structurally the same call as Check In.

Request body

{
  "acwapp_checkouttimetimezoneindependent": "2026-01-12T11:00:00.000Z"
}

(empty body)

Option Sets #

All picklist values verified against the live CRM metadata. Cache these at kiosk start-up rather than querying them per guest.

acwapp_language — preferred language

Used by acwapp_preferredlanguage on both Contact and Booking Occupant. Referenced by Create Booking Occupant, Create Booking Occupant (Existing Contact), Update Contact Details.

The kiosk offers Korean, English, Japanese and Chinese. Traditional and Simplified Chinese both map to the Chinese UI — store the script variant the guest selected.

acwapp_identificationtype — identity document type

Used by acwapp_identificationtype on Contact. Referenced by Get or Update Identification Type.

wvlv_purpose_of_stay — purpose of stay

Used by wvlv_purpose_of_stay on the Lead. Referenced by Update Purpose of Stay.

acwapp_howdidyouhearaboutus — how did you hear about us

Used by acwapp_howdidyouhearaboutus on the Lead. Referenced by Update Hear About Us.

Note the numbering is not contiguous — 557130026, 557130027 and 557130028 are out of label order. Key on the value, never on the position.

acwapp_cleaningstatus — room readiness

Used by acwapp_cleaningstatus on Property Unit. Referenced by Get Room Status.

Note 406530000 — a different publisher prefix. Do not assume the 5571300xx pattern.

Data Dictionary #

The CRM entities the kiosk touches. All names verified against live metadata.

Entity map

Key fields by entity

Property Booking — acwapp_propertybooking

Booking Occupant — acwapp_bookingoccupant

Contact — contact

A second picklist wvlv_identification_type exists on Contact but is not used by this integration.

Lead — lead

Property Unit / Room — acwapp_propertyunit

Scope & Open Items #

What is in this phase, what has been left out, and the small number of things still outstanding.

In scope

Deferred to a later phase

These are acknowledged but not required for the first release. They are listed so they are not lost.

Still outstanding

These need something from Weave Living before the related work can be completed.

Decisions already taken

Answers to questions raised during specification. Recorded here so they do not have to be asked again.

Revision History #