Справочник API floorplan

GET

/v1/floorplan/get_by_id

#

Returns one floorplan by ID with all floors, layouts, and areas hydrated. Used by the editor JS to refresh state after a write. Public-by-design: the floorplan tree itself isn't sensitive (the editor surface gates its own write actions via permissions).

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplan_ID`	`int`	`Да`	`—`	Floorplan to fetch.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/floorplan/get_by_id' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplan_ID={{ATFloorplan_ID}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`floorplan_get_by_id_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocation_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocation_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocation_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocation_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocation_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocationEvent_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocationEvent_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocationEvent_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocationEvent_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATLocationEvent_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].Creator-ATUser_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].Creator-ATUser_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].Creator-ATUser_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATDiscussionPosts_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ATDiscussionPosts_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].URLSlug`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].URLSlug.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].URLSlug.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].Status`	`string ["Draft","Submitted","Active","Superseded","Rejected"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].PublishedDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].PublishedDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].PublishedDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ReviewedBy-ATUser_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ReviewedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ReviewedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ReviewedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].ReviewedBy-ATUser_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].Cache-EarnedTraderPoints`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].Cache-EarnedTraderPoints.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].Cache-EarnedTraderPoints.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LocationName`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LocationName.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LocationName.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LocationAlias`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LocationAlias.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].LocationAlias.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].EventName`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].EventName.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].EventName.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].EventURLSlug`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].EventURLSlug.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].EventURLSlug.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].location`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].location.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].location.anyOf[0].ATLocation_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].location.anyOf[0].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].location.anyOf[0].Alias`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].location.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].event`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].event.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].event.anyOf[0].ATLocationEvent_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].event.anyOf[0].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].event.anyOf[0].URLSlug`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].event.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ATFloorplan_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ATFloorplan_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ATFloorplan_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].FloorOrder`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].FloorOrder.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].FloorOrder.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ViewBoxWidth`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ViewBoxWidth.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ViewBoxWidth.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ViewBoxHeight`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ViewBoxHeight.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ViewBoxHeight.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ArchitectureSVG`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ArchitectureSVG.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].ArchitectureSVG.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].BackgroundImageURL`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].BackgroundImageURL.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].BackgroundImageURL.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].ATFloorplanFloor_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].ATFloorplanFloor_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].ATFloorplanFloor_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].Status`	`string ["Draft","Active","Historical"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].EffectiveStartDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].EffectiveStartDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].EffectiveStartDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].EffectiveEndDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].EffectiveEndDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].EffectiveEndDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].Creator-ATUser_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].Creator-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].Creator-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].Creator-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].Creator-ATUser_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].ATFloorplanLayout_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].ATFloorplanLayout_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].ATFloorplanLayout_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Label`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Category`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Category.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Category.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].SVGShape`	`string ["rect","polygon","circle","path"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].SVGGeometry`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].DesirabilityScore`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].DesirabilityScore.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].DesirabilityScore.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].DesirabilityScore.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].DesirabilityScore.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Capacity`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Capacity.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Capacity.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Capacity.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].Capacity.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].SortOrder`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].SortOrder.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[0].floors[].layouts[].areas[].SortOrder.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplan.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/get_by_id",
    "RequestUserAlias": "example-user",
    "Payload": {
        "floorplan": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": null,
            "ATLocation_ID": 0,
            "ATLocationEvent_ID": 0,
            "Creator-ATUser_ID": 0,
            "ATDiscussionPosts_ID": 0,
            "Name": "synthetic-example",
            "URLSlug": "synthetic-example",
            "Status": "Draft",
            "PublishedDate": "synthetic-example",
            "ReviewedBy-ATUser_ID": 0,
            "Cache-EarnedTraderPoints": 0,
            "LocationName": "synthetic-example",
            "LocationAlias": "synthetic-example",
            "EventName": "synthetic-example",
            "EventURLSlug": "synthetic-example",
            "location": {
                "ATLocation_ID": 0,
                "Name": "synthetic-example",
                "Alias": "synthetic-example"
            },
            "event": {
                "ATLocationEvent_ID": 0,
                "Name": "synthetic-example",
                "URLSlug": "synthetic-example"
            },
            "floors": []
        }
    }
}

Машиночитаемая документация метода

GET

/v1/floorplan/get_floor

#

Single-floor detail (architecture SVG + the floor's Active layout with all areas). Used by the editor when switching between floors. Public-by-design: same rationale as `get_for_location`.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplanFloor_ID`	`int`	`Да`	`—`	Floor row ID.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/floorplan/get_floor' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplanFloor_ID={{ATFloorplanFloor_ID}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`floorplan_get_floor_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floor`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ATFloorplan_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ATFloorplan_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ATFloorplan_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].FloorOrder`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].FloorOrder.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].FloorOrder.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ViewBoxWidth`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ViewBoxWidth.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ViewBoxWidth.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ViewBoxHeight`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ViewBoxHeight.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ViewBoxHeight.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ArchitectureSVG`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ArchitectureSVG.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].ArchitectureSVG.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].BackgroundImageURL`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].BackgroundImageURL.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].BackgroundImageURL.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].ATFloorplanFloor_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].ATFloorplanFloor_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].ATFloorplanFloor_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].Status`	`string ["Draft","Active","Historical"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].EffectiveStartDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].EffectiveStartDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].EffectiveStartDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].EffectiveEndDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].EffectiveEndDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].EffectiveEndDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].Creator-ATUser_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].Creator-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].Creator-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].Creator-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].Creator-ATUser_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].ATFloorplanLayout_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].ATFloorplanLayout_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].ATFloorplanLayout_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Label`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Category`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Category.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Category.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].SVGShape`	`string ["rect","polygon","circle","path"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].SVGGeometry`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].DesirabilityScore`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].DesirabilityScore.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].DesirabilityScore.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].DesirabilityScore.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].DesirabilityScore.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Capacity`		`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Capacity.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Capacity.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Capacity.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].Capacity.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].SortOrder`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].SortOrder.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[0].layouts[].areas[].SortOrder.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floor.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/get_floor",
    "RequestUserAlias": "example-user",
    "Payload": {
        "floor": {
            "ID": 0,
            "CreatedDate": "synthetic-example",
            "LastUpdateDate": "synthetic-example",
            "DeletedDate": null,
            "ATFloorplan_ID": 0,
            "Name": "synthetic-example",
            "FloorOrder": 0,
            "ViewBoxWidth": 0,
            "ViewBoxHeight": 0,
            "ArchitectureSVG": "synthetic-example",
            "BackgroundImageURL": "synthetic-example",
            "layouts": []
        }
    }
}

Машиночитаемая документация метода

GET

/v1/floorplan/get_for_event

#

Returns Active floorplans linked to an `ATLocationEvents` row via `ATFloorplans.ATLocationEvent_ID`. Public-by-design: floorplans are reused across modules and apps; no sensitive content lives on this surface.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATLocationEvent_ID`	`int`	`Да`	`—`	Event to fetch floorplans for.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/floorplan/get_for_event' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATLocationEvent_ID={{ATLocationEvent_ID}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`floorplan_get_for_event_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplans[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Creator-ATUser_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].Creator-ATUser_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Creator-ATUser_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].URLSlug`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].URLSlug.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].URLSlug.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Status`	`string ["Draft","Submitted","Active","Superseded","Rejected"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].PublishedDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].PublishedDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].PublishedDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Cache-EarnedTraderPoints`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].Cache-EarnedTraderPoints.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Cache-EarnedTraderPoints.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationName`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationName.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationName.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationAlias`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationAlias.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationAlias.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventName`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventName.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventName.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventURLSlug`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventURLSlug.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventURLSlug.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[0].ATLocation_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[0].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[0].Alias`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[0].ATLocationEvent_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[0].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[0].URLSlug`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ATFloorplan_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ATFloorplan_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ATFloorplan_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].FloorOrder`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].FloorOrder.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].FloorOrder.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxWidth`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxWidth.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxWidth.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxHeight`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxHeight.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxHeight.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ArchitectureSVG`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ArchitectureSVG.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ArchitectureSVG.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].BackgroundImageURL`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].BackgroundImageURL.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].BackgroundImageURL.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ATFloorplanFloor_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ATFloorplanFloor_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ATFloorplanFloor_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Status`	`string ["Draft","Active","Historical"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveStartDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveStartDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveStartDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveEndDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveEndDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveEndDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ATFloorplanLayout_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ATFloorplanLayout_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ATFloorplanLayout_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Label`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Category`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Category.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Category.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SVGShape`	`string ["rect","polygon","circle","path"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SVGGeometry`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SortOrder`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SortOrder.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SortOrder.oneOf[1]`	`string`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/get_for_event",
    "RequestUserAlias": "example-user",
    "Payload": {
        "floorplans": []
    }
}

Машиночитаемая документация метода

GET

/v1/floorplan/get_for_location

#

Returns the Active floorplans linked to an `ATLocation` via the direct `ATFloorplans.ATLocation_ID` column, with all floors, the currently- Active layout per floor, and every area on that layout. Returns an empty list (still wrapped in Success) when no Active floorplan covers the venue. Multiple floorplans may cover the same venue (different creators, different perspectives). Consuming surfaces typically render the first Active result; finer attribution comes via the area-level tag `ATLocation.ATFloorplanArea_ID`. Public-by-design: floorplans are reused across modules and apps; no sensitive content lives on this surface.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATLocation_ID`	`int`	`Да`	`—`	Location to fetch floorplans for.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/floorplan/get_for_location' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATLocation_ID={{ATLocation_ID}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`floorplan_get_for_location_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplans[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocation_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATLocationEvent_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Creator-ATUser_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].Creator-ATUser_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Creator-ATUser_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ATDiscussionPosts_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].URLSlug`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].URLSlug.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].URLSlug.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Status`	`string ["Draft","Submitted","Active","Superseded","Rejected"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].PublishedDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].PublishedDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].PublishedDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].ReviewedBy-ATUser_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Cache-EarnedTraderPoints`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].Cache-EarnedTraderPoints.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].Cache-EarnedTraderPoints.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationName`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationName.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationName.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationAlias`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationAlias.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].LocationAlias.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventName`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventName.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventName.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventURLSlug`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventURLSlug.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].EventURLSlug.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[0].ATLocation_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[0].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[0].Alias`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].location.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[0].ATLocationEvent_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[0].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[0].URLSlug`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].event.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ATFloorplan_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ATFloorplan_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ATFloorplan_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].FloorOrder`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].FloorOrder.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].FloorOrder.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxWidth`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxWidth.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxWidth.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxHeight`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxHeight.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ViewBoxHeight.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ArchitectureSVG`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ArchitectureSVG.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].ArchitectureSVG.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].BackgroundImageURL`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].BackgroundImageURL.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].BackgroundImageURL.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ATFloorplanFloor_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ATFloorplanFloor_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].ATFloorplanFloor_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Status`	`string ["Draft","Active","Historical"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveStartDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveStartDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveStartDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveEndDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveEndDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].EffectiveEndDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].Creator-ATUser_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DeletedDate`	`= null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ATFloorplanLayout_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ATFloorplanLayout_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].ATFloorplanLayout_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Label`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Category`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Category.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Category.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SVGShape`	`string ["rect","polygon","circle","path"]`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SVGGeometry`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].DesirabilityScore.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity`		`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].Capacity.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SortOrder`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SortOrder.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.floorplans[].floors[].layouts[].areas[].SortOrder.oneOf[1]`	`string`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/get_for_location",
    "RequestUserAlias": "example-user",
    "Payload": {
        "floorplans": []
    }
}

Машиночитаемая документация метода

GET

/v1/floorplan/get_license_for_app

#

License lookup for a (floorplan, app) pair. Resolution order: 1. Per-app override row in `ATFloorplanLicenses` (Status='Active'). 2. Wildcard row (`ATApps_ID IS NULL`, Status='Active'). 3. Fall through to the `Permission::FloorplanAreaTradeRoyaltyPct` default for the floorplan originator. Public-by-design: app renderers can inspect published floorplan terms.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplan_ID`	`int`	`Да`	`—`	Floorplan to look up.
`ATApps_ID`	`int`	`Нет`	`0`	App requesting the data; pass 0 for first-party.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/floorplan/get_license_for_app' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplan_ID={{ATFloorplan_ID}}' \
  --data-urlencode 'ATApps_ID={{ATApps_ID}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_get_license_for_app_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.royaltyPct`	`number`	`Да`
`$.oneOf[0].allOf[1].Payload.flatFeeCents`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.source`	`string ["app","wildcard","default"]`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/get_license_for_app",
    "RequestUserAlias": "example-user",
    "Payload": {
        "royaltyPct": 0,
        "flatFeeCents": 0,
        "source": "app"
    }
}

Машиночитаемая документация метода

GET

/v1/floorplan/get_link_candidates

#

Creator-only link picker for floorplan creation. Returns normalized `ATV2SearchSelect` options for venues, events, or both. `results` is returned as a compatibility alias for older `ATV2Search` callers.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`searchText`	`string`	`Нет`	`""`	User-entered venue or event query.
`resultLimit`	`int`	`Нет`	`8`	Max rows per type.
`linkType`	`string`	`Нет`	`""`	Optional filter: location, venue, event, or blank for both.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/floorplan/get_link_candidates' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchText={{searchText}}' \
  --data-urlencode 'resultLimit={{resultLimit}}' \
  --data-urlencode 'linkType={{linkType}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_get_link_candidates_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.options`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.options[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.options[].value`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].label`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].subtitle`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].title`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].key`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].type`	`string ["location","event"]`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].raw`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].raw.type`	`string ["location","event"]`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].raw.id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].raw.name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].raw.slug`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].group`	`string ["Venues","Events"]`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].meta`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].meta.type`	`string ["location","event"]`	`Да`
`$.oneOf[0].allOf[1].Payload.options[].meta.id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.results`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.results[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.results[].value`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].label`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].subtitle`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].title`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].key`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].type`	`string ["location","event"]`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].raw`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].raw.type`	`string ["location","event"]`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].raw.id`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].raw.name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].raw.slug`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].group`	`string ["Venues","Events"]`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].meta`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].meta.type`	`string ["location","event"]`	`Да`
`$.oneOf[0].allOf[1].Payload.results[].meta.id`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/get_link_candidates",
    "RequestUserAlias": "example-user",
    "Payload": {
        "options": [],
        "results": []
    }
}

Машиночитаемая документация метода

GET

/v1/floorplan/get_pending_review_list

#

Moderation queue: floorplans waiting for review. Gated by `Permission::CanReviewFloorplanSubmissions`.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`resultLimit`	`int`	`Нет`	`50`	Max rows to return.
`resultOffset`	`int`	`Нет`	`0`	Pagination offset.

Пример запроса (cURL)

curl --get \
  'https://ru.appointmenttrader.com/v1/floorplan/get_pending_review_list' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'resultLimit={{resultLimit}}' \
  --data-urlencode 'resultOffset={{resultOffset}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно	Описание
`$`	`floorplan_get_pending_review_list_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.items`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.items[]`	`object`	`Нет`
`$.oneOf[0].allOf[1].Payload.items[].ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].Name`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].Creator-ATUser_ID`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].Creator-ATUser_ID.oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].Creator-ATUser_ID.oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ATLocation_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.items[].ATLocation_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].ATLocation_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ATLocation_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ATLocation_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ATLocationEvent_ID`		`Да`
`$.oneOf[0].allOf[1].Payload.items[].ATLocationEvent_ID.anyOf[0]`	`DatabaseInteger`	`Да`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.items[].ATLocationEvent_ID.anyOf[0].oneOf[0]`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ATLocationEvent_ID.anyOf[0].oneOf[1]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].ATLocationEvent_ID.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].CreatedDate`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].LastUpdateDate`		`Да`
`$.oneOf[0].allOf[1].Payload.items[].LastUpdateDate.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].LastUpdateDate.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].CreatorAlias`		`Да`
`$.oneOf[0].allOf[1].Payload.items[].CreatorAlias.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].CreatorAlias.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].LocationName`		`Да`
`$.oneOf[0].allOf[1].Payload.items[].LocationName.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].LocationName.anyOf[1]`	`null`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].EventName`		`Да`
`$.oneOf[0].allOf[1].Payload.items[].EventName.anyOf[0]`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.items[].EventName.anyOf[1]`	`null`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/get_pending_review_list",
    "RequestUserAlias": "example-user",
    "Payload": {
        "items": []
    }
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_approved

#

Approve a Submitted floorplan, promoting it to Active. Floorplans are not exclusive per venue/event -- multiple Active floorplans may share the same direct link -- so no supersede pass runs at this layer; the moderator can manually mark an older floorplan as Superseded if a true replacement is intended. Gated by `Permission::CanReviewFloorplanSubmissions`.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplan_ID`	`int`	`Да`	`—`	Floorplan to approve.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually transition.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_approved' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplan_ID={{ATFloorplan_ID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_approved_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.Status`	`= "Active"`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_approved",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Status": "Active"
    }
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_areas

#

Replace every area on a layout with the supplied list. The whole-list replace is intentional: the editor sends its current state, the server is the single source of truth on disk. Existing areas are soft-deleted (`DeletedDate=NOW()`) and the supplied rows are inserted fresh; this preserves historical attribution because the old area IDs aren't reused, but tagged ATLocation/ATLocationEvent rows pointing at deleted areas will need re-tagging by the operator.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplanLayout_ID`	`int`	`Да`	`—`	Layout to replace areas on.
`areas`	`array`	`Да`	`—`	Array of {label, category, svgShape, svgGeometry, capacity?, desirabilityScore?, sortOrder?} objects. The dispatcher accepts a JSON-encoded array on the wire (e.g. via the `areas` POST field) and auto-decodes it.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually persist.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_areas' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplanLayout_ID={{ATFloorplanLayout_ID}}' \
  --data-urlencode 'areas={{areas}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Параметры: areas

Поле	Тип	Обязательно	Описание
`areas`	`string (application/json)`	`Да`	Pass a JSON-encoded string, not nested form fields.
`areas`	`array (декодированный JSON)`	`Да`
`areas[]`	`object`	`Нет`
`areas[].label`	`string`	`Да`
`areas[].svgShape`	`string ["rect","polygon","circle","path"]`	`Нет`
`areas[].svgGeometry`	`string`	`Да`
`areas[].category`	`string`	`Нет`
`areas[].desirabilityScore`		`Нет`
`areas[].desirabilityScore.anyOf[0]`	`integer`	`Нет`
`areas[].desirabilityScore.anyOf[1]`	`null`	`Нет`
`areas[].capacity`		`Нет`
`areas[].capacity.anyOf[0]`	`integer`	`Нет`
`areas[].capacity.anyOf[1]`	`null`	`Нет`
`areas[].sortOrder`	`integer`	`Нет`

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_areas_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.areaIDs`	`array`	`Да`
`$.oneOf[0].allOf[1].Payload.areaIDs[]`	`integer`	`Нет`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_areas",
    "RequestUserAlias": "example-user",
    "Payload": {
        "areaIDs": []
    }
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_event_area

#

Tag an `ATLocationEvent` with a floorplan area. Same gate as `set_location_area`.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATLocationEvent_ID`	`int`	`Да`	`—`	Event to tag.
`ATFloorplanArea_ID`	`int`	`Да`	`—`	Area to bind (0 to clear).
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually persist.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_event_area' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATLocationEvent_ID={{ATLocationEvent_ID}}' \
  --data-urlencode 'ATFloorplanArea_ID={{ATFloorplanArea_ID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_event_area_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_event_area",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_floor

#

Upsert a floor (architecture SVG, viewbox, name, order). Pass ATFloorplanFloor_ID = 0 to create a new floor under the supplied floorplan; non-zero updates the existing row. Architecture SVG is sanitised before write so user-pasted blobs can't smuggle scripts.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplan_ID`	`int`	`Да`	`—`	Owner floorplan; required when creating.
`ATFloorplanFloor_ID`	`int`	`Да`	`—`	0 to create, or existing row ID to update.
`name`	`string`	`Да`	`—`	Floor display name.
`floorOrder`	`int`	`Нет`	`0`	-2..N ordering hint (-2 = sub-basement, 0 = ground).
`viewBoxWidth`	`int`	`Нет`	`1000`	SVG viewbox width.
`viewBoxHeight`	`int`	`Нет`	`1000`	SVG viewbox height.
`architectureSVG`	`string`	`Нет`	`""`	Raw SVG fragment for the building shell; sanitised server-side.
`backgroundImageURL`	`string`	`Нет`	`""`	Optional traced reference photo URL.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually persist.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_floor' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplan_ID={{ATFloorplan_ID}}' \
  --data-urlencode 'ATFloorplanFloor_ID={{ATFloorplanFloor_ID}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'floorOrder={{floorOrder}}' \
  --data-urlencode 'viewBoxWidth={{viewBoxWidth}}' \
  --data-urlencode 'viewBoxHeight={{viewBoxHeight}}' \
  --data-urlencode 'architectureSVG={{architectureSVG}}' \
  --data-urlencode 'backgroundImageURL={{backgroundImageURL}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_floor_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.ATFloorplanFloor_ID`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_floor",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATFloorplanFloor_ID": 0
    }
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_imported_svg

#

Import a pasted/uploaded SVG fragment as the architecture layer of a floor. The fragment is sanitised server-side: script elements, event handlers (onload, onclick, ...), foreignObject elements, external references, and unsafe URL schemes are stripped before write. Optional autoExtractAreas mode walks the cleaned tree for rect, polygon, circle, and path elements that carry either a title child or a data-atv2-label attribute, and inserts each into the floor's currently-Active layout as a draft area, ready for the creator to assign categories to.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplanFloor_ID`	`int`	`Да`	`—`	Floor to land the architecture on.
`svgFragment`	`string`	`Да`	`—`	The SVG text. May or may not have an outer svg element.
`autoExtractAreas`	`bool`	`Нет`	`false`	True to also create draft areas from titled shapes.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually persist.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_imported_svg' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplanFloor_ID={{ATFloorplanFloor_ID}}' \
  --data-urlencode 'svgFragment={{svgFragment}}' \
  --data-urlencode 'autoExtractAreas={{autoExtractAreas}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_imported_svg_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.ATFloorplanFloor_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.architectureSVG`	`string`	`Да`
`$.oneOf[0].allOf[1].Payload.extractedAreaCount`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.sanitisedBytes`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.sanitizedBytes`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_imported_svg",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATFloorplanFloor_ID": 0,
        "architectureSVG": "synthetic-example",
        "extractedAreaCount": 0,
        "sanitisedBytes": 0,
        "sanitizedBytes": 0
    }
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_layout

#

Upsert a layout. Pass `ATFloorplanLayout_ID = 0` to create a new layout under the supplied floor; non-zero updates the existing row. When the resulting status is `Active`, ANY other Active layout on the same floor flips to `Historical` in the same write -- there can be exactly one Active layout per floor at a time.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplanFloor_ID`	`int`	`Да`	`—`	Owner floor; required when creating.
`ATFloorplanLayout_ID`	`int`	`Да`	`—`	0 to create, or existing row ID to update.
`name`	`string`	`Да`	`—`	Layout display name.
`statusValue`	`string`	`Нет`	`"Draft"`	One of Draft, Active, Historical.
`effectiveStartDate`	`string`	`Нет`	`""`	Optional ISO datetime.
`effectiveEndDate`	`string`	`Нет`	`""`	Optional ISO datetime.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually persist.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_layout' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplanFloor_ID={{ATFloorplanFloor_ID}}' \
  --data-urlencode 'ATFloorplanLayout_ID={{ATFloorplanLayout_ID}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'statusValue={{statusValue}}' \
  --data-urlencode 'effectiveStartDate={{effectiveStartDate}}' \
  --data-urlencode 'effectiveEndDate={{effectiveEndDate}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_layout_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.ATFloorplanLayout_ID`	`integer`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_layout",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATFloorplanLayout_ID": 0
    }
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_location_area

#

Tag an `ATLocation` with a floorplan area so trades against that venue inherit area attribution for royalty purposes. Gated either by floorplan ownership OR `Permission::LocationAdministration`.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATLocation_ID`	`int`	`Да`	`—`	Venue to tag.
`ATFloorplanArea_ID`	`int`	`Да`	`—`	Area to bind to this venue (0 to clear).
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually persist.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_location_area' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATLocation_ID={{ATLocation_ID}}' \
  --data-urlencode 'ATFloorplanArea_ID={{ATFloorplanArea_ID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_location_area_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`= true`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_location_area",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_new

#

Direct creation entry point. Transactionally creates an ATFloorplans row (Draft), plus an initial ATFloorplanFloor ("Ground") and an initial ATFloorplanLayout ("Default", Active) so the editor has somewhere to draw immediately. Gated by `Permission::CanCreateFloorplan`. At least one of `ATLocation_ID` or `ATLocationEvent_ID` is required. Both may be supplied.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`name`	`string`	`Да`	`—`	Display name for the floorplan.
`ATLocation_ID`	`int`	`Нет`	`0`	Optional venue link.
`ATLocationEvent_ID`	`int`	`Нет`	`0`	Optional event link.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually create. Defaults false (dry-run).

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_new' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'name={{name}}' \
  --data-urlencode 'ATLocation_ID={{ATLocation_ID}}' \
  --data-urlencode 'ATLocationEvent_ID={{ATLocationEvent_ID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_new_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.ATFloorplan_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.ATFloorplanFloor_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.ATFloorplanLayout_ID`	`integer`	`Да`
`$.oneOf[0].allOf[1].Payload.editorURL`	`string`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_new",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATFloorplan_ID": 0,
        "ATFloorplanFloor_ID": 0,
        "ATFloorplanLayout_ID": 0,
        "editorURL": "synthetic-example"
    }
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_rejected

#

Reject a Submitted floorplan with a reviewer note. Gated by `Permission::CanReviewFloorplanSubmissions`.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplan_ID`	`int`	`Да`	`—`	Floorplan to reject.
`reason`	`string`	`Нет`	`""`	Short note for the originator.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually transition.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_rejected' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplan_ID={{ATFloorplan_ID}}' \
  --data-urlencode 'reason={{reason}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_rejected_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.Status`	`= "Rejected"`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_rejected",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Status": "Rejected"
    }
}

Машиночитаемая документация метода

POST

/v1/floorplan/set_submitted_for_review

#

Move a Draft floorplan into the moderation queue. Owner-only.

Параметры

Имя	Тип	Обязательно	По умолчанию	Описание
`ATFloorplan_ID`	`int`	`Да`	`—`	Floorplan to submit.
`isWritingRequest`	`bool`	`Нет`	`false`	Set true to actually transition.

Пример запроса (cURL)

curl --request POST \
  'https://ru.appointmenttrader.com/v1/floorplan/set_submitted_for_review' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'ATFloorplan_ID={{ATFloorplan_ID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Возвращает

JSON

See the shared response schema and synthetic example.

Поля ответа

Поле	Тип	Обязательно
`$`	`floorplan_set_submitted_for_review_Response`	`Да`
`$.oneOf[0]`		`Да`
`$.oneOf[0].allOf[0]`	`object`	`Да`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Да`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Да`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Да`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`Нет`
`$.oneOf[0].allOf[1]`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload`	`object`	`Да`
`$.oneOf[0].allOf[1].Payload.Status`	`= "Submitted"`	`Да`
`$.oneOf[1]`	`object`	`Да`
`$.oneOf[1].RequestUserAlias`	`string`	`Да`
`$.oneOf[1].RequestPath`	`string \| null`	`Да`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Да`
`$.oneOf[1].ResponseCode`	`integer`	`Да`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`Нет`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Да`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`Нет`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`Нет`

Пример ответа

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/floorplan/set_submitted_for_review",
    "RequestUserAlias": "example-user",
    "Payload": {
        "Status": "Submitted"
    }
}

Машиночитаемая документация метода