Comment on page
GateDocument
This is the representation of the
GateDocument data structure which you receive in the Gate API response.{
"id": "5bf299b4-1cf5-41d9-baf7-1280f2cb8df6",
"name": "A420",
"hostelId": "f5004750-a11f-4641-9033-4245a77a1e46",
"type": "room",
"floor": "1",
"createdAt": "2021-01-11T09:37:23+00:00",
"updatedAt": "2021-01-11T09:38:28+00:00"
},
Property | Type | Required | Description |
id | string | Y | ID of the gate in Goki |
name | string | Y | Gate name in Goki |
hostelId | string | Y | ID of the property in Goki |
type | string | Y | Type of the Goki space. Can be one of room or commonArea |
floor | string | N | Floor name of the gate |
createdAt | string | Y | Gate creation date |
updatedAt | string | Y | Gate modification date |
Some properties have a private room within a dorm room, which means the dorm room act as a gate for the private room. To flag them we have a type property in the document that is set to room. It works like any other common area for its private room.
Last modified 1yr ago