Перейти к содержимому
Портал разработчика

Resolve static dictionary data by property IDs

POST
/api/json/hotels/getPropertiesInfo
curl --request POST \
  --url https://dictionary.example.invalid/api/json/hotels/getPropertiesInfo \
  --header 'Content-Type: application/json' \
  --data '{ "propertyIds": [ "00000000-0000-4000-8000-000000000101" ], "isActive": true }'

Returns static dictionary payload for requested propertyIds. Missing IDs are silently skipped in response (items contains only found entries).

Request Bodyrequired

Заголовок раздела «Request Bodyrequired»
Media typeapplication/json
object
propertyIds
required

Property IDs used by SPO (GetResultsResponse.Property.property_id, UUID).

Array<string>
>= 1 items unique items
isActive

Optional active filter:

  • true: return only active properties
  • false: return only inactive properties
  • omitted: return both active and inactive
boolean

Example 

{
  "propertyIds": [
    "00000000-0000-4000-8000-000000000101"
  ],
  "isActive": true
}

Responses

Заголовок раздела «Responses»

200

Заголовок раздела «200»

Static payload for found properties

Media typeapplication/json
object
success
required
boolean
errors
required
Array<string>
actions
required
Array<string>
platform
required
string
uuid
required
string format: uuid
timestamp
required
integer format: int64
success
required
boolean
data
required
object
items
required

Found properties only.

Array<object>
object
propertyId
required

Join key for SPO merge (UUID).

string format: uuid
/^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$/
sPropertyId

Internal Sutochno ID in s<digits> format.

string
nullable
isActive
required

Property archival flag.

boolean
title
required
string
type

Localized SPO property type title (current set from dictionary mapping, e.g. ‘Отель’, ‘Апартаменты’, ‘Квартира’, ‘Частный дом’, ‘Комната’, ‘Койко-место в хостеле’).

string
nullable
stars
integer format: int32
nullable
isSuperhost
boolean
nullable
freeDepositForSuperguest
boolean
nullable
convenientLocation
boolean
nullable
rating
object
value
number format: float
nullable
count
integer format: int32
media
object
images
Array<object>
object
url
required
string
blurHash
string
nullable
location
object
lat
number format: double
nullable
lng
number format: double
nullable
relations
object
ropeway
Array<object>
object
title
string
distance
integer format: int32
sea
Array<object>
object
title
string
distance
integer format: int32
name
string
firstLine
boolean
metro
Array<object>
object
title
string
distance
integer format: int32
walkTime
integer format: int32
lineColor
string
address
object
title
string
nullable
house
string
nullable
country
object
id
string
nullable
title
string
nullable
region
object
id
string
nullable
title
string
nullable
city
object
id
string
nullable
title
string
nullable
place
object
id
string
nullable
title
string
nullable
streetType
object
id
string
nullable
title
string
nullable
street
object
id
string
nullable
title
string
nullable
rooms

Dictionary room categories. SPO matches UniversalOffer.roomType.id with rooms[].id.

Array<object>
object
id
required
string
title
string
nullable
properties
object
beds
integer format: int32
nullable
area
integer format: int32
nullable
rooms
integer format: int32
nullable
bedrooms
integer format: int32
nullable
maxGuests
integer format: int32
nullable
windowViews
string
nullable
Allowed values: EMPTY SEA MOUNTAIN RIVER_LAKE CITY FOREST

Example 

{
  "success": true,
  "errors": [
    null
  ],
  "actions": [
    null
  ],
  "platform": "DEMO_VALUE",
  "uuid": "00000000-0000-4000-8000-000000000101",
  "timestamp": 1,
  "data": {
    "items": null
  }
}

400

Заголовок раздела «400»

Invalid request payload

Media typeapplication/json
object
success
required
boolean
data
required
object
errors
required
Array<string>
actions
required
Array<string>
platform
required
string
uuid
required
string format: uuid
timestamp
required
integer format: int64

Example 

{
  "success": false,
  "data": {},
  "errors": [
    "DEMO_VALUE"
  ],
  "actions": [
    "DEMO_VALUE"
  ],
  "platform": "DEMO_VALUE",
  "uuid": "00000000-0000-4000-8000-000000000101",
  "timestamp": 1
}

405

Заголовок раздела «405»

Method not allowed

Media typeapplication/json
object
success
required
boolean
data
required
object
errors
required
Array<string>
actions
required
Array<string>
platform
required
string
uuid
required
string format: uuid
timestamp
required
integer format: int64

Example 

{
  "success": false,
  "data": {},
  "errors": [
    "DEMO_VALUE"
  ],
  "actions": [
    "DEMO_VALUE"
  ],
  "platform": "DEMO_VALUE",
  "uuid": "00000000-0000-4000-8000-000000000101",
  "timestamp": 1
}

500

Заголовок раздела «500»

Internal server error

Media typeapplication/json
object
success
required
boolean
data
required
object
errors
required
Array<string>
actions
required
Array<string>
platform
required
string
uuid
required
string format: uuid
timestamp
required
integer format: int64

Example 

{
  "success": false,
  "data": {},
  "errors": [
    "DEMO_VALUE"
  ],
  "actions": [
    "DEMO_VALUE"
  ],
  "platform": "DEMO_VALUE",
  "uuid": "00000000-0000-4000-8000-000000000101",
  "timestamp": 1
}