listVenueDetails
POST {{url}}/operatorconsole/venues/listVenueDetails
- Use this API to list all venues/locations.
- Optional : KeyPoolID - only show venues that are connected to a specific KeyPoolID
Request Body
{"VenueID"=>"{{VenueID}}"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
origin | string |
RESPONSES
status: OK
{"message":"","USA.MA.02081.ROAMINGIQLABS.WALPOLE._V3VENUE.USA.MA.01588.RUSSROOS.WHITINSVIL":{"dateAddedUTC":"2023-08-01T18:25:12.419Z","dateAddedUTC.ISO8601":"2023-08-01T18:25:12.419Z","VenueID":"USA.MA.02081.ROAMINGIQLABS.WALPOLE._V3VENUE.USA.MA.01588.RUSSROOS.WHITINSVIL","externalVenueID":"","VenueName":"Russ' Rooster Resort","AddressLine1":"20 Robin Rd","AddressLine2":"","City":"Whitinsville","State":"MA","Country":"USA","Country.ISO3166A3":"USA","PostalCode":"01588","TimeZone":-4,"PropertyManagementGroupID":"USA.MA.02081.ROAMINGIQLABS.WALPOLE","NetworkConfiguration":{"NAS-Identifier":"USA.MA.01588.RUSSROOS.WHITINSVIL","MinimumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess":1,"MaximumAutoGeneratedVLAN_GlobalWirelessPlusLocalWiredAccess":4000,"MinimumAutoGeneratedVLAN_LocalWirelessAccess":1,"MaximumAutoGeneratedVLAN_LocalWirelessAccess":4000,"MinimumAutoGeneratedVLAN_GlobalWirelessRoaming":1,"MaximumAutoGeneratedVLAN_GlobalWirelessRoaming":4000,"allowOverlappingSubscriptionWiredUnit":false,"VenueSSID":[],"GWError":""},"ServicePlanConfiguration":{"DefaultServicePlanID_GlobalWirelessPlusLocalWiredAccess":"USA.MA.02081.ROAMINGIQ.WALPOLE._V3SERVICEPLAN_.1GBPS","DefaultServicePlanID_LocalWirelessAccess":"USA.MA.02081.ROAMINGIQ.WALPOLE._V3SERVICEPLAN_.100MBPS","ServicePlanIDs":["USA.MA.02081.ROAMINGIQ.WALPOLE._V3SERVICEPLAN_.1GBPS","USA.MA.02081.ROAMINGIQ.WALPOLE._V3SERVICEPLAN_.100MBPS"],"ServicePlans":[{"ServicePlanID":"USA.MA.02081.ROAMINGIQ.WALPOLE._V3SERVICEPLAN_.1GBPS","ServicePlanName":"1 Gbps","DownloadKbps":1000000,"UploadKbps":1000000,"ConcurrentDevices":100,"GloballyAvailablePlan":true,"ServicePlanDescription":"1 Gbps (with in-unit wired ports, billed monthly)","externalServicePlanID":"","SMSCode":"","ServicePlanImageURL":"https://s3.amazonaws.com/ui.us-east-1.dev.wifikey.io/roamingiq/speed3.png","TrialCycles":0,"BillingCycleHours":730.5,"Currencies":["USD"],"BillingCyclePrice.USD":0,"BillingCycleRecurrence":0,"MaximumTrialCyclesPerSubscriberPerVenue":-1,"MaximumFreeEnrollmentsPerSubscriberPerVenue":-1,"SessionTimeoutSecondsPerDevice":3600},{"ServicePlanID":"USA.MA.02081.ROAMINGIQ.WALPOLE._V3SERVICEPLAN_.100MBPS","ServicePlanName":"100MBPS","DownloadKbps":100000,"UploadKbps":100000,"ConcurrentDevices":10,"GloballyAvailablePlan":true,"ServicePlanDescription":"100 Mbps (without in-unit wired ports)","externalServicePlanID":"","SMSCode":"","ServicePlanImageURL":"https://s3.amazonaws.com/ui.us-east-1.dev.wifikey.io/roamingiq/speed1.png","TrialCycles":0,"BillingCycleHours":24,"Currencies":["USD"],"BillingCyclePrice.USD":0,"BillingCycleRecurrence":1,"MaximumTrialCyclesPerSubscriberPerVenue":-1,"MaximumFreeEnrollmentsPerSubscriberPerVenue":-1,"SessionTimeoutSecondsPerDevice":3600}]},"Notifications":{"WelcomeEmail_countdown_hours":0,"sendSubscriptionAddedEmail":true,"sendSubscriptionEndEmail":false,"supressSubscriberNotifications":"Inherit"},"Roles":{"VenueAdministrators":[],"LeasingAgents":[]},"Integrations":{"ConnectWise":{"URL":"","serviceboardid":"","Authorization":""},"PRTG":{"URL":"","Username":"","PasswordHash":""}},"Reporting":{"ReportingSubscriptionEnd_lookahead_hours":720,"ReportingSubscriptionEnd_frequency_hours":720},"PMS":{"RealPage":{"RealPagePMCId":"","RealPageSiteId":"","enableRealPageSync":"Inherit","RealPageSyncDateTimeUTC.ISO8601":""}},"ShoppingCart":{"enableShoppingCart":true,"Currency":"USD","Stripe":{"StripePublishableKey":"Inherit","Stripe_Secret_key":"Inherit","Stripe_Webhook_signingsecret":"Inherit","StripeWebHookURL":"https://api.roamingiqtest.com/v1/eventprocessors/StripeEvents?stripeop=Russ' Rooster Resort","Stripe_allowrefund":"Inherit"},"TrialCycleAdjustment":0,"MaximumTrialCyclesPerSubscriber":"Inherit","MaximumFreeEnrollmentsPerSubscriber":"Inherit","ShoppingCartPriceAdjustment":0},"DisplayOptionID":"Inherit","Units":[],"UnitCount":0,"DisplayConfiguration":{"ThemeLight":{"LogoFileNameDesktopLogin":"roamingiq-logo.png","LogoFileNameMobileLogin":"roamingiq-logo.png","LogoFileNameDesktopMobileAfterLogin":"roamingiq-logo.png","LoginBackgroundColorHex":"#eeeeee","LoginTextColorHex":"#ffffff","BackgroundColorHex":"#eeeeee","PrimaryColorHex":"#044b77","SecondaryColorHex":"#000000","PrimaryTextColorHex":"#000000","SecondaryTextColorHex":"#000000","BorderColorHex":"#BFBFBF","LinkColorHex":"#000000","TableColorHex":"","BannerColor1Hex":"#044b77","BannerColor2Hex":"#044b77","NavbarColorHex":"","ModalColorHex":"","InputBoxColorHex":""},"ThemeDark":{"LogoFileNameDesktopLogin":"roamingiq-logo.png","LogoFileNameMobileLogin":"roamingiq-logo.png","LogoFileNameDesktopMobileAfterLogin":"roamingiq-logo.png","LoginBackgroundColorHex":"#eeeeee","LoginTextColorHex":"#ffffff","BackgroundColorHex":"#eeeeee","PrimaryColorHex":"#044b77","SecondaryColorHex":"#000000","PrimaryTextColorHex":"#000000","SecondaryTextColorHex":"#000000","BorderColorHex":"#BFBFBF","LinkColorHex":"#000000","TableColorHex":"","BannerColor1Hex":"#044b77","BannerColor2Hex":"#044b77","NavbarColorHex":"","ModalColorHex":"","InputBoxColorHex":""},"MetaData":{"FavIconHRef":"/favicon.ico?v=3","TitleTextContent":"VAULT Wi-Fi Service (Demo)","DescriptionContent":"VAULT Wi-Fi Service (Demo)"},"Behavior":{"CancellationMethod":"radio","PrivacyPolicyURL":"https://roamingiq.com/privacy-policy/","AllowedLocales":{"en-us":"English (US)","es-xl":"Spanish (Latin America)"},"ShowTour":false,"ShowFooterOnLoginPage":true,"S3Directory":"common","S3DirectoryCustomComponents":"common","GoogleAnalyticsID":""},"ShoppingCart":{"AllowSelfCancellation":true,"AllowSelfPaymentMethodUpdate":true,"AllowSelfServicePlanUpdate":true},"Support":{"ShowSupportLinks":true,"ExternallyManagedSupport":true,"ExternalSupportSystemURL":"","ShowEquipmentStatusToVenueAdministrator":true,"DisplaySuperAdminEmailModule":true,"SupportEmailAddress":"support@dish.wifikey.link","SupportPhoneNumber.E164":"+14042298114"}}},"errorProcessing":false}