Rooms: GetRoomFieldData

Returns the field data associated with a room. This is the information that appears on the room's Details tab.

To better understand the room's field data, use the Rooms::GetRoomFieldSet method to retrieve the set of fields that the room uses.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/rooms/{roomId}/field_data

Parameters

Parameter NameValueDescription
Path Parameters
roomIdinteger

(Required) The id of the room.

accountIdstring

(Required) The globally unique identifier (GUID) for the account.

Responses

CodeDescriptionReference
200

Field data successfully retrieved.

FieldData
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Rooms::GetRoomFieldData

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

FieldData

The field data associated with a room. See Rooms::GetRoomFieldData.

dataobject

Field data is a collection of name/value pairs where the names correspond to the fields in the room's Details tab. The value of name/value object can be a field data collection itself. These collections are implemented as JSON objects.

For example, the field data for fields named "Tax annual amount" and "buyer1" might look like this:

{
  "data": {
    "taxAnnualAmount": 3389.12,
    "buyer1": {
      "email": "lizzy@example.com",
      "country": "England",
      "businessPhone": null,
      "name": "Elizabeth Bennet",
      "homePhone": null,
      "city": "Meryton",
      "address2": null,
      "postalCode": null,
      "state": "Hertfordshire",
      "company": null,
      "cellPhone": null,
      "address1": "Longbourn Estate"
    }
  }
}

}} />