מדריך API של floorplan | AppointmentTrader

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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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://he.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"
    }
}

תיעוד נקודת קצה קריא למכונה