{"items":[{"type":"link","label":"Property Management","link":"/api/property-management-1.0.1","routeSlug":"/api/property-management-1.0.1","content":{"contentType":"overview","meta":{"name":"Property Management"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Download PDF","url":"https://docs.ruckus.cloud/static/api/property-management-1.0.1.pdf"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"RUCKUS Cloud Privacy Policy","url":"https://support.ruckuswireless.com/ruckus-one-privacy-policy"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Property Management (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[]}],"sectionId":"/api/property-management-1.0.1"},{"nodeType":"external-docs","url":"https://docs.ruckusone.cloud/","description":"RUCKUS One API Documentation"}],"sectionId":"/api/property-management-1.0.1"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":1,"id":"section/overview"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These APIs facilitate managing property configurations and units management for a venue."},"children":[]}]}]}]}],"sectionId":"/api/property-management-1.0.1/section/overview"}]}]}},{"type":"link","label":"Overview","link":"/api/property-management-1.0.1/section/overview","routeSlug":"/api/property-management-1.0.1/section/overview","content":null},{"type":"group","label":"Properties","link":"/api/property-management-1.0.1/properties","routeSlug":"/api/property-management-1.0.1/properties","items":[{"label":"Get Property Configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/properties/getproperty","routeSlug":"/api/property-management-1.0.1/properties/getproperty","metadata":{"seo":{"title":"Get Property Configuration","description":"Gets property configuration for the requested venue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProperty","name":"Get Property Configuration","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Property Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets property configuration for the requested venue."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/venues/{venueId}/propertyConfigs","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404","500"],"pointer":"/venues/{venueId}/propertyConfigs","href":"properties/getproperty","openApiOperationId":"getProperty","summary":"Get Property Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/EntityModelPropertyDto"},"application/json":{"schemaId":"components/schemas/EntityModelPropertyDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelPropertyDto"}},"schemaId":"components/schemas/EntityModelPropertyDto"},{"code":"400","description":"Bad request","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not found","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityModelPropertyDto","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/EntityModelPropertyDto"},"application/json":{"schemaId":"components/schemas/EntityModelPropertyDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelPropertyDto"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/propertyConfigs"},{"label":"Update Property Configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/properties/enableproperty","routeSlug":"/api/property-management-1.0.1/properties/enableproperty","metadata":{"seo":{"title":"Update Property Configuration","description":"Allows the user to enable or disable property management configuration on the specified venue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enableProperty","name":"Update Property Configuration","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Property Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to enable or disable property management configuration on the specified venue."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PropertyUpdateDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PropertyUpdateDto"}},"schemaId":"components/schemas/PropertyUpdateDto","pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/put/requestBody","description":"Property configuration to enable"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/venues/{venueId}/propertyConfigs","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PropertyUpdateDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PropertyUpdateDto"}},"responseCodes":["202","400","404","500"],"pointer":"/venues/{venueId}/propertyConfigs","href":"properties/enableproperty","openApiOperationId":"enableProperty","summary":"Update Property Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/PropertyUpdateDto","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PropertyUpdateDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PropertyUpdateDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}},"schemaId":"components/schemas/EntityModelAcceptedResponse","headers":{"Location":{"description":"Url for the enabled property configuration","style":"simple","schema":{"type":"string"}}},"headerSchemaId":"schema_1"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Property configuration not found for the given venue id","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/EntityModelAcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/propertyConfigs"},{"label":"Selectively Update Property Configuration","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/properties/enablepropertyselectively","routeSlug":"/api/property-management-1.0.1/properties/enablepropertyselectively","metadata":{"seo":{"title":"Selectively Update Property Configuration","description":"Allows the user to selectively update property management configuration on the specified venue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"enablePropertySelectively","name":"Selectively Update Property Configuration","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Selectively Update Property Configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to selectively update property management configuration on the specified venue."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PropertyDto"}},"schemaId":"components/schemas/PropertyDto","pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/patch/requestBody","description":"Property configuration to enable"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/venues/{venueId}/propertyConfigs","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PropertyDto"}},"responseCodes":["202","400","404","500"],"pointer":"/venues/{venueId}/propertyConfigs","href":"properties/enablepropertyselectively","openApiOperationId":"enablePropertySelectively","summary":"Selectively Update Property Configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/PropertyDto","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PropertyDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}},"schemaId":"components/schemas/EntityModelAcceptedResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Property configuration not found for the given venue id","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/EntityModelAcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/propertyConfigs"},{"label":"Update Resident Portal Assignment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/properties/assignresidentportal","routeSlug":"/api/property-management-1.0.1/properties/assignresidentportal","metadata":{"seo":{"title":"Update Resident Portal Assignment","description":"Allows the user to assign resident portal for the specified venue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assignResidentPortal","name":"Update Resident Portal Assignment","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs~1residentPortalAssignments~1{residentPortalId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Resident Portal Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to assign resident portal for the specified venue."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true},{"name":"residentPortalId","in":"path","schemaId":"schema_2","description":"Resident PortalId Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs~1residentPortalAssignments~1{residentPortalId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/venues/{venueId}/propertyConfigs/residentPortalAssignments/{residentPortalId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"},{"name":"residentPortalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404","500"],"pointer":"/venues/{venueId}/propertyConfigs/residentPortalAssignments/{residentPortalId}","href":"properties/assignresidentportal","openApiOperationId":"assignResidentPortal","summary":"Update Resident Portal Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertyResidentPortalAssignment"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PropertyResidentPortalAssignment"}},"schemaId":"components/schemas/PropertyResidentPortalAssignment"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Property configuration not found for the given venue id","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1propertyConfigs~1residentPortalAssignments~1{residentPortalId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PropertyResidentPortalAssignment","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PropertyResidentPortalAssignment"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PropertyResidentPortalAssignment"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/propertyConfigs/residentPortalAssignments/{residentPortalId}"},{"label":"Query Property Configurations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/properties/querypropertyconfigs","routeSlug":"/api/property-management-1.0.1/properties/querypropertyconfigs","metadata":{"seo":{"title":"Query Property Configurations","description":"Gets the list of property configurations using the specified query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryPropertyConfigs","name":"Query Property Configurations","isWebhook":false,"pointer":"/paths/~1venues~1propertyConfigs~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Property Configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of property configurations using the specified query."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_3","description":"Indicates that the content should be excluded from the query and only count and size data returned."}],"pointer":"/paths/~1venues~1propertyConfigs~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1venues~1propertyConfigs~1query/post/requestBody","description":"Data for the requested query "}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/venues/propertyConfigs/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400"],"pointer":"/venues/propertyConfigs/query","href":"properties/querypropertyconfigs","openApiOperationId":"queryPropertyConfigs","summary":"Query Property Configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Collection of property configurations.","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/Page"},"application/json":{"schemaId":"components/schemas/Page"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Page"}},"schemaId":"components/schemas/Page"},{"code":"400","description":"Invalid query data supplied.","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1propertyConfigs~1query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Page","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/Page"},"application/json":{"schemaId":"components/schemas/Page"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Page"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/propertyConfigs/query"},{"label":"Gets Property Configurations","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/properties/getallpropertyconfigs","routeSlug":"/api/property-management-1.0.1/properties/getallpropertyconfigs","metadata":{"seo":{"title":"Gets Property Configurations","description":"Gets the list of property configurations paged. This method will be removed no sooner than 08/31/2026. The following URL POST /venues/propertyConfigs/query can be used for this content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllPropertyConfigs","name":"Gets Property Configurations","deprecated":true,"isWebhook":false,"pointer":"/paths/~1venues~1propertyConfigs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets Property Configurations","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of property configurations paged. This method will be removed no sooner than 08/31/2026. The following URL POST /venues/propertyConfigs/query can be used for this content."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_4","description":"Page size"},{"name":"page","in":"query","schemaId":"schema_4","description":"The page to retrieve (starts at one)."},{"name":"sort","in":"query","schemaId":"schema_5","description":"The field name to sort, comma separated from the sort order (asc or desc)."}],"pointer":"/paths/~1venues~1propertyConfigs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/venues/propertyConfigs","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"size","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_4"},{"name":"sort","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/venues/propertyConfigs","href":"properties/getallpropertyconfigs","openApiOperationId":"getAllPropertyConfigs","summary":"Gets Property Configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Property configurations.","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/PageEntityModelPropertyDto"},"application/json":{"schemaId":"components/schemas/PageEntityModelPropertyDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelPropertyDto"}},"schemaId":"components/schemas/PageEntityModelPropertyDto"},{"code":"400","description":"Invalid input supplied.","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1propertyConfigs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageEntityModelPropertyDto","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/PageEntityModelPropertyDto"},"application/json":{"schemaId":"components/schemas/PageEntityModelPropertyDto"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelPropertyDto"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/propertyConfigs"}],"content":{"contentType":"group","meta":{"name":"Properties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Properties","showPageActions":true},{"nodeType":"markdoc","content":"Manages property configuration for a venue."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/venues/{venueId}/propertyConfigs","summary":"Get Property Configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/properties/getproperty","deprecated":false},{"title":"/venues/{venueId}/propertyConfigs","summary":"Update Property Configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/properties/enableproperty","deprecated":false},{"title":"/venues/{venueId}/propertyConfigs","summary":"Selectively Update Property Configuration","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/properties/enablepropertyselectively","deprecated":false},{"title":"/venues/{venueId}/propertyConfigs/residentPortalAssignments/{residentPortalId}","summary":"Update Resident Portal Assignment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/properties/assignresidentportal","deprecated":false},{"title":"/venues/propertyConfigs/query","summary":"Query Property Configurations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/properties/querypropertyconfigs","deprecated":false},{"title":"/venues/propertyConfigs","summary":"Gets Property Configurations","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/properties/getallpropertyconfigs","deprecated":true}]}]}]}]}},{"type":"group","label":"Residents","link":"/api/property-management-1.0.1/residents","routeSlug":"/api/property-management-1.0.1/residents","items":[{"label":"Adds Resident Portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/addresidentportal","routeSlug":"/api/property-management-1.0.1/residents/addresidentportal","metadata":{"seo":{"title":"Adds Resident Portal","description":"Allows the user to add a resident portal."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addResidentPortal","name":"Adds Resident Portal","isWebhook":false,"pointer":"/paths/~1residentPortals/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds Resident Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to add a resident portal."},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_6"}},"schemaId":"schema_6","pointer":"/paths/~1residentPortals/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/residentPortals","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_6"}},"responseCodes":["201","400","409","500"],"pointer":"/residentPortals","href":"residents/addresidentportal","openApiOperationId":"addResidentPortal","summary":"Adds Resident Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"schema_6","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_6"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}},"schemaId":"components/schemas/EntityModelAcceptedResponse","headers":{"Location":{"description":"Url for the added resident portal","style":"simple","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict - The resident portal trying to add already exists","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource","headers":{"Location":{"description":"Url of the existing resident portal","style":"simple","schema":{"type":"string"}}},"headerSchemaId":"schema_8"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/EntityModelAcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals"},{"label":"Query Resident Portals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/queryresidentportals","routeSlug":"/api/property-management-1.0.1/residents/queryresidentportals","metadata":{"seo":{"title":"Query Resident Portals","description":"Gets the list of resident portals using the specified query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryResidentPortals","name":"Query Resident Portals","isWebhook":false,"pointer":"/paths/~1residentPortals~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Resident Portals","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of resident portals using the specified query."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_3","description":"Indicates that the content should be excluded from the query and only count and size data returned."}],"pointer":"/paths/~1residentPortals~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1residentPortals~1query/post/requestBody","description":"Data for the requested query "}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/residentPortals/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400"],"pointer":"/residentPortals/query","href":"residents/queryresidentportals","openApiOperationId":"queryResidentPortals","summary":"Query Resident Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resident portal details.","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"},"application/json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"}},"schemaId":"components/schemas/PageEntityModelResidentPortal"},{"code":"400","description":"Invalid query data supplied.","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals~1query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageEntityModelResidentPortal","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"},"application/json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals/query"},{"label":"Gets Resident Portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/fetchresidentportal","routeSlug":"/api/property-management-1.0.1/residents/fetchresidentportal","metadata":{"seo":{"title":"Gets Resident Portal","description":"Allows the user to get a resident portal with the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchResidentPortal","name":"Gets Resident Portal","isWebhook":false,"pointer":"/paths/~1residentPortals~1{portalId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets Resident Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to get a resident portal with the given id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portalId","in":"path","schemaId":"schema_2","description":"Resident Portal Id","required":true}],"pointer":"/paths/~1residentPortals~1{portalId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/residentPortals/{portalId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"portalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404","500"],"pointer":"/residentPortals/{portalId}","href":"residents/fetchresidentportal","openApiOperationId":"fetchResidentPortal","summary":"Gets Resident Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/EntityModelResidentPortal"},"application/json":{"schemaId":"components/schemas/EntityModelResidentPortal"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelResidentPortal"}},"schemaId":"components/schemas/EntityModelResidentPortal"},{"code":"400","description":"Bad request","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not found","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals~1{portalId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityModelResidentPortal","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/EntityModelResidentPortal"},"application/json":{"schemaId":"components/schemas/EntityModelResidentPortal"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelResidentPortal"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals/{portalId}"},{"label":"Delete Resident Portal","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/deleteresidentportal","routeSlug":"/api/property-management-1.0.1/residents/deleteresidentportal","metadata":{"seo":{"title":"Delete Resident Portal","description":"Allows the user to delete a resident portal with the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteResidentPortal","name":"Delete Resident Portal","isWebhook":false,"pointer":"/paths/~1residentPortals~1{portalId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Resident Portal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to delete a resident portal with the given id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portalId","in":"path","schemaId":"schema_2","description":"Resident Portal Id","required":true}],"pointer":"/paths/~1residentPortals~1{portalId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/residentPortals/{portalId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"portalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","500"],"pointer":"/residentPortals/{portalId}","href":"residents/deleteresidentportal","openApiOperationId":"deleteResidentPortal","summary":"Delete Resident Portal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals~1{portalId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals/{portalId}"},{"label":"Updates Resident Portal Configurations","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/editresidentportal","routeSlug":"/api/property-management-1.0.1/residents/editresidentportal","metadata":{"seo":{"title":"Updates Resident Portal Configurations","description":"Allows the user to selectively update resident portal configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editResidentPortal","name":"Updates Resident Portal Configurations","isWebhook":false,"pointer":"/paths/~1residentPortals~1{portalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates Resident Portal Configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to selectively update resident portal configurations."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portalId","in":"path","schemaId":"schema_2","description":"Resident Portal Id","required":true}],"pointer":"/paths/~1residentPortals~1{portalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_9"}},"schemaId":"schema_9","pointer":"/paths/~1residentPortals~1{portalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/residentPortals/{portalId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"portalId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"multipart/form-data":{"schemaId":"schema_9"}},"responseCodes":["200","400","404","500"],"pointer":"/residentPortals/{portalId}","href":"residents/editresidentportal","openApiOperationId":"editResidentPortal","summary":"Updates Resident Portal Configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"schema_9","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_9"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resident portal configuration updated","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelResidentPortal"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelResidentPortal"}},"schemaId":"components/schemas/EntityModelResidentPortal"},{"code":"400","description":"Missing or invalid request body","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Resident portal configuration not found for the given id","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals~1{portalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityModelResidentPortal","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelResidentPortal"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelResidentPortal"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals/{portalId}"},{"label":"Gets Resident Portal File","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/downloadportalfile","routeSlug":"/api/property-management-1.0.1/residents/downloadportalfile","metadata":{"seo":{"title":"Gets Resident Portal File","description":"Allows the user to get a resident portal file with the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPortalFile","name":"Gets Resident Portal File","isWebhook":false,"pointer":"/paths/~1residentPortals~1{portalId}~1files~1{type}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets Resident Portal File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to get a resident portal file with the given id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portalId","in":"path","schemaId":"schema_2","description":"Resident Portal Id","required":true},{"name":"type","in":"path","schemaId":"schema_10","description":"Resident Portal file type","required":true}],"pointer":"/paths/~1residentPortals~1{portalId}~1files~1{type}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/residentPortals/{portalId}/files/{type}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"portalId","in":"path","required":true,"schemaId":"schema_2"},{"name":"type","in":"path","required":true,"schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","404","500"],"pointer":"/residentPortals/{portalId}/files/{type}","href":"residents/downloadportalfile","openApiOperationId":"downloadPortalFile","summary":"Gets Resident Portal File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"400","description":"Bad request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Not found","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals~1{portalId}~1files~1{type}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"schema_11"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals/{portalId}/files/{type}"},{"label":"Deletes Resident Portal File","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/deleteportalfile","routeSlug":"/api/property-management-1.0.1/residents/deleteportalfile","metadata":{"seo":{"title":"Deletes Resident Portal File","description":"Allows the user to delete a resident portal file with the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePortalFile","name":"Deletes Resident Portal File","isWebhook":false,"pointer":"/paths/~1residentPortals~1{portalId}~1files~1{type}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes Resident Portal File","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to delete a resident portal file with the given id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portalId","in":"path","schemaId":"schema_2","description":"Resident Portal Id","required":true},{"name":"type","in":"path","schemaId":"schema_10","description":"Resident Portal file type","required":true}],"pointer":"/paths/~1residentPortals~1{portalId}~1files~1{type}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/residentPortals/{portalId}/files/{type}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"portalId","in":"path","required":true,"schemaId":"schema_2"},{"name":"type","in":"path","required":true,"schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","500"],"pointer":"/residentPortals/{portalId}/files/{type}","href":"residents/deleteportalfile","openApiOperationId":"deletePortalFile","summary":"Deletes Resident Portal File"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals~1{portalId}~1files~1{type}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals/{portalId}/files/{type}"},{"label":"Get Resident Portals","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/getallportals","routeSlug":"/api/property-management-1.0.1/residents/getallportals","metadata":{"seo":{"title":"Get Resident Portals","description":"Gets the list of resident portals paged. This method will be removed no sooner than 08/31/2026. The following URL POST /residentPortals/query can be used for this content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllPortals","name":"Get Resident Portals","deprecated":true,"isWebhook":false,"pointer":"/paths/~1residentPortals/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Resident Portals","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of resident portals paged. This method will be removed no sooner than 08/31/2026. The following URL POST /residentPortals/query can be used for this content."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_4","description":"Page size"},{"name":"page","in":"query","schemaId":"schema_4","description":"The page to retrieve (starts at one)."},{"name":"sort","in":"query","schemaId":"schema_5","description":"The field name to sort, comma separated from the sort order (asc or desc)."}],"pointer":"/paths/~1residentPortals/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/residentPortals","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"size","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_4"},{"name":"sort","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/residentPortals","href":"residents/getallportals","openApiOperationId":"getAllPortals","summary":"Get Resident Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resident portal details.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"}},"schemaId":"components/schemas/PageEntityModelResidentPortal"},{"code":"400","description":"Invalid input supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageEntityModelResidentPortal","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelResidentPortal"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals"},{"label":"Delete Resident Portals","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/residents/deleteresidentportals","routeSlug":"/api/property-management-1.0.1/residents/deleteresidentportals","metadata":{"seo":{"title":"Delete Resident Portals","description":"Allows the user to delete resident portals with the given ids. This method will be removed no sooner than 08/31/2026. The following URL DELETE /residentPortals/{portalId} can be used for this content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteResidentPortals","name":"Delete Resident Portals","deprecated":true,"isWebhook":false,"pointer":"/paths/~1residentPortals/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Resident Portals","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to delete resident portals with the given ids. This method will be removed no sooner than 08/31/2026. The following URL DELETE /residentPortals/{portalId} can be used for this content."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12","pointer":"/paths/~1residentPortals/delete/requestBody","description":"Resident portal ids to delete"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/residentPortals","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_12"}},"responseCodes":["200","400","500"],"pointer":"/residentPortals","href":"residents/deleteresidentportals","openApiOperationId":"deleteResidentPortals","summary":"Delete Resident Portals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_12"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1residentPortals/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/residentPortals"}],"content":{"contentType":"group","meta":{"name":"Residents"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Residents","showPageActions":true},{"nodeType":"markdoc","content":"Manages resident portals and announcements for a tenant."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/residentPortals","summary":"Adds Resident Portal","prefix":{"name":"post","color":"post"},"badges":[],"link":"/residents/addresidentportal","deprecated":false},{"title":"/residentPortals/query","summary":"Query Resident Portals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/residents/queryresidentportals","deprecated":false},{"title":"/residentPortals/{portalId}","summary":"Gets Resident Portal","prefix":{"name":"get","color":"get"},"badges":[],"link":"/residents/fetchresidentportal","deprecated":false},{"title":"/residentPortals/{portalId}","summary":"Delete Resident Portal","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/residents/deleteresidentportal","deprecated":false},{"title":"/residentPortals/{portalId}","summary":"Updates Resident Portal Configurations","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/residents/editresidentportal","deprecated":false},{"title":"/residentPortals/{portalId}/files/{type}","summary":"Gets Resident Portal File","prefix":{"name":"get","color":"get"},"badges":[],"link":"/residents/downloadportalfile","deprecated":false},{"title":"/residentPortals/{portalId}/files/{type}","summary":"Deletes Resident Portal File","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/residents/deleteportalfile","deprecated":false},{"title":"/residentPortals","summary":"Get Resident Portals","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/residents/getallportals","deprecated":true},{"title":"/residentPortals","summary":"Delete Resident Portals","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/residents/deleteresidentportals","deprecated":true}]}]}]}]}},{"type":"group","label":"Units","link":"/api/property-management-1.0.1/units","routeSlug":"/api/property-management-1.0.1/units","items":[{"label":"Associate Identity to Unit","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/associateidentity","routeSlug":"/api/property-management-1.0.1/units/associateidentity","metadata":{"seo":{"title":"Associate Identity to Unit","description":"Allows the user to associate identities on the specified unit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"associateIdentity","name":"Associate Identity to Unit","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}~1identities~1{identityId}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Associate Identity to Unit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to associate identities on the specified unit."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","required":true},{"name":"unitId","in":"path","schemaId":"schema_2","required":true},{"name":"identityId","in":"path","schemaId":"schema_2","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}~1identities~1{identityId}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/venues/{venueId}/units/{unitId}/identities/{identityId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"},{"name":"unitId","in":"path","required":true,"schemaId":"schema_2"},{"name":"identityId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","409","500"],"pointer":"/venues/{venueId}/units/{unitId}/identities/{identityId}","href":"units/associateidentity","openApiOperationId":"associateIdentity","summary":"Associate Identity to Unit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Persona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Persona"}},"schemaId":"components/schemas/Persona","headers":{"Location":{"description":"Url for the added unit","style":"simple","schema":{"type":"string"}}},"headerSchemaId":"schema_13"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Persona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Persona"}},"schemaId":"components/schemas/Persona"},{"code":"409","description":"Conflict - The unit trying to add already exists","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Persona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Persona"}},"schemaId":"components/schemas/Persona","headers":{"Location":{"description":"Url of the existing unit","style":"simple","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Persona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Persona"}},"schemaId":"components/schemas/Persona"}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}~1identities~1{identityId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Persona","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Persona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Persona"}}},{"code":"400","schemaId":"components/schemas/Persona","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Persona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Persona"}}},{"code":"409","schemaId":"components/schemas/Persona","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Persona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Persona"}}},{"code":"500","schemaId":"components/schemas/Persona","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Persona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Persona"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/{unitId}/identities/{identityId}"},{"label":"Delete Unit Identity ","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/deleteidentity","routeSlug":"/api/property-management-1.0.1/units/deleteidentity","metadata":{"seo":{"title":"Delete Unit Identity ","description":"Allows the user to delete associated identity of the unit."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteIdentity","name":"Delete Unit Identity ","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}~1identities~1{identityId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Unit Identity ","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to delete associated identity of the unit."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true},{"name":"unitId","in":"path","schemaId":"schema_2","description":"Unit Id","required":true},{"name":"identityId","in":"path","schemaId":"schema_2","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}~1identities~1{identityId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/venues/{venueId}/units/{unitId}/identities/{identityId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"},{"name":"unitId","in":"path","required":true,"schemaId":"schema_2"},{"name":"identityId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","500"],"pointer":"/venues/{venueId}/units/{unitId}/identities/{identityId}","href":"units/deleteidentity","openApiOperationId":"deleteIdentity","summary":"Delete Unit Identity "},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok"},{"code":"400","description":"Bad request","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}~1identities~1{identityId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/{unitId}/identities/{identityId}"},{"label":"Update QoS Profile Assignment","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/qosprofileassignments","routeSlug":"/api/property-management-1.0.1/units/qosprofileassignments","metadata":{"seo":{"title":"Update QoS Profile Assignment","description":"Allows the user to update QoS profile assignments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"qosProfileAssignments","name":"Update QoS Profile Assignment","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1qosProfileAssignments~1{qosProfileId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update QoS Profile Assignment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to update QoS profile assignments."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","required":true},{"name":"qosProfileId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1qosProfileAssignments~1{qosProfileId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QoSProfileAssignment"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QoSProfileAssignment"}},"schemaId":"components/schemas/QoSProfileAssignment","pointer":"/paths/~1venues~1{venueId}~1units~1qosProfileAssignments~1{qosProfileId}/put/requestBody","description":"QoS profile assignment to assign"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/venues/{venueId}/units/qosProfileAssignments/{qosProfileId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"},{"name":"qosProfileId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QoSProfileAssignment"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QoSProfileAssignment"}},"responseCodes":["202","400","500"],"pointer":"/venues/{venueId}/units/qosProfileAssignments/{qosProfileId}","href":"units/qosprofileassignments","openApiOperationId":"qosProfileAssignments","summary":"Update QoS Profile Assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QoSProfileAssignment","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QoSProfileAssignment"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QoSProfileAssignment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}},"schemaId":"components/schemas/AcceptedResponse","headers":{"Location":{"description":"Url for the activity status","style":"simple","schema":{"type":"string"}}},"headerSchemaId":"schema_15"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units~1qosProfileAssignments~1{qosProfileId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"202","schemaId":"components/schemas/AcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/qosProfileAssignments/{qosProfileId}"},{"label":"Gets Units for Venue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/getallunits","routeSlug":"/api/property-management-1.0.1/units/getallunits","metadata":{"seo":{"title":"Gets Units for Venue","description":"Gets the list of units paged."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAllUnits","name":"Gets Units for Venue","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets Units for Venue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of units paged."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"size","in":"query","schemaId":"schema_4","description":"Page size"},{"name":"page","in":"query","schemaId":"schema_4","description":"The page to retrieve (starts at one)."},{"name":"sort","in":"query","schemaId":"schema_5","description":"The field name to sort, comma separated from the sort order (asc or desc)."}],"pointer":"/paths/~1venues~1{venueId}~1units/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/venues/{venueId}/units","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"size","in":"query","schemaId":"schema_4"},{"name":"page","in":"query","schemaId":"schema_4"},{"name":"sort","in":"query","schemaId":"schema_5"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400"],"pointer":"/venues/{venueId}/units","href":"units/getallunits","openApiOperationId":"getAllUnits","summary":"Gets Units for Venue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Units for venue.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Page"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Page"}},"schemaId":"components/schemas/Page"},{"code":"400","description":"Invalid input supplied.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Page","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Page"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Page"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units"},{"label":"Adds Unit to Venue","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/addunit","routeSlug":"/api/property-management-1.0.1/units/addunit","metadata":{"seo":{"title":"Adds Unit to Venue","description":"Allows the user to add a unit on the specified venue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addUnit","name":"Adds Unit to Venue","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adds Unit to Venue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to add a unit on the specified venue."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"bulk","in":"query","schemaId":"schema_16","description":"Flag to indicate bulk operation","required":true},{"name":"venueId","in":"query","schemaId":"schema_17","description":"Venue Id"},{"name":"category","in":"query","schemaId":"schema_18","description":"Category applied to every imported unit."}],"pointer":"/paths/~1venues~1{venueId}~1units/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Unit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Unit"},"multipart/form-data":{"schemaId":"schema_19"}},"schemaId":"components/schemas/Unit","pointer":"/paths/~1venues~1{venueId}~1units/post/requestBody","description":"Unit to add"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/venues/{venueId}/units","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"bulk","in":"query","required":true,"schemaId":"schema_16"},{"name":"venueId","in":"query"},{"name":"category","in":"query","required":false,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Unit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Unit"},"multipart/form-data":{"schemaId":"schema_19"}},"responseCodes":["200","202","400","409","422","500"],"pointer":"/venues/{venueId}/units","href":"units/addunit","openApiOperationId":"addUnit","summary":"Adds Unit to Venue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/Unit","mediaTypes":["application/json","application/vnd.ruckus.v1+json","multipart/form-data"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Unit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Unit"},"multipart/form-data":{"schemaId":"schema_19"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUnitsResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/BulkUnitsResponse"}},"schemaId":"components/schemas/BulkUnitsResponse"},{"code":"202","description":"Accepted","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}},"schemaId":"components/schemas/EntityModelAcceptedResponse","headers":{"Location":{"description":"Url for the added unit","style":"simple","schema":{"type":"string"}}},"headerSchemaId":"schema_13"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json","*/*"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"},"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"409","description":"Conflict - The unit trying to add already exists.","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource","headers":{"Location":{"description":"Url of the existing unit","style":"simple","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"422","description":"Unable to process the file","mediaType":"*/*","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json","*/*"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"},"*/*":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BulkUnitsResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BulkUnitsResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/BulkUnitsResponse"}}},{"code":"202","schemaId":"components/schemas/EntityModelAcceptedResponse","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json","*/*"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"},"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"409","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"422","schemaId":"components/schemas/ErrorResource","mediaTypes":["*/*"],"mediaTypeContent":{"*/*":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json","*/*"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"},"*/*":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units"},{"label":"Query Units for Venue","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/queryunits","routeSlug":"/api/property-management-1.0.1/units/queryunits","metadata":{"seo":{"title":"Query Units for Venue","description":"Gets the list of units using the specified query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryUnits","name":"Query Units for Venue","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Units for Venue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of units using the specified query."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1query/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_3","description":"Indicates that the content should be excluded from the query and only count and size data returned."}],"pointer":"/paths/~1venues~1{venueId}~1units~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1venues~1{venueId}~1units~1query/post/requestBody","description":"Data for the requested query "}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/venues/{venueId}/units/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400"],"pointer":"/venues/{venueId}/units/query","href":"units/queryunits","openApiOperationId":"queryUnits","summary":"Query Units for Venue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Units for venue.","mediaType":"text/csv","mediaTypes":["text/csv","application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_20"},"application/hal+json":{"schemaId":"components/schemas/PageEntityModelUnit"},"application/json":{"schemaId":"components/schemas/PageEntityModelUnit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelUnit"}},"schemaId":"schema_20"},{"code":"400","description":"Invalid query data supplied.","mediaType":"text/csv","mediaTypes":["text/csv","application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"text/csv":{"schemaId":"components/schemas/ErrorResource"},"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units~1query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["text/csv","application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_20"},"application/hal+json":{"schemaId":"components/schemas/PageEntityModelUnit"},"application/json":{"schemaId":"components/schemas/PageEntityModelUnit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelUnit"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["text/csv","application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"text/csv":{"schemaId":"components/schemas/ErrorResource"},"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/query"},{"label":"Gets Notifications for Units","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/resendnotifications","routeSlug":"/api/property-management-1.0.1/units/resendnotifications","metadata":{"seo":{"title":"Gets Notifications for Units","description":"Allows the user to resend notifications for units with the given ids."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"resendNotifications","name":"Gets Notifications for Units","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1notifications/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets Notifications for Units","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to resend notifications for units with the given ids."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1notifications/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_12"},"application/vnd.ruckus.v1+json":{"schemaId":"schema_12"}},"schemaId":"schema_12","pointer":"/paths/~1venues~1{venueId}~1units~1notifications/post/requestBody","description":"Unit ids (maximum of 100) to send notifications"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/venues/{venueId}/units/notifications","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_12"},"application/vnd.ruckus.v1+json":{"schemaId":"schema_12"}},"responseCodes":["200","400","500"],"pointer":"/venues/{venueId}/units/notifications","href":"units/resendnotifications","openApiOperationId":"resendNotifications","summary":"Gets Notifications for Units"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"schema_12","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_12"},"application/vnd.ruckus.v1+json":{"schemaId":"schema_12"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Notifications sent successfully."},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units~1notifications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/notifications"},{"label":"Query Unit Identities","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/queryidentities","routeSlug":"/api/property-management-1.0.1/units/queryidentities","metadata":{"seo":{"title":"Query Unit Identities","description":"Gets the list of identities using the specified query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryIdentities","name":"Query Unit Identities","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1identities~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Unit Identities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the list of identities using the specified query."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1identities~1query/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_3","description":"Indicates that the content should be excluded from the query and only count and size data returned."}],"pointer":"/paths/~1venues~1{venueId}~1units~1identities~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"schemaId":"components/schemas/QueryData","pointer":"/paths/~1venues~1{venueId}~1units~1identities~1query/post/requestBody","description":"Data for the requested query "}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/venues/{venueId}/units/identities/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_3"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"responseCodes":["200","400"],"pointer":"/venues/{venueId}/units/identities/query","href":"units/queryidentities","openApiOperationId":"queryIdentities","summary":"Query Unit Identities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/QueryData","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/QueryData"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/QueryData"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Identities for venue.","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/PageEntityModelPersona"},"application/json":{"schemaId":"components/schemas/PageEntityModelPersona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelPersona"}},"schemaId":"components/schemas/PageEntityModelPersona"},{"code":"400","description":"Invalid query data supplied.","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units~1identities~1query/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PageEntityModelPersona","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/PageEntityModelPersona"},"application/json":{"schemaId":"components/schemas/PageEntityModelPersona"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/PageEntityModelPersona"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/identities/query"},{"label":"Gets Unit for Venue","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/fetchunit","routeSlug":"/api/property-management-1.0.1/units/fetchunit","metadata":{"seo":{"title":"Gets Unit for Venue","description":"Allows the user to get a unit with the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchUnit","name":"Gets Unit for Venue","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets Unit for Venue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to get a unit with the given id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true},{"name":"unitId","in":"path","schemaId":"schema_2","description":"Unit Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/venues/{venueId}/units/{unitId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"},{"name":"unitId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","500"],"pointer":"/venues/{venueId}/units/{unitId}","href":"units/fetchunit","openApiOperationId":"fetchUnit","summary":"Gets Unit for Venue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/EntityModelUnit"},"application/json":{"schemaId":"components/schemas/EntityModelUnit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelUnit"}},"schemaId":"components/schemas/EntityModelUnit"},{"code":"400","description":"Bad request","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/hal+json","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityModelUnit","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/EntityModelUnit"},"application/json":{"schemaId":"components/schemas/EntityModelUnit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelUnit"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/hal+json","application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/hal+json":{"schemaId":"components/schemas/ErrorResource"},"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/{unitId}"},{"label":"Delete Unit for Venue","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/deleteunit","routeSlug":"/api/property-management-1.0.1/units/deleteunit","metadata":{"seo":{"title":"Delete Unit for Venue","description":"Allows the user to delete a unit with the given id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUnit","name":"Delete Unit for Venue","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Unit for Venue","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to delete a unit with the given id."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true},{"name":"unitId","in":"path","schemaId":"schema_2","description":"Unit Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/venues/{venueId}/units/{unitId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"},{"name":"unitId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","202","400","500"],"pointer":"/venues/{venueId}/units/{unitId}","href":"units/deleteunit","openApiOperationId":"deleteUnit","summary":"Delete Unit for Venue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}},"schemaId":"components/schemas/AcceptedResponse"},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}},"schemaId":"components/schemas/AcceptedResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}}},{"code":"202","schemaId":"components/schemas/AcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/{unitId}"},{"label":"Selectively Updates Unit Configurations","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/editunit","routeSlug":"/api/property-management-1.0.1/units/editunit","metadata":{"seo":{"title":"Selectively Updates Unit Configurations","description":"Allows the user to selectively update unit configurations on the specified venue."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"editUnit","name":"Selectively Updates Unit Configurations","isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Selectively Updates Unit Configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows the user to selectively update unit configurations on the specified venue."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true},{"name":"unitId","in":"path","schemaId":"schema_2","description":"Unit Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Unit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Unit"}},"schemaId":"components/schemas/Unit","pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/patch/requestBody","description":"Unit to edit"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/venues/{venueId}/units/{unitId}","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"},{"name":"unitId","in":"path","required":true,"schemaId":"schema_2"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/Unit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Unit"}},"responseCodes":["200","202","400","404","500"],"pointer":"/venues/{venueId}/units/{unitId}","href":"units/editunit","openApiOperationId":"editUnit","summary":"Selectively Updates Unit Configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/Unit","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Unit"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/Unit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Unit configuration updated","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}},"schemaId":"components/schemas/EntityModelAcceptedResponse"},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}},"schemaId":"components/schemas/EntityModelAcceptedResponse"},{"code":"400","description":"Missing or invalid request body","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"404","description":"Unit configuration not found for the given venue id","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units~1{unitId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntityModelAcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}}},{"code":"202","schemaId":"components/schemas/EntityModelAcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/EntityModelAcceptedResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"404","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units/{unitId}"},{"label":"Delete Units for Venue","deprecated":true,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/property-management-1.0.1/units/deleteunits","routeSlug":"/api/property-management-1.0.1/units/deleteunits","metadata":{"seo":{"title":"Delete Units for Venue","description":"Allows the user to delete units with the given ids. This method will be removed no sooner than 08/31/2026. The following URL DELETE /venues/{venueId}/units/{unitId} can be used for this content."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUnits","name":"Delete Units for Venue","deprecated":true,"isWebhook":false,"pointer":"/paths/~1venues~1{venueId}~1units/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Units for Venue","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allows the user to delete units with the given ids. This method will be removed no sooner than 08/31/2026. The following URL DELETE /venues/{venueId}/units/{unitId} can be used for this content."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"venueId","in":"path","schemaId":"schema_0","description":"Venue Id","required":true}],"pointer":"/paths/~1venues~1{venueId}~1units/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_12"},"application/vnd.ruckus.v1+json":{"schemaId":"schema_12"}},"schemaId":"schema_12","pointer":"/paths/~1venues~1{venueId}~1units/delete/requestBody","description":"Unit ids to delete"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/venues/{venueId}/units","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[{"name":"venueId","in":"path","required":true,"schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_12"},"application/vnd.ruckus.v1+json":{"schemaId":"schema_12"}},"responseCodes":["200","202","400","500"],"pointer":"/venues/{venueId}/units","href":"units/deleteunits","openApiOperationId":"deleteUnits","summary":"Delete Units for Venue"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"schema_12","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_12"},"application/vnd.ruckus.v1+json":{"schemaId":"schema_12"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Ok","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}},"schemaId":"components/schemas/AcceptedResponse"},{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}},"schemaId":"components/schemas/AcceptedResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"},{"code":"500","description":"Internal server error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}},"schemaId":"components/schemas/ErrorResource"}],"pointer":"/paths/~1venues~1{venueId}~1units/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}}},{"code":"202","schemaId":"components/schemas/AcceptedResponse","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedResponse"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/AcceptedResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}},{"code":"500","schemaId":"components/schemas/ErrorResource","mediaTypes":["application/json","application/vnd.ruckus.v1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResource"},"application/vnd.ruckus.v1+json":{"schemaId":"components/schemas/ErrorResource"}}}],"examples":[]}]}]}]},"httpPath":"/venues/{venueId}/units"}],"content":{"contentType":"group","meta":{"name":"Units"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Units","showPageActions":true},{"nodeType":"markdoc","content":"Manages units for a venue."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/venues/{venueId}/units/{unitId}/identities/{identityId}","summary":"Associate Identity to Unit","prefix":{"name":"put","color":"put"},"badges":[],"link":"/units/associateidentity","deprecated":false},{"title":"/venues/{venueId}/units/{unitId}/identities/{identityId}","summary":"Delete Unit Identity ","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/units/deleteidentity","deprecated":false},{"title":"/venues/{venueId}/units/qosProfileAssignments/{qosProfileId}","summary":"Update QoS Profile Assignment","prefix":{"name":"put","color":"put"},"badges":[],"link":"/units/qosprofileassignments","deprecated":false},{"title":"/venues/{venueId}/units","summary":"Gets Units for Venue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/units/getallunits","deprecated":false},{"title":"/venues/{venueId}/units","summary":"Adds Unit to Venue","prefix":{"name":"post","color":"post"},"badges":[],"link":"/units/addunit","deprecated":false},{"title":"/venues/{venueId}/units/query","summary":"Query Units for Venue","prefix":{"name":"post","color":"post"},"badges":[],"link":"/units/queryunits","deprecated":false},{"title":"/venues/{venueId}/units/notifications","summary":"Gets Notifications for Units","prefix":{"name":"post","color":"post"},"badges":[],"link":"/units/resendnotifications","deprecated":false},{"title":"/venues/{venueId}/units/identities/query","summary":"Query Unit Identities","prefix":{"name":"post","color":"post"},"badges":[],"link":"/units/queryidentities","deprecated":false},{"title":"/venues/{venueId}/units/{unitId}","summary":"Gets Unit for Venue","prefix":{"name":"get","color":"get"},"badges":[],"link":"/units/fetchunit","deprecated":false},{"title":"/venues/{venueId}/units/{unitId}","summary":"Delete Unit for Venue","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/units/deleteunit","deprecated":false},{"title":"/venues/{venueId}/units/{unitId}","summary":"Selectively Updates Unit Configurations","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/units/editunit","deprecated":false},{"title":"/venues/{venueId}/units","summary":"Delete Units for Venue","prefix":{"name":"delete","color":"http-deprecated"},"badges":[],"link":"/units/deleteunits","deprecated":true}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Persona":{"id":"components/schemas/Persona","kind":"json-schema","title":"Persona","data":{"type":"object","description":"Represents a persona identity associated with a unit.","properties":{"unitId":{"type":"string","format":"uuid","description":"Unique identifier of the unit this persona belongs to."},"personaType":{"type":"string","description":"Type of persona: UNIT, GUEST, or LINKED.","enum":["UNIT","GUEST","LINKED"]},"personaId":{"type":"string","format":"uuid","description":"Unique identifier of the persona."}},"required":["personaId","personaType","unitId"]}},"components/schemas/ErrorResource":{"id":"components/schemas/ErrorResource","kind":"json-schema","title":"ErrorResource","data":{"type":"object","description":"Standard error response containing error details and validation messages.","properties":{"status":{"type":"string","description":"HTTP status code of the error response.","enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","103 CHECKPOINT","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","302 MOVED_TEMPORARILY","303 SEE_OTHER","304 NOT_MODIFIED","305 USE_PROXY","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 PAYLOAD_TOO_LARGE","413 REQUEST_ENTITY_TOO_LARGE","414 URI_TOO_LONG","414 REQUEST_URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","419 INSUFFICIENT_SPACE_ON_RESOURCE","420 METHOD_FAILURE","421 DESTINATION_LOCKED","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"timestamp":{"type":"string","format":"date-time","description":"Timestamp when the error occurred."},"requestId":{"type":"string","description":"Unique identifier for tracking the failed request."},"message":{"type":"string","description":"Brief error message describing the issue."},"detailedMessage":{"type":"string","description":"Detailed error message with additional context."},"validationErrors":{"type":"array","description":"List of validation error messages.","items":{"type":"string"}},"errors":{"type":"array","description":"List of nested error details.","items":{"$ref":"#/components/schemas/NestedError"}}}}},"components/schemas/NestedError":{"id":"components/schemas/NestedError","kind":"json-schema","title":"NestedError","data":{"type":"object","description":"Nested error details for validation errors.","properties":{"code":{"type":"string","description":"Error code identifier."},"message":{"type":"string","description":"Human-readable error message."},"reason":{"type":"string","description":"Reason for the error."},"suggestion":{"type":"string","description":"Suggested action to resolve the error."}}}},"components/schemas/QoSProfileAssignment":{"id":"components/schemas/QoSProfileAssignment","kind":"json-schema","title":"QoSProfileAssignment","data":{"type":"object","description":"QoS profile assignment details for units.","properties":{"unitIds":{"type":"array","description":"List of unit identifiers to assign the QoS profile to.","items":{"type":"string","format":"uuid"},"minItems":1},"profileExpiry":{"type":"string","format":"date-time","description":"Expiration date and time for the metering profile."}},"required":["profileExpiry","unitIds"]}},"components/schemas/AcceptedResponse":{"id":"components/schemas/AcceptedResponse","kind":"json-schema","title":"AcceptedResponse","data":{"type":"object","description":"Response returned when a request is accepted for asynchronous processing.","properties":{"requestId":{"type":"string","description":"Unique identifier for tracking the asynchronous request."}}}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"type":"object","description":"Physical address information for a venue location.","properties":{"country":{"type":"string","description":"Country where the venue is located."},"city":{"type":"string","description":"City where the venue is located."},"addressLine":{"type":"string","description":"Street address line of the venue."}},"required":["city","country"]}},"components/schemas/CommunicationConfigDto":{"id":"components/schemas/CommunicationConfigDto","kind":"json-schema","title":"CommunicationConfigDto","data":{"type":"object","description":"Configuration for unit change event notifications.","properties":{"type":{"type":"string"},"sendEmail":{"type":"boolean","description":"Flag to enable email notifications."},"sendSms":{"type":"boolean","description":"Flag to enable SMS notifications."},"notifyOnUnitSuspend":{"type":"boolean","description":"Notify on unit suspend."},"unitAssignmentHtmlRegId":{"type":"string","description":"Unit assignment hyper text template."},"unitAssignmentTextRegId":{"type":"string","description":"Unit assignment text template."},"unitPassphraseChangeHtmlRegId":{"type":"string","description":"Unit passphrase change hyper text template."},"unitPassphraseChangeTextRegId":{"type":"string","description":"Unit passphrase change text template."},"guestPassphraseChangeHtmlRegId":{"type":"string","description":"Guest passphrase change hyper text template."},"guestPassphraseChangeTextRegId":{"type":"string","description":"Guest passphrase change text template."},"portalAccessResetHtmlRegId":{"type":"string","description":"Portal access reset hyper text template."},"portalAccessResetTextRegId":{"type":"string","description":"Portal access reset text template."},"portAssignmentHtmlRegId":{"type":"string","description":"Port assignment hyper text template."},"portAssignmentTextRegId":{"type":"string","description":"Port assignment text template."},"unitSuspendHtmlRegId":{"type":"string","description":"Unit suspend hyper text template."},"unitSuspendTextRegId":{"type":"string","description":"Unit suspend text template."},"unitUserSuspendHtmlRegId":{"type":"string","description":"Unit user suspend hyper text template."},"unitUserSuspendTextRegId":{"type":"string","description":"Unit user suspend text template."},"unitReactivateHtmlRegId":{"type":"string","description":"Unit reactivate hyper text template."},"unitReactivateTextRegId":{"type":"string","description":"Unit reactivate text template."},"unitUserReactivateHtmlRegId":{"type":"string","description":"Unit user reactivate hyper text template."},"unitUserReactivateTextRegId":{"type":"string","description":"Unit user reactivate text template."}}}},"components/schemas/PropertyUpdateDto":{"id":"components/schemas/PropertyUpdateDto","kind":"json-schema","title":"PropertyUpdateDto","data":{"type":"object","description":"Property configuration update details for a venue.","properties":{"venueId":{"type":"string","description":"Unique identifier of the venue."},"venueName":{"type":"string","description":"Display name for the venue."},"address":{"$ref":"#/components/schemas/Address","description":"Physical address of the venue."},"description":{"type":"string"},"venue":{"description":"Property venue details and address."},"personaGroupId":{"type":"string","description":"Identifier of the associated persona group."},"residentPortalId":{"type":"string","format":"uuid","deprecated":true,"description":"Identifier of the assigned resident portal."},"status":{"type":"string","default":"DISABLED","description":"Status of the property","enum":["DISABLED","ENABLED"]},"pmsId":{"type":"string","description":"Property management system identifier."},"pmsPropertyId":{"type":"string","description":"Identifier for the property in the associated property management system."},"unitConfig":{"$ref":"#/components/schemas/UnitConfigDto","description":"Basic configuration on property units."},"communicationConfig":{"$ref":"#/components/schemas/CommunicationConfigDto","description":"Configuration for communicating unit change events."},"retainPmsUnits":{"type":"boolean","description":"Whether to retain PMS units on changing or removing associated PMS."}},"required":["personaGroupId","status","venue","venueName"]}},"components/schemas/UnitConfigDto":{"id":"components/schemas/UnitConfigDto","kind":"json-schema","title":"UnitConfigDto","data":{"type":"object","description":"Basic configuration settings for property units.","properties":{"type":{"type":"string","description":"Configuration type identifier."},"residentPortalAllowed":{"type":"boolean","description":"Flag to allow resident portal access for units."},"residentApiAllowed":{"type":"boolean","description":"Flag to allow resident portal API access."},"useMaxUnitCount":{"type":"boolean","description":"Flag to restrict maximum unit count for property."},"maxUnitCount":{"type":"integer","format":"int32","description":"Maximum allowed unit count for the property."},"guestAllowed":{"type":"boolean","description":"Flag to allow separate guest persona for the unit."}}}},"components/schemas/EntityModelAcceptedResponse":{"id":"components/schemas/EntityModelAcceptedResponse","kind":"json-schema","title":"EntityModelAcceptedResponse","data":{"type":"object","description":"HATEOAS wrapper for accepted response with hypermedia links.","properties":{"requestId":{"type":"string","description":"Unique identifier for tracking the asynchronous request."},"_links":{"$ref":"#/components/schemas/Links"}}}},"components/schemas/PropertyResidentPortalAssignment":{"id":"components/schemas/PropertyResidentPortalAssignment","kind":"json-schema","title":"PropertyResidentPortalAssignment","data":{"type":"object","description":"Assignment mapping between a property venue and resident portal.","properties":{"venueId":{"type":"string","description":"Unique identifier of the venue."},"residentPortalId":{"type":"string","format":"uuid","description":"Unique identifier of the assigned resident portal."}}}},"components/schemas/DpskSettings":{"id":"components/schemas/DpskSettings","kind":"json-schema","title":"DpskSettings","data":{"type":"object","description":"DPSK passphrase and VLAN configuration settings.","properties":{"type":{"type":"string","description":"Type of DPSK persona: UNIT, GUEST, or LINKED.","enum":["UNIT","GUEST","LINKED"]},"passphrase":{"type":"string","description":"DPSK passphrase for wireless network access. Maximum length is 63 characters.","maxLength":63,"minLength":0},"vlan":{"type":"integer","format":"int32","description":"VLAN ID for the DPSK configuration. Valid range is 1-4094.","maximum":4094,"minimum":1}},"required":["type"]}},"components/schemas/LanPort":{"id":"components/schemas/LanPort","kind":"json-schema","title":"LanPort","data":{"type":"object","description":"LAN port configuration with MAC address and port index.","properties":{"macAddress":{"type":"string","description":"The MAC address of the port.","pattern":"^([0-9A-Fa-f]{2}-){5}([0-9A-Fa-f]{2})$|^([0-9A-Fa-f]{2}:){5}([0-9A-Fa-f]{2})$|^([0-9A-Fa-f]{6})-([0-9A-Fa-f]{6})$|^([0-9A-Fa-f]{4}[.]){2}([0-9A-Fa-f]{4})$|^[0-9A-Fa-f]{12}$"},"portIndex":{"type":"integer","format":"int32","description":"The index of the port."}},"required":["macAddress","portIndex"]}},"components/schemas/Resident":{"id":"components/schemas/Resident","kind":"json-schema","title":"Resident","data":{"type":"object","description":"Contact information for a unit resident.","properties":{"name":{"type":"string","description":"Full name of the unit resident.","maxLength":255,"minLength":0},"email":{"type":"string","description":"Email address for contacting the resident.","maxLength":255,"minLength":0},"phoneNumber":{"type":"string","description":"Phone number for contacting the resident.","maxLength":16,"minLength":0}}}},"components/schemas/TrafficControl":{"id":"components/schemas/TrafficControl","kind":"json-schema","title":"TrafficControl","data":{"type":"object","description":"Traffic control and QoS metering profile settings.","properties":{"meteringProfileId":{"type":"string","description":"Identifier of the metering profile to apply.","minLength":1},"profileExpiry":{"type":"string","format":"date-time","description":"Expiration date and time for the metering profile."}},"required":["meteringProfileId","profileExpiry"]}},"components/schemas/Unit":{"id":"components/schemas/Unit","kind":"json-schema","title":"Unit","data":{"type":"object","description":"Represents a unit within a property venue.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the unit."},"name":{"type":"string","description":"Unit name.","maxLength":235,"minLength":0},"resident":{"$ref":"#/components/schemas/Resident","description":"Contact details of the unit resident."},"pmsUnitId":{"type":"string","description":"Property management system unit identifier."},"type":{"type":"string","description":"Unit type.","enum":["R1","PMS","INTERNAL"]},"category":{"type":"string","description":"Category of the unit.","enum":["UNIT","CONFERENCEROOM"]},"status":{"type":"string","description":"Unit status.","enum":["DISABLED","ENABLED"]},"dpsks":{"type":"array","description":"List of DPSK passphrase configurations.","items":{"$ref":"#/components/schemas/DpskSettings"},"maxItems":2,"minItems":0},"accessPoint":{"$ref":"#/components/schemas/UnitAp","description":"Access point configuration for the unit."},"trafficControl":{"$ref":"#/components/schemas/TrafficControl","description":"Traffic control and QoS profile details."},"personaId":{"type":"string","format":"uuid","description":"Unique identifier of the unit persona."},"guestPersonaId":{"type":"string","format":"uuid","description":"Unique identifier of the guest persona."},"identityCount":{"type":"integer","format":"int64","description":"Count of identities associated with the unit.","readOnly":true}},"required":["name","resident"]}},"components/schemas/UnitAp":{"id":"components/schemas/UnitAp","kind":"json-schema","title":"UnitAp","data":{"type":"object","description":"Access point configuration details for a unit.","properties":{"name":{"type":"string","description":"Name identifier for the access point.","minLength":1},"selectedPorts":{"type":"array","description":"List of selected LAN ports for the unit.","items":{"$ref":"#/components/schemas/LanPort"}}},"required":["name"]}},"components/schemas/BulkUnitsResponse":{"id":"components/schemas/BulkUnitsResponse","kind":"json-schema","title":"BulkUnitsResponse","data":{"type":"object","description":"Response for bulk units operation with success and failure details.","properties":{"totalCount":{"type":"integer","format":"int64","description":"Total number of units processed.","example":100},"createdCount":{"type":"integer","format":"int64","description":"Number of newly created units.","example":60},"existingCount":{"type":"integer","format":"int64","description":"Number of units that already existed (already imported).","example":25},"failedCount":{"type":"integer","format":"int64","description":"Number of units that failed to process.","example":15},"errorMessage":{"type":"string","description":"Error message if the operation failed (e.g., quota exceeded)."},"venueId":{"type":"string","description":"Venue ID associated with the bulk units operation.","example":"9fcb769a6a9e446ca7f2991326cbe5be"},"venueName":{"type":"string","description":"Venue name associated with the bulk units operation.","example":"Opera"},"unitsByStatus":{"$ref":"#/components/schemas/UnitsByStatus","description":"Units grouped by status: created, existing, and failed."}}}},"components/schemas/UnitsByStatus":{"id":"components/schemas/UnitsByStatus","kind":"json-schema","title":"UnitsByStatus","data":{"type":"object","description":"Units grouped by status with created, existing, and failed units.","properties":{"created":{"type":"array","description":"List of newly created unit names.","items":{"type":"string"}},"existing":{"type":"array","description":"List of existing unit names (already imported).","items":{"type":"string"}},"failed":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of failed units with unit name as key and error message as value."}}}},"components/schemas/QueryData":{"id":"components/schemas/QueryData","kind":"json-schema","title":"QueryData","data":{"type":"object","description":"Query parameters for filtering, sorting, and paginating results.","properties":{"fields":{"type":"array","description":"List of field names to include in results.","items":{"type":"string"}},"sortField":{"type":"string","description":"Field name to use for sorting results."},"keyword":{"type":"string","description":"Search keyword for filtering results."},"sortOrder":{"type":"string","description":"Sort direction: ASC for ascending or DESC for descending.","enum":["ASC","DESC"]},"page":{"type":"integer","format":"int32","description":"Page number to retrieve starting from one."},"pageSize":{"type":"integer","format":"int32","description":"Number of items to include per page."},"filters":{"type":"object","additionalProperties":{},"description":"Filter criteria specified as name and value pairs."}},"required":["page","pageSize","sortOrder"]}},"components/schemas/EntityModelUnit":{"id":"components/schemas/EntityModelUnit","kind":"json-schema","title":"EntityModelUnit","data":{"type":"object","description":"HATEOAS wrapper for unit details with hypermedia links.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the unit."},"name":{"type":"string","description":"Unit name.","maxLength":235,"minLength":0},"resident":{"$ref":"#/components/schemas/Resident","description":"Contact details of the unit resident."},"pmsUnitId":{"type":"string","description":"Property management system unit identifier."},"type":{"type":"string","description":"Unit type.","enum":["R1","PMS","INTERNAL"]},"category":{"type":"string","description":"Category of the unit.","enum":["UNIT","CONFERENCEROOM"]},"status":{"type":"string","description":"Unit status.","enum":["DISABLED","ENABLED"]},"dpsks":{"type":"array","description":"List of DPSK passphrase configurations.","items":{"$ref":"#/components/schemas/DpskSettings"},"maxItems":2,"minItems":0},"accessPoint":{"$ref":"#/components/schemas/UnitAp","description":"Access point configuration for the unit."},"trafficControl":{"$ref":"#/components/schemas/TrafficControl","description":"Traffic control and QoS profile details."},"personaId":{"type":"string","format":"uuid","description":"Unique identifier of the unit persona."},"guestPersonaId":{"type":"string","format":"uuid","description":"Unique identifier of the guest persona."},"identityCount":{"type":"integer","format":"int64","description":"Count of identities associated with the unit.","readOnly":true},"_links":{"$ref":"#/components/schemas/Links"}},"required":["name","resident"]}},"components/schemas/PageEntityModelUnit":{"id":"components/schemas/PageEntityModelUnit","kind":"json-schema","title":"PageEntityModelUnit","data":{"type":"object","description":"Paginated response containing unit details.","properties":{"totalElements":{"type":"integer","format":"int64","description":"Total number of units across all pages."},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages available."},"pageable":{"$ref":"#/components/schemas/PageableObject","description":"Pagination parameters used for the request."},"first":{"type":"boolean","description":"Indicates if this is the first page."},"last":{"type":"boolean","description":"Indicates if this is the last page."},"size":{"type":"integer","format":"int32","description":"Maximum number of units per page."},"content":{"type":"array","description":"List of units in the current page.","items":{"$ref":"#/components/schemas/EntityModelUnit"}},"number":{"type":"integer","format":"int32","description":"Current page number starting from zero."},"sort":{"$ref":"#/components/schemas/SortObject","description":"Sort information for the page."},"numberOfElements":{"type":"integer","format":"int32","description":"Number of units in the current page."},"empty":{"type":"boolean","description":"Indicates if the page has no content."}}}},"components/schemas/PageableObject":{"id":"components/schemas/PageableObject","kind":"json-schema","title":"PageableObject","data":{"type":"object","description":"Pagination information for the request.","properties":{"pageSize":{"type":"integer","format":"int32","description":"Number of elements per page."},"paged":{"type":"boolean","description":"Indicates if pagination is enabled."},"pageNumber":{"type":"integer","format":"int32","description":"Current page number starting from zero."},"unpaged":{"type":"boolean","description":"Indicates if pagination is disabled."},"offset":{"type":"integer","format":"int64","description":"Offset of the first element in the page."},"sort":{"$ref":"#/components/schemas/SortObject","description":"Sort information for the page."}}}},"components/schemas/SortObject":{"id":"components/schemas/SortObject","kind":"json-schema","title":"SortObject","data":{"type":"object","description":"Sorting information for the request.","properties":{"sorted":{"type":"boolean","description":"Indicates if results are sorted."},"unsorted":{"type":"boolean","description":"Indicates if results are unsorted."},"empty":{"type":"boolean","description":"Indicates if no sort criteria specified."}}}},"components/schemas/EntityModelPersona":{"id":"components/schemas/EntityModelPersona","kind":"json-schema","title":"EntityModelPersona","data":{"type":"object","description":"HATEOAS wrapper for persona details with hypermedia links.","properties":{"unitId":{"type":"string","format":"uuid","description":"Unique identifier of the unit this persona belongs to."},"personaType":{"type":"string","description":"Type of persona: UNIT, GUEST, or LINKED.","enum":["UNIT","GUEST","LINKED"]},"personaId":{"type":"string","format":"uuid","description":"Unique identifier of the persona."},"_links":{"$ref":"#/components/schemas/Links"}},"required":["personaId","personaType","unitId"]}},"components/schemas/PageEntityModelPersona":{"id":"components/schemas/PageEntityModelPersona","kind":"json-schema","title":"PageEntityModelPersona","data":{"type":"object","description":"Paginated response containing persona details.","properties":{"totalElements":{"type":"integer","format":"int64","description":"Total number of personas across all pages."},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages available."},"pageable":{"$ref":"#/components/schemas/PageableObject","description":"Pagination parameters used for the request."},"first":{"type":"boolean","description":"Indicates if this is the first page."},"last":{"type":"boolean","description":"Indicates if this is the last page."},"size":{"type":"integer","format":"int32","description":"Maximum number of personas per page."},"content":{"type":"array","description":"List of personas in the current page.","items":{"$ref":"#/components/schemas/EntityModelPersona"}},"number":{"type":"integer","format":"int32","description":"Current page number starting from zero."},"sort":{"$ref":"#/components/schemas/SortObject","description":"Sort information for the page."},"numberOfElements":{"type":"integer","format":"int32","description":"Number of personas in the current page."},"empty":{"type":"boolean","description":"Indicates if the page has no content."}}}},"components/schemas/Page":{"id":"components/schemas/Page","kind":"json-schema","title":"Page","data":{"type":"object","description":"Paginated response containing a list of items.","properties":{"totalElements":{"type":"integer","format":"int64","description":"Total number of elements across all pages."},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages available."},"pageable":{"$ref":"#/components/schemas/PageableObject","description":"Pagination parameters used for the request."},"first":{"type":"boolean","description":"Indicates if this is the first page."},"last":{"type":"boolean","description":"Indicates if this is the last page."},"size":{"type":"integer","format":"int32","description":"Maximum number of elements per page."},"content":{"type":"array","description":"List of items in the current page.","items":{}},"number":{"type":"integer","format":"int32","description":"Current page number starting from zero."},"sort":{"$ref":"#/components/schemas/SortObject","description":"Sort information for the page."},"numberOfElements":{"type":"integer","format":"int32","description":"Number of elements in the current page."},"empty":{"type":"boolean","description":"Indicates if the page has no content."}}}},"components/schemas/ResidentPortal":{"id":"components/schemas/ResidentPortal","kind":"json-schema","title":"ResidentPortal","data":{"type":"object","description":"Resident portal configuration and settings.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the resident portal."},"name":{"type":"string","description":"Resident portal name.","minLength":1},"description":{"type":"string","description":"Resident portal description."},"portalStatus":{"type":"string","description":"Current status of the resident portal.","enum":["DISABLED","ENABLED"]},"venueCount":{"type":"integer","format":"int64","description":"Number of venues using this resident portal.","readOnly":true},"uiConfiguration":{"description":"UI configuration settings for the portal.","oneOf":[{"$ref":"#/components/schemas/ResidentPortalUiConfigs"}]}},"required":["name","uiConfiguration"]}},"components/schemas/ResidentPortalAccessConfig":{"id":"components/schemas/ResidentPortalAccessConfig","kind":"json-schema","title":"ResidentPortalAccessConfig","data":{"type":"object","description":"Access configuration settings for the resident portal.","properties":{"tenantSetDpsk":{"type":"boolean","description":"Indicates if tenant can set DPSK passphrase."}}}},"components/schemas/ResidentPortalColorConfig":{"id":"components/schemas/ResidentPortalColorConfig","kind":"json-schema","title":"ResidentPortalColorConfig","data":{"type":"object","description":"Color theme configuration for the resident portal UI.","properties":{"mainColor":{"type":"string","description":"Primary color for the portal theme.","pattern":"^$|^#(?:[0-9a-fA-F]{3}){1,2}$|^(?:[0-9a-fA-F]{3}){1,2}$"},"accentColor":{"type":"string","description":"Accent color for the portal theme.","pattern":"^$|^#(?:[0-9a-fA-F]{3}){1,2}$|^(?:[0-9a-fA-F]{3}){1,2}$"},"separatorColor":{"type":"string","description":"Separator line color for the portal.","pattern":"^$|^#(?:[0-9a-fA-F]{3}){1,2}$|^(?:[0-9a-fA-F]{3}){1,2}$"},"textColor":{"type":"string","description":"Text color for the portal content.","pattern":"^$|^#(?:[0-9a-fA-F]{3}){1,2}$|^(?:[0-9a-fA-F]{3}){1,2}$"}}}},"components/schemas/ResidentPortalConfig":{"id":"components/schemas/ResidentPortalConfig","kind":"json-schema","title":"ResidentPortalConfig","data":{"type":"object","description":"Base configuration interface for resident portal settings.","discriminator":{"propertyName":"type","mapping":{"ResidentPortalUiConfigs":"#/components/schemas/ResidentPortalUiConfigs"}},"properties":{"type":{"type":"string"}}}},"components/schemas/ResidentPortalFileConfig":{"id":"components/schemas/ResidentPortalFileConfig","kind":"json-schema","title":"ResidentPortalFileConfig","data":{"type":"object","description":"File configuration for portal logo and favorite icon.","properties":{"logoFileName":{"type":"string","description":"File name of the portal logo image.","maxLength":52,"minLength":0},"favIconFileName":{"type":"string","description":"File name of the portal favorite icon.","maxLength":52,"minLength":0}}}},"components/schemas/ResidentPortalTextConfig":{"id":"components/schemas/ResidentPortalTextConfig","kind":"json-schema","title":"ResidentPortalTextConfig","data":{"type":"object","description":"Text content configuration for the resident portal UI.","properties":{"loginText":{"type":"string","description":"Text displayed on the login page.","maxLength":52,"minLength":0},"title":{"type":"string","description":"Title text for the portal.","maxLength":52,"minLength":0},"subTitle":{"type":"string","description":"Subtitle text for the portal.","maxLength":52,"minLength":0},"announcements":{"type":"string","description":"Announcement text displayed on the portal.","maxLength":5000,"minLength":0},"helpText":{"type":"string","description":"Help text displayed on the portal.","maxLength":5000,"minLength":0}}}},"components/schemas/ResidentPortalUiConfigs":{"id":"components/schemas/ResidentPortalUiConfigs","kind":"json-schema","title":"ResidentPortalUiConfigs","data":{"allOf":[{"$ref":"#/components/schemas/ResidentPortalConfig"},{"type":"object","properties":{"access":{"$ref":"#/components/schemas/ResidentPortalAccessConfig","description":"Access configuration settings."},"color":{"$ref":"#/components/schemas/ResidentPortalColorConfig","description":"Color theme configuration."},"files":{"$ref":"#/components/schemas/ResidentPortalFileConfig","description":"File configuration for logo and favicon."},"text":{"$ref":"#/components/schemas/ResidentPortalTextConfig","description":"Text content configuration."},"type":{"type":"string","description":"Configuration type identifier."}}}],"description":"Complete UI configuration settings for the resident portal."}},"components/schemas/EntityModelResidentPortal":{"id":"components/schemas/EntityModelResidentPortal","kind":"json-schema","title":"EntityModelResidentPortal","data":{"type":"object","description":"HATEOAS wrapper for resident portal details with hypermedia links.","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the resident portal."},"name":{"type":"string","description":"Resident portal name.","minLength":1},"description":{"type":"string","description":"Resident portal description."},"portalStatus":{"type":"string","description":"Current status of the resident portal.","enum":["DISABLED","ENABLED"]},"venueCount":{"type":"integer","format":"int64","description":"Number of venues using this resident portal.","readOnly":true},"uiConfiguration":{"description":"UI configuration settings for the portal.","oneOf":[{"$ref":"#/components/schemas/ResidentPortalUiConfigs"}]},"_links":{"$ref":"#/components/schemas/Links"}},"required":["name","uiConfiguration"]}},"components/schemas/PageEntityModelResidentPortal":{"id":"components/schemas/PageEntityModelResidentPortal","kind":"json-schema","title":"PageEntityModelResidentPortal","data":{"type":"object","description":"Paginated response containing resident portal details.","properties":{"totalElements":{"type":"integer","format":"int64","description":"Total number of portals across all pages."},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages available."},"pageable":{"$ref":"#/components/schemas/PageableObject","description":"Pagination parameters used for the request."},"first":{"type":"boolean","description":"Indicates if this is the first page."},"last":{"type":"boolean","description":"Indicates if this is the last page."},"size":{"type":"integer","format":"int32","description":"Maximum number of portals per page."},"content":{"type":"array","description":"List of resident portals in the current page.","items":{"$ref":"#/components/schemas/EntityModelResidentPortal"}},"number":{"type":"integer","format":"int32","description":"Current page number starting from zero."},"sort":{"$ref":"#/components/schemas/SortObject","description":"Sort information for the page."},"numberOfElements":{"type":"integer","format":"int32","description":"Number of portals in the current page."},"empty":{"type":"boolean","description":"Indicates if the page has no content."}}}},"components/schemas/PropertyDto":{"id":"components/schemas/PropertyDto","kind":"json-schema","title":"PropertyDto","data":{"type":"object","description":"Property configuration details for a venue.","properties":{"venueId":{"type":"string","description":"Unique identifier of the venue."},"venueName":{"type":"string","description":"Display name for the venue."},"address":{"$ref":"#/components/schemas/Address","description":"Physical address of the venue."},"description":{"type":"string"},"venue":{"description":"Property venue details and address."},"personaGroupId":{"type":"string","description":"Identifier of the associated persona group."},"residentPortalId":{"type":"string","format":"uuid","deprecated":true,"description":"Identifier of the assigned resident portal."},"status":{"type":"string","default":"DISABLED","description":"Status of the property","enum":["DISABLED","ENABLED"]},"pmsId":{"type":"string","description":"Property management system identifier."},"pmsPropertyId":{"type":"string","description":"Identifier for the property in the associated property management system."},"unitConfig":{"$ref":"#/components/schemas/UnitConfigDto","description":"Basic configuration on property units."},"communicationConfig":{"$ref":"#/components/schemas/CommunicationConfigDto","description":"Configuration for communicating unit change events."}},"required":["personaGroupId","status","venue","venueName"]}},"components/schemas/EntityModelPropertyDto":{"id":"components/schemas/EntityModelPropertyDto","kind":"json-schema","title":"EntityModelPropertyDto","data":{"type":"object","description":"HATEOAS wrapper for property configuration with hypermedia links.","properties":{"venueId":{"type":"string","description":"Unique identifier of the venue."},"venueName":{"type":"string","description":"Display name for the venue."},"address":{"$ref":"#/components/schemas/Address","description":"Physical address of the venue."},"description":{"type":"string"},"venue":{"description":"Property venue details and address."},"personaGroupId":{"type":"string","description":"Identifier of the associated persona group."},"residentPortalId":{"type":"string","format":"uuid","deprecated":true,"description":"Identifier of the assigned resident portal."},"status":{"type":"string","default":"DISABLED","description":"Status of the property","enum":["DISABLED","ENABLED"]},"pmsId":{"type":"string","description":"Property management system identifier."},"pmsPropertyId":{"type":"string","description":"Identifier for the property in the associated property management system."},"unitConfig":{"$ref":"#/components/schemas/UnitConfigDto","description":"Basic configuration on property units."},"communicationConfig":{"$ref":"#/components/schemas/CommunicationConfigDto","description":"Configuration for communicating unit change events."},"_links":{"$ref":"#/components/schemas/Links"}},"required":["personaGroupId","status","venue","venueName"]}},"components/schemas/PageEntityModelPropertyDto":{"id":"components/schemas/PageEntityModelPropertyDto","kind":"json-schema","title":"PageEntityModelPropertyDto","data":{"type":"object","description":"Paginated response containing property configuration details.","properties":{"totalElements":{"type":"integer","format":"int64","description":"Total number of properties across all pages."},"totalPages":{"type":"integer","format":"int32","description":"Total number of pages available."},"pageable":{"$ref":"#/components/schemas/PageableObject","description":"Pagination parameters used for the request."},"first":{"type":"boolean","description":"Indicates if this is the first page."},"last":{"type":"boolean","description":"Indicates if this is the last page."},"size":{"type":"integer","format":"int32","description":"Maximum number of properties per page."},"content":{"type":"array","description":"List of property configurations in the current page.","items":{"$ref":"#/components/schemas/EntityModelPropertyDto"}},"number":{"type":"integer","format":"int32","description":"Current page number starting from zero."},"sort":{"$ref":"#/components/schemas/SortObject","description":"Sort information for the page."},"numberOfElements":{"type":"integer","format":"int32","description":"Number of properties in the current page."},"empty":{"type":"boolean","description":"Indicates if the page has no content."}}}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string"},"hreflang":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"deprecation":{"type":"string"},"profile":{"type":"string"},"name":{"type":"string"},"templated":{"type":"boolean"}}}},"components/schemas/Links":{"id":"components/schemas/Links","kind":"json-schema","title":"Links","data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Link"}}},"schema_0":{"kind":"json-schema","data":{"type":"string","minLength":1},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"Url for the enabled property configuration"}}},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"integer","format":"int32"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"string"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"portal":{"$ref":"#/components/schemas/ResidentPortal"},"logo":{"type":"string","format":"binary","description":"Portal logo image"},"favIcon":{"type":"string","format":"binary","description":"Portal fav icon image"}},"required":["portal"]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"Url for the added resident portal"}}},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"Url of the existing resident portal"}}},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"changes":{"$ref":"#/components/schemas/ResidentPortal","description":"A map contains the keys and values to be updated for the resident portal resource. Minimum one and maximum twenty keys can be present in the map."},"logo":{"type":"string","format":"binary","description":"Portal logo image"},"favIcon":{"type":"string","format":"binary","description":"Portal fav icon image"}}},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"string","enum":["logo","favIcon"]},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","format":"byte"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","format":"uuid"}},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"Url for the added unit"}}},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"Url of the existing unit"}}},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","description":"Url for the activity status"}}},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"string","enum":["UNIT","CONFERENCEROOM"]},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"object","properties":{"unitImports":{"type":"string","format":"binary"}},"required":["unitImports"]},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","format":"binary"},"id":"schema_20"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"specType":"openapi"},"options":{"hideReplay":true,"hideDownloadButtons":false,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"}]},"downloadUrls":[{"title":"Download PDF","url":"https://docs.ruckus.cloud/static/api/property-management-1.0.1.pdf"}],"feedback":{"hide":true,"settings":{"label":""}},"mockServer":{"off":true,"position":"off"},"disableRouter":true,"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Property Management","description":"# Overview\n\nThese APIs facilitate managing property configurations and units management for a venue.\n"}},"baseSlug":"/api/property-management-1.0.1","routesMapping":{}}