API v.253

• admin
  • roles.list
  • roles.get
  • roles.add
  • roles.edit
  • roles.rem
  • roles.users.list
  • roles.users.assign
  • roles.users.remove
  • roles.users.set_triderole
  • roles.permissions.list
  • analytics.overview
  • analytics.clubs.list
  • analytics.club.card
  • analytics.sessions
  • analytics.devices.monitor
  • analytics.equipment.summary
  • analytics.workouts.usage
  • analytics.billing.anomalies
  • client_service.event_types.list
  • client_service.event_types.add
  • client_service.event_types.edit
  • client_service.event_types.remove
  • client_service.events.list
  • client_service.events.set
  • client_service.events.edit
  • client_service.events.remove
  • client_service.templates.list
  • client_service.templates.get
  • client_service.templates.add
  • client_service.templates.edit
  • client_service.templates.remove
  • client_service.rules.list
  • client_service.rules.get
  • client_service.rules.add
  • client_service.rules.edit
  • client_service.rules.remove
  • client_service.message_templates.list
  • client_service.actions.list
  • client_service.actions.cancel
  • client_service.actions.reschedule
  • client_service.actions.runNow
  • client_service.actions.addManual
  • client_service.funnel.report
  • client_service.surveys.results
  • club_notes.add
  • club_notes.list
  • club_notes.edit
  • club_notes.remove
  • challenges.search
  • challenges.get
  • challenges.stats
  • challenges.participants.list
  • challenges.participants.add
  • challenges.participants.remove
  • challenges.simulate.autojoin
  • challenges.simulate.activity
  • challenges.audit.list
  • challenges.reprocess
  • challenges.reprocess.user
  • challenges.reprocess.bulk
  • challenges.set.published
  • challenges.remove
  • challenges.restore
  • challenges.ratings.reset_lock
  • challenges.teams.redistribute
  • challenges.excluded.list
  • hero_routes.list
  • hero_routes.get
  • hero_routes.add
  • hero_routes.edit
  • hero_routes.remove
  • hero_routes.calculate
  • hero_routes.waypoints.update
  • hero_routes.points.list
  • hero_routes.points.get
  • hero_routes.points.add
  • hero_routes.points.edit
  • hero_routes.points.remove
  • manual_activity.preview
  • manual_activity.add
  • sessions.search
  • sessions.get
  • crm.billing.options.add
  • crm.billing.options.edit
  • crm.billing.options.get
  • crm.billing.options.list
  • crm.billing.options.remove
  • crm.billing.tariffs.add
  • crm.billing.tariffs.edit
  • crm.billing.tariffs.get
  • crm.billing.tariffs.list
  • crm.billing.tariffs.remove
  • crm.client_categories.add
  • crm.client_categories.edit
  • crm.client_categories.get
  • crm.client_categories.list
  • crm.client_categories.visible
  • crm.client_categories.remove
  • crm.client_comments.add
  • crm.client_comments.edit
  • crm.client_comments.get
  • crm.client_comments.list
  • crm.client_comments.remove
  • crm.client_contacts.add
  • crm.client_contacts.edit
  • crm.client_contacts.get
  • crm.client_contacts.list
  • crm.client_contacts.remove
  • crm.client_events.add
  • crm.client_events.edit
  • crm.client_events.get
  • crm.client_events.list
  • crm.client_events.remove
  • crm.clients.add
  • crm.clients.edit
  • crm.clients.get
  • crm.clients.list
  • crm.clients.remove
  • crm.clients.merge
  • crm.clients.merge_preview
  • crm.clients.import
  • crm.clients.set_categories
  • crm.clients.get_categories
  • cockpit.get
  • cockpit.clients.clubs_list
  • cockpit.categories.list
  • crm.clients.set_lifecycle
  • cockpit.clubs.create
  • cockpit.tariffs.list
  • cockpit.options.list
  • cockpit.invoices.create
  • cockpit.invoices.generate_pdf
  • cockpit.invoices.send_to_chat
  • cockpit.param_tree.list
  • cockpit.param_tree.add
  • cockpit.param_tree.edit
  • cockpit.param_tree.move
  • cockpit.param_tree.remove
  • cockpit.client_params.get
  • cockpit.client_params.set
  • cockpit.templates.list
  • cockpit.templates.get
  • cockpit.templates.add
  • cockpit.templates.edit
  • cockpit.templates.remove
  • cockpit.templates.applicable
  • cockpit.chat.binding.get
  • cockpit.chat.binding.generate
  • cockpit.chat.binding.unlink
  • cockpit.chat.history
  • cockpit.chat.new
  • cockpit.chat.send
  • cockpit.chat.send_template
  • cockpit.chat.subscribe
  • cockpit.chat.unsubscribe
  • cockpit.comments.list
  • cockpit.comments.add
  • cockpit.comments.remove
  • cockpit.equipment.list
  • cockpit.proposals.list
  • cockpit.proposals.get
  • cockpit.proposals.create
  • cockpit.proposals.update
  • cockpit.proposals.remove
  • cockpit.proposals.generate
  • cockpit.proposals.send_to_chat
  • cockpit.supplies.list
  • cockpit.supplies.get
  • cockpit.supplies.create
  • cockpit.supplies.edit
  • cockpit.supplies.shipment
  • cockpit.supplies.equipment_list
  • cockpit.supplies.statuses_list
  • cockpit.supplies.companies_list
  • cockpit.supplies.contract.generate
  • cockpit.supplies.contract.send_to_chat
  • cockpit.supplies.send_tracking
  • cockpit.cs.events.list
  • cockpit.cs.actions.list
  • cockpit.cs.surveys.results
  • cockpit.cs.templates.list
  • cockpit.cs.events.set
  • cockpit.cs.actions.cancel
  • cockpit.cs.actions.reschedule
  • cockpit.cs.actions.runNow
  • cockpit.cs.actions.addManual
  • cockpit.companies.list
  • cockpit.companies.add
  • cockpit.companies.edit
  • crm.deal_statuses.add
  • crm.deal_statuses.edit
  • crm.deal_statuses.get
  • crm.deal_statuses.list
  • crm.deal_statuses.remove
  • crm.deals.add
  • crm.deals.kanban
  • crm.deals.edit
  • crm.deals.move
  • crm.deals.win
  • crm.deals.lose
  • crm.deals.remove
  • crm.deals.get
  • crm.deals.list
  • crm.lead_sources.add
  • crm.lead_sources.edit
  • crm.lead_sources.list
  • crm.lead_sources.remove
  • crm.lost_reasons.add
  • crm.lost_reasons.edit
  • crm.lost_reasons.list
  • crm.lost_reasons.remove
  • crm.notifications.settings.get
  • crm.notifications.settings.save
  • crm.notifications.link_status
  • crm.notifications.unlink_telegram
  • crm.notifications.event_types
  • crm.pipelines.add
  • crm.pipelines.edit
  • crm.pipelines.list
  • crm.pipelines.get
  • crm.pipelines.remove
  • crm.sync.status
  • crm.sync.test
  • crm.sync.run
  • crm.sync.logs
  • crm.sync.dlq
  • crm.sync.dlq_retry
  • crm.sync.reconcile
  • crm.sync.drift
  • crm.reports.generate
  • crm.reports.forecast
  • crm.supplies.add
  • crm.supplies.edit
  • crm.supplies.get
  • crm.supplies.list
  • crm.supplies.remove
  • crm.supplies.shipment
  • crm.supplies.create_invoice
  • crm.supply_statuses.add
  • crm.supply_statuses.edit
  • crm.supply_statuses.get
  • crm.supply_statuses.list
  • crm.supply_statuses.remove
  • crm.equipment.add
  • crm.equipment.edit
  • crm.equipment.get
  • crm.equipment.list
  • crm.equipment.remove
  • invoices.add
  • invoices.edit
  • invoices.get
  • invoices.remove
  • invoices.list_all
  • invoices.mark_paid
  • invoices.paid
  • invoices.add_payment
  • invoices.set_status
  • payout.get
  • payout.list_all
  • payout.mark_paid
  • services.add
  • services.edit
  • services.get
  • services.list
  • services.remove
  • settings.update
  • users.employee_roles.list
  • users.client_clubs.list
  • users.videos.list
  • users.workouts.list
  • users.sessions.participant.list
  • users.sessions.coach.list
  • users.devices.list
  • users.challenges.list
  • users.merge.dryrun
  • users.merge
  • vectorizer.status
  • vectorizer.reindex
  • vectorizer.requeue_failed
  • vectorizer.metrics
  • screen.circle.types.add
  • certificates.create
  • certificates.list
  • screen.circle.types.edit
  • screen.circle.types.list
  • screen.circle.types.remove
  • club.devices.list
  • tags.add
  • tags.edit
  • tags.list
  • tags.remove
  • equipment_types.list
  • equipment_types.add
  • equipment_types.edit
  • equipment_types.get
  • box_types.list
  • box_types.add
  • box_types.edit
  • box_types.get
  • clubs.list
  • clubs.add
  • clubs.remove
  • clubs.edit
  • clubs.get
  • partners.list
  • partners.add
  • partners.get
  • partners.edit
  • clients.add
  • companies.list
  • clients.edit
  • clients.remove
  • clients.merge
  • clients.get
  • clients.list
  • contacts.add
  • contacts.edit
  • contacts.list
  • contacts.remove
  • contacts.get
  • comments.add
  • comments.edit
  • comments.remove
  • comments.get
  • comments.list
  • client.events.add
  • client.events.edit
  • client.events.remove
  • client.events.get
  • client.events.list
  • sport_types.add
  • sport_types.remove
  • sport_types.list
  • sport_types.edit
  • sport_types.settings_set
  • versions.add
  • versions.edit
  • versions.remove
  • versions.list
  • versions.get
  • app_versions.list
  • app_versions.add
  • app_versions.edit
  • banners.add
  • banners.edit
  • banners.get
  • banners.list
  • banners.remove
  • app_updates.add
  • app_updates.list
  • app_updates.edit
  • app_updates.get
  • app_updates.remove
  • app_updates.check
  • synctasks.list
  • synctasks.stats
  • synctasks.methods
  • synctasks.clubs
  • push_configs.list
  • push_configs.get
  • push_configs.add
  • push_configs.edit
  • push_configs.remove
  • push_configs.reload
• auth
  • requests.initscreen
  • requests.init
  • requests.check
  • requests.get
  • requests.confirmscreen
  • requests.confirm
  • init
  • uses.captcha
  • confirm
  • checktoken
• balance
  • current
  • operation
  • create.payout
• caddy
  • validateDomain
  • invalidateCache
  • clearCache
  • getCacheStats
• authors
  • get
  • save
  • set.avatar
• releases
  • create
  • edit
  • get
  • list
  • remove
• subscriptions
  • create
  • edit
  • remove
  • get
  • list
  • club-buy
  • client-buy
  • sales
• workouts
  • add
  • edit
  • list
  • get
  • filters
  • remove
• activities
  • history
  • graph
  • get
  • get.prevdiff
  • pmc
  • progress
• assistant
  • config
  • brief
  • post_session
  • activity_analysis
  • suggest_booking
  • chat.history
  • chat.send
• club
  • badges.client.list
  • badges.client.award
  • badges.stats
  • badges.clients_grid
  • badges.generate_image
  • badges.sync_progress
  • badges.manual_award
  • badges.revoke_award
  • badges.check_user
  • badges.user_progress
  • badges.list
  • badges.grid
  • badges.get
  • badges.add
  • badges.edit
  • badges.remove
  • badges.hide
  • badges.unhide
  • badges.conditions
  • badges.user_awards
  • badges.available
  • badges.my_badges
  • badges.year_wrapped
  • clients.list
  • clients.add
  • clients.remove
  • clients.editdata
  • clients.edittags
  • users.short
  • client_notes.add
  • client_notes.remove
  • client_notes.list
  • clients.batch_set_tag
  • clients.batch_remove_tag
  • clients.export
  • clients.integrations.get
  • clients.integrations.set
  • client_tags.add
  • client_tags.remove
  • client_tags.edit
  • client_tags.list
  • client_tags.grid
  • client_tags.get
  • achievements.add
  • achievements.edit
  • achievements.remove
  • achievements.bulkremove
  • achievements.hideforclubs
  • achievements.unhideforclubs
  • achievements.list
  • bookings.my.upcoming
  • bookings.session.participants
  • bookings.session.get
  • bookings.session.book
  • bookings.session.cancel
  • bookings.session.products.check
  • bookings.session.payment_options
  • bookings.session.check_payment
  • bookings.admin.grid
  • bookings.admin.get
  • bookings.admin.cancel
  • bookings.admin.checkin
  • bookings.admin.noshow
  • bookings.admin.refund
  • bookings.admin.batch
  • bookings.admin.export
  • bookings.personal.services
  • bookings.personal.slots
  • bookings.personal.book
  • bookings.personal.payment_options
  • bookings.personal.products.check
  • bookings.personal.check_payment
  • bookings.personal.cancel
  • boxes.zonehealth
  • boxes.list
  • boxes.stats
  • boxes.switch
  • boxes.remove
  • boxes.edit
  • boxes.get
  • boxes.update
  • boxes.settask
  • boxes.emulate
  • branding.gen
  • theme.schema.get
  • theme.assist
  • getsettings
  • editsettings
  • edit-settings
  • mainmenu.get
  • menu.get
  • menu.update
  • theme.get
  • theme.update
  • logos.get
  • logos.update
  • homescreen.get
  • homescreen.update
  • startsceeen.get
  • startscreen.update
  • bottommenu.get
  • bottommenu.update
  • employeemenu.get
  • employeemenu.update
  • ui_layout.get
  • customsettings.get
  • customsettings.update
  • titles.get
  • titles.edit
  • pages.get
  • pages.edit
  • icons.get
  • icons.update
  • icons.clear
  • ui_layout.update
  • chat.messages.new
  • chat.messages.old
  • clientchat.dashboard
  • clientchat.list
  • clientchat.get
  • clientchat.messages.list
  • clientchat.messages.new
  • clientchat.messages.send
  • clientchat.messages.read
  • clientchat.initiate
  • clientchat.assign
  • clientchat.notification_settings.get
  • clientchat.notification_settings.update
  • clientchat.client.get
  • clientchat.client.messages.list
  • clientchat.client.messages.new
  • clientchat.client.messages.send
  • clientchat.client.messages.read
  • clientchat.client.notification_settings.get
  • clientchat.client.notification_settings.update
  • clientchat.widget.config
  • clientchat.widget.init
  • clientchat.widget.messages
  • clientchat.widget.send
  • companies.list
  • companies.get
  • companies.lookup
  • companies.add
  • companies.edit
  • competitions.add
  • competitions.edit
  • competitions.remove
  • competitions.bulkremove
  • competitions.hideforclubs
  • competitions.unhideforclubs
  • competitions.list
  • competitions.get
  • competitions.listforclub
  • competitions.copy
  • competitions.reorder
  • checkSubdomainAvailable
  • setSubdomain
  • setCustomDomain
  • verifyCustomDomain
  • removeCustomDomain
  • getDomainSettings
  • setDomainMeta
  • setAnalytics
  • setAppStores
  • setClientsOnlyAuth
  • employees.list
  • employees.add
  • employees.remove
  • employees.edit
  • employees.get
  • employee.card.get
  • employee.card.list.public
  • employee.card.get.public
  • employee.card.edit
  • employees.integrations.set
  • employees.integrations.get
  • employees.maplist
  • employees.mapsave
  • employees.availability.get
  • employees.availability.set
  • employees.availability.check
  • employees.availability.slots
  • external_specialists.set
  • external_specialists.get
  • external_specialists.trainer_candidates
  • external_specialists.list
  • external_specialists.my_host_clubs
  • engagement.feed
  • faq.grid
  • faq.add
  • faq.edit
  • faq.get
  • faq.list
  • faq.remove
  • faq.clientList
  • faq.clientGet
  • client_fields.add
  • client_fields.edit
  • client_fields.remove
  • client_fields.hide
  • client_fields.unhide
  • client_fields.list
  • client_fields.client_list
  • indoortv.playlists.add
  • indoortv.playlists.list
  • indoortv.playlists.edit
  • indoortv.playlists.remove
  • indoortv.playlists.get
  • indoortv.schedule.add
  • indoortv.schedule.edit
  • indoortv.schedule.remove
  • indoortv.schedule.list
  • indoortv.schedule.get
  • indoortv.chat.send
  • indoortv.anouncements.add
  • indoortv.anouncements.list
  • indoortv.anouncements.remove
  • indoortv.anouncements.edit
  • indoortv.music.playlists.list
  • indoortv.music.playlists.add
  • indoortv.music.playlists.edit
  • indoortv.music.playlists.remove
  • indoortv.music.playlists.get
  • indoortv.layouts.list
  • indoortv.devices.list
  • indoortv.devices.update
  • polls.grid
  • polls.add
  • polls.edit
  • polls.remove
  • polls.get
  • polls.responses
  • polls.stats
  • polls.export
  • polls.clientList
  • polls.clientGet
  • polls.clientSubmit
  • polls.clientDecline
  • note_tags.add
  • note_tags.edit
  • note_tags.remove
  • note_tags.hide
  • note_tags.list
  • note_tags.list_simple
  • note_tags.grid
  • note_tags.get
  • notify_providers.add
  • notify_providers.get
  • notify_providers.list
  • notify_providers.grid
  • notify_providers.edit
  • notify_providers.remove
  • notify_providers.set_default
  • notify_providers.test
  • notify_providers.stats
  • notify_providers.options
  • notify_templates.add
  • notify_templates.get
  • notify_templates.list
  • notify_templates.grid
  • notify_templates.edit
  • notify_templates.remove
  • notify_templates.clone
  • notify_templates.types
  • notify_templates.preview
  • notify_templates.options
  • goods.list
  • goods.get
  • goods.add
  • goods.edit
  • goods.remove
  • goods.adjustStock
  • inventory.list
  • inventory.get
  • inventory.add
  • inventory.edit
  • inventory.remove
  • inventory.units.list
  • inventory.units.add
  • inventory.units.edit
  • inventory.units.status
  • inventory.units.remove
  • inventory.units.history
  • inventory.rent
  • inventory.return
  • inventory.available
  • inventory.rentalHistory
  • products.dashboard
  • products.list
  • products.categories.list
  • products.categories.list.public
  • products.list.public
  • products.remove
  • products.get
  • products.edit
  • products.add
  • products.categories.add
  • products.categories.edit
  • products.categories.remove
  • products.categories.get
  • products.categories.tree
  • products.categories.move
  • products.categories.reorder
  • packages.list
  • packages.get
  • packages.add
  • packages.edit
  • packages.remove
  • memberships.list
  • memberships.get
  • memberships.add
  • memberships.edit
  • memberships.remove
  • products.assist
  • products.generateDescription
  • products.maplist
  • products.mapsave
  • prolongationProducts.list
  • memberships.zones.list
  • products.calculatePrice
  • products.categories.maplist
  • products.categories.mapsave
  • purchases.list
  • purchases.make
  • purchases.cancel
  • payee.info.get
  • purchases.check_external_status
  • sessions.competition.top
  • clients.last.sessions
  • clients.upcoming.sessions
  • employee.last.sessions
  • employee.upcoming.sessions
  • sessions.photos.add
  • sessions.photos.list
  • sessions.like
  • sessions.likes.status
  • sessions.rate
  • sessions.comments.add
  • sessions.comments.remove
  • sessions.comments.list
  • sessions.restore
  • sessions.feed
  • schedule.list.public
  • sessiontypes.add
  • sessiontypes.grid
  • sessiontypes.listpublic
  • sessiontypes.getpublic
  • sessiontypes.list.multiclub
  • sessiontypes.list
  • sessiontypes.edit
  • sessiontypes.remove
  • sessiontypes.get
  • sessiontypes.maplist
  • sessiontypes.mapsave
  • serviceproducts.create
  • serviceproducts.update
  • serviceproducts.delete
  • serviceproducts.get
  • serviceproducts.grid
  • serviceproducts.list
  • serviceproducts.hide_system
  • serviceproducts.unhide_system
  • serviceproducts.listpublic
  • serviceproducts.maplist
  • serviceproducts.mapsave
  • serviceproducts.multiclublist
  • serviceproducts.getpublic
  • skills.create
  • skills.edit
  • skills.remove
  • skills.list
  • skills.grid
  • skills.get
  • levels.create
  • levels.edit
  • levels.remove
  • levels.list
  • levels.grid
  • levels.get
  • smiles.add
  • smiles.edit
  • smiles.remove
  • smiles.bulkremove
  • smiles.hideforclubs
  • smiles.unhideforclubs
  • smiles.list
  • smiles.get
  • smiles.listforclub
  • stickers.add
  • stickers.edit
  • stickers.remove
  • stickers.bulkremove
  • stickers.hideforclubs
  • stickers.unhideforclubs
  • stickers.list
  • zones.maplist
  • zones.mapsave
  • zones.mylist
  • zones.get
  • zones.savemap
  • zones.getmap
  • zones.add
  • zones.edit
  • zones.getintegration
  • zones.editintegration
  • zones.list
  • zones.grid
  • zones.remove
  • payment_providers.list
  • payment_providers.get
  • payment_providers.add
  • payment_providers.edit
  • payment_providers.remove
  • payment_providers.set_default
  • payment_providers.test
  • payment_providers.enable_platform
  • payment_providers.disable_platform
  • paymentWebhooksCloudPayments
  • paymentWebhooksPayU
  • paymentWebhooksYookassa
  • paymentWebhooksTinkoff
  • paymentWebhooksRetry
  • paymentWebhooksStats
  • promocodes.list
  • promocodes.get
  • promocodes.add
  • promocodes.edit
  • promocodes.remove
  • promocodes.validate
  • promocodes.apply
  • promocodes.has_active
  • promocodes.check
  • legal.get
  • legal.edit
  • legal.public.get
  • legal.lookup
  • segments.list
  • segments.grid
  • segments.get
  • segments.add
  • segments.edit
  • segments.remove
  • segments.recalculate
  • segments.conditions
  • segments.members
  • segments.members.grid
  • segments.history
  • segments.preview
  • segments.preview.result
  • segments.activate
  • segments.archive
  • segments.loadDataSource
  • segments.user.list
  • segments.listByClubs
  • load.current
  • load.statistics
  • load.heatmap
  • load.pattern
  • load.patterns
  • load.forecast
  • load.trends
  • load.zones
  • load.peakHours
  • load.recommendations
  • load.dashboard
  • load.recalculatePatterns
  • load.aggregateHours
  • banners.grid
  • session.events
  • roles.list
  • roles.add
  • roles.edit
  • roles.remove
  • roles.hide
  • rent.history
  • employee_categories.list
  • employee_categories.grid
  • employee_categories.add
  • employee_categories.edit
  • employee_categories.remove
  • check.active
  • sessions.listequipment
  • add
  • edit
  • get.public
  • get
  • list
  • address.lookup
  • address.getcoords
  • coaches.list
  • coaches.list.public
  • equipment.add
  • equipment.bulkadd
  • equipment.free
  • equipment.rent
  • equipment.multilist
  • equipment.list
  • info.timezone
  • equipment.edit
  • equipment.remove
  • equipment.get
  • sensors.scan
  • equipment_types.list
  • sessions.self_training_check
  • sessions.self_training_start
  • schedule.duplicate
  • sessions.add
  • sessions.edit
  • sessions.addduration
  • sessions.get
  • sessions.graphs
  • banners.add
  • news.client.get
  • news.read
  • news.client.list
  • news.remove
  • news.get
  • news.list
  • news.edit
  • news.add
  • notify.add
  • banners.edit
  • notify.edit
  • banners.get
  • notify.get
  • banners.clientList
  • sessions.next
  • banners.list
  • notify.list
  • notify.grid
  • banners.remove
  • notify.remove
  • notify.personal.add
  • clients.communications
  • clients.communications.grid
  • notify.viewed
  • reels.create
  • reels.edit
  • reels.view
  • reels.list
  • reels.clientList
  • reels.like
  • reels.remove
  • sessions.stats
  • sessions.rem
  • sessions.list
  • get.device.token
  • integrations.get
  • integrations.update
  • group.edit
  • integrations.keys
  • integrations.sync_settings.get
  • integrations.sync_settings.update
  • integrations.operations.get
  • integrations.operations.update
  • integrations.sync_status.get
  • integrations.sync.trigger
  • integrations.all_settings.get
  • feedback.session.grid
  • feedback.coach.grid
  • smartdevices.grid
  • smartdevices.list
  • smartdevices.get
  • smartdevices.add
  • smartdevices.edit
  • smartdevices.remove
  • smartdevices.groups.list
  • smartdevices.groups.add
  • smartdevices.groups.edit
  • smartdevices.groups.remove
  • smartdevices.setstate
• challenges
  • draft
  • save
  • remove
  • get
  • list
  • set.published
  • export
  • invite
  • team.results
  • club.results
  • rating.get
  • join
  • remove.club
  • join.club
  • exit
  • kick
  • ban
  • unban
  • activities.add
  • activities.remove
  • activities.list
  • reprocessuser
  • reprocess
  • import.parse.text
  • import.parse
  • import.execute
  • prizes.add
  • prizes.edit
  • prizes.remove
  • prizes.move
  • teams.add
  • teams.edit
  • teams.remove
  • teams.move
  • rating.manage
  • awards.draw
  • awards.confirm
  • awards.edit
  • awards.remove
  • my
  • prize.issue
  • prize.edit
  • prize.revoke
  • prize.list
• club.frontend
  • getConfigByDomain
• club.mobile
  • getMobileAppSettings
  • setMobileAppSettings
  • setAppIcon
  • setAppIconBackground
  • setSplashSettings
  • setStoreSettings
• competitions
  • save
  • list
  • get
  • remove
  • teams.add
  • teams.edit
  • teams.remove
  • categories.add
  • categories.edit
  • categories.remove
  • participants.edit
  • participants.add
  • participants.removeall
  • teams.removeall
  • participants.remove
  • finish
  • steps.finish
  • waves.restart
  • live.team.results
  • live.participant.results
  • waves.start
  • start
  • teams.setresult
  • join
  • exit
  • participants.setresult
  • results
  • results.export
  • live.results
  • live.test
  • public.get
  • import.parse
  • import.execute
  • teams.import.parse
  • teams.import.execute
  • teams.transfer
  • participants.transfer
• content
  • search.guess
  • images.list
  • updategps
  • genprogram
  • genblock
  • genavatar
  • genimage
  • genIcon
  • like
  • tags.list
  • translate
  • music.get
  • music.search
  • music.import
  • music.list
  • music.edit
  • music.rem
  • catalog.music.charts
  • catalog.music.charts.get
  • music.playlists.add
  • music.playlists.get
  • music.playlists.list
  • music.playlists.addtrack
  • music.playlists.edit
  • music.playlists.remove
  • generate.music.start
  • generate.music.status
  • generate.music.draft
  • generate.music.count
  • getvideotostore
  • setvideostored
  • youtube.add
  • video.get
  • externalvideos.search
  • videos.getuploadlink
  • videos.add
  • videos.update
  • videos.get
  • videos.setgps
  • videos.remove
  • videos.list.local
  • videos.list
  • videos.grid
  • videos.set_download
  • videos.get_download_url
• cycle
  • getworkout
  • data
  • hrdata
  • shortdata
  • fulldata
  • testupdate
  • multidata
  • getgraphfordata
  • listmyclubs
  • setmydata
  • getmydata
  • remworkout
  • setuser
  • stopcoachupdates
  • getcoachupdates
  • getuserupdates
  • sensors.list.hr
  • year_wrapped.options
  • year_wrapped.get
  • year_wrapped.ai_insights
  • year_wrapped.club_dashboard
• hw
  • sync
  • runping
  • getmyclubid
  • setmylocalip
  • initping
  • getmysensors
  • getmysmartdevices
  • reportsmartdevicestatus
  • getscreenstate
  • devices.register
  • devices.lookup
  • devices.setclub
• personal
  • sessions.prepare
• pulse
  • getDailyStats
  • getClubRanking
  • getDayGraph
  • importExternalData
  • getAnalytics
• psport
  • coaches.list
  • sessiontypes.list
  • zones.list
  • check.org_id
  • schedule.list
  • product.categories
  • products.list
  • purchases.list
• onec
  • coaches.list
  • sessiontypes.list
  • zones.list
  • schedule.list
  • product.categories
  • products.list
  • purchases.list
  • check.url
• settings
  • get
  • sport_types
  • country.get
  • permissions.list
  • uibuilder.registry
• support
  • chat.get
  • messages.list
  • messages.new
  • messages.send
  • messages.read
  • notification_settings.get
  • notification_settings.update
  • dashboard
  • chats.list
  • chats.get
  • chats.assign
  • chats.tag
  • agents.list
  • agents.search
  • agents.add
  • agents.edit
  • agents.remove
  • broadcast.send
  • broadcast.history
• tride
  • object.versions.list
  • object.versions.rename
  • object.versions.revert
  • screen.modes.add
  • club.getconfig
  • worlds.token.get
  • clubs.switch
  • sessions.checkfinished
  • qrcode.checkgeneric
  • qrcode.setgeneric
  • sessions.setsynced
  • sessions.getnotsynced
  • sessions.checksynced
  • mobile.checkupdate
  • sessions.syncparticipant
  • circles.remove
  • screenmodes.has_club
  • screenmodes.has_own
  • mybookings.listnext
  • mybookings.participants
  • checkusedble
  • ble.set
  • ble.setsession
  • ble.get
  • ble.clear
  • notifications.count
  • notifications.read
  • notifications.readall
  • notifications.remove
  • notifications.status
  • notifications.list
  • sessions.ready
  • sessions.switchteam
  • sessions.updates.apply
  • sessions.switchall
  • sessions.switchcurrent
  • sessions.cancellocalchallenge
  • sessions.nextwavelocalchallenge
  • sessions.localchallengeresults
  • sessions.publish
  • sessions.publishaudio
  • sessions.listenaudio
  • sessions.listpublishers
  • sessions.configurepublisher
  • sessions.mutepublisher
  • sessions.unmutepublisher
  • sessions.unmuteroom
  • sessions.muteroom
  • sessions.preparelisten
  • sessions.listen
  • sessions.listenerice
  • sessions.publisherice
  • sessions.getzones
  • sessions.getcoaches
  • sessions.finishlocalchallenge
  • sessions.startlocalchallenge
  • sessions.runlivecoach
  • sessions.stoplivecoach
  • sessions.start
  • sessions.pause
  • sessions.resetall
  • sessions.competitionstarted
  • sessions.disableall
  • sessions.enableall
  • sessions.unoccupyall
  • sessions.settest
  • sessions.starttest
  • sessions.stoptest
  • sessions.finishtest
  • sessions.testresult
  • sessions.finish
  • sessions.addmusic
  • sessions.addmusiceffects
  • sessions.setmusicplaylist
  • sessions.setmusiceffectsplaylist
  • sessions.addvideo
  • sessions.addcoachvideo
  • screen.getscreenmodes
  • sessions.setscreendisplay
  • sessions.starttabata
  • sessions.finishtabata
  • sessions.setscreenvolume
  • sessions.setscreencontroldata
  • sessions.setscreendata
  • sessions.getscreendisplay
  • sessions.getscreenlocked
  • sessions.getscreenvolume
  • sessions.getscreendata
  • sessions.getscreencontroldata
  • sessions.setprofile
  • sessions.getgroupgraphs
  • sessions.getcurrent
  • sessions.getmyself
  • sessions.sendlike
  • sessions.sendreaction
  • sessions.makescreenshot
  • sessions.screenshot_made
  • sessions.setmyself
  • sessions.unsetmyself
  • sessions.setparticipant
  • sessions.setparticipantenabled
  • sessions.unsetparticipant
  • sessions.get
  • sessions.getbyeqid
  • get.zonestate
  • check.rentedSensor
  • get.state
  • get.participantstate
  • sessions.getparticipants
  • sessions.getparticipant
  • sessions.getparticipantdata
  • sessions.getparticipantsdata
  • sessions.getparticipantgraph
  • sessions.listequipment
  • sensors.scan
  • sport_types.get
  • versions.shown
  • versions.list
  • versions.get
  • banners.has
  • banners.list
  • banners.get
• user_stats
  • summary
  • daily
  • weekly
  • monthly
  • metrics
  • intensity
  • clubs_comparison
  • plateau_users
• versions
  • check
• invoice
  • get
  • list
  • club.create.card
  • club.create.company
  • club.create.balance
  • club.recurrent
  • options.create.card
  • options.create.company
  • options.create.balance
  • release.create.card
  • release.create.company
  • release.create.balance
  • release.recurrent
  • user.release.create.card
  • user.release.recurrent
  • balance.create.card
  • balance.create.company
• pay
  • cards.list
  • cards.remove
  • pay
  • check
  • paycompany
• oauth
  • authorize
  • consent.info
  • consent
  • token
  • userinfo
  • revoke
  • token.generate
  • scopes
  • clients.list
  • clients.grid
  • clients.get
  • clients.add
  • clients.edit
  • clients.remove
  • clients.regenerate_secret
• users
  • addemailrequest
  • addemail
  • setemailprimaryrequest
  • setemailprimary
  • removeemailrequest
  • removeemail
  • strava.sync
  • strava.authurl
  • strava.saveauth
  • strava.exchange
  • strava.disconnect
  • strava.syncStatus
  • tables.setup.get
  • tables.setup.set
  • tables.filters.list
  • tables.filters.add
  • tables.filters.edit
  • tables.filters.rem
  • list
  • edit
  • remclient
  • getconnections
  • garmin.login
  • garmin.loginMfa
  • garmin.disconnect
  • garmin.syncStatus
  • privacy.set
  • privacy.get
  • add
  • info
  • getsettings
  • setsettings
  • mwlogin
  • remaccount
  • weight.history
  • ftp.history
  • ftp.tests
• devices
  • register
  • new_device
  • getscreenmode
  • getupdatedata
  • setscreenmode
  • gettask
  • tasksack
  • setversion
  • setinfo
  • getgateways
  • getotherboxesips
  • setlogmessage
  • setlastspeed
  • setFiles
  • getVideosToDownload
  • getMusicToDownload
  • setDownloadedVideos
  • setDownloadedMusic
  • getSchedule
  • getAnouncements
  • getClubChat
  • getClubChallenge
  • getClubSchedule
  • getClubRating
  • fingerprint.save
  • fingerprint.check
• sessions
  • impersonate.start
  • impersonate.stop
  • ping
  • logout
• ex
  • find.class
  • create.class
  • edit.class
  • list.class.types
  • check.auth
  • remove.class
  • listequipment
  • club.listequipment
  • client.info
  • client.register
  • activities.list
  • sensors.list.hr
  • class.set.participant
  • class.unset.participant
  • activities.get
  • matrix.ident
  • matrix.result
• sms
  • sendmessage
  • send

Модули

Модуль admin

Общая информация

Название: admin
roles.list

Описание: Список всех административных ролей
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
roles.get

Описание: Получение информации об административной роли
Входящие переменные:
• role_id обязательно
  Описание:
  ID роли
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• name
  Тип данных: Строка
• description
  Тип данных: Строка
• admin_permissions
  Тип данных: Массив строк
• club_permissions
  Тип данных: Массив строк
• system
  Тип данных: Логическое выражение
roles.add

Описание: Создание новой административной роли
Входящие переменные:
• name обязательно
  Описание:
  Название роли
  Допустимый тип данных: Строка
• description
  Описание:
  Описание роли
  Допустимый тип данных: Строка
• admin_permissions
  Описание:
  Системные права (admin:*)
  Допустимый тип данных: Массив строк
• club_permissions
  Описание:
  Права на все клубы (*/*)
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• role_id
  Тип данных: Строка
roles.edit

Описание: Редактирование административной роли
Входящие переменные:
• role_id обязательно
  Описание:
  ID роли
  Допустимый тип данных: Строка
• name
  Описание:
  Название роли
  Допустимый тип данных: Строка
• description
  Описание:
  Описание роли
  Допустимый тип данных: Строка
• admin_permissions
  Описание:
  Системные права (admin:*)
  Допустимый тип данных: Массив строк
• club_permissions
  Описание:
  Права на все клубы (*/*)
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
roles.rem

Описание: Удаление административной роли
Входящие переменные:
• role_id обязательно
  Описание:
  ID роли
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
roles.users.list

Описание: Список пользователей с административными ролями
Входящие переменные:
• role_id
  Описание:
  ID роли для фильтрации
  Допустимый тип данных: Строка
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
roles.users.assign

Описание: Назначение административной роли пользователю
Входящие переменные:
• uid обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• role_id обязательно
  Описание:
  ID роли
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
roles.users.remove

Описание: Удаление административной роли у пользователя
Входящие переменные:
• uid обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• role_id обязательно
  Описание:
  ID роли
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
roles.users.set_triderole

Описание: Установка triderole пользователю (0, 1, 200, 100)
Входящие переменные:
• uid обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• triderole обязательно
  Описание:
  Уровень triderole (0, 1, 200, 100)
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
roles.permissions.list

Описание: Список всех доступных админских и клубных прав
Входящие переменные:
Возвращаемые параметры:
• admin_permissions
  Тип данных: Массив объектов
• club_permissions
  Тип данных: Массив объектов
analytics.overview

Описание: Сводный обзор: клубы по статусам, активность, устройства, оплаты, окончания
Входящие переменные:
Возвращаемые параметры:
analytics.clubs.list

Описание: Расширенный список клубов: статус доступа, активность, устройства, заметки, ответственный
Входящие переменные:
• search
  Допустимый тип данных: Строка
• status
  Допустимый тип данных: Строка
• country
  Допустимый тип данных: Строка
• has_anomalies
  Допустимый тип данных: Логическое выражение
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
analytics.club.card

Описание: Детальная карточка клуба для внутренней админки
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
analytics.sessions

Описание: Занятия клуба: booked / checked-in / actual / anonymous и расхождения
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• date_from
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• date_to
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• coach_id
  Допустимый тип данных: Число
• finished_only
  Допустимый тип данных: Логическое выражение
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
analytics.devices.monitor

Описание: Мониторинг экранных устройств: online/offline, версия, проблемные фильтры
Входящие переменные:
• search
  Допустимый тип данных: Строка
• problem_filter
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
analytics.equipment.summary

Описание: Сводка по оборудованию: тренажёры, пульсометры, аренда
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
analytics.workouts.usage

Описание: Использование тренировочных программ клубом
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• date_from
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• date_to
  Допустимый тип данных: Возможно несколько типов: Число, Строка
Возвращаемые параметры:
analytics.billing.anomalies

Описание: Биллинг: скорые окончания, истёкшие, аномалии trial/paid, нерасставленные license-оплаты
Входящие переменные:
Возвращаемые параметры:
client_service.event_types.list

Описание: Справочник типов событий воронки
Входящие переменные:
Возвращаемые параметры:
client_service.event_types.add

Описание: Добавить тип события
Входящие переменные:
• key обязательно
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• category
  Допустимый тип данных: Строка
• sort
  Допустимый тип данных: Число
• active
  Допустимый тип данных: Логическое выражение
• auto_advance
  Допустимый тип данных: Логическое выражение
• next_event_key
  Допустимый тип данных: Строка
• next_offset_days
  Допустимый тип данных: Число
Возвращаемые параметры:
client_service.event_types.edit

Описание: Редактировать тип события
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• category
  Допустимый тип данных: Строка
• sort
  Допустимый тип данных: Число
• active
  Допустимый тип данных: Логическое выражение
• auto_advance
  Допустимый тип данных: Логическое выражение
• next_event_key
  Допустимый тип данных: Строка
• next_offset_days
  Допустимый тип данных: Число
Возвращаемые параметры:
client_service.event_types.remove

Описание: Удалить тип события
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.events.list

Описание: События воронки по клубу (с объединением со справочником)
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.events.set

Описание: Отметить статус/дату события клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• type_key обязательно
  Допустимый тип данных: Строка
• status
  Допустимый тип данных: Строка
• event_date
  Допустимый тип данных: Число
• planned_date
  Допустимый тип данных: Число
• note
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.events.edit

Описание: Редактировать событие клуба
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• status
  Допустимый тип данных: Строка
• event_date
  Допустимый тип данных: Число
• planned_date
  Допустимый тип данных: Число
• note
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.events.remove

Описание: Удалить событие клуба
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.templates.list

Описание: Список шаблонов (push/survey)
Входящие переменные:
• kind
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.templates.get

Описание: Получить шаблон
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.templates.add

Описание: Создать шаблон
Входящие переменные:
• kind обязательно
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• push
  Допустимый тип данных: Объект
• survey
  Допустимый тип данных: Объект
• active
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
client_service.templates.edit

Описание: Редактировать шаблон
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• push
  Допустимый тип данных: Объект
• survey
  Допустимый тип данных: Объект
• active
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
client_service.templates.remove

Описание: Удалить шаблон
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.rules.list

Описание: Список правил-триггеров
Входящие переменные:
Возвращаемые параметры:
client_service.rules.get

Описание: Получить правило
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.rules.add

Описание: Создать правило
Входящие переменные:
• name
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
• anchors
  Допустимый тип данных: Массив строк
• offset_days
  Допустимый тип данных: Число
• action_type
  Допустимый тип данных: Строка
• template_id
  Допустимый тип данных: Строка
• message_template_id
  Допустимый тип данных: Строка
• audience
  Допустимый тип данных: Объект
• survey_window_days
  Допустимый тип данных: Число
• remind_days
  Допустимый тип данных: Число
• remind_declined
  Допустимый тип данных: Логическое выражение
• one_per_club
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
client_service.rules.edit

Описание: Редактировать правило
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
• anchors
  Допустимый тип данных: Массив строк
• offset_days
  Допустимый тип данных: Число
• action_type
  Допустимый тип данных: Строка
• template_id
  Допустимый тип данных: Строка
• message_template_id
  Допустимый тип данных: Строка
• audience
  Допустимый тип данных: Объект
• survey_window_days
  Допустимый тип данных: Число
• remind_days
  Допустимый тип данных: Число
• remind_declined
  Допустимый тип данных: Логическое выражение
• one_per_club
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
client_service.rules.remove

Описание: Удалить правило
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.message_templates.list

Описание: CRM-шаблоны сообщений (для message-правил)
Входящие переменные:
• channel
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
client_service.actions.list

Описание: Очередь запланированных действий
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• status
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
client_service.actions.cancel

Описание: Отменить действие
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.actions.reschedule

Описание: Перенести действие
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• scheduled_ts обязательно
  Допустимый тип данных: Число
Возвращаемые параметры:
client_service.actions.runNow

Описание: Запустить действие сейчас
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
client_service.actions.addManual

Описание: Добавить действие вручную
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• action_type обязательно
  Допустимый тип данных: Строка
• template_id
  Допустимый тип данных: Строка
• message_template_id
  Допустимый тип данных: Строка
• scheduled_ts
  Допустимый тип данных: Число
• survey_window_days
  Допустимый тип данных: Число
• audience
  Допустимый тип данных: Объект
Возвращаемые параметры:
client_service.funnel.report

Описание: Сводный отчёт воронки клиентского сервиса
Входящие переменные:
Возвращаемые параметры:
client_service.surveys.results

Описание: Результаты опросов клиентского сервиса по клубу
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
club_notes.add

Описание: Добавить внутреннюю заметку по клубу
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• body
  Допустимый тип данных: Строка
• assigned_uid
  Допустимый тип данных: Число
• tags
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• id
  Тип данных: Строка
club_notes.list

Описание: Список внутренних заметок по клубу
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
club_notes.edit

Описание: Изменить внутреннюю заметку по клубу
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• body
  Допустимый тип данных: Строка
• assigned_uid
  Допустимый тип данных: Число
• tags
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
club_notes.remove

Описание: Удалить внутреннюю заметку по клубу
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
challenges.search

Описание: Поиск/листинг челленджей для админа TRIDE
Входящие переменные:
• q
  Описание:
  Поиск по названию/описанию или точное совпадение по ObjectId (24-char hex)
  Допустимый тип данных: Строка
• status
  Описание:
  draft|unpublished|published|started|finished|removed|active
  Допустимый тип данных: Строка
• privacy_level
  Описание:
  1|2|3|4
  Допустимый тип данных: Число
• aim_type
  Описание:
  distance|calories|points
  Допустимый тип данных: Строка
• autojoin
  Допустимый тип данных: Логическое выражение
• coach_allowed
  Допустимый тип данных: Логическое выражение
• club_id
  Допустимый тип данных: Строка
• creator_uid
  Допустимый тип данных: Число
• creator_phone
  Допустимый тип данных: Строка
• creator_email
  Допустимый тип данных: Строка
• participant_uid
  Допустимый тип данных: Число
• participant_phone
  Допустимый тип данных: Строка
• date_from
  Описание:
  unix sec
  Допустимый тип данных: Число
• date_to
  Описание:
  unix sec
  Допустимый тип данных: Число
• include_removed
  Допустимый тип данных: Логическое выражение
• include_drafts
  Допустимый тип данных: Логическое выражение
• has_dirty_ratings
  Допустимый тип данных: Логическое выражение
• stuck_ratings
  Допустимый тип данных: Логическое выражение
• sort
  Описание:
  created_ts|date_start|updated_ts|participants_count|ratings_last_sync_ts
  Допустимый тип данных: Строка
• sort_dir
  Описание:
  asc|desc
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
challenges.get

Описание: Полная информация о челлендже для админа
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
challenges.stats

Описание: Агрегированная статистика по активностям челленджа
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
challenges.participants.list

Описание: Список участников челленджа с обогащением
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
• q
  Допустимый тип данных: Строка
• sort
  Допустимый тип данных: Строка
• sort_dir
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
challenges.participants.add

Описание: Принудительное добавление участника в челлендж
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
• uid обязательно
  Допустимый тип данных: Число
challenges.participants.remove

Описание: Удаление участника (kick) или бан
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
• uid обязательно
  Допустимый тип данных: Число
• mode обязательно
  Описание:
  kick|ban
  Допустимый тип данных: Строка
challenges.simulate.autojoin

Описание: Dry-run симуляция автоджойна пользователя
Входящие переменные:
• uid обязательно
  Допустимый тип данных: Число
• club_id
  Допустимый тип данных: Строка
• sport_type
  Допустимый тип данных: Число
• session_id
  Допустимый тип данных: Строка
• ts
  Допустимый тип данных: Число
• challenge_id
  Допустимый тип данных: Строка
• noaudit
  Допустимый тип данных: Логическое выражение
challenges.simulate.activity

Описание: Dry-run симуляция попадания существующей активности в челленджи
Входящие переменные:
• activity_id обязательно
  Допустимый тип данных: Строка
• challenge_id
  Допустимый тип данных: Строка
challenges.audit.list

Описание: Журнал админских действий по челленджам
Входящие переменные:
• challenge_id
  Допустимый тип данных: Строка
• admin_uid
  Допустимый тип данных: Число
• target_uid
  Допустимый тип данных: Число
• action
  Допустимый тип данных: Строка
• date_from
  Допустимый тип данных: Число
• date_to
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
challenges.reprocess

Описание: Полный пересчёт результатов челленджа
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
• club_ids
  Допустимый тип данных: Массив строк
challenges.reprocess.user

Описание: Пересчёт результатов одного участника
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
• user_id обязательно
  Допустимый тип данных: Число
• club_ids
  Допустимый тип данных: Массив строк
challenges.reprocess.bulk

Описание: Массовый пересчёт списка челленджей (до 50)
Входящие переменные:
• challenge_ids обязательно
  Допустимый тип данных: Массив строк
• club_ids
  Допустимый тип данных: Массив строк
challenges.set.published

Описание: Переключить флаг published у челленджа (admin-only)
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
• published обязательно
  Допустимый тип данных: Логическое выражение
challenges.remove

Описание: Мягкое удаление челленджа (removed:true)
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
challenges.restore

Описание: Восстановление удалённого челленджа
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
challenges.ratings.reset_lock

Описание: Сброс зависшего флага ratings_processing
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
challenges.teams.redistribute

Описание: Перераспределение всех участников по командам согласно текущим настройкам (gender/age/random). Поддерживает dry_run.
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
• dry_run
  Описание:
  Только превью изменений без записи в БД
  Допустимый тип данных: Логическое выражение
challenges.excluded.list

Описание: Список активностей, исключённых из челленджа (challenge_excluded:true)
Входящие переменные:
• challenge_id обязательно
  Допустимый тип данных: Строка
• uid
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
hero_routes.list

Описание: Список маршрутов "Путь героя"
Входящие переменные:
• search
  Описание:
  Поиск по названию/описанию
  Допустимый тип данных: Строка
• status
  Описание:
  Фильтр по статусу (draft, active, completed, archived)
  Допустимый тип данных: Строка
• skip
  Описание:
  Смещение для пагинации
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит записей (max 200)
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
• items
  Тип данных: Массив объектов
hero_routes.get

Описание: Получение маршрута по ID
Входящие переменные:
• id обязательно
  Описание:
  ID маршрута
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• name
  Тип данных: Строка
• description
  Тип данных: Строка
• status
  Тип данных: Строка
• visibility
  Тип данных: Объект
• period
  Тип данных: Объект
• route_data
  Тип данных: Объект
hero_routes.add

Описание: Создание нового маршрута
Входящие переменные:
• name обязательно
  Описание:
  Название маршрута
  Допустимый тип данных: Строка
• description
  Описание:
  Описание в markdown формате
  Допустимый тип данных: Строка
• status
  Описание:
  Статус (draft, active, completed, archived)
  Допустимый тип данных: Строка
• visibility
  Описание:
  Настройки видимости {clients, staff}
  Допустимый тип данных: Объект
• period
  Описание:
  Период действия {start_date, end_date}
  Допустимый тип данных: Объект
Возвращаемые параметры:
• id
  Тип данных: Строка
hero_routes.edit

Описание: Редактирование метаданных маршрута
Входящие переменные:
• id обязательно
  Описание:
  ID маршрута
  Допустимый тип данных: Строка
• name
  Описание:
  Название маршрута
  Допустимый тип данных: Строка
• description
  Описание:
  Описание в markdown формате
  Допустимый тип данных: Строка
• status
  Описание:
  Статус (draft, active, completed, archived)
  Допустимый тип данных: Строка
• visibility
  Описание:
  Настройки видимости {clients, staff}
  Допустимый тип данных: Объект
• period
  Описание:
  Период действия {start_date, end_date}
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
hero_routes.remove

Описание: Удаление маршрута (soft-delete) с каскадным удалением точек
Входящие переменные:
• id обязательно
  Описание:
  ID маршрута
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
hero_routes.calculate

Описание: Расчёт маршрута через OpenRouteService (без записи в БД)
Входящие переменные:
• waypoints обязательно
  Описание:
  Массив опорных точек [{coordinates: [lat, lon]}]
  Допустимый тип данных: Массив объектов
• profile
  Описание:
  Профиль маршрутизации (foot-walking, cycling-regular)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• data
  Тип данных: Объект
hero_routes.waypoints.update

Описание: Автосейв опорных точек и геометрии маршрута
Входящие переменные:
• id обязательно
  Описание:
  ID маршрута
  Допустимый тип данных: Строка
• waypoints
  Описание:
  Массив опорных точек
  Допустимый тип данных: Массив объектов
• geometry
  Описание:
  GeoJSON геометрия маршрута
  Допустимый тип данных: Объект
• total_distance_km
  Описание:
  Общая дистанция, км
  Допустимый тип данных: Дробное число в строке
• elevation
  Описание:
  Данные о высотах
  Допустимый тип данных: Объект
• surface_stats
  Описание:
  Статистика покрытия
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
hero_routes.points.list

Описание: Список бонусных точек маршрута
Входящие переменные:
• route_id обязательно
  Описание:
  ID маршрута
  Допустимый тип данных: Строка
• type
  Описание:
  Фильтр по типу (boost, partner_discount, partner_boost)
  Допустимый тип данных: Строка
• status
  Описание:
  Фильтр по статусу (active, inactive)
  Допустимый тип данных: Строка
• skip
  Описание:
  Смещение для пагинации
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит записей (max 500)
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
• items
  Тип данных: Массив объектов
hero_routes.points.get

Описание: Получение бонусной точки по ID
Входящие переменные:
• id обязательно
  Описание:
  ID точки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• route_id
  Тип данных: Строка
• type
  Тип данных: Строка
• name
  Тип данных: Строка
• description
  Тип данных: Строка
• coordinates
  Тип данных: Массив дробных чисел (floating point)
• distance_from_start_km
  Тип данных: Дробное число в строке
• status
  Тип данных: Строка
hero_routes.points.add

Описание: Добавление бонусной точки на маршрут
Входящие переменные:
• route_id обязательно
  Описание:
  ID маршрута
  Допустимый тип данных: Строка
• type обязательно
  Описание:
  Тип точки (boost, partner_discount, partner_boost)
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название точки
  Допустимый тип данных: Строка
• description
  Описание:
  Описание
  Допустимый тип данных: Строка
• coordinates обязательно
  Описание:
  Координаты [lat, lon]
  Допустимый тип данных: Массив дробных чисел (floating point)
• distance_from_start_km
  Описание:
  Дистанция от старта, км (override)
  Допустимый тип данных: Дробное число в строке
• distance_override
  Описание:
  Использовать ручное значение distance_from_start_km
  Допустимый тип данных: Логическое выражение
• avatar
  Описание:
  Аватарка (fileid)
  Допустимый тип данных: Строка
• status
  Описание:
  Статус (active, inactive)
  Допустимый тип данных: Строка
• boost_config
  Описание:
  Конфигурация буста
  Допустимый тип данных: Объект
• discount_config
  Описание:
  Конфигурация партнёрской скидки
  Допустимый тип данных: Объект
• partner_boost_config
  Описание:
  Конфигурация партнёрского ускорения
  Допустимый тип данных: Объект
• linked_waypoint_id
  Описание:
  ID связанной опорной точки
  Допустимый тип данных: Строка
• follow_waypoint
  Описание:
  Следовать за опорной точкой при её сдвиге
  Допустимый тип данных: Логическое выражение
• club_id
  Описание:
  ID клуба (для расширения)
  Допустимый тип данных: Строка
• club_group_id
  Описание:
  ID группы клубов
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
hero_routes.points.edit

Описание: Редактирование бонусной точки маршрута
Входящие переменные:
• id обязательно
  Описание:
  ID точки
  Допустимый тип данных: Строка
• name
  Описание:
  Название точки
  Допустимый тип данных: Строка
• description
  Описание:
  Описание
  Допустимый тип данных: Строка
• type
  Описание:
  Тип точки
  Допустимый тип данных: Строка
• coordinates
  Описание:
  Координаты [lat, lon]
  Допустимый тип данных: Массив дробных чисел (floating point)
• distance_from_start_km
  Описание:
  Дистанция от старта, км (override)
  Допустимый тип данных: Дробное число в строке
• distance_override
  Описание:
  Использовать ручное значение distance_from_start_km
  Допустимый тип данных: Логическое выражение
• avatar
  Описание:
  Аватарка (fileid)
  Допустимый тип данных: Строка
• status
  Описание:
  Статус (active, inactive)
  Допустимый тип данных: Строка
• boost_config
  Описание:
  Конфигурация буста
  Допустимый тип данных: Объект
• discount_config
  Описание:
  Конфигурация партнёрской скидки
  Допустимый тип данных: Объект
• partner_boost_config
  Описание:
  Конфигурация партнёрского ускорения
  Допустимый тип данных: Объект
• linked_waypoint_id
  Описание:
  ID связанной опорной точки
  Допустимый тип данных: Строка
• follow_waypoint
  Описание:
  Следовать за опорной точкой при её сдвиге
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
hero_routes.points.remove

Описание: Удаление бонусной точки (soft-delete)
Входящие переменные:
• id обязательно
  Описание:
  ID точки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
manual_activity.preview

Описание: Dry-run расчёта метрик ручной активности (без записи в БД).
Входящие переменные:
• uid обязательно
  Описание:
  ID пользователя (users._id)
  Допустимый тип данных: Число
• session_id обязательно
  Описание:
  ObjectId cycle_session
  Допустимый тип данных: Строка
• sport_type обязательно
  Описание:
  Вид спорта (должен входить в session.sport_types)
  Допустимый тип данных: Число
• distance
  Описание:
  Дистанция в км (для cycle/rowing/run)
  Допустимый тип данных: Дробное число в строке
• avg_hr
  Описание:
  Средняя ЧСС за тренировку
  Допустимый тип данных: Число
• eqid
  Описание:
  ObjectId оборудования (опционально)
  Допустимый тип данных: Строка
• sensor_hr_id
  Описание:
  ObjectId HR-датчика (опционально)
  Допустимый тип данных: Строка
manual_activity.add

Описание: Создать cycle_activities + участника в cycle_sessions для прошедшей сессии.
Входящие переменные:
• uid обязательно
  Описание:
  ID пользователя (users._id)
  Допустимый тип данных: Число
• session_id обязательно
  Описание:
  ObjectId cycle_session (finished=true)
  Допустимый тип данных: Строка
• sport_type обязательно
  Описание:
  Вид спорта
  Допустимый тип данных: Число
• distance
  Описание:
  Дистанция в км
  Допустимый тип данных: Дробное число в строке
• avg_hr
  Описание:
  Средняя ЧСС
  Допустимый тип данных: Число
• eqid
  Описание:
  ObjectId оборудования
  Допустимый тип данных: Строка
• sensor_hr_id
  Описание:
  ObjectId HR-датчика
  Допустимый тип данных: Строка
• include_in_challenges
  Описание:
  Учитывать в челленджах (по умолчанию false → challenge_excluded=true)
  Допустимый тип данных: Логическое выражение
• create_booking
  Описание:
  Создать также booking_bookings с activity_data (по умолчанию false)
  Допустимый тип данных: Логическое выражение
sessions.search

Описание: Поиск прошедших cycle_sessions клуба (для ручного добавления участника)
Входящие переменные:
• club_id обязательно
  Описание:
  ObjectId клуба
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Фильтр по виду спорта
  Допустимый тип данных: Число
• from_ts
  Описание:
  Начало периода (unix sec); по умолчанию now-90d
  Допустимый тип данных: Число
• to_ts
  Описание:
  Конец периода (unix sec); по умолчанию now
  Допустимый тип данных: Число
• search
  Описание:
  Поиск по имени сессии (regex, case-insensitive)
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
sessions.get

Описание: Детали cycle_session по id (для wizard выбора sport_type/eqid)
Входящие переменные:
• session_id обязательно
  Допустимый тип данных: Строка
crm.billing.options.add

Описание: Add billing option
Входящие переменные:
• code
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• client_name
  Допустимый тип данных: Строка
• category_ids
  Допустимый тип данных: Массив (любые типы внутри)
• price_month_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• price_year_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• price_2y_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• enabled
  Допустимый тип данных: Логическое выражение
• description
  Допустимый тип данных: Строка
• permissions
  Допустимый тип данных: Массив (любые типы внутри)
• sort_order
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.billing.options.edit

Описание: Edit billing option
Входящие переменные:
• id
  Допустимый тип данных: Строка
• code
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• client_name
  Допустимый тип данных: Строка
• category_ids
  Допустимый тип данных: Массив (любые типы внутри)
• price_month_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• price_year_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• price_2y_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• enabled
  Допустимый тип данных: Логическое выражение
• description
  Допустимый тип данных: Строка
• permissions
  Допустимый тип данных: Массив (любые типы внутри)
• sort_order
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.billing.options.get

Описание: Get billing option
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.billing.options.list

Описание: List billing options
Входящие переменные:
• search
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
crm.billing.options.remove

Описание: Remove billing option
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.billing.tariffs.add

Описание: Add billing tariff
Входящие переменные:
• code
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• client_name
  Допустимый тип данных: Строка
• category_ids
  Допустимый тип данных: Массив (любые типы внутри)
• price_month_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• price_year_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• price_2y_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• option_ids
  Допустимый тип данных: Массив (любые типы внутри)
• extended_option_ids
  Допустимый тип данных: Массив (любые типы внутри)
• options
  Допустимый тип данных: Массив объектов
• enabled
  Допустимый тип данных: Логическое выражение
• default
  Допустимый тип данных: Логическое выражение
• trial_days
  Допустимый тип данных: Число
• sort_order
  Допустимый тип данных: Число
• description
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.billing.tariffs.edit

Описание: Edit billing tariff
Входящие переменные:
• id
  Допустимый тип данных: Строка
• code
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• client_name
  Допустимый тип данных: Строка
• category_ids
  Допустимый тип данных: Массив (любые типы внутри)
• price_month_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• price_year_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• price_2y_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• option_ids
  Допустимый тип данных: Массив (любые типы внутри)
• extended_option_ids
  Допустимый тип данных: Массив (любые типы внутри)
• options
  Допустимый тип данных: Массив объектов
• enabled
  Допустимый тип данных: Логическое выражение
• default
  Допустимый тип данных: Логическое выражение
• trial_days
  Допустимый тип данных: Число
• sort_order
  Допустимый тип данных: Число
• description
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.billing.tariffs.get

Описание: Get billing tariff
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.billing.tariffs.list

Описание: List billing tariffs
Входящие переменные:
• search
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
crm.billing.tariffs.remove

Описание: Remove billing tariff
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.client_categories.add

Описание: Add client category
Входящие переменные:
• name
  Допустимый тип данных: Строка
• client_name
  Допустимый тип данных: Строка
• color
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• visible_to_clients
  Допустимый тип данных: Логическое выражение
• sort_order
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.client_categories.edit

Описание: Edit client category
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• client_name
  Допустимый тип данных: Строка
• color
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• visible_to_clients
  Допустимый тип данных: Логическое выражение
• sort_order
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.client_categories.get

Описание: Get client category
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.client_categories.list

Описание: List client categories
Входящие переменные:
• search
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
crm.client_categories.visible

Описание: Список категорий клиентов, видимых клиентам
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
crm.client_categories.remove

Описание: Remove client category
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.client_comments.add

Описание: Добавить комментарий к клиенту
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• event_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.client_comments.edit

Описание: Изменить комментарий к клиенту
Входящие переменные:
• id
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• event_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.client_comments.get

Описание: Получить комментарий к клиенту
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.client_comments.list

Описание: Получить список комментариев к клиенту
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
crm.client_comments.remove

Описание: Удалить комментарий к клиенту
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.client_contacts.add

Описание: Добавить контакт клиента
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• firstname
  Допустимый тип данных: Строка
• lastname
  Допустимый тип данных: Строка
• phone
  Допустимый тип данных: Строка
• workphone
  Допустимый тип данных: Строка
• email
  Допустимый тип данных: Строка
• position
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.client_contacts.edit

Описание: Изменить контакт клиента
Входящие переменные:
• id
  Допустимый тип данных: Строка
• firstname
  Допустимый тип данных: Строка
• lastname
  Допустимый тип данных: Строка
• phone
  Допустимый тип данных: Строка
• workphone
  Допустимый тип данных: Строка
• email
  Допустимый тип данных: Строка
• position
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.client_contacts.get

Описание: Получить контакт клиента
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.client_contacts.list

Описание: Получить список контактов клиента
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• firstname
  Допустимый тип данных: Строка
• lastname
  Допустимый тип данных: Строка
• phone
  Допустимый тип данных: Строка
• search
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
• skip
  Тип данных: Число
• limit
  Тип данных: Число
crm.client_contacts.remove

Описание: Удалить контакт клиента
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.client_events.add

Описание: Добавить событие клиента
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• planned_ts
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• address
  Допустимый тип данных: Строка
• event_type
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• event_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.client_events.edit

Описание: Изменить событие клиента
Входящие переменные:
• id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• event_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• address
  Допустимый тип данных: Строка
• event_type
  Допустимый тип данных: Строка
• planned_ts
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.client_events.get

Описание: Получить событие клиента
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.client_events.list

Описание: Получить список событий клиента
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• from_ts
  Допустимый тип данных: Число
• to_ts
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
crm.client_events.remove

Описание: Удалить событие клиента
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.clients.add

Описание: Add client
Входящие переменные:
• type
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• city
  Допустимый тип данных: Строка
• country
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• owner_uid
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.clients.edit

Описание: Edit client
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• city
  Допустимый тип данных: Строка
• country
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• owner_uid
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.clients.get

Описание: Get client
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.clients.list

Описание: List clients
Входящие переменные:
• search
  Допустимый тип данных: Строка
• soon_events
  Допустимый тип данных: Логическое выражение
• recent_events
  Допустимый тип данных: Логическое выражение
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
• skip
  Тип данных: Число
• limit
  Тип данных: Число
crm.clients.remove

Описание: Remove client
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.clients.merge

Описание: Merge two clients (source into target)
Входящие переменные:
• source_id
  Допустимый тип данных: Строка
• target_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.clients.merge_preview

Описание: Preview merge of two clients
Входящие переменные:
• source_id
  Допустимый тип данных: Строка
• target_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• contacts_count
  Тип данных: Число
• deals_count
  Тип данных: Число
• supplies_count
  Тип данных: Число
• events_count
  Тип данных: Число
• comments_count
  Тип данных: Число
• clubs_count
  Тип данных: Число
crm.clients.import

Описание: Import clients from array
Входящие переменные:
• clients
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• created
  Тип данных: Число
• skipped
  Тип данных: Число
• errors
  Тип данных: Число
crm.clients.set_categories

Описание: Set categories for a client
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• category_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.clients.get_categories

Описание: Get categories for a client
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.get

Описание: Агрегат данных пульта управления клиентом
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• client
  Тип данных: Объект
cockpit.clients.clubs_list

Описание: Клубы клиента со статусом подписки
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.categories.list

Описание: Категории клиентов (для пульта/шаблонов)
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
crm.clients.set_lifecycle

Описание: Установить стадию жизненного цикла клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• lifecycle_stage обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.clubs.create

Описание: Создать клуб клиента из пульта
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• name обязательно
  Допустимый тип данных: Строка
• email обязательно
  Допустимый тип данных: Строка
• timezone
  Допустимый тип данных: Строка
• phone
  Допустимый тип данных: Строка
• tariff_id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• club_id
  Тип данных: Строка
cockpit.tariffs.list

Описание: Тарифы (для пульта)
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.options.list

Описание: Опции (для пульта)
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.invoices.create

Описание: Создать мульти-клубный счёт из пульта
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• lines обязательно
  Допустимый тип данных: Массив объектов
• company_id
  Допустимый тип данных: Строка
• type
  Допустимый тип данных: Строка
• due_date
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
cockpit.invoices.generate_pdf

Описание: Сгенерировать PDF счёта
Входящие переменные:
• invoice_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• file_key
  Тип данных: Строка
cockpit.invoices.send_to_chat

Описание: Отправить счёт в чат клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• invoice_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• outbox_id
  Тип данных: Строка
cockpit.param_tree.list

Описание: Дерево параметров клиента
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.param_tree.add

Описание: Добавить узел дерева параметров
Входящие переменные:
• parent_id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• key
  Допустимый тип данных: Строка
• sort
  Допустимый тип данных: Число
• is_leaf
  Допустимый тип данных: Логическое выражение
• active
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
cockpit.param_tree.edit

Описание: Редактировать узел дерева параметров
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• key
  Допустимый тип данных: Строка
• sort
  Допустимый тип данных: Число
• is_leaf
  Допустимый тип данных: Логическое выражение
• active
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.param_tree.move

Описание: Переместить узел дерева параметров
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• parent_id
  Допустимый тип данных: Строка
• sort
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.param_tree.remove

Описание: Удалить узел дерева параметров
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.client_params.get

Описание: Отмеченные параметры клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• node_ids
  Тип данных: Массив строк
cockpit.client_params.set

Описание: Сохранить отмеченные параметры клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• node_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.templates.list

Описание: Список шаблонов сообщений
Входящие переменные:
• channel
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.templates.get

Описание: Получить шаблон сообщения
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• item
  Тип данных: Объект
cockpit.templates.add

Описание: Создать шаблон сообщения
Входящие переменные:
• name
  Допустимый тип данных: Строка
• channel
  Допустимый тип данных: Строка
• is_welcome
  Допустимый тип данных: Логическое выражение
• auto_send_on_stage
  Допустимый тип данных: Строка
• applies_to_all
  Допустимый тип данных: Логическое выражение
• category_ids
  Допустимый тип данных: Массив строк
• tariff_ids
  Допустимый тип данных: Массив строк
• required_param_ids
  Допустимый тип данных: Массив строк
• required_param_mode
  Допустимый тип данных: Строка
• subject
  Допустимый тип данных: Строка
• body_md
  Допустимый тип данных: Строка
• active
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
cockpit.templates.edit

Описание: Редактировать шаблон сообщения
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• channel
  Допустимый тип данных: Строка
• is_welcome
  Допустимый тип данных: Логическое выражение
• auto_send_on_stage
  Допустимый тип данных: Строка
• applies_to_all
  Допустимый тип данных: Логическое выражение
• category_ids
  Допустимый тип данных: Массив строк
• tariff_ids
  Допустимый тип данных: Массив строк
• required_param_ids
  Допустимый тип данных: Массив строк
• required_param_mode
  Допустимый тип данных: Строка
• subject
  Допустимый тип данных: Строка
• body_md
  Допустимый тип данных: Строка
• active
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.templates.remove

Описание: Удалить шаблон сообщения
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.templates.applicable

Описание: Применимые к клиенту шаблоны (+ предпросмотр)
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• channel
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.chat.binding.get

Описание: Статус привязки чата клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• bound
  Тип данных: Логическое выражение
cockpit.chat.binding.generate

Описание: Код привязки чата к клиенту
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• code
  Тип данных: Строка
cockpit.chat.binding.unlink

Описание: Отвязать чат от клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.chat.history

Описание: История сообщений чата клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• first_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• messages
  Тип данных: Массив объектов
cockpit.chat.new

Описание: Новые сообщения чата клиента (поллинг)
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• last_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• messages
  Тип данных: Массив объектов
cockpit.chat.send

Описание: Отправить свободное сообщение в чат клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• text обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• outbox_id
  Тип данных: Строка
cockpit.chat.send_template

Описание: Отправить сообщение по шаблону в чат клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• template_id обязательно
  Допустимый тип данных: Строка
• welcome
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• outbox_id
  Тип данных: Строка
cockpit.chat.subscribe

Описание: Подписаться на realtime-обновления чата клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.chat.unsubscribe

Описание: Отписаться от realtime-обновлений чата клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.comments.list

Описание: Комментарии клиента (пульт)
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
cockpit.comments.add

Описание: Добавить комментарий клиента (пульт)
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
cockpit.comments.remove

Описание: Удалить комментарий клиента (пульт)
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.equipment.list

Описание: Оборудование (для КП)
Входящие переменные:
• search
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.proposals.list

Описание: Список КП клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.proposals.get

Описание: Получить КП
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• item
  Тип данных: Объект
cockpit.proposals.create

Описание: Создать КП
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• type
  Допустимый тип данных: Строка
• title
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• company_id
  Допустимый тип данных: Строка
• counterparty_company_id
  Допустимый тип данных: Строка
• club_blocks обязательно
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• id
  Тип данных: Строка
cockpit.proposals.update

Описание: Редактировать КП (черновик)
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• type
  Допустимый тип данных: Строка
• title
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• company_id
  Допустимый тип данных: Строка
• counterparty_company_id
  Допустимый тип данных: Строка
• club_blocks
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.proposals.remove

Описание: Удалить КП
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.proposals.generate

Описание: Сгенерировать PDF КП
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• file_url
  Тип данных: Строка
cockpit.proposals.send_to_chat

Описание: Отправить КП в чат клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• outbox_id
  Тип данных: Строка
cockpit.supplies.list

Описание: Поставки клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.supplies.get

Описание: Поставка
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• item
  Тип данных: Объект
cockpit.supplies.create

Описание: Создать поставку
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• status_id
  Допустимый тип данных: Строка
• items
  Допустимый тип данных: Массив объектов
• delivery_address
  Допустимый тип данных: Строка
• carrier
  Допустимый тип данных: Строка
• tracking_number
  Допустимый тип данных: Строка
• planned_ship_ts
  Допустимый тип данных: Число
• comment
  Допустимый тип данных: Строка
• terms
  Допустимый тип данных: Строка
• kit_name
  Допустимый тип данных: Строка
• is_kit
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
cockpit.supplies.edit

Описание: Редактировать поставку
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• status_id
  Допустимый тип данных: Строка
• items
  Допустимый тип данных: Массив объектов
• delivery_address
  Допустимый тип данных: Строка
• carrier
  Допустимый тип данных: Строка
• tracking_number
  Допустимый тип данных: Строка
• planned_ship_ts
  Допустимый тип данных: Число
• actual_ship_ts
  Допустимый тип данных: Число
• comment
  Допустимый тип данных: Строка
• terms
  Допустимый тип данных: Строка
• kit_name
  Допустимый тип данных: Строка
• is_kit
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.supplies.shipment

Описание: Отметить отгрузку
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• items
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
cockpit.supplies.equipment_list

Описание: Оборудование (для поставки)
Входящие переменные:
• search
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.supplies.statuses_list

Описание: Статусы поставок
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.supplies.companies_list

Описание: Юр.лица (реквизиты для договора)
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.supplies.contract.generate

Описание: Сформировать договор поставки
Входящие переменные:
• supply_id обязательно
  Допустимый тип данных: Строка
• company_id
  Допустимый тип данных: Строка
• counterparty_company_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• document_id
  Тип данных: Строка
cockpit.supplies.contract.send_to_chat

Описание: Отправить договор в чат клиента
Входящие переменные:
• supply_id обязательно
  Допустимый тип данных: Строка
• document_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• outbox_id
  Тип данных: Строка
cockpit.supplies.send_tracking

Описание: Отправить ссылку на трекинг поставки в чат клиента
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• outbox_id
  Тип данных: Строка
cockpit.cs.events.list

Описание: События воронки клуба (пульт)
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
cockpit.cs.actions.list

Описание: Очередь действий КС клуба (пульт)
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• status
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
cockpit.cs.surveys.results

Описание: Результаты опросов КС клуба (пульт)
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
cockpit.cs.templates.list

Описание: Шаблоны КС push/survey (пульт)
Входящие переменные:
• kind
  Допустимый тип данных: Строка
Возвращаемые параметры:
cockpit.cs.events.set

Описание: Отметить статус/дату события клуба (пульт)
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• type_key обязательно
  Допустимый тип данных: Строка
• status
  Допустимый тип данных: Строка
• event_date
  Допустимый тип данных: Число
• planned_date
  Допустимый тип данных: Число
• note
  Допустимый тип данных: Строка
Возвращаемые параметры:
cockpit.cs.actions.cancel

Описание: Отменить действие КС (пульт)
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
cockpit.cs.actions.reschedule

Описание: Перенести действие КС (пульт)
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• scheduled_ts обязательно
  Допустимый тип данных: Число
Возвращаемые параметры:
cockpit.cs.actions.runNow

Описание: Запустить действие КС сейчас (пульт)
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
cockpit.cs.actions.addManual

Описание: Добавить действие КС вручную (пульт)
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• action_type обязательно
  Допустимый тип данных: Строка
• template_id
  Допустимый тип данных: Строка
• message_template_id
  Допустимый тип данных: Строка
• scheduled_ts
  Допустимый тип данных: Число
• survey_window_days
  Допустимый тип данных: Число
• audience
  Допустимый тип данных: Объект
Возвращаемые параметры:
cockpit.companies.list

Описание: Реквизиты (юр.лица) клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
cockpit.companies.add

Описание: Добавить реквизиты юр.лица клиента
Входящие переменные:
• client_id обязательно
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• entity_type
  Допустимый тип данных: Число
• name обязательно
  Допустимый тип данных: Строка
• inn обязательно
  Допустимый тип данных: Строка
• ogrn обязательно
  Допустимый тип данных: Строка
• kpp
  Допустимый тип данных: Строка
• director_name
  Допустимый тип данных: Строка
• phone обязательно
  Допустимый тип данных: Строка
• email обязательно
  Допустимый тип данных: Строка
• okup_contract
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
cockpit.companies.edit

Описание: Редактировать реквизиты юр.лица клиента
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• entity_type
  Допустимый тип данных: Число
• name обязательно
  Допустимый тип данных: Строка
• inn обязательно
  Допустимый тип данных: Строка
• ogrn обязательно
  Допустимый тип данных: Строка
• kpp
  Допустимый тип данных: Строка
• director_name
  Допустимый тип данных: Строка
• phone обязательно
  Допустимый тип данных: Строка
• email обязательно
  Допустимый тип данных: Строка
• okup_contract
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.deal_statuses.add

Описание: Add deal status
Входящие переменные:
• name
  Допустимый тип данных: Строка
• color
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: undefined
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.deal_statuses.edit

Описание: Edit deal status
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• color
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: undefined
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.deal_statuses.get

Описание: Get deal status
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.deal_statuses.list

Описание: List deal statuses
Входящие переменные:
• skip
  Допустимый тип данных: undefined
• limit
  Допустимый тип данных: undefined
• search
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив (любые типы внутри)
crm.deal_statuses.remove

Описание: Remove deal status
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.deals.add

Описание: Create CRM deal
Входящие переменные:
• title
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• client_id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• pipeline_id
  Допустимый тип данных: Строка
• stage_id
  Допустимый тип данных: Строка
• lead_source_id
  Допустимый тип данных: Строка
• lost_reason_id
  Допустимый тип данных: Строка
• amount
  Допустимый тип данных: undefined
• currency
  Допустимый тип данных: Строка
• probability
  Допустимый тип данных: undefined
• expected_close_ts
  Описание:
  ISO date
  Допустимый тип данных: Строка
• source
  Допустимый тип данных: Строка
• tags
  Допустимый тип данных: Массив (любые типы внутри)
• custom_fields
  Допустимый тип данных: Объект
• owner_uid
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.deals.kanban

Описание: Deals aggregation for Kanban by pipeline/stage
Входящие переменные:
• pipeline_id
  Допустимый тип данных: Строка
• status
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• client_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• pipelines
  Тип данных: Массив объектов
crm.deals.edit

Описание: Edit CRM deal
Входящие переменные:
• id
  Допустимый тип данных: Строка
• title
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• client_id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• pipeline_id
  Допустимый тип данных: Строка
• stage_id
  Допустимый тип данных: Строка
• lead_source_id
  Допустимый тип данных: Строка
• lost_reason_id
  Допустимый тип данных: Строка
• amount
  Допустимый тип данных: undefined
• currency
  Допустимый тип данных: Строка
• probability
  Допустимый тип данных: undefined
• expected_close_ts
  Допустимый тип данных: Строка
• source
  Допустимый тип данных: Строка
• tags
  Допустимый тип данных: Массив (любые типы внутри)
• custom_fields
  Допустимый тип данных: Объект
• owner_uid
  Допустимый тип данных: Число
• status
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
crm.deals.move

Описание: Move CRM deal to another stage/pipeline
Входящие переменные:
• id
  Допустимый тип данных: Строка
• pipeline_id
  Допустимый тип данных: Строка
• stage_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.deals.win

Описание: Mark deal as won
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.deals.lose

Описание: Mark deal as lost
Входящие переменные:
• id
  Допустимый тип данных: Строка
• reason
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.deals.remove

Описание: Remove deal
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.deals.get

Описание: Get deal
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.deals.list

Описание: List deals
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• pipeline_id
  Допустимый тип данных: Строка
• stage_id
  Допустимый тип данных: Строка
• owner_uid
  Допустимый тип данных: Число
• status
  Допустимый тип данных: Строка
• search
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
• skip
  Тип данных: Число
• limit
  Тип данных: Число
crm.lead_sources.add

Описание: Добавить источник лида
Входящие переменные:
• name
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: Число
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.lead_sources.edit

Описание: Редактировать источник лида
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: Число
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.lead_sources.list

Описание: Список источников лидов
Входящие переменные:
• search
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
crm.lead_sources.remove

Описание: Удалить источник лида
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.lost_reasons.add

Описание: Добавить причину отказа
Входящие переменные:
• name
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: Число
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.lost_reasons.edit

Описание: Редактировать причину отказа
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: Число
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.lost_reasons.list

Описание: Список причин отказа
Входящие переменные:
• search
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
crm.lost_reasons.remove

Описание: Удалить причину отказа
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.notifications.settings.get

Описание: Возвращает персональные настройки уведомлений пользователя
Входящие переменные:
• user_id
  Описание:
  ID пользователя (опционально, по умолчанию текущий)
  Допустимый тип данных: Число
crm.notifications.settings.save

Описание: Сохраняет персональные настройки уведомлений пользователя
Входящие переменные:
• user_id
  Описание:
  ID пользователя (опционально)
  Допустимый тип данных: Число
• enabled
  Описание:
  Включить уведомления
  Допустимый тип данных: Логическое выражение
• events
  Описание:
  Настройки событий {event_type: boolean}
  Допустимый тип данных: Объект
• filters
  Описание:
  Фильтры: only_my_deals, only_my_clients, pipelines
  Допустимый тип данных: Объект
• schedule
  Описание:
  Расписание: quiet_hours_enabled, quiet_hours_start, quiet_hours_end, timezone
  Допустимый тип данных: Объект
crm.notifications.link_status

Описание: Возвращает статус привязки Telegram аккаунта и информацию о боте
Входящие переменные:
• user_id
  Описание:
  ID пользователя (опционально)
  Допустимый тип данных: Число
crm.notifications.unlink_telegram

Описание: Отключает связку Telegram аккаунта с пользователем
Входящие переменные:
• user_id
  Описание:
  ID пользователя (опционально)
  Допустимый тип данных: Число
crm.notifications.event_types

Описание: Возвращает список доступных типов событий для уведомлений
Входящие переменные:
crm.pipelines.add

Описание: Create CRM pipeline with stages
Входящие переменные:
• name
  Допустимый тип данных: Строка
• stages
  Допустимый тип данных: Массив объектов
• default
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.pipelines.edit

Описание: Edit CRM pipeline
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• stages
  Допустимый тип данных: Массив объектов
• default
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
crm.pipelines.list

Описание: List CRM pipelines
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
crm.pipelines.get

Описание: Get CRM pipeline
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.pipelines.remove

Описание: Remove CRM pipeline
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.sync.status

Описание: Сводное состояние синхронизации Bitrix по сущностям
Входящие переменные:
Возвращаемые параметры:
• entities
  Тип данных: Массив (любые типы внутри)
• push_enabled
  Тип данных: Логическое выражение
• enabled
  Тип данных: Логическое выражение
• portal_url
  Тип данных: Строка
• pending_tasks
  Тип данных: Число
crm.sync.test

Описание: Проверка связи с порталом Bitrix24
Входящие переменные:
Возвращаемые параметры:
• ok
  Тип данных: Логическое выражение
• error
  Тип данных: Строка
crm.sync.run

Описание: Ручной запуск синхронизации сущности (pull или push)
Входящие переменные:
• entity_type
  Допустимый тип данных: Строка
• direction
  Допустимый тип данных: Строка
• entity_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• error
  Тип данных: Строка
crm.sync.logs

Описание: Лог синхронизации Bitrix (пагинация)
Входящие переменные:
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
• entity_type
  Допустимый тип данных: Строка
• direction
  Допустимый тип данных: Строка
• result
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив (любые типы внутри)
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
crm.sync.dlq

Описание: Список упавших push-задач (DLQ)
Входящие переменные:
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
• entity_type
  Допустимый тип данных: Строка
• resolved
  Допустимый тип данных: Логическое выражение
• dead
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив (любые типы внутри)
• total
  Тип данных: Число
crm.sync.dlq_retry

Описание: Повторить упавшие push-задачи (DLQ)
Входящие переменные:
• dlq_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.sync.reconcile

Описание: Реконсиляция сущности (dry-run по умолчанию)
Входящие переменные:
• entity_type
  Допустимый тип данных: Строка
• dry_run
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.sync.drift

Описание: Отчёт о расхождениях (последний dry-run реконсиляции)
Входящие переменные:
• entity_type
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив (любые типы внутри)
crm.reports.generate

Описание: Generate CRM report
Входящие переменные:
• report_type
  Допустимый тип данных: Строка
• date_from
  Допустимый тип данных: Строка
• date_to
  Допустимый тип данных: Строка
Возвращаемые параметры:
• data
  Тип данных: Массив объектов
crm.reports.forecast

Описание: Get revenue forecast based on open deals
Входящие переменные:
Возвращаемые параметры:
• deals_count
  Тип данных: Число
• total_amount
  Тип данных: Число
• weighted_forecast
  Тип данных: Число
crm.supplies.add

Описание: Add supply
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• invoice_id
  Допустимый тип данных: Строка
• items
  Допустимый тип данных: Массив объектов
• status_id
  Допустимый тип данных: Строка
• planned_ship_ts
  Допустимый тип данных: Строка
• actual_ship_ts
  Допустимый тип данных: Строка
• paid_ts
  Допустимый тип данных: Строка
• tracking_number
  Допустимый тип данных: Строка
• carrier
  Допустимый тип данных: Строка
• delivery_address
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.supplies.edit

Описание: Edit supply
Входящие переменные:
• id
  Допустимый тип данных: Строка
• client_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• invoice_id
  Допустимый тип данных: Строка
• items
  Допустимый тип данных: Массив объектов
• status_id
  Допустимый тип данных: Строка
• planned_ship_ts
  Допустимый тип данных: Строка
• actual_ship_ts
  Допустимый тип данных: Строка
• paid_ts
  Допустимый тип данных: Строка
• tracking_number
  Допустимый тип данных: Строка
• carrier
  Допустимый тип данных: Строка
• delivery_address
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.supplies.get

Описание: Get supply
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.supplies.list

Описание: List supplies
Входящие переменные:
• client_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• contact_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• status_id
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
crm.supplies.remove

Описание: Remove supply
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.supplies.shipment

Описание: Add shipment to supply (partial shipping)
Входящие переменные:
• id
  Допустимый тип данных: Строка
• tracking_number
  Допустимый тип данных: Строка
• carrier
  Допустимый тип данных: Строка
• items
  Допустимый тип данных: Массив объектов
• comment
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• shipment_id
  Тип данных: Строка
crm.supplies.create_invoice

Описание: Create invoice for a supply (company payment)
Входящие переменные:
• id
  Допустимый тип данных: Строка
• company_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• invoice_id
  Тип данных: Строка
crm.supply_statuses.add

Описание: Add supply status
Входящие переменные:
• name
  Допустимый тип данных: Строка
• color
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: undefined
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.supply_statuses.edit

Описание: Edit supply status
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• color
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: undefined
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.supply_statuses.get

Описание: Get supply status
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Число в строке
crm.supply_statuses.list

Описание: List supply statuses
Входящие переменные:
• skip
  Допустимый тип данных: undefined
• limit
  Допустимый тип данных: undefined
• search
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
crm.supply_statuses.remove

Описание: Remove supply status
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.equipment.add

Описание: Add equipment registry item
Входящие переменные:
• sku
  Допустимый тип данных: Строка
• type
  Допустимый тип данных: Строка
• brand
  Допустимый тип данных: Строка
• model
  Допустимый тип данных: Строка
• price_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• description
  Допустимый тип данных: Строка
• stock_qty
  Допустимый тип данных: Число
• reserved_qty
  Допустимый тип данных: Число
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Тип данных: Строка
crm.equipment.edit

Описание: Edit equipment registry item
Входящие переменные:
• id
  Допустимый тип данных: Строка
• sku
  Допустимый тип данных: Строка
• type
  Допустимый тип данных: Строка
• brand
  Допустимый тип данных: Строка
• model
  Допустимый тип данных: Строка
• price_rub
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
• description
  Допустимый тип данных: Строка
• stock_qty
  Допустимый тип данных: Число
• reserved_qty
  Допустимый тип данных: Число
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
crm.equipment.get

Описание: Get equipment registry item
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
crm.equipment.list

Описание: List equipment registry items
Входящие переменные:
• search
  Допустимый тип данных: Строка
• enabled
  Допустимый тип данных: Логическое выражение
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
crm.equipment.remove

Описание: Remove equipment registry item
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
invoices.add

Описание: Создать счёт (на поставку, лицензию, услугу)
Входящие переменные:
• type
  Описание:
  Тип: company (безнал)
  Допустимый тип данных: Строка
• subject
  Описание:
  Предмет: license | supply | service
  Допустимый тип данных: Строка
• amount
  Описание:
  Сумма в копейках
  Допустимый тип данных: Число
• company_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• client_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• supply_id
  Допустимый тип данных: Строка
• tariff_id
  Допустимый тип данных: Строка
• option_ids
  Допустимый тип данных: Массив строк
• months
  Описание:
  Период оплаты в месяцах
  Допустимый тип данных: Число
• service_id
  Допустимый тип данных: Строка
• service_items
  Допустимый тип данных: Массив объектов
• comment
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• invoice_id
  Тип данных: Число
invoices.edit

Описание: Редактировать счёт
Входящие переменные:
• invoice_id
  Допустимый тип данных: Строка
• id
  Допустимый тип данных: Строка
• amount
  Допустимый тип данных: Число
• company_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
• client_id
  Допустимый тип данных: Строка
• deal_id
  Допустимый тип данных: Строка
• subject
  Допустимый тип данных: Строка
• tariff_id
  Допустимый тип данных: Строка
• option_ids
  Допустимый тип данных: Массив строк
• months
  Допустимый тип данных: Число
• service_id
  Допустимый тип данных: Строка
• service_items
  Допустимый тип данных: Массив объектов
• comment
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
invoices.get

Описание: Получить счёт
Входящие переменные:
• invoice_id
  Допустимый тип данных: Строка
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
invoices.remove

Описание:
Входящие переменные:
• invoice_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
invoices.list_all

Описание: List all invoices (company+card)
Входящие переменные:
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• paid
  Допустимый тип данных: Логическое выражение
• club_id
  Допустимый тип данных: Строка
• client_id
  Допустимый тип данных: Строка
• type
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
invoices.mark_paid

Описание: Mark invoice paid with date
Входящие переменные:
• invoice_id
  Допустимый тип данных: Строка
• paid_ts
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
invoices.paid

Описание:
Входящие переменные:
• invoice_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
invoices.add_payment

Описание: Добавить платёж к счёту
Входящие переменные:
• invoice_id
  Допустимый тип данных: Строка
• amount
  Описание:
  Сумма платежа
  Допустимый тип данных: Число
• method
  Описание:
  Способ оплаты: bank_transfer | card | cash
  Допустимый тип данных: Строка
• comment
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• payment_id
  Тип данных: Строка
• paid_amount
  Тип данных: Число
• status
  Тип данных: Строка
• fully_paid
  Тип данных: Логическое выражение
invoices.set_status

Описание: Изменить статус счёта
Входящие переменные:
• invoice_id
  Допустимый тип данных: Строка
• status
  Описание:
  draft | sent | viewed | paid | partial | overdue | cancelled
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
payout.get

Описание: Получить выплату
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
payout.list_all

Описание: List all invoices (company+card)
Входящие переменные:
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
payout.mark_paid

Описание: Пометить выплату выплаченной
Входящие переменные:
• invoice_id
  Допустимый тип данных: Строка
• paid_ts
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
services.add

Описание: Add service
Входящие переменные:
• name
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• price
  Допустимый тип данных: undefined
• currency
  Допустимый тип данных: Строка
• unit
  Допустимый тип данных: Строка
• category
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
services.edit

Описание: Edit service
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
• price
  Допустимый тип данных: undefined
• currency
  Допустимый тип данных: Строка
• unit
  Допустимый тип данных: Строка
• category
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
services.get

Описание: Get service
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
services.list

Описание: List services
Входящие переменные:
• search
  Допустимый тип данных: Строка
• category
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
services.remove

Описание: Remove service
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
settings.update

Описание: Обновить настройки приложения
Входящие переменные:
users.employee_roles.list

Описание: Сотрудничество и роли пользователя по uid — единый листинг для Grid
Входящие переменные:
• uid
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
users.client_clubs.list

Описание: Клубы где пользователь является клиентом (clubs_client)
Входящие переменные:
• uid
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
users.videos.list

Описание: Видео пользователя (internal) с фильтрами/сортировкой/пагинацией
Входящие переменные:
• uid
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• show_removed
  Допустимый тип данных: Логическое выражение
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
users.workouts.list

Описание: Тренировочные профили пользователя (workouts) с фильтрами/пагинацией
Входящие переменные:
• uid
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
users.sessions.participant.list

Описание: Сессии, где пользователь участник (participant_uids)
Входящие переменные:
• uid
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
users.sessions.coach.list

Описание: Сессии, где пользователь тренер (coach_ids)
Входящие переменные:
• uid
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
users.devices.list

Описание: Активные устройства пользователя с фильтрами/сортировкой/пагинацией
Входящие переменные:
• uid
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
users.challenges.list

Описание: Список челленджей published:true, removed:false с участием пользователя
Входящие переменные:
• uid
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• filters
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Тип данных: Число
• items
  Тип данных: Массив объектов
users.merge.dryrun

Описание: Dry-run слияния данных двух пользователей: подсчёт документов по категориям без изменений
Входящие переменные:
• uid_from
  Допустимый тип данных: Число
• uid_to
  Допустимый тип данных: Число
Возвращаемые параметры:
• ok
  Тип данных: Логическое выражение
• uid_from
  Тип данных: Число
• uid_to
  Тип данных: Число
• counts
  Тип данных: Объект
users.merge

Описание: Слияние данных пользователя uid_from в uid_to по выбранным категориям
Входящие переменные:
• uid_from
  Допустимый тип данных: Число
• uid_to
  Допустимый тип данных: Число
• move
  Допустимый тип данных: Объект
Возвращаемые параметры:
• ok
  Тип данных: Логическое выражение
• uid_from
  Тип данных: Число
• uid_to
  Тип данных: Число
• changed
  Тип данных: Объект
vectorizer.status

Описание: Статус очереди векторизации и метрики сервиса
Входящие переменные:
vectorizer.reindex

Описание: Ручная постановка сущности на переэмбеддинг
Входящие переменные:
• entity_type
  Описание:
  Тип сущности (workout|service|...)
  Допустимый тип данных: Строка
• entity_id
  Описание:
  ID сущности
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба (опционально)
  Допустимый тип данных: Строка
• reason
  Описание:
  Причина постановки
  Допустимый тип данных: Строка
vectorizer.requeue_failed

Описание: Массовый перезапуск зафейленных задач
Входящие переменные:
• entity_type
  Описание:
  Фильтр по типу сущности (опционально)
  Допустимый тип данных: Строка
vectorizer.metrics

Описание: Список задач в очереди с пагинацией
Входящие переменные:
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит (max 200)
  Допустимый тип данных: Число
• entity_type
  Описание:
  Фильтр по типу
  Допустимый тип данных: Строка
• status
  Описание:
  Фильтр по статусу
  Допустимый тип данных: Строка
screen.circle.types.add

Описание:
Входящие переменные:
• mode
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• tag
  Допустимый тип данных: Строка
• up
  Допустимый тип данных: Строка
• down
  Допустимый тип данных: Строка
• center
  Допустимый тип данных: Строка
• innerzone
  Допустимый тип данных: Строка
• outerzone
  Допустимый тип данных: Строка
• showavatar
  Допустимый тип данных: Логическое выражение
• showgraph
  Допустимый тип данных: Логическое выражение
• sport_type
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Тип данных: Строка
• mode
  Тип данных: Строка
• tag
  Тип данных: Строка
• up
  Тип данных: Строка
• down
  Тип данных: Строка
• center
  Тип данных: Строка
• innerzone
  Тип данных: Строка
• outerzone
  Тип данных: Строка
• showavatar
  Тип данных: Логическое выражение
• showgraph
  Тип данных: Логическое выражение
• sport_type
  Тип данных: Число
certificates.create

Описание:
Входящие переменные:
Возвращаемые параметры:
• id
  Тип данных: Строка
certificates.list

Описание:
Входящие переменные:
Возвращаемые параметры:
• id
  Тип данных: Строка
screen.circle.types.edit

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• tag
  Допустимый тип данных: Строка
• up
  Допустимый тип данных: Строка
• down
  Допустимый тип данных: Строка
• center
  Допустимый тип данных: Строка
• innerzone
  Допустимый тип данных: Строка
• outerzone
  Допустимый тип данных: Строка
• showavatar
  Допустимый тип данных: Логическое выражение
• showgraph
  Допустимый тип данных: Логическое выражение
• sport_type
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Тип данных: Строка
• tag
  Тип данных: Строка
• up
  Тип данных: Строка
• down
  Тип данных: Строка
• center
  Тип данных: Строка
• innerzone
  Тип данных: Строка
• outerzone
  Тип данных: Строка
• showavatar
  Тип данных: Логическое выражение
• showgraph
  Тип данных: Логическое выражение
• sport_type
  Тип данных: Число
screen.circle.types.list

Описание:
Входящие переменные:
• tag
  Допустимый тип данных: Строка
• search
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • tag
    Тип данных: Строка
  • up
    Тип данных: Строка
  • down
    Тип данных: Строка
  • center
    Тип данных: Строка
  • innerzone
    Тип данных: Строка
  • outerzone
    Тип данных: Строка
  • showavatar
    Тип данных: Логическое выражение
  • showgraph
    Тип данных: Логическое выражение
  • sport_type
    Тип данных: Число
screen.circle.types.remove

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• removed
  Тип данных: Логическое выражение
club.devices.list

Описание:
Входящие переменные:
Возвращаемые параметры:
tags.add

Описание:
Входящие переменные:
• name
  Допустимый тип данных: Строка
• type
  Описание:
  1 - категории видео, 2 - категории тренировок, 3 - категории показателей на экране
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Тип данных: Строка
• name
  Тип данных: Строка
• type
  Описание:
  1 - категории видео, 2 - категории тренировок, 3 - категории показателей на экране
  Тип данных: Число
tags.edit

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• name
  Тип данных: Строка
• names_lang
  Тип данных: Объект
tags.list

Описание:
Входящие переменные:
• type обязательно
  Допустимый тип данных: Число
Возвращаемые параметры:
• tags
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • name
    Тип данных: Строка
tags.remove

Описание:
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
equipment_types.list

Описание:
Входящие переменные:
• showdisabled
  Описание:
  show disabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
equipment_types.add

Описание:
Входящие переменные:
• brand
  Описание:
  brand
  Допустимый тип данных: Строка
• model
  Описание:
  model
  Допустимый тип данных: Строка
• sport_type
  Описание:
  sport type
  Допустимый тип данных: Число
• picture
  Описание:
  pictuire
  Допустимый тип данных: Строка
• enabled
  Описание:
  enabled
  Допустимый тип данных: Логическое выражение
• sensors_available
  Описание:
  sensors available
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • radio
    Описание:
    radio
    Тип данных: Строка
  • data
    Описание:
    Набор данных: power, cadence, speed, rower, hr
    Тип данных: Массив (любые типы внутри)
Возвращаемые параметры:
equipment_types.edit

Описание:
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
• brand
  Описание:
  brand
  Допустимый тип данных: Строка
• model
  Описание:
  model
  Допустимый тип данных: Строка
• sport_type
  Описание:
  sport type
  Допустимый тип данных: Число
• picture
  Описание:
  pictuire
  Допустимый тип данных: Строка
• enabled
  Описание:
  enabled
  Допустимый тип данных: Логическое выражение
• sensors_available
  Описание:
  sensors available
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • radio
    Описание:
    radio
    Тип данных: Строка
  • data
    Описание:
    Набор данных: power, cadence, speed, rower, hr
    Тип данных: Массив (любые типы внутри)
Возвращаемые параметры:
equipment_types.get

Описание:
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
Возвращаемые параметры:
box_types.list

Описание:
Входящие переменные:
• showdisabled
  Описание:
  show disabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
box_types.add

Описание:
Входящие переменные:
• version
  Описание:
  version
  Допустимый тип данных: Строка
• name
  Описание:
  name
  Допустимый тип данных: Строка
• hwid
  Описание:
  hwid
  Допустимый тип данных: Строка
• picture
  Описание:
  pictuire
  Допустимый тип данных: Строка
• enabled
  Описание:
  enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
box_types.edit

Описание:
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
• version
  Описание:
  version
  Допустимый тип данных: Строка
• name
  Описание:
  name
  Допустимый тип данных: Строка
• hwid
  Описание:
  hwid
  Допустимый тип данных: Строка
• picture
  Описание:
  pictuire
  Допустимый тип данных: Строка
• enabled
  Описание:
  enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
box_types.get

Описание:
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
Возвращаемые параметры:
clubs.list

Описание:
Входящие переменные:
Возвращаемые параметры:
clubs.add

Описание:
Входящие переменные:
• name
  Описание:
  name
  Допустимый тип данных: Строка
• description
  Описание:
  description
  Допустимый тип данных: Строка
• picture
  Описание:
  pictuire
  Допустимый тип данных: Строка
• timezone
  Описание:
  timezone
  Допустимый тип данных: Строка
• paid_ts
  Описание:
  paid_ts
  Допустимый тип данных: Число
• paid_till
  Описание:
  paid_persiod days
  Допустимый тип данных: Число
• tariff_id
  Описание:
  tariff_id
  Допустимый тип данных: Число
• num_boxes
  Описание:
  num_boxes
  Допустимый тип данных: Число
• phone
  Описание:
  phone
  Допустимый тип данных: Строка
• apikey
  Описание:
  apikey
  Допустимый тип данных: Строка
Возвращаемые параметры:
clubs.remove

Описание:
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
Возвращаемые параметры:
clubs.edit

Описание:
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
• name
  Описание:
  name
  Допустимый тип данных: Строка
• description
  Описание:
  description
  Допустимый тип данных: Строка
• picture
  Описание:
  pictuire
  Допустимый тип данных: Строка
• timezone
  Описание:
  timezone
  Допустимый тип данных: Строка
• paid_ts
  Описание:
  paid_ts
  Допустимый тип данных: Число
• paid_till
  Описание:
  Оплачено по (unix timestamp)
  Допустимый тип данных: Число
• paid_period
  Описание:
  paid_persiod days
  Допустимый тип данных: Число
• tariff_id
  Описание:
  ID тарифа
  Допустимый тип данных: Строка
• num_boxes
  Описание:
  num_boxes
  Допустимый тип данных: Число
• apikey
  Описание:
  apikey
  Допустимый тип данных: Строка
• phone
  Описание:
  phone
  Допустимый тип данных: Строка
• referrer_uid
  Описание:
  UID привлекшего пользователя (реферальный код). Пустое значение очищает реферера
  Допустимый тип данных: Строка
Возвращаемые параметры:
clubs.get

Описание:
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  id
  Тип данных: Строка
• name
  Описание:
  name
  Тип данных: Строка
• description
  Описание:
  description
  Тип данных: Строка
• picture
  Описание:
  pictuire
  Тип данных: Строка
• timezone
  Описание:
  timezone
  Тип данных: Строка
• apikey
  Описание:
  Ключ API
  Тип данных: Строка
• owner
  Тип данных: Объект
  Вложенные элементы:
  • uid
    Тип данных: Число
  • phone
    Тип данных: Строка
• tariff
  Тип данных: Объект
  Вложенные элементы:
  • paid_ts
    Описание:
    paid_ts
    Тип данных: Число
  • paid_period
    Описание:
    paid_persiod days
    Тип данных: Число
  • tariff_id
    Описание:
    tariff_id
    Тип данных: Число
  • num_boxes
    Описание:
    num_boxes
    Тип данных: Число
  • with_partner_id
    Описание:
    with_partner_id
    Тип данных: Число
partners.list

Описание: Список партнеров
Входящие переменные:
Возвращаемые параметры:
• partners
  Описание:
  Список партнеров
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    id
    Тип данных: Строка
  • name
    Описание:
    name
    Тип данных: Строка
  • status
    Описание:
    status
    Тип данных: Логическое выражение
partners.add

Описание: Добавить партнера
Входящие переменные:
• name
  Описание:
  name
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  id
  Тип данных: Строка
• name
  Описание:
  name
  Тип данных: Строка
partners.get

Описание: Получить партнера
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  id
  Тип данных: Строка
• name
  Описание:
  name
  Тип данных: Строка
• status
  Описание:
  status
  Тип данных: Логическое выражение
partners.edit

Описание: Получить партнера
Входящие переменные:
• id
  Описание:
  id
  Допустимый тип данных: Строка
• name
  Описание:
  name
  Допустимый тип данных: Строка
• status
  Описание:
  status
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Описание:
  id
  Тип данных: Строка
• name
  Описание:
  name
  Тип данных: Строка
• status
  Описание:
  status
  Тип данных: Логическое выражение
clients.add

Описание:
Входящие переменные:
Возвращаемые параметры:
companies.list

Описание:
Входящие переменные:
Возвращаемые параметры:
clients.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
clients.remove

Описание:
Входящие переменные:
Возвращаемые параметры:
clients.merge

Описание:
Входящие переменные:
Возвращаемые параметры:
clients.get

Описание:
Входящие переменные:
Возвращаемые параметры:
clients.list

Описание:
Входящие переменные:
Возвращаемые параметры:
contacts.add

Описание:
Входящие переменные:
Возвращаемые параметры:
contacts.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
contacts.list

Описание:
Входящие переменные:
Возвращаемые параметры:
contacts.remove

Описание:
Входящие переменные:
Возвращаемые параметры:
contacts.get

Описание:
Входящие переменные:
Возвращаемые параметры:
comments.add

Описание:
Входящие переменные:
Возвращаемые параметры:
comments.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
comments.remove

Описание:
Входящие переменные:
Возвращаемые параметры:
comments.get

Описание:
Входящие переменные:
Возвращаемые параметры:
comments.list

Описание:
Входящие переменные:
Возвращаемые параметры:
client.events.add

Описание:
Входящие переменные:
Возвращаемые параметры:
client.events.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
client.events.remove

Описание:
Входящие переменные:
Возвращаемые параметры:
client.events.get

Описание:
Входящие переменные:
Возвращаемые параметры:
client.events.list

Описание:
Входящие переменные:
Возвращаемые параметры:
sport_types.add

Описание:
Входящие переменные:
Возвращаемые параметры:
sport_types.remove

Описание:
Входящие переменные:
Возвращаемые параметры:
sport_types.list

Описание:
Входящие переменные:
Возвращаемые параметры:
sport_types.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
sport_types.settings_set

Описание:
Входящие переменные:
Возвращаемые параметры:
versions.add

Описание:
Входящие переменные:
• version
  Описание:
  Версия
  Допустимый тип данных: Строка
• platforms
  Описание:
  Платформы на которых вышло обновление
  Допустимый тип данных: Массив чисел
• role
  Описание:
  Минимальная роль
  Допустимый тип данных: Число
• body
  Описание:
  Описание изменений
  Допустимый тип данных: Строка
• status
  Описание:
  Статус
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Описание:
  Идентфикатор версии
  Тип данных: Строка
versions.edit

Описание:
Входящие переменные:
• id
  Описание:
  Идентфикатор версии
  Допустимый тип данных: Строка
• version
  Описание:
  Версия
  Допустимый тип данных: Строка
• role
  Описание:
  Минимальная роль
  Допустимый тип данных: Число
• platforms
  Описание:
  Платформы на которых вышло обновление
  Допустимый тип данных: Массив чисел
• body
  Описание:
  Описание изменений
  Допустимый тип данных: Строка
• status
  Описание:
  Статус
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
versions.remove

Описание:
Входящие переменные:
• id
  Описание:
  Идентфикатор версии
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
versions.list

Описание:
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентфикатор версии
    Тип данных: Строка
  • version
    Описание:
    Версия
    Тип данных: Строка
  • role
    Описание:
    Минимальная роль
    Тип данных: Число
  • platforms
    Описание:
    Платформы на которых вышло обновление
    Тип данных: Массив чисел
  • status
    Описание:
    Статус
    Тип данных: Логическое выражение
versions.get

Описание:
Входящие переменные:
• id
  Описание:
  Идентфикатор версии
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентфикатор версии
  Тип данных: Строка
• version
  Описание:
  Версия
  Тип данных: Строка
• body
  Описание:
  Описание изменений
  Тип данных: Строка
• role
  Описание:
  Минимальная роль
  Тип данных: Число
• platforms
  Описание:
  Платформы на которых вышло обновление
  Тип данных: Массив чисел
• status
  Описание:
  Статус
  Тип данных: Логическое выражение
app_versions.list

Описание:
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентфикатор версии
    Тип данных: Строка
  • name
    Описание:
    Версия
    Тип данных: Строка
  • app_version
    Описание:
    Минимальная роль
    Тип данных: Строка
  • status
    Описание:
    Статус
    Тип данных: Логическое выражение
app_versions.add

Описание:
Входящие переменные:
• name
  Допустимый тип данных: Строка
• app_version
  Допустимый тип данных: Строка
• fixed_clubs
  Допустимый тип данных: Логическое выражение
• status
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
app_versions.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
banners.add

Описание: Добавить баннер в клуб
Входящие переменные:
• title
  Описание:
  Заголовок баннера
  Допустимый тип данных: Строка
• platforms
  Описание:
  Платформы на которых показывается баннер
  Допустимый тип данных: Массив чисел
• role
  Описание:
  Минимальная роль для показа баннера
  Допустимый тип данных: Число
• fileid
  Описание:
  Идентификатор файла
  Допустимый тип данных: Строка
• islink
  Описание:
  Баннер является ссылкой
  Допустимый тип данных: Логическое выражение
• body
  Описание:
  Текст баннера
  Допустимый тип данных: Строка
• order
  Описание:
  Порядок показа
  Допустимый тип данных: Число
• showmoretext
  Описание:
  Текст 'Показать больше'
  Допустимый тип данных: Строка
• showmorelink
  Описание:
  Ссылка 'Показать больше'
  Допустимый тип данных: Строка
• openinapp
  Описание:
  Открывать ссылку в приложении
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Описание:
  Идентификатор баннера
  Тип данных: Строка
banners.edit

Описание: Добавить баннер в клуб
Входящие переменные:
• id
  Описание:
  Идентификатор баннера
  Допустимый тип данных: Строка
• platforms
  Описание:
  Платформы на которых показывается баннер
  Допустимый тип данных: Массив чисел
• role
  Описание:
  Минимальная роль для показа баннера
  Допустимый тип данных: Число
• title
  Описание:
  Заголовок баннера
  Допустимый тип данных: Строка
• fileid
  Описание:
  Идентификатор файла
  Допустимый тип данных: Строка
• showmoretext
  Описание:
  Текст 'Показать больше'
  Допустимый тип данных: Строка
• islink
  Описание:
  Баннер является ссылкой
  Допустимый тип данных: Логическое выражение
• body
  Описание:
  Текст баннера
  Допустимый тип данных: Строка
• order
  Описание:
  Порядок следования баннеров
  Допустимый тип данных: Число
• showmorelink
  Описание:
  Ссылка 'Показать больше'
  Допустимый тип данных: Строка
• openinapp
  Описание:
  Открывать ссылку в приложении
  Допустимый тип данных: Логическое выражение
• status
  Описание:
  Статус баннера
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  результат операции
  Тип данных: Логическое выражение
banners.get

Описание: Получить баннер
Входящие переменные:
• id
  Описание:
  Идентификатор баннера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор баннера
  Тип данных: Строка
• platforms
  Описание:
  Платформы на которых показывается баннер
  Тип данных: Массив чисел
• role
  Описание:
  Минимальная роль для показа баннера
  Тип данных: Число
• order
  Описание:
  Порядок следования баннеров
  Тип данных: Число
• title
  Описание:
  Заголовок баннера
  Тип данных: Строка
• fileid
  Описание:
  Идентификатор файла
  Тип данных: Строка
• islink
  Описание:
  Баннер является ссылкой
  Тип данных: Логическое выражение
• body
  Описание:
  Текст баннера
  Тип данных: Строка
• showmoretext
  Описание:
  Текст 'Показать больше'
  Тип данных: Строка
• showmorelink
  Описание:
  Ссылка 'Показать больше'
  Тип данных: Строка
• openinapp
  Описание:
  Открывать ссылку в приложении
  Тип данных: Логическое выражение
• status
  Описание:
  Статус баннера
  Тип данных: Логическое выражение
banners.list

Описание: Получить список баннеров в клубе
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор баннера
    Тип данных: Строка
  • platforms
    Описание:
    Платформы на которых показывается баннер
    Тип данных: Массив чисел
  • role
    Описание:
    Минимальная роль для показа баннера
    Тип данных: Число
  • title
    Описание:
    Заголовок баннера
    Тип данных: Строка
  • order
    Описание:
    Порядок следования баннеров
    Тип данных: Число
  • fileid
    Описание:
    Файл картинки
    Тип данных: Строка
  • status
    Описание:
    Статус баннера
    Тип данных: Логическое выражение
banners.remove

Описание: Удалить баннер в клубе
Входящие переменные:
• id
  Описание:
  Идентификатор баннера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  результат операции
  Тип данных: Логическое выражение
app_updates.add

Описание: Добавить обновление приложения
Входящие переменные:
• version
  Описание:
  Версия приложения
  Допустимый тип данных: Строка
• app_id
  Описание:
  ID приложения
  Допустимый тип данных: Строка
• title
  Описание:
  Название версии
  Допустимый тип данных: Строка
• description
  Описание:
  Описание версии для пользователей
  Допустимый тип данных: Строка
• comment
  Описание:
  Внутренний комментарий
  Допустимый тип данных: Строка
• platforms
  Описание:
  Платформы (android, ios)
  Допустимый тип данных: Массив строк
• status
  Описание:
  Включена ли версия
  Допустимый тип данных: Логическое выражение
• not_authed
  Описание:
  Доступна для неавторизованных
  Допустимый тип данных: Логическое выражение
• screenmode
  Описание:
  Доступна для режима экрана
  Допустимый тип данных: Логическое выражение
• normal
  Описание:
  Доступна для обычного режима
  Допустимый тип данных: Логическое выражение
• admins
  Описание:
  Доступна админам
  Допустимый тип данных: Логическое выражение
• employees
  Описание:
  Доступна сотрудникам
  Допустимый тип данных: Логическое выражение
• clients
  Описание:
  Доступна клиентам
  Допустимый тип данных: Логическое выражение
• auto
  Описание:
  Автоматическое обновление
  Допустимый тип данных: Логическое выражение
• required
  Описание:
  Обязательное обновление
  Допустимый тип данных: Логическое выражение
• force
  Описание:
  Принудительное обновление
  Допустимый тип данных: Логическое выражение
• min_version
  Описание:
  Минимальная версия
  Допустимый тип данных: Строка
• specific_users
  Описание:
  Конкретные пользователи (uid)
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
app_updates.list

Описание: Список обновлений приложения
Входящие переменные:
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка
  Допустимый тип данных: Объект
• filters
  Описание:
  Фильтры от Grid
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
app_updates.edit

Описание: Редактировать обновление приложения
Входящие переменные:
• id
  Описание:
  ID версии
  Допустимый тип данных: Строка
• version
  Описание:
  Версия приложения
  Допустимый тип данных: Строка
• app_id
  Описание:
  ID приложения
  Допустимый тип данных: Строка
• title
  Описание:
  Название версии
  Допустимый тип данных: Строка
• description
  Описание:
  Описание версии для пользователей
  Допустимый тип данных: Строка
• comment
  Описание:
  Внутренний комментарий
  Допустимый тип данных: Строка
• platforms
  Описание:
  Платформы (android, ios)
  Допустимый тип данных: Массив строк
• status
  Описание:
  Включена ли версия
  Допустимый тип данных: Логическое выражение
• not_authed
  Описание:
  Доступна для неавторизованных
  Допустимый тип данных: Логическое выражение
• screenmode
  Описание:
  Доступна для режима экрана
  Допустимый тип данных: Логическое выражение
• normal
  Описание:
  Доступна для обычного режима
  Допустимый тип данных: Логическое выражение
• admins
  Описание:
  Доступна админам
  Допустимый тип данных: Логическое выражение
• employees
  Описание:
  Доступна сотрудникам
  Допустимый тип данных: Логическое выражение
• clients
  Описание:
  Доступна клиентам
  Допустимый тип данных: Логическое выражение
• auto
  Описание:
  Автоматическое обновление
  Допустимый тип данных: Логическое выражение
• required
  Описание:
  Обязательное обновление
  Допустимый тип данных: Логическое выражение
• force
  Описание:
  Принудительное обновление
  Допустимый тип данных: Логическое выражение
• min_version
  Описание:
  Минимальная версия
  Допустимый тип данных: Строка
• specific_users
  Описание:
  Конкретные пользователи (uid)
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
app_updates.get

Описание: Получить обновление приложения
Входящие переменные:
• id
  Описание:
  ID версии
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• version
  Тип данных: Строка
• app_id
  Тип данных: Строка
• title
  Тип данных: Строка
• description
  Тип данных: Строка
• comment
  Тип данных: Строка
• platforms
  Тип данных: Массив строк
• status
  Тип данных: Логическое выражение
• not_authed
  Тип данных: Логическое выражение
• screenmode
  Тип данных: Логическое выражение
• normal
  Тип данных: Логическое выражение
• admins
  Тип данных: Логическое выражение
• employees
  Тип данных: Логическое выражение
• clients
  Тип данных: Логическое выражение
• auto
  Тип данных: Логическое выражение
• required
  Тип данных: Логическое выражение
• force
  Тип данных: Логическое выражение
• min_version
  Тип данных: Строка
• specific_users
  Тип данных: Массив чисел
• created_ts
  Тип данных: Временной штамп (timestamp)
• updated_ts
  Тип данных: Временной штамп (timestamp)
app_updates.remove

Описание: Удалить обновление приложения
Входящие переменные:
• id
  Описание:
  ID версии
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
app_updates.check

Описание: Проверить доступные обновления для пользователя
Входящие переменные:
• app_id
  Описание:
  ID приложения
  Допустимый тип данных: Строка
• version
  Описание:
  Текущая версия
  Допустимый тип данных: Строка
• authed
  Описание:
  Авторизован ли пользователь
  Допустимый тип данных: Логическое выражение
• token
  Описание:
  Токен доступа
  Допустимый тип данных: Строка
• uid
  Описание:
  ID пользователя
  Допустимый тип данных: Строка
• platform
  Описание:
  Платформа (android, ios)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• version
  Тип данных: Строка
• auto
  Тип данных: Логическое выражение
• required
  Тип данных: Логическое выражение
• force
  Тип данных: Логическое выражение
• title
  Тип данных: Строка
• description
  Тип данных: Строка
• comment
  Тип данных: Строка
synctasks.list

Описание: Получение списка задач синхронизации
Входящие переменные:
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит (макс. 200)
  Допустимый тип данных: Число
• provider
  Описание:
  Фильтр по провайдеру (psport)
  Допустимый тип данных: Строка
• method
  Описание:
  Фильтр по методу синхронизации
  Допустимый тип данных: Строка
• club_id
  Описание:
  Фильтр по клубу
  Допустимый тип данных: Строка
• status
  Описание:
  Фильтр по статусу (pending, processing, processed, error, canceled)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список задач
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
synctasks.stats

Описание: Получение статистики синхронизации
Входящие переменные:
• provider
  Описание:
  Фильтр по провайдеру
  Допустимый тип данных: Строка
Возвращаемые параметры:
• summary
  Описание:
  Сводка по статусам
  Тип данных: Объект
• by_method
  Описание:
  Статистика по методам
  Тип данных: Массив объектов
• by_club
  Описание:
  Статистика по клубам
  Тип данных: Массив объектов
• avg_times
  Описание:
  Среднее время выполнения по методам
  Тип данных: Массив объектов
• recent_errors
  Описание:
  Последние ошибки
  Тип данных: Массив объектов
synctasks.methods

Описание: Получение списка методов и провайдеров синхронизации
Входящие переменные:
Возвращаемые параметры:
• methods
  Описание:
  Список методов
  Тип данных: Массив строк
• providers
  Описание:
  Список провайдеров
  Тип данных: Массив строк
synctasks.clubs

Описание: Получение списка клубов с интеграциями
Входящие переменные:
Возвращаемые параметры:
• clubs
  Описание:
  Список клубов с интеграциями
  Тип данных: Массив объектов
push_configs.list

Описание: Список push-конфигов для клубных приложений
Входящие переменные:
Возвращаемые параметры:
• items
  Описание:
  Список push-конфигов
  Тип данных: Массив объектов
push_configs.get

Описание: Получение push-конфига по id
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор конфига
  Допустимый тип данных: Строка
Возвращаемые параметры:
push_configs.add

Описание: Создание push-конфига
Входящие переменные:
• name обязательно
  Описание:
  Название конфига
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Массив ID клубов/групп
  Допустимый тип данных: Массив строк
• manual_aliases
  Описание:
  Ручные дополнительные aliases
  Допустимый тип данных: Массив строк
• collapsekey
  Описание:
  Collapse key для push
  Допустимый тип данных: Строка
• ios_enabled
  Описание:
  iOS push включен
  Допустимый тип данных: Логическое выражение
• ios_bundleid
  Описание:
  iOS Bundle ID
  Допустимый тип данных: Строка
• ios_teamid
  Описание:
  iOS Team ID
  Допустимый тип данных: Строка
• ios_cert_pem
  Описание:
  Содержимое PEM-сертификата iOS
  Допустимый тип данных: Строка
• ios_key_pem
  Описание:
  Содержимое PEM-ключа iOS
  Допустимый тип данных: Строка
• ios_passphrase
  Описание:
  Passphrase для iOS-ключа
  Допустимый тип данных: Строка
• ios_env
  Описание:
  iOS окружение (production/development)
  Допустимый тип данных: Строка
• status
  Описание:
  Статус (активен/неактивен)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
push_configs.edit

Описание: Редактирование push-конфига
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор конфига
  Допустимый тип данных: Строка
• name
  Описание:
  Название конфига
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Массив ID клубов/групп
  Допустимый тип данных: Массив строк
• manual_aliases
  Описание:
  Ручные дополнительные aliases
  Допустимый тип данных: Массив строк
• collapsekey
  Описание:
  Collapse key для push
  Допустимый тип данных: Строка
• ios_enabled
  Описание:
  iOS push включен
  Допустимый тип данных: Логическое выражение
• ios_bundleid
  Описание:
  iOS Bundle ID
  Допустимый тип данных: Строка
• ios_teamid
  Описание:
  iOS Team ID
  Допустимый тип данных: Строка
• ios_cert_pem
  Описание:
  Содержимое PEM-сертификата iOS
  Допустимый тип данных: Строка
• ios_key_pem
  Описание:
  Содержимое PEM-ключа iOS
  Допустимый тип данных: Строка
• ios_passphrase
  Описание:
  Passphrase для iOS-ключа
  Допустимый тип данных: Строка
• ios_env
  Описание:
  iOS окружение (production/development)
  Допустимый тип данных: Строка
• status
  Описание:
  Статус (активен/неактивен)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
push_configs.remove

Описание: Удаление push-конфига
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор конфига
  Допустимый тип данных: Строка
Возвращаемые параметры:
push_configs.reload

Описание: Перезагрузка push-конфигов в pushservice
Входящие переменные:
Возвращаемые параметры:

Модуль auth

Общая информация

Название: Авторизация
requests.initscreen

Описание: Запросить код для подтверждения авторизации
Входящие переменные:
Возвращаемые параметры:
• authrequest
  Описание:
  Код для подтверждения авторизации
  Тип данных: Строка
requests.init

Описание: Запросить код для подтверждения авторизации
Входящие переменные:
Возвращаемые параметры:
• authrequest
  Описание:
  Код для подтверждения авторизации
  Тип данных: Строка
requests.check

Описание: Проверить код авторизации
Входящие переменные:
• authrequest
  Описание:
  Код для подтверждения авторизации
  Допустимый тип данных: Строка
Возвращаемые параметры:
• valid
  Тип данных: Логическое выражение
• token
  Тип данных: Строка
requests.get

Описание: Проверить код авторизации
Входящие переменные:
• authrequest
  Описание:
  Код для подтверждения авторизации
  Допустимый тип данных: Строка
Возвращаемые параметры:
• valid
  Тип данных: Логическое выражение
• token
  Тип данных: Строка
requests.confirmscreen

Описание: Проверить код авторизации
Входящие переменные:
• authrequest
  Описание:
  Код для подтверждения авторизации
  Допустимый тип данных: Строка
• zone_id
  Допустимый тип данных: Строка
• screenmode_type
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• confirmed
  Тип данных: Логическое выражение
requests.confirm

Описание: Проверить код авторизации
Входящие переменные:
• authrequest
  Описание:
  Код для подтверждения авторизации
  Допустимый тип данных: Строка
Возвращаемые параметры:
• valid
  Тип данных: Логическое выражение
• confirmed
  Тип данных: Логическое выражение
init

Описание: Инициализация аутентификации
Входящие переменные:
• phone
  Описание:
  Номер телефона без знака + и пробелов, только цифры
  Допустимый тип данных: Строка
Возвращаемые параметры:
• type
  Тип данных: Логическое выражение
• data
  Описание:
  sms - ожидается код в смс,
  Тип данных: Строка
• error_msg
  Описание:
  wait 88 - ожидать столько то секунд до повторной отправки
  Тип данных: Строка
uses.captcha

Описание: Проверить нужна ли капча
Входящие переменные:
• app_version
  Допустимый тип данных: Строка
Возвращаемые параметры:
• uses_captcha
  Тип данных: Логическое выражение
confirm

Описание: Подтверждение аутентификации
Входящие переменные:
• phone
  Описание:
  Номер телефона
  Допустимый тип данных: Строка
• code
  Описание:
  Код, полученный из смс
  Допустимый тип данных: Возможно несколько типов: Число, Строка
Возвращаемые параметры:
• type
  Тип данных: Логическое выражение
• data
  Тип данных: Объект
  Вложенные элементы:
  • access_token
    Описание:
    Access token
    Тип данных: Строка
  • uid
    Описание:
    User id
    Тип данных: Число
checktoken

Описание: Проверка действия токена
Входящие переменные:
• access_token обязательно
  Описание:
  Токен авторизационной сессии
  Допустимый тип данных: Строка
Возвращаемые параметры:
• type
  Описание:
  всегда true (легаси остаток)
  Тип данных: Логическое выражение
• data
  Описание:
  Сам ответ
  Тип данных: Объект
  Вложенные элементы:
  • error
    Описание:
    Найден ли такой токен
    Тип данных: Логическое выражение
  • access_token
    Описание:
    Если найден то этот же токен приходит. если нет то такое поле отсутствует
    Тип данных: Строка
  • uid
    Описание:
    Идентификатор пользователя
    Тип данных: Число
  • locked
    Описание:
    Заблокирована ли сессия
    Тип данных: Логическое выражение

Модуль balance

Общая информация

Название: balance
current

Описание: Получить текущий счет
Входящие переменные:
Возвращаемые параметры:
• paid
  Описание:
  Оплачено
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  Id созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
operation

Описание: Получить операции по счету
Входящие переменные:
Возвращаемые параметры:
• paid
  Описание:
  Оплачено
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  Id созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
create.payout

Описание: Создать запрос на выплату
Входящие переменные:

Модуль caddy

Общая информация

Название: Caddy API
Описание:
API для валидации доменов и управления Caddy reverse proxy
validateDomain

Описание: Валидация домена для on-demand TLS сертификатов
Входящие переменные:
• domain обязательно
  Описание:
  Домен для валидации
  Допустимый тип данных: Строка
Возвращаемые параметры:
• allowed
  Описание:
  Разрешён ли домен
  Тип данных: Логическое выражение
• status
  Описание:
  HTTP статус (200 или 403)
  Тип данных: Число
• club_id
  Описание:
  ID клуба (если найден)
  Тип данных: Строка
• reason
  Описание:
  Причина отказа (если не разрешён)
  Тип данных: Строка
invalidateCache

Описание: Инвалидация кэша валидации для домена
Входящие переменные:
• domain обязательно
  Описание:
  Домен для инвалидации кэша
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
clearCache

Описание: Очистка всего кэша валидации доменов
Входящие переменные:
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
getCacheStats

Описание: Получение статистики кэша валидации
Входящие переменные:
Возвращаемые параметры:
• size
  Описание:
  Количество записей в кэше
  Тип данных: Число
• entries
  Описание:
  Список записей кэша
  Тип данных: Массив (любые типы внутри)

Модуль authors

Общая информация

Название: authors
get

Описание: Получить автора по Id
Входящие переменные:
• id
  Описание:
  Id автора
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор автора
  Тип данных: Число
• firstname
  Описание:
  Имя автора
  Тип данных: Строка
• rating
  Описание:
  Рейтинг автора
  Тип данных: Дробное число в строке
• author_picture
  Описание:
  Идентификатор файла аватарки автора
  Тип данных: Строка
save

Описание: Сохранить автора текущего клуба
Входящие переменные:
• search
  Описание:
  Поисковая фраза
  Допустимый тип данных: Строка
• sport_types
  Описание:
  Виды спорта
  Допустимый тип данных: Массив чисел
• min_rating
  Описание:
  Минимальный рейтинг
  Допустимый тип данных: Дробное число в строке
Возвращаемые параметры:
• id
  Описание:
  Id автора
  Тип данных: Строка
set.avatar

Описание: Получить информацию об авторе тренировочных программ
Входящие переменные:
Возвращаемые параметры:
• id
  Описание:
  Id автора
  Тип данных: Строка

Модуль releases

Общая информация

Название: releases
Описание:
Работа с релизами
create

Описание: Создать релиз
Входящие переменные:
• title
  Описание:
  Название релиза
  Допустимый тип данных: Строка
• description
  Описание:
  Описание релиза
  Допустимый тип данных: Строка
• sport_types
  Описание:
  Виды занятия
  Допустимый тип данных: Массив чисел
• tags
  Описание:
  Теги
  Допустимый тип данных: Массив строк
• picture_file_id
  Описание:
  Идентификатор файла аватарки челленджа
  Допустимый тип данных: Строка
• subscriptions
  Описание:
  Подписки, в рамках которых доступен релиз
  Допустимый тип данных: Массив строк
• privacy
  Описание:
  Уровень приватности релиза:
  • 1 - Доступен только автору (только я)
  • 10 - мне и выбранным клубам
  • 1000 - Всем пользователям трайд
  
  Допустимый тип данных: Число
• club_ids
  Описание:
  Идентификаторы клубов, которым доступен релиз
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• id
  Описание:
  ID релиза
  Тип данных: Строка
edit

Описание: Редактировать релиз
Входящие переменные:
• id
  Описание:
  Идентификатор релиза
  Допустимый тип данных: Строка
• title
  Описание:
  Название релиза
  Допустимый тип данных: Строка
• sport_types
  Описание:
  Виды занятия
  Допустимый тип данных: Массив чисел
• description
  Описание:
  Описание релиза
  Допустимый тип данных: Строка
• tags
  Описание:
  Теги
  Допустимый тип данных: Массив строк
• picture_fileid
  Описание:
  Идентификатор файла аватарки челленджа
  Допустимый тип данных: Строка
• subscriptions
  Описание:
  Подписки, в рамках которых доступен релиз
  Допустимый тип данных: Массив строк
• privacy
  Описание:
  Уровень приватности релиза:
  • 1 - Доступен только автору (только я)
  • 10 - мне и выбранным клубам
  • 1000 - Всем пользователям трайд
  
  Допустимый тип данных: Число
• club_ids
  Описание:
  Идентификаторы клубов, которым доступен релиз
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• id
  Описание:
  ID релиза
  Тип данных: Строка
get

Описание: Получить информацию о релизе
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор релиза
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор релиза
  Тип данных: Строка
• title
  Описание:
  Название релиза
  Тип данных: Строка
• description
  Описание:
  Описание релиза
  Тип данных: Строка
• sport_types
  Описание:
  Виды занятия
  Тип данных: Массив чисел
• tags
  Описание:
  Теги
  Тип данных: Массив строк
• picture_fileid
  Описание:
  Идентификатор файла аватарки челленджа
  Тип данных: Строка
• subscriptions
  Описание:
  Подписки, в рамках которых доступен релиз
  Тип данных: Массив строк
• privacy
  Описание:
  Уровень приватности релиза:
  • 1 - Доступен только автору (только я)
  • 10 - мне и выбранным клубам
  • 1000 - Всем пользователям трайд
  
  Тип данных: Число
• club_ids
  Описание:
  Идентификаторы клубов, которым доступен релиз
  Тип данных: Массив строк
• previous_id
  Описание:
  Идентификатор предыдущего релиза, пусто если нет
  Тип данных: Строка
• workout_ids
  Описание:
  Идентификаторы программ
  Тип данных: Массив строк
• workouts_count
  Описание:
  Количество привязанных программ
  Тип данных: Число
• duration
  Описание:
  Продолжительность релиза в минутах
  Тип данных: Число
• favorite
  Описание:
  Флаг избранности релиза
  Тип данных: Логическое выражение
• subscribed
  Описание:
  Флаг подписки на релиз
  Тип данных: Логическое выражение
• author
  Описание:
  Автор релиза
  Тип данных: Объект
  Вложенные элементы:
  • id
    Описание:
    Идентификатор автора
    Тип данных: Число
  • name
    Описание:
    Имя автора
    Тип данных: Строка
• rating
  Описание:
  Рейтинг релиза
  Тип данных: Дробное число в строке
• is_my
  Описание:
  Данный пользователь является автором релиза
  Тип данных: Логическое выражение
• is_free
  Описание:
  Релиз является бесплатным
  Тип данных: Логическое выражение
• price
  Описание:
  Цена
  Тип данных: Строка
list

Описание: Получить каталог релизов
Входящие переменные:
• limit
  Описание:
  Количество релизов на странице
  Допустимый тип данных: Число
• skip
  Описание:
  Начиная с какого релиза
  Допустимый тип данных: Число
• tags
  Описание:
  Теги (массив идентификаторов)
  Допустимый тип данных: Массив строк
• duration_min
  Описание:
  Минимальная продолжительность релиза в минутах
  Допустимый тип данных: Число
• duration_max
  Описание:
  Максимальная продолжительность релиза в минутах
  Допустимый тип данных: Число
• levels
  Описание:
  Уровни сложности (массив чисел идентификаторов)
  Допустимый тип данных: Массив чисел
• authors
  Описание:
  Идентификаторы авторов (массив чисел идентификаторов)
  Допустимый тип данных: Массив чисел
• search
  Описание:
  Поисковый запрос
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• total
  Описание:
  Общее количество релизов
  Тип данных: Число
• limit
  Описание:
  Количество релизов на странице
  Тип данных: Число
• skip
  Описание:
  Начиная с какого релиза
  Тип данных: Число
• list
  Описание:
  Список релизов
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор релиза
    Тип данных: Строка
  • title
    Описание:
    Название релиза
    Тип данных: Строка
  • workouts_count
    Описание:
    Количество привязанных программ
    Тип данных: Число
  • duration
    Описание:
    Продолжительность релиза в минутах
    Тип данных: Число
  • favorite
    Описание:
    Флаг избранности релиза
    Тип данных: Логическое выражение
  • subscribed
    Описание:
    Флаг подписки на релиз
    Тип данных: Логическое выражение
  • level
    Описание:
    Уровень сложности релиза
    Тип данных: Число
  • rating
    Описание:
    Рейтинг релиза
    Тип данных: Дробное число в строке
  • is_my
    Описание:
    Данный пользователь является автором релиза
    Тип данных: Логическое выражение
  • is_free
    Описание:
    Релиз является бесплатным
    Тип данных: Логическое выражение
  • price
    Описание:
    Цена
    Тип данных: Строка
  • author
    Описание:
    Автор релиза
    Тип данных: Объект
    Вложенные элементы:
    • id
      Описание:
      Идентификатор автора
      Тип данных: Число
    • name
      Описание:
      Имя автора
      Тип данных: Строка
remove

Описание: Удалить релиз
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор релиза
  Допустимый тип данных: Строка
Возвращаемые параметры:

Модуль subscriptions

Общая информация

Название: subscriptions
Описание:
Работа с подписками
create

Описание: Создать подписку
Входящие переменные:
• title
  Описание:
  Название релиза
  Допустимый тип данных: Строка
• description
  Описание:
  Описание релиза
  Допустимый тип данных: Строка
• tags
  Описание:
  Теги
  Допустимый тип данных: Массив строк
• price_individual
  Описание:
  Цены для индивидуальных клиентов
  Допустимый тип данных: Объект
  Вложенные элементы:
  • month
    Описание:
    Цена в месяц
    Тип данных: Дробное число в строке
  • half_year
    Описание:
    Цена в полгода
    Тип данных: Дробное число в строке
  • year
    Описание:
    Цена в год
    Тип данных: Дробное число в строке
  • lifetime
    Описание:
    Цена подписки навсегда
    Тип данных: Дробное число в строке
• price_coach
  Описание:
  Цены для тренеров
  Допустимый тип данных: Объект
  Вложенные элементы:
  • month
    Описание:
    Цена в месяц
    Тип данных: Дробное число в строке
  • half_year
    Описание:
    Цена в полгода
    Тип данных: Дробное число в строке
  • year
    Описание:
    Цена в год
    Тип данных: Дробное число в строке
  • lifetime
    Описание:
    Цена подписки навсегда
    Тип данных: Дробное число в строке
• price_clubs
  Описание:
  Цены для клуба
  Допустимый тип данных: Объект
  Вложенные элементы:
  • month
    Описание:
    Цена в месяц
    Тип данных: Дробное число в строке
  • half_year
    Описание:
    Цена в полгода
    Тип данных: Дробное число в строке
  • year
    Описание:
    Цена в год
    Тип данных: Дробное число в строке
  • lifetime
    Описание:
    Цена подписки навсегда
    Тип данных: Дробное число в строке
• published
  Описание:
  Опубликовано и доступно пользователям
  Допустимый тип данных: Логическое выражение
• privacy
  Описание:
  Уровень приватности релиза: 0 - созданные мной, 1 - доступные мне, 10 - доступные клубу
  Допустимый тип данных: Число
• club_ids
  Описание:
  Id клубов
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• id
  Описание:
  Id подписки
  Тип данных: Строка
edit

Описание: Изменить подписку
Входящие переменные:
• id
  Описание:
  Идентификатор подписки
  Допустимый тип данных: Строка
• title
  Описание:
  Название релиза
  Допустимый тип данных: Строка
• description
  Описание:
  Описание релиза
  Допустимый тип данных: Строка
• tags
  Описание:
  Теги
  Допустимый тип данных: Массив строк
• price_individual
  Описание:
  Цены для индивидуальных клиентов
  Допустимый тип данных: Объект
  Вложенные элементы:
  • month
    Описание:
    Цена в месяц
    Тип данных: Дробное число в строке
  • half_year
    Описание:
    Цена в полгода
    Тип данных: Дробное число в строке
  • year
    Описание:
    Цена в год
    Тип данных: Дробное число в строке
  • lifetime
    Описание:
    Цена подписки навсегда
    Тип данных: Дробное число в строке
• price_coach
  Описание:
  Цены для тренеров
  Допустимый тип данных: Объект
  Вложенные элементы:
  • month
    Описание:
    Цена в месяц
    Тип данных: Дробное число в строке
  • half_year
    Описание:
    Цена в полгода
    Тип данных: Дробное число в строке
  • year
    Описание:
    Цена в год
    Тип данных: Дробное число в строке
  • lifetime
    Описание:
    Цена подписки навсегда
    Тип данных: Дробное число в строке
• price_clubs
  Описание:
  Цены для клуба
  Допустимый тип данных: Объект
  Вложенные элементы:
  • month
    Описание:
    Цена в месяц
    Тип данных: Дробное число в строке
  • half_year
    Описание:
    Цена в полгода
    Тип данных: Дробное число в строке
  • year
    Описание:
    Цена в год
    Тип данных: Дробное число в строке
  • lifetime
    Описание:
    Цена подписки навсегда
    Тип данных: Дробное число в строке
• published
  Описание:
  Опубликовано и доступно пользователям
  Допустимый тип данных: Логическое выражение
• privacy
  Описание:
  Уровень приватности релиза: 0 - созданные мной, 1 - доступные мне, 10 - доступные клубу
  Допустимый тип данных: Число
• club_ids
  Описание:
  Id клубов
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
remove

Описание: Удалить подписку
Входящие переменные:
• id
  Описание:
  Идентификатор подписки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
get

Описание: Получить детальную подписку
Входящие переменные:
Возвращаемые параметры:
• list
  Описание:
  Список подписок
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор подписки
    Тип данных: Строка
  • title
    Описание:
    Название подписки
    Тип данных: Строка
list

Описание: Получить список подписок
Входящие переменные:
Возвращаемые параметры:
• list
  Описание:
  Список подписок
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор подписки
    Тип данных: Строка
  • title
    Описание:
    Название подписки
    Тип данных: Строка
club-buy

Описание: Получить список покупок клуба
Входящие переменные:
Возвращаемые параметры:
• list
  Описание:
  Список подписок
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор подписки
    Тип данных: Строка
  • title
    Описание:
    Название подписки
    Тип данных: Строка
client-buy

Описание: Получить список покупок клиента
Входящие переменные:
Возвращаемые параметры:
• list
  Описание:
  Список подписок
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор подписки
    Тип данных: Строка
  • title
    Описание:
    Название подписки
    Тип данных: Строка
sales

Описание: Получить список продаж
Входящие переменные:
Возвращаемые параметры:
• list
  Описание:
  Список подписок
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор подписки
    Тип данных: Строка
  • title
    Описание:
    Название подписки
    Тип данных: Строка

Модуль workouts

Общая информация

Название: workouts
Описание:
Работа с программами тренировок
add

Описание: Создать тренировочную программу
Входящие переменные:
• name
  Описание:
  Название программы
  Допустимый тип данных: Строка
• description
  Описание:
  Описание тренировки
  Допустимый тип данных: Строка
• tags
  Описание:
  Список id тегов
  Допустимый тип данных: Массив строк
• duration
  Описание:
  Продолжительность тренировки в минутах
  Допустимый тип данных: Число
• privacy
  Описание:
  Кто будет видеть эту тренировку (0, 10, 100, 200)
  Допустимый тип данных: Число
• profile
  Описание:
  Профили задач (дорожка)
  Допустимый тип данных: Объект
• music
  Описание:
  Музыка (дорожка)
  Допустимый тип данных: Объект
• videos
  Описание:
  Видео (дорожка)
  Допустимый тип данных: Объект
• coach_videos
  Описание:
  Видео тренера (дорожка)
  Допустимый тип данных: Объект
• music_effects
  Описание:
  Музыкальные эффекты (дорожка)
  Допустимый тип данных: Объект
• triggers
  Описание:
  Триггеры (дорожка)
  Допустимый тип данных: Объект
• relief
  Описание:
  Рельеф (дорожка)
  Допустимый тип данных: Объект
• sport_types
  Описание:
  Виды занятия
  Допустимый тип данных: Массив чисел
• club_id
  Описание:
  Id клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Id тренировки
  Тип данных: Строка
• version
  Описание:
  Номер версии
  Тип данных: Число
edit

Описание: Изменить тренировочную программу
Входящие переменные:
• name
  Описание:
  Название программы
  Допустимый тип данных: Строка
• description
  Описание:
  Описание тренировки
  Допустимый тип данных: Строка
• tags
  Описание:
  Список id тегов
  Допустимый тип данных: Массив строк
• duration
  Описание:
  Продолжительность тренировки в минутах
  Допустимый тип данных: Число
• privacy
  Описание:
  Кто будет видеть эту тренировку (0, 10, 100, 200)
  Допустимый тип данных: Число
• profile
  Описание:
  Профили задач (дорожка)
  Допустимый тип данных: Объект
• music
  Описание:
  Музыка (дорожка)
  Допустимый тип данных: Объект
• videos
  Описание:
  Видео (дорожка)
  Допустимый тип данных: Объект
• coach_videos
  Описание:
  Видео тренера (дорожка)
  Допустимый тип данных: Объект
• music_effects
  Описание:
  Музыкальные эффекты (дорожка)
  Допустимый тип данных: Объект
• triggers
  Описание:
  Триггеры (дорожка)
  Допустимый тип данных: Объект
• relief
  Описание:
  Рельеф (дорожка)
  Допустимый тип данных: Объект
• id
  Описание:
  Id тренировки
  Допустимый тип данных: Строка
• autosave
  Описание:
  Автосохранение
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Описание:
  Id тренировки
  Тип данных: Строка
• version
  Описание:
  Номер версии
  Тип данных: Число
list

Описание: Получить список тренировочных программ
Входящие переменные:
• search
  Описание:
  Поисковая фраза (может быть пустой)
  Допустимый тип данных: Строка
• sport_types
  Описание:
  Список видов спорта (может быть пустым)
  Допустимый тип данных: Массив чисел
• tags
  Описание:
  Список id тегов (может быть пустым)
  Допустимый тип данных: Массив строк
• min_duration
  Описание:
  Минимальная продолжительность тренировки в минутах (может быть пустым)
  Допустимый тип данных: Число
• max_duration
  Описание:
  Максимальная продолжительность тренировки в минутах (может быть пустым)
  Допустимый тип данных: Число
• difficulty
  Описание:
  Уровень сложности релиза от 1 до 3 (может быть пустым или 0)
  Допустимый тип данных: Число
• author_ids
  Описание:
  Список id авторов (может быть пустым)
  Допустимый тип данных: Массив чисел
• min_price
  Описание:
  Минимальная цена подписки (может быть пустым или 0)
  Допустимый тип данных: Число
• max_price
  Описание:
  Максимальная цена подписки (может быть пустым или 0)
  Допустимый тип данных: Число
• min_rating
  Описание:
  Минимальный рейтинг релиза (может быть пустым или 0)
  Допустимый тип данных: Дробное число
• only_own
  Описание:
  Только свои собственные тренировочные программы (если true)
  Допустимый тип данных: Логическое выражение
• no_own
  Описание:
  Не свои собственные тренировочные программы (если true)
  Допустимый тип данных: Логическое выражение
• same_club
  Описание:
  Только тренировочные программы текущего клуба (если true)
  Допустимый тип данных: Логическое выражение
• club_id
  Описание:
  Id клуба
  Допустимый тип данных: Строка
• has_videos
  Описание:
  Только тренировочные программы с видео (если true)
  Допустимый тип данных: Логическое выражение
• has_music
  Описание:
  Только тренировочные программы с музыкой (если true)
  Допустимый тип данных: Логическое выражение
• has_profile
  Описание:
  Только тренировочные программы с профилем задач (если true)
  Допустимый тип данных: Логическое выражение
• for_clubs
  Описание:
  Тренировочные программы для занятий в клубах (если true)
  Допустимый тип данных: Логическое выражение
• for_home
  Описание:
  Тренировочные программы для домашних занятий (если true)
  Допустимый тип данных: Логическое выражение
• for_groups
  Описание:
  Тренировочные программы для групповых занятий (если true)
  Допустимый тип данных: Логическое выражение
• for_virtual
  Описание:
  Тренировочные программы для виртуальных занятий (если true)
  Допустимый тип данных: Логическое выражение
• for_self
  Описание:
  Тренировочные программы для самостоятельных занятий (если true)
  Допустимый тип данных: Логическое выражение
• featured
  Описание:
  Тренировочные программы помеченные как особенные для меня (если true)
  Допустимый тип данных: Логическое выражение
• show_drafts
  Описание:
  Показывать заготовки (черновики) (если true)
  Допустимый тип данных: Логическое выражение
• in_my_subscriptions
  Описание:
  Тренировочные программы в моих подписках (если true)
  Допустимый тип данных: Логическое выражение
• release_id
  Описание:
  Показать тренировочные программы по id релиза (если true)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Описание:
  Id релиза
  Тип данных: Строка
get

Описание: Получить тренировочную программу
Входящие переменные:
• id
  Описание:
  Id тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Id тренировки
  Тип данных: Строка
filters

Описание: Получить фильтры тренировочных программ
Входящие переменные:
• id
  Описание:
  Id тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Id тренировки
  Тип данных: Строка
remove

Описание: Удалить тренировочную программу
Входящие переменные:
• id
  Описание:
  Id тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Id тренировки
  Тип данных: Строка

Модуль activities

Общая информация

Название: activities
history

Описание:
Входящие переменные:
• limit
  Описание:
  Количество записей в 1 выдаче
  Допустимый тип данных: Число
• skip
  Описание:
  Сколько записей необходимо пропустить
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка записей.'desc' в прошлое 'asc' в будущее
  Допустимый тип данных: Строка
• start_ts
  Описание:
  unixtimestamp начала периода
  Допустимый тип данных: Число
• end_ts
  Описание:
  unixtimestamp конца периода
  Допустимый тип данных: Число
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• sport_type
  Описание:
  Идентификатор вида спорта
  Допустимый тип данных: Число
• uid
  Описание:
  Идентификатор клиента
  Допустимый тип данных: Число
• coach_ids
  Описание:
  Идентификаторы тренеров
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• total
  Описание:
  Всего записей отвечающих критериям запроса
  Тип данных: Число
• items
  Описание:
  Массив объектов записей занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор активности (занятия)
    Тип данных: Строка
  • title
    Описание:
    Название занятия
    Тип данных: Строка
  • clubs
    Описание:
    Массив названий клубов
    Тип данных: Массив строк
  • sport_type
    Описание:
    Идентификатор вида спорта
    Тип данных: Число
  • coaches
    Описание:
    Массив объектов данных тренера
    Тип данных: Массив объектов
    Вложенные элементы:
    • firstname
      Описание:
      Имя тренера
      Тип данных: Строка
    • lastname
      Описание:
      Фамилия тренера
      Тип данных: Строка
    • uid
      Описание:
      Идентификатор тренера
      Тип данных: Число
  • color
    Описание:
    Цвет занятия, Если пустой то цвет не задан
    Тип данных: Строка
  • duration
    Описание:
    Длительность занятия в секундах
    Тип данных: Число
  • started_ts
    Описание:
    unixtimestamp начала занятия
    Тип данных: Число
  • totals
    Описание:
    Результаты занятия
    Тип данных: Объект
    Вложенные элементы:
    • distance
      Описание:
      Дистанция в км (для видов спорта 1,2)
      Тип данных: Строка
    • calories
      Описание:
      Калории
      Тип данных: Число
    • points
      Описание:
      Баллы
      Тип данных: Число
graph

Описание:
Входящие переменные:
• start_ts
  Описание:
  unixtimestamp начала периода
  Допустимый тип данных: Число
• end_ts
  Описание:
  unixtimestamp конца периода
  Допустимый тип данных: Число
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• sport_type
  Описание:
  Идентификатор вида спорта
  Допустимый тип данных: Число
• uid
  Описание:
  Идентификатор клиента
  Допустимый тип данных: Число
• coach_ids
  Описание:
  Идентификаторы тренеров
  Допустимый тип данных: Массив чисел
• type
  Описание:
  Тип графика: points - по очкам, power - по средней мощности, distance - по расстоянию, calories - по калориям,count - по количеству занятий, hr - по среднему пульсу
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив точек
  Тип данных: Массив объектов
  Вложенные элементы:
  • ts
    Описание:
    unix timestamp точки
    Тип данных: Число
  • duration_min
    Описание:
    Минимальная длительность тренировки
    Тип данных: Строка
  • duration_max
    Описание:
    Максимальная длительность тренировки
    Тип данных: Число
  • duration
    Описание:
    Длительность занятия в секундах
    Тип данных: Число
  • count
    Описание:
    Всего занятий
    Тип данных: Число
  • distance
    Описание:
    Общая дистанция в км
    Тип данных: Дробное число
  • distance_max
    Описание:
    Максимальная дистанция в км
    Тип данных: Дробное число
  • distance_min
    Описание:
    Минимальная дистанция в км
    Тип данных: Дробное число
  • points
    Описание:
    Баллы
    Тип данных: Число
  • points_max
    Описание:
    Максимальная баллы
    Тип данных: Число
  • points_min
    Описание:
    Минимальная баллы
    Тип данных: Число
  • power
    Описание:
    Средняя мощность
    Тип данных: Число
  • power_max
    Описание:
    Максимальная средняя мощность
    Тип данных: Число
  • power_min
    Описание:
    Минимальная средняя мощность
    Тип данных: Число
  • hr
    Описание:
    Средний пульс
    Тип данных: Число
  • hr_max
    Описание:
    Максимальный средний пульс
    Тип данных: Число
  • hr_min
    Описание:
    Минимальный средний пульс
    Тип данных: Число
• totals
  Описание:
  Общие итоги
  Тип данных: Объект
  Вложенные элементы:
  • distance
    Описание:
    Дистанция в км
    Тип данных: Дробное число
  • calories
    Описание:
    Калории
    Тип данных: Число
  • points
    Описание:
    Баллы
    Тип данных: Число
  • count
    Описание:
    Всего занятий
    Тип данных: Число
get

Описание:
Входящие переменные:
• id
  Описание:
  Идентификатор активности
  Допустимый тип данных: Строка
Возвращаемые параметры:
get.prevdiff

Описание: Получить разницу с предыдущим занятием клиента (если было)
Входящие переменные:
• id
  Описание:
  Идентификатор активности
  Допустимый тип данных: Строка
Возвращаемые параметры:
• percent
  Тип данных: Объект
  Вложенные элементы:
  • averages
    Тип данных: Объект
  • maximums
    Тип данных: Объект
  • totals
    Тип данных: Объект
• absolutes
  Тип данных: Объект
  Вложенные элементы:
  • averages
    Тип данных: Объект
  • maximums
    Тип данных: Объект
  • totals
    Тип данных: Объект
pmc

Описание: Получить данные Performance Management Chart (CTL, ATL, TSB) для пользователя
Входящие переменные:
• days
  Описание:
  Количество дней для графика (по умолчанию 90)
  Допустимый тип данных: Число
• club_id
  Описание:
  Идентификатор клуба (опционально, если не указан - общая статистика)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• points
  Описание:
  Массив точек графика
  Тип данных: Массив объектов
  Вложенные элементы:
  • date
    Описание:
    Дата точки
    Тип данных: Дата в формате ISO
  • date_ts
    Описание:
    Unix timestamp даты
    Тип данных: Число
  • ctl
    Описание:
    Chronic Training Load (Fitness/Форма)
    Тип данных: Дробное число
  • atl
    Описание:
    Acute Training Load (Fatigue/Усталость)
    Тип данных: Дробное число
  • tsb
    Описание:
    Training Stress Balance (Form/Готовность)
    Тип данных: Дробное число
  • training_load
    Описание:
    Тренировочная нагрузка за день (TSS)
    Тип данных: Дробное число
• current
  Описание:
  Текущие значения метрик
  Тип данных: Объект
  Вложенные элементы:
  • ctl
    Описание:
    Текущий CTL
    Тип данных: Дробное число
  • atl
    Описание:
    Текущий ATL
    Тип данных: Дробное число
  • tsb
    Описание:
    Текущий TSB
    Тип данных: Дробное число
  • acwr
    Описание:
    Acute:Chronic Workload Ratio
    Тип данных: Дробное число
  • acwr_status
    Описание:
    Статус ACWR: low (<0.8), optimal (0.8-1.3), moderate (1.3-1.5), high (>1.5)
    Тип данных: Строка
  • monotony
    Описание:
    Монотонность тренировок
    Тип данных: Дробное число
  • monotony_status
    Описание:
    Статус монотонности: low (<1.5), moderate (1.5-2.0), high (>2.0)
    Тип данных: Строка
  • strain
    Описание:
    Тренировочное напряжение
    Тип данных: Дробное число
  • strain_status
    Описание:
    Статус напряжения: low (<800), moderate (800-1200), high (1200-1500), very_high (>1500)
    Тип данных: Строка
• summary
  Описание:
  Сводка за период
  Тип данных: Объект
  Вложенные элементы:
  • total_activities
    Описание:
    Всего тренировок
    Тип данных: Число
  • total_load
    Описание:
    Суммарная нагрузка
    Тип данных: Дробное число
  • avg_daily_load
    Описание:
    Средняя дневная нагрузка
    Тип данных: Дробное число
  • ctl_change
    Описание:
    Изменение CTL за период
    Тип данных: Дробное число
progress

Описание: Получить данные о прогрессе пользователя по неделям/месяцам
Входящие переменные:
• weeks
  Описание:
  Количество недель для анализа (используется если не указан months)
  Допустимый тип данных: Число
• months
  Описание:
  Количество месяцев для анализа (по умолчанию 6)
  Допустимый тип данных: Число
• metric
  Описание:
  Метрика для отслеживания: distance, calories, power, duration, activities (по умолчанию distance)
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба (опционально)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• points
  Описание:
  Массив данных по месяцам
  Тип данных: Массив объектов
  Вложенные элементы:
  • month
    Описание:
    Номер месяца (1-12)
    Тип данных: Число
  • year
    Описание:
    Год
    Тип данных: Число
  • label
    Описание:
    Название месяца
    Тип данных: Строка
  • value
    Описание:
    Значение метрики
    Тип данных: Дробное число
  • activities_count
    Описание:
    Количество тренировок
    Тип данных: Число
• current
  Описание:
  Данные текущего месяца
  Тип данных: Объект
  Вложенные элементы:
  • value
    Описание:
    Текущее значение
    Тип данных: Дробное число
  • change_percent
    Описание:
    Процент изменения относительно предыдущего месяца
    Тип данных: Дробное число
  • change_absolute
    Описание:
    Абсолютное изменение
    Тип данных: Дробное число
  • trend
    Описание:
    Тренд: up, down, stable
    Тип данных: Строка
• records
  Описание:
  Личные рекорды
  Тип данных: Объект
  Вложенные элементы:
  • best_5min_power
    Описание:
    Лучшая 5-минутная мощность
    Тип данных: Число
  • best_20min_power
    Описание:
    Лучшая 20-минутная мощность
    Тип данных: Число
  • max_distance
    Описание:
    Максимальная дистанция за тренировку
    Тип данных: Дробное число
  • max_calories
    Описание:
    Максимум калорий за тренировку
    Тип данных: Число
  • max_duration
    Описание:
    Максимальная длительность тренировки
    Тип данных: Число
  • total_distance
    Описание:
    Общая дистанция за всё время
    Тип данных: Дробное число
  • total_activities
    Описание:
    Всего тренировок
    Тип данных: Число
• metric
  Описание:
  Использованная метрика
  Тип данных: Строка

Модуль assistant

Общая информация

config

Описание: Эффективный конфиг ИИ-ассистента для клиента (включён ли, имя, слои)
Требуется предварительная авторизация: Да
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• enabled
  Описание:
  Включён ли ассистент
  Тип данных: Логическое выражение
• name
  Описание:
  Имя ассистента
  Тип данных: Строка
• tone
  Описание:
  Тон общения
  Тип данных: Строка
• layers
  Описание:
  Включённые слои (бриф/post-session/анализ/чат и т.д.)
  Тип данных: Объект
brief

Описание: Дневной бриф ассистента (генерация 1 раз в день, кэш)
Требуется предварительная авторизация: Да
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• enabled
  Описание:
  Включён ли бриф
  Тип данных: Логическое выражение
• text
  Описание:
  Текст брифа
  Тип данных: Строка
• suggestions
  Описание:
  Рекомендации записи
  Тип данных: Массив объектов
• greeting_part
  Описание:
  Часть суток (утро/день/вечер/ночь)
  Тип данных: Строка
post_session

Описание: Post-session разбор завершённой тренировки (кэш по session_id)
Требуется предварительная авторизация: Да
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• session_id обязательно
  Описание:
  Идентификатор сессии
  Допустимый тип данных: Строка
• metrics
  Описание:
  Снапшот лайв-метрик с экрана тренировки
  Допустимый тип данных: Объект
Возвращаемые параметры:
• enabled
  Описание:
  Включён ли разбор
  Тип данных: Логическое выражение
• text
  Описание:
  Текст разбора
  Тип данных: Строка
activity_analysis

Описание: Анализ активности из истории (кэш навсегда по activity_id)
Требуется предварительная авторизация: Да
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• activity_id обязательно
  Описание:
  Идентификатор активности
  Допустимый тип данных: Строка
Возвращаемые параметры:
• enabled
  Описание:
  Включён ли анализ
  Тип данных: Логическое выражение
• text
  Описание:
  Текст анализа
  Тип данных: Строка
suggest_booking

Описание: Рекомендации записи на свободные занятия по привычкам клиента
Требуется предварительная авторизация: Да
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список рекомендаций
  Тип данных: Массив объектов
chat.history

Описание: История диалога чат-коуча + персональное приветствие
Требуется предварительная авторизация: Да
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• enabled
  Описание:
  Включён ли чат
  Тип данных: Логическое выражение
• assistant_name
  Описание:
  Имя ассистента
  Тип данных: Строка
• greeting
  Описание:
  Приветствие
  Тип данных: Строка
• messages
  Описание:
  Сообщения диалога
  Тип данных: Массив объектов
chat.send

Описание: Отправка сообщения в чат-коуч (модерация, rate-limit, контекст)
Требуется предварительная авторизация: Да
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• message обязательно
  Описание:
  Текст сообщения клиента
  Допустимый тип данных: Строка
Возвращаемые параметры:
• enabled
  Описание:
  Включён ли чат
  Тип данных: Логическое выражение
• reply
  Описание:
  Ответ ассистента
  Тип данных: Строка
• quick_actions
  Описание:
  Быстрые действия (например запись)
  Тип данных: Массив объектов
• error
  Описание:
  Код ошибки при наличии
  Тип данных: Строка

Модуль club

Общая информация

Название: club
badges.client.list

Описание: Получение наград клиента
Входящие переменные:
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• include_progress
  Описание:
  Включить прогресс метрик
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• items
  Описание:
  Награды клиента
  Тип данных: Массив объектов
• progress
  Описание:
  Прогресс метрик (если запрошен)
  Тип данных: Объект
badges.client.award

Описание: Ручная выдача награды клиенту
Входящие переменные:
• badge_id обязательно
  Описание:
  ID награды
  Допустимый тип данных: Строка
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• award_id
  Описание:
  ID выдачи
  Тип данных: Строка
badges.stats

Описание: Статистика награды
Входящие переменные:
• badge_id обязательно
  Описание:
  ID награды
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• statistics
  Описание:
  Статистика награды
  Тип данных: Объект
badges.clients_grid

Описание: Grid клиентов с наградой
Входящие переменные:
• badge_id обязательно
  Описание:
  ID награды
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
• order
  Описание:
  Сортировка
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
badges.generate_image

Описание: Генерация изображения награды через AI
Входящие переменные:
• prompt
  Описание:
  Промпт для генерации
  Допустимый тип данных: Строка
• style
  Описание:
  Стиль изображения (achievement_badge, flat_icon, realistic, cartoon)
  Допустимый тип данных: Строка
• badge_name
  Описание:
  Название награды (для авто-промпта)
  Допустимый тип данных: Строка
• badge_description
  Описание:
  Описание награды (для авто-промпта)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• image
  Описание:
  Сгенерированное изображение { file_id, url }
  Тип данных: Объект
badges.sync_progress

Описание: Синхронизация прогресса пользователя
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• metrics
  Описание:
  Обновлённые метрики
  Тип данных: Объект
badges.manual_award

Описание: Ручная выдача награды пользователю
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• badge_id обязательно
  Описание:
  ID награды
  Допустимый тип данных: Строка
• reason
  Описание:
  Причина выдачи
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• award
  Описание:
  Выданная награда
  Тип данных: Объект
badges.revoke_award

Описание: Отзыв награды у пользователя
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• award_id обязательно
  Описание:
  ID выданной награды
  Допустимый тип данных: Строка
• reason
  Описание:
  Причина отзыва
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
badges.check_user

Описание: Ручная проверка наград для пользователя
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• check_result
  Описание:
  Результат проверки
  Тип данных: Объект
badges.user_progress

Описание: Получение прогресса пользователя
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• progress
  Описание:
  Прогресс пользователя
  Тип данных: Объект
badges.list

Описание: Получение списка наград клуба
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• status
  Описание:
  Фильтр по статусу (draft, active, archived)
  Допустимый тип данных: Строка
• include_archived
  Описание:
  Включить архивные
  Допустимый тип данных: Логическое выражение
• order
  Описание:
  Сортировка { field, direction }
  Допустимый тип данных: Объект
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• items
  Описание:
  Массив наград
  Тип данных: Массив объектов
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
badges.grid

Описание: Grid метод для наград с фильтрацией и сортировкой
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
• order
  Описание:
  Сортировка
  Допустимый тип данных: Объект
• skip
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
badges.get

Описание: Получение награды по ID
Входящие переменные:
• badge_id
  Описание:
  ID награды
  Допустимый тип данных: Строка
• id
  Описание:
  ID награды (альтернатива)
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• badge
  Описание:
  Данные награды
  Тип данных: Объект
badges.add

Описание: Создание новой награды
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название награды
  Допустимый тип данных: Строка
• description
  Описание:
  Описание награды (до получения)
  Допустимый тип данных: Строка
• description_earned
  Описание:
  Описание награды (после получения)
  Допустимый тип данных: Строка
• code
  Описание:
  Уникальный код награды
  Допустимый тип данных: Строка
• award_type
  Описание:
  Тип выдачи { type, max_awards, period }
  Допустимый тип данных: Объект
• rarity
  Описание:
  Редкость (common, uncommon, rare, epic, legendary)
  Допустимый тип данных: Строка
• image
  Описание:
  Изображение { file_id, generated }
  Допустимый тип данных: Объект
• conditions
  Описание:
  Условия получения { logic, groups }
  Допустимый тип данных: Объект
• availability
  Описание:
  Доступность по времени { type, start_date, end_date }
  Допустимый тип данных: Объект
• prerequisites
  Описание:
  Prerequisite награды { badges, logic }
  Допустимый тип данных: Объект
• rewards
  Описание:
  Награда клиенту { points, bonus_amount }
  Допустимый тип данных: Объект
• notification_settings
  Описание:
  Настройки уведомлений
  Допустимый тип данных: Объект
• order
  Описание:
  Порядок сортировки
  Допустимый тип данных: Число
• status
  Описание:
  Статус (draft, active, archived)
  Допустимый тип данных: Строка
• tags
  Описание:
  Теги
  Допустимый тип данных: Массив строк
• category
  Описание:
  Категория
  Допустимый тип данных: Строка
• scope_club_ids
  Описание:
  ID клубов для анализа (для сетей)
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Описание:
  ID созданной награды
  Тип данных: Строка
• badge
  Описание:
  Созданная награда
  Тип данных: Объект
badges.edit

Описание: Редактирование награды
Входящие переменные:
• badge_id
  Описание:
  ID награды
  Допустимый тип данных: Строка
• id
  Описание:
  ID награды (альтернатива)
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• description
  Описание:
  Описание награды (до получения)
  Допустимый тип данных: Строка
• description_earned
  Описание:
  Описание награды (после получения)
  Допустимый тип данных: Строка
• code
  Допустимый тип данных: Строка
• award_type
  Допустимый тип данных: Объект
• rarity
  Допустимый тип данных: Строка
• image
  Допустимый тип данных: Объект
• conditions
  Допустимый тип данных: Объект
• availability
  Допустимый тип данных: Объект
• prerequisites
  Допустимый тип данных: Объект
• rewards
  Допустимый тип данных: Объект
• notification_settings
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Число
• status
  Допустимый тип данных: Строка
• tags
  Допустимый тип данных: Массив строк
• category
  Допустимый тип данных: Строка
• scope_club_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
badges.remove

Описание: Удаление награды
Входящие переменные:
• badge_id
  Описание:
  ID награды
  Допустимый тип данных: Строка
• id
  Описание:
  ID награды (альтернатива)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• removed
  Тип данных: Логическое выражение
badges.hide

Описание: Скрытие системных наград для клуба
Входящие переменные:
• badge_ids обязательно
  Описание:
  ID наград
  Допустимый тип данных: Массив строк
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
badges.unhide

Описание: Показ системных наград для клуба
Входящие переменные:
• badge_ids обязательно
  Описание:
  ID наград
  Допустимый тип данных: Массив строк
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
badges.conditions

Описание: Получение конфигурации условий для конструктора
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• config
  Описание:
  Конфигурация условий
  Тип данных: Объект
badges.user_awards

Описание: Получение наград пользователя (для админки)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• include_badge_details
  Описание:
  Включить детали наград
  Допустимый тип данных: Логическое выражение
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• awards
  Описание:
  Список выданных наград
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество наград
  Тип данных: Число
badges.available

Описание: Получение доступных наград для клиента с прогрессом
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• include_earned
  Описание:
  Включить уже полученные награды
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• badges
  Описание:
  Доступные награды с прогрессом
  Тип данных: Массив объектов
• earned_count
  Описание:
  Количество полученных наград
  Тип данных: Число
badges.my_badges

Описание: Получение наград текущего пользователя (для личного кабинета)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• earned
  Описание:
  Полученные награды
  Тип данных: Массив объектов
• available
  Описание:
  Доступные награды с прогрессом
  Тип данных: Массив объектов
• stats
  Описание:
  Статистика наград
  Тип данных: Объект
badges.year_wrapped

Описание: Получение данных о наградах для Year Wrapped
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• year
  Описание:
  Год (по умолчанию текущий)
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• badges_earned
  Описание:
  Награды за год
  Тип данных: Массив объектов
• total_earned
  Описание:
  Всего наград
  Тип данных: Число
• rarest_badge
  Описание:
  Самая редкая награда
  Тип данных: Объект
• first_badge
  Описание:
  Первая награда года
  Тип данных: Объект
clients.list

Описание: Список клиентов
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка {field, order}
  Допустимый тип данных: Объект
• filters
  Описание:
  Фильтры таблицы. Поддерживаются стандартные поля, а также club_fields: {"": {condition, value}}
  Допустимый тип данных: Объект
  Вложенные элементы:
  • club_fields
    Описание:
    Фильтры по доп. полям
    Тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Список клиентов
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
clients.add

Описание: Добавить клиента в клуб (с привязкой к группе)
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• phone обязательно
  Описание:
  Номер телефона клиента
  Допустимый тип данных: Номер телефона
• firstname
  Описание:
  Имя
  Допустимый тип данных: Строка
• lastname
  Описание:
  Фамилия
  Допустимый тип данных: Строка
• gender
  Описание:
  Пол (1 — мужской, 2 — женский)
  Допустимый тип данных: Число
• birthdate
  Описание:
  Дата рождения (дд.мм.гггг)
  Допустимый тип данных: Строка
• club_fields
  Описание:
  Кастомные поля клуба
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• uid
  Описание:
  Идентификатор пользователя
  Тип данных: Число
• error
  Описание:
  Код ошибки
  Тип данных: Строка
clients.remove

Описание: Удалить клиента из клуба
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  ID клиента
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• error
  Тип данных: Строка
clients.editdata

Описание: Изменить данные клиента
Входящие переменные:
Возвращаемые параметры:
clients.edittags

Описание: Установить категории клиенту
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  ID клиента
  Допустимый тип данных: Число
• tags
  Описание:
  ID категорий
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• error
  Тип данных: Строка
users.short

Описание: Получить краткую информацию о пользователе
Входящие переменные:
Возвращаемые параметры:
client_notes.add

Описание: Добавление заметки к клиенту
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• uid
  Описание:
  ID клиента
  Допустимый тип данных: Число
• body
  Описание:
  Текст заметки
  Допустимый тип данных: Строка
• tags
  Описание:
  Массив ID тегов для заметки (необязательно)
  Допустимый тип данных: Массив (любые типы внутри)
• session_id
  Описание:
  ID сессии, к которой относится заметка (необязательно)
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Тип спорта (необязательно, по умолчанию 0)
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• id
  Описание:
  ID созданной заметки
  Тип данных: Строка
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
client_notes.remove

Описание: Удаление заметки клиента
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• id
  Описание:
  ID удаляемой заметки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
client_notes.list

Описание: Получение списка заметок клиента
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• uid
  Описание:
  ID клиента
  Допустимый тип данных: Число
• author
  Описание:
  ID автора заметок для фильтрации (необязательно)
  Допустимый тип данных: Число
• sport_type
  Описание:
  Тип спорта для фильтрации (необязательно)
  Допустимый тип данных: Число
• search
  Описание:
  Поисковая фраза в тексте заметки (необязательно)
  Допустимый тип данных: Строка
• limit
  Описание:
  Количество записей на страницу (по умолчанию 30, максимум 100)
  Допустимый тип данных: Число
• skip
  Описание:
  Количество записей для пропуска (для пагинации)
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Описание:
  Общее количество заметок
  Тип данных: Число
• skip
  Описание:
  Количество пропущенных записей
  Тип данных: Число
• limit
  Описание:
  Лимит записей на страницу
  Тип данных: Число
• items
  Описание:
  Массив заметок с информацией об авторе, тегах, сессии и типе сессии
  Тип данных: Массив (любые типы внутри)
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
clients.batch_set_tag

Описание: Массовая установка категории клиентам по фильтрам или списку ID
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• tag_id обязательно
  Описание:
  ID категории для установки
  Допустимый тип данных: Строка
• filters
  Описание:
  Объект фильтров для выборки клиентов
  Допустимый тип данных: Объект
• uids
  Описание:
  Массив ID клиентов (если не указан, применяются фильтры)
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• affected_count
  Описание:
  Количество обновлённых клиентов
  Тип данных: Число
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
clients.batch_remove_tag

Описание: Массовое удаление категории у клиентов по фильтрам или списку ID
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• tag_id обязательно
  Описание:
  ID категории для удаления
  Допустимый тип данных: Строка
• filters
  Описание:
  Объект фильтров для выборки клиентов
  Допустимый тип данных: Объект
• uids
  Описание:
  Массив ID клиентов (если не указан, применяются фильтры)
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• affected_count
  Описание:
  Количество обновлённых клиентов
  Тип данных: Число
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
clients.export

Описание: Экспорт клиентов в Excel по фильтрам или списку ID
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Объект фильтров для выборки клиентов
  Допустимый тип данных: Объект
• uids
  Описание:
  Массив ID клиентов (если не указан, применяются фильтры)
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• url
  Описание:
  URL для скачивания файла
  Тип данных: Строка
• count
  Описание:
  Количество экспортированных клиентов
  Тип данных: Число
• expires_at
  Описание:
  Время истечения ссылки (для S3)
  Тип данных: Строка
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
clients.integrations.get

Описание: Получить настройки интеграции для клиента
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• uid
  Допустимый тип данных: Число
Возвращаемые параметры:
• external_id
  Тип данных: Строка
• api_actions_blocked
  Тип данных: Логическое выражение
• error
  Тип данных: Строка
clients.integrations.set

Описание: Изменить настройки интеграции для клиента
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• uid
  Допустимый тип данных: Число
• external_id
  Допустимый тип данных: Строка
• api_actions_blocked
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• error
  Тип данных: Строка
client_tags.add

Описание: Добавление категории клиента
Входящие переменные:
• name
  Описание:
  Название категории
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Массив ID клубов для категории
  Допустимый тип данных: Массив строк
• external_id
  Описание:
  Внешний ID (опционально)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• tag_id
  Описание:
  ID созданной категории
  Тип данных: Строка
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
client_tags.remove

Описание: Удаление категории клиента (также удаляет тег у всех клиентов)
Входящие переменные:
• tag_id
  Описание:
  ID удаляемой категории
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
client_tags.edit

Описание: Редактирование категории клиента
Входящие переменные:
• tag_id
  Описание:
  ID редактируемой категории
  Допустимый тип данных: Строка
• name
  Описание:
  Новое название категории
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Новый массив ID клубов
  Допустимый тип данных: Массив строк
• external_id
  Описание:
  Внешний ID (опционально)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
client_tags.list

Описание: Список категорий клиентов в клубе
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив категорий клиентов (id, name, club_ids, external_id)
  Тип данных: Массив объектов
client_tags.grid

Описание: Список категорий клиентов для Grid компонента с пагинацией и фильтрацией
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Объект фильтров (search)
  Допустимый тип данных: Объект
• order
  Описание:
  Объект сортировки (field, direction)
  Допустимый тип данных: Объект
• limit
  Описание:
  Лимит записей на страницу
  Допустимый тип данных: Число
• skip
  Описание:
  Количество записей для пропуска (offset)
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Массив категорий
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество записей
  Тип данных: Число
• skip
  Описание:
  Текущий offset
  Тип данных: Число
• limit
  Описание:
  Текущий лимит
  Тип данных: Число
client_tags.get

Описание: Получение одной категории клиента по ID
Входящие переменные:
• tag_id
  Описание:
  ID категории
  Допустимый тип данных: Строка
Возвращаемые параметры:
• item
  Описание:
  Объект категории
  Тип данных: Объект
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
achievements.add

Описание: Add achievement phrase (system or club-specific)
Входящие переменные:
• type
  Допустимый тип данных: Строка
• threshold
  Допустимый тип данных: Возможно несколько типов: Число, Дробное число
• sport_types
  Допустимый тип данных: Массив объектов
• sport_type
  Допустимый тип данных: Число
• text
  Допустимый тип данных: Строка
• names_lang
  Допустимый тип данных: Объект
• system
  Допустимый тип данных: Логическое выражение
• club_ids
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
achievements.edit

Описание: Edit achievement phrase
Входящие переменные:
• id
  Допустимый тип данных: Строка
• type
  Допустимый тип данных: Строка
• threshold
  Допустимый тип данных: Возможно несколько типов: Число, Дробное число
• sport_types
  Допустимый тип данных: Массив объектов
• text
  Допустимый тип данных: Строка
• names_lang
  Допустимый тип данных: Объект
• club_ids
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
achievements.remove

Описание: Remove achievement phrase
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
achievements.bulkremove

Описание: Bulk remove non-system phrases
Входящие переменные:
• ids
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
• count
  Тип данных: Число
achievements.hideforclubs

Описание: Hide system phrases for specified clubs
Входящие переменные:
• ids
  Допустимый тип данных: Массив объектов
• club_ids
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
achievements.unhideforclubs

Описание: Unhide system phrases for specified clubs
Входящие переменные:
• ids
  Допустимый тип данных: Массив объектов
• club_ids
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
achievements.list

Описание: List achievements for management
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• filters
  Допустимый тип данных: Объект
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
bookings.my.upcoming

Описание: Получить список ближайших бронирований пользователя
Входящие переменные:
• limit
  Описание:
  Максимальное количество бронирований
  Допустимый тип данных: Число
Возвращаемые параметры:
bookings.session.participants

Описание: Получить список участников занятия
Входящие переменные:
• session_id обязательно
  Описание:
  ID занятия в расписании
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.session.get

Описание: Получить информацию о тренировке
Входящие переменные:
Возвращаемые параметры:
bookings.session.book

Описание: Забронировать занятие
Входящие переменные:
Возвращаемые параметры:
bookings.session.cancel

Описание: Отменить бронь занятия
Входящие переменные:
Возвращаемые параметры:
bookings.session.products.check

Описание: Получить информацию о тренировке
Входящие переменные:
Возвращаемые параметры:
bookings.session.payment_options

Описание: Получить опции оплаты разового занятия
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• session_id обязательно
  Описание:
  ID занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.session.check_payment

Описание: Проверить оплату через CloudPayments виджет и подтвердить бронирование
Входящие переменные:
• invoice_id обязательно
  Описание:
  ID invoice
  Допустимый тип данных: Строка
• booking_id обязательно
  Описание:
  ID бронирования
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.admin.grid

Описание: Grid список бронирований клуба для раздела «Продажи / Все бронирования»
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры таблицы
  Допустимый тип данных: Объект
• order
  Описание:
  Сортировка {field, order}
  Допустимый тип данных: Объект
• skip
  Описание:
  Пропустить
  Допустимый тип данных: Число
• limit
  Описание:
  Количество на странице
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Список бронирований
  Тип данных: Массив объектов
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
bookings.admin.get

Описание: Получить детальную карточку бронирования (для модалки)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• booking_id обязательно
  Описание:
  ID бронирования
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.admin.cancel

Описание: Отмена бронирования администратором (с автоматическим возвратом по политике)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• booking_id обязательно
  Описание:
  ID бронирования
  Допустимый тип данных: Строка
• reason
  Описание:
  Причина отмены
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.admin.checkin

Описание: Отметить присутствие клиента на бронировании
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• booking_id обязательно
  Описание:
  ID бронирования
  Допустимый тип данных: Строка
• start
  Описание:
  Перевести в in_progress (если confirmed)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
bookings.admin.noshow

Описание: Отметить бронирование как неявку (no_show)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• booking_id обязательно
  Описание:
  ID бронирования
  Допустимый тип данных: Строка
• apply_penalty
  Описание:
  Применять штраф по политике
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
bookings.admin.refund

Описание: Возврат денежных средств по бронированию (без отмены брони)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• booking_id обязательно
  Описание:
  ID бронирования
  Допустимый тип данных: Строка
• amount обязательно
  Описание:
  Сумма возврата (Decimal-строка)
  Допустимый тип данных: Дробное число в строке
• reason
  Описание:
  Причина возврата
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.admin.batch

Описание: Массовая операция над бронированиями (cancel/checkin/noshow)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• booking_ids обязательно
  Описание:
  Массив ID бронирований
  Допустимый тип данных: Массив строк
• operation обязательно
  Описание:
  Операция: cancel | checkin | noshow
  Допустимый тип данных: Строка
• reason
  Описание:
  Причина (для cancel)
  Допустимый тип данных: Строка
• apply_penalty
  Описание:
  Применять штраф (для noshow)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
bookings.admin.export

Описание: Экспорт бронирований в XLSX по фильтрам
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Те же фильтры что и в grid
  Допустимый тип данных: Объект
• order
  Описание:
  Сортировка {field, order}
  Допустимый тип данных: Объект
• columns
  Описание:
  Колонки для выгрузки (если не указаны — все)
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• url
  Описание:
  URL для скачивания файла
  Тип данных: Строка
• count
  Тип данных: Число
• expires_at
  Тип данных: Строка
bookings.personal.services

Описание: Список услуг с включённой индивидуальной записью
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.personal.slots

Описание: Получить доступные слоты для записи на индивидуальную услугу
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• service_id
  Описание:
  ID услуги (ServiceProduct), опционально если передан service_type
  Допустимый тип данных: Строка
• service_type
  Описание:
  Тип услуги (personal_training, spa, massage) — если без service_id
  Допустимый тип данных: Строка
• date обязательно
  Описание:
  Дата (YYYY-MM-DD)
  Допустимый тип данных: Строка
• staff_id
  Описание:
  UID сотрудника (опционально, в backend игнорируется — фильтрация на фронте)
  Допустимый тип данных: Число
• zone_id
  Описание:
  ID зоны (опционально, в backend игнорируется — фильтрация на фронте)
  Допустимый тип данных: Строка
• favorite_staff_only
  Описание:
  Только избранные сотрудники
  Допустимый тип данных: Логическое выражение
• timezone
  Описание:
  Часовой пояс
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.personal.book

Описание: Создать бронирование индивидуальной услуги с оплатой
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• service_id обязательно
  Описание:
  ID услуги
  Допустимый тип данных: Строка
• staff_id обязательно
  Описание:
  UID сотрудника
  Допустимый тип данных: Число
• zone_id
  Описание:
  ID зоны (помещения). Обязателен если у услуги requires_zone и нет однозначного дефолта
  Допустимый тип данных: Строка
• date обязательно
  Описание:
  Дата (YYYY-MM-DD)
  Допустимый тип данных: Строка
• start_time обязательно
  Описание:
  Время начала (HH:mm)
  Допустимый тип данных: Строка
• duration_minutes
  Описание:
  Длительность в минутах (опционально, по умолчанию из услуги)
  Допустимый тип данных: Число
• payment_method
  Описание:
  Способ оплаты: free, package, balance, bonus, card
  Допустимый тип данных: Строка
• product_id
  Описание:
  ID пакета/членства для списания визита
  Допустимый тип данных: Строка
• return_url
  Описание:
  URL возврата после оплаты картой
  Допустимый тип данных: Строка
• notes
  Описание:
  Заметка клиента
  Допустимый тип данных: Строка
• timezone
  Описание:
  Часовой пояс
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.personal.payment_options

Описание: Опции оплаты для индивидуальной услуги
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• service_id обязательно
  Описание:
  ID услуги
  Допустимый тип данных: Строка
• date
  Описание:
  Дата бронирования (YYYY-MM-DD)
  Допустимый тип данных: Строка
• start_time
  Описание:
  Время начала (HH:mm)
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.personal.products.check

Описание: Проверить доступные пакеты/членства клиента для персональной услуги
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• service_id обязательно
  Описание:
  ID услуги
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.personal.check_payment

Описание: Проверить оплату через CloudPayments виджет и подтвердить бронирование
Входящие переменные:
• invoice_id обязательно
  Описание:
  ID invoice
  Допустимый тип данных: Строка
• booking_id обязательно
  Описание:
  ID бронирования
  Допустимый тип данных: Строка
Возвращаемые параметры:
bookings.personal.cancel

Описание: Отменить бронирование индивидуальной услуги
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• booking_id обязательно
  Описание:
  ID бронирования
  Допустимый тип данных: Строка
• reason
  Описание:
  Причина отмены
  Допустимый тип данных: Строка
Возвращаемые параметры:
boxes.zonehealth

Описание: Здоровье зоны: онлайн/всего активных screenmode-устройств
Входящие переменные:
• session_id
  Описание:
  Идентификатор занятия (режим управления, зоны берутся из сессии)
  Допустимый тип данных: Строка
• zone_ids
  Описание:
  Идентификаторы зон (режим быстрого старта)
  Допустимый тип данных: Массив строк
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
boxes.list

Описание:
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• boxes
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Число
  • caption
    Тип данных: Строка
boxes.stats

Описание: Aggregated device stats for last 1d/2d/7d
Входящие переменные:
• id
  Допустимый тип данных: Число
• range
  Допустимый тип данных: Строка
• type
  Допустимый тип данных: Строка
Возвращаемые параметры:
boxes.switch

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• enabled
  Тип данных: Логическое выражение
boxes.remove

Описание:
Входящие переменные:
Возвращаемые параметры:
boxes.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
boxes.get

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Число
Возвращаемые параметры:
boxes.update

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Число
Возвращаемые параметры:
boxes.settask

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Число
Возвращаемые параметры:
boxes.emulate

Описание: Поставить задачу эмуляции данных датчиков для устройства tridegate
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор устройства
  Допустимый тип данных: Число
• data_types обязательно
  Описание:
  Набор данных для трансляции: pulse, power, cadence, speed
  Допустимый тип данных: Массив строк
• device_ids обязательно
  Описание:
  Идентификаторы устройств для эмуляции (не более 20)
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
branding.gen

Описание: Сгенерировать тему клуба по промпту и/или файлам брендбука
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• prompt
  Описание:
  Текстовый запрос/описание стиля от пользователя
  Допустимый тип данных: Строка
• files
  Описание:
  Массив файлов брендбука/логотипов ({fileid, name})
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• theme
  Описание:
  Полная сгенерированная тема
  Тип данных: Объект
• warnings
  Описание:
  Предупреждения (пропущенные/нормализованные ключи)
  Тип данных: Массив строк
• error
  Описание:
  Код ошибки: ai_no_response | ai_invalid_json | ai_partial
  Тип данных: Строка
theme.schema.get

Описание: Получить схему переменных темы (для фронтового редактора)
Входящие переменные:
Возвращаемые параметры:
• schema
  Описание:
  Массив элементов схемы темы
  Тип данных: Массив объектов
theme.assist

Описание: AI помощник для редактирования темы
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• prompt обязательно
  Описание:
  Запрос пользователя для изменения темы
  Допустимый тип данных: Строка
• current_theme обязательно
  Описание:
  Текущие значения темы
  Допустимый тип данных: Объект
Возвращаемые параметры:
• changes
  Описание:
  Объект с изменениями переменных темы
  Тип данных: Объект
getsettings

Описание: Редактировать клуб
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
editsettings

Описание: Редактировать клуб
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
edit-settings

Описание:
Входящие переменные:
mainmenu.get

Описание: Получить меню клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• menu
  Тип данных: Массив объектов
menu.get

Описание: Получить меню клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• menu
  Тип данных: Массив объектов
menu.update

Описание: Сохранить меню клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• menu
  Тип данных: Массив объектов
theme.get

Описание: Получить тему клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Массив объектов
theme.update

Описание: Сохранить тему клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Массив объектов
logos.get

Описание: Получить лого клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Массив объектов
logos.update

Описание: Сохранить лого клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Массив объектов
homescreen.get

Описание: Получить главный экран клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Массив объектов
homescreen.update

Описание: Сохранить лого клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Массив объектов
startsceeen.get

Описание: Получить настройки стартового экрана клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Массив объектов
startscreen.update

Описание: Сохранить стартовый экран клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Массив объектов
bottommenu.get

Описание: Получить нижнее меню клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• menu
  Тип данных: Массив объектов
bottommenu.update

Описание: Сохранить меню клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• menu
  Тип данных: Массив объектов
employeemenu.get

Описание: Получить меню сотрудников клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• menu
  Тип данных: Массив объектов
employeemenu.update

Описание: Сохранить меню сотрудников клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• menu обязательно
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• menu
  Тип данных: Массив объектов
ui_layout.get

Описание: Получить конфигурацию UI Builder для раздела клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• section обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
customsettings.get

Описание: Получить кастомные настройки клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
customsettings.update

Описание: Сохранить кастомные настройки клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• settings
  Описание:
  Настройки
  Допустимый тип данных: Объект
titles.get

Описание: Получить заголовки
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
titles.edit

Описание: Сохранить заголовок
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• key
  Описание:
  Ключ
  Допустимый тип данных: Строка
• value
  Описание:
  Значение
  Допустимый тип данных: Строка
Возвращаемые параметры:
pages.get

Описание: Получить настройки интеграций
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
pages.edit

Описание: Получить настройки интеграций
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
icons.get

Описание: Получить кастомные иконки меню клуба
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
icons.update

Описание: Обновить иконку пункта меню клуба
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• page
  Описание:
  ID страницы/пункта меню
  Допустимый тип данных: Строка
• icon_type
  Описание:
  Тип иконки: tride, lucide, custom, ai
  Допустимый тип данных: Строка
• icon_value
  Описание:
  Значение иконки (имя или SVG код)
  Допустимый тип данных: Строка
Возвращаемые параметры:
icons.clear

Описание: Сбросить иконку пункта меню на дефолтную
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• page
  Описание:
  ID страницы/пункта меню
  Допустимый тип данных: Строка
Возвращаемые параметры:
ui_layout.update

Описание: Сохранить конфигурацию UI Builder для раздела клуба
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• section обязательно
  Допустимый тип данных: Строка
• config обязательно
  Допустимый тип данных: undefined
Возвращаемые параметры:
chat.messages.new

Описание: Получить новые сообщения в чате
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• last_id обязательно
  Описание:
  Идентификатор последнего сообщения в чате
  Допустимый тип данных: Число
Возвращаемые параметры:
chat.messages.old

Описание: Получить старые/последние сообщения в чате
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• first_id
  Описание:
  Идентификатор первого сообщения в чате
  Допустимый тип данных: Число
Возвращаемые параметры:
clientchat.dashboard

Описание: Дашборд чатов с клиентами — статистика
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
clientchat.list

Описание: Список чатов с клиентами
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• filter
  Описание:
  Фильтр: my, unassigned, all
  Допустимый тип данных: Строка
• status
  Описание:
  Статус чатов: active, archived, closed
  Допустимый тип данных: Строка
• search
  Описание:
  Поиск по имени клиента
  Допустимый тип данных: Строка
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
clientchat.get

Описание: Детали чата с клиентом
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• chat_id
  Описание:
  Идентификатор чата
  Допустимый тип данных: Строка
• client_uid
  Описание:
  UID клиента (альтернативный поиск)
  Допустимый тип данных: Строка
clientchat.messages.list

Описание: Список сообщений чата (подгрузка старых)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• chat_id обязательно
  Описание:
  Идентификатор чата
  Допустимый тип данных: Строка
• first_id
  Описание:
  ID первого сообщения для пагинации
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит сообщений
  Допустимый тип данных: Число
clientchat.messages.new

Описание: Новые сообщения чата (после last_id)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• chat_id обязательно
  Описание:
  Идентификатор чата
  Допустимый тип данных: Строка
• last_id
  Описание:
  ID последнего полученного сообщения
  Допустимый тип данных: Число
clientchat.messages.send

Описание: Отправка сообщения клиенту (REST фаллбек)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• chat_id обязательно
  Описание:
  Идентификатор чата
  Допустимый тип данных: Строка
• text
  Описание:
  Текст сообщения
  Допустимый тип данных: Строка
• attachments
  Описание:
  Вложения
  Допустимый тип данных: Массив объектов
• reply_to
  Описание:
  ID сообщения для ответа
  Допустимый тип данных: Число
clientchat.messages.read

Описание: Отметить сообщения прочитанными (сотрудник)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• chat_id обязательно
  Описание:
  Идентификатор чата
  Допустимый тип данных: Строка
• last_read_id обязательно
  Описание:
  ID последнего прочитанного сообщения
  Допустимый тип данных: Число
clientchat.initiate

Описание: Создать чат с клиентом проактивно
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• client_uid обязательно
  Описание:
  UID клиента
  Допустимый тип данных: Строка
clientchat.assign

Описание: Назначить чат на сотрудника
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• chat_id обязательно
  Описание:
  Идентификатор чата
  Допустимый тип данных: Строка
• employee_uid
  Описание:
  UID сотрудника (null для снятия)
  Допустимый тип данных: Строка
clientchat.notification_settings.get

Описание: Настройки уведомлений чата (сотрудник)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
clientchat.notification_settings.update

Описание: Обновить настройки уведомлений чата (сотрудник)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• enabled
  Описание:
  Включены ли уведомления
  Допустимый тип данных: Логическое выражение
• throttle_hours
  Описание:
  Throttling в часах
  Допустимый тип данных: Число
clientchat.client.get

Описание: Получить/создать чат клиента с клубом
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
clientchat.client.messages.list

Описание: Список сообщений клиентского чата (подгрузка старых)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• first_id
  Описание:
  ID первого сообщения для пагинации
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит сообщений
  Допустимый тип данных: Число
clientchat.client.messages.new

Описание: Новые сообщения клиентского чата (после last_id)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• last_id
  Описание:
  ID последнего полученного сообщения
  Допустимый тип данных: Число
clientchat.client.messages.send

Описание: Отправка сообщения от клиента в чат с клубом
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• text
  Описание:
  Текст сообщения
  Допустимый тип данных: Строка
• attachments
  Описание:
  Вложения
  Допустимый тип данных: Массив объектов
• reply_to
  Описание:
  ID сообщения для ответа
  Допустимый тип данных: Число
clientchat.client.messages.read

Описание: Отметить сообщения прочитанными (клиент)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• last_read_id обязательно
  Описание:
  ID последнего прочитанного сообщения
  Допустимый тип данных: Число
clientchat.client.notification_settings.get

Описание: Настройки уведомлений клиентского чата
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
clientchat.client.notification_settings.update

Описание: Обновить настройки уведомлений клиентского чата
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• enabled
  Описание:
  Включены ли уведомления
  Допустимый тип данных: Логическое выражение
• throttle_hours
  Описание:
  Throttling в часах
  Допустимый тип данных: Число
clientchat.widget.config

Описание: Конфигурация виджета чата для сайта клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
clientchat.widget.init

Описание: Инициализация виджет-сессии чата
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• name
  Описание:
  Имя посетителя
  Допустимый тип данных: Строка
• email
  Описание:
  Email посетителя
  Допустимый тип данных: Email. Содержит @. и больше 5 символов
• phone
  Описание:
  Телефон посетителя
  Допустимый тип данных: Строка
• widget_token
  Описание:
  Токен для восстановления сессии
  Допустимый тип данных: Строка
clientchat.widget.messages

Описание: Сообщения виджета чата
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• widget_token обязательно
  Описание:
  Токен виджета
  Допустимый тип данных: Строка
• first_id
  Описание:
  ID первого сообщения (пагинация)
  Допустимый тип данных: Число
• last_id
  Описание:
  ID последнего сообщения (новые)
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит сообщений
  Допустимый тип данных: Число
clientchat.widget.send

Описание: Отправка сообщения из виджета чата
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• widget_token обязательно
  Описание:
  Токен виджета
  Допустимый тип данных: Строка
• text
  Описание:
  Текст сообщения
  Допустимый тип данных: Строка
• attachments
  Описание:
  Вложения
  Допустимый тип данных: Массив объектов
• reply_to
  Описание:
  ID сообщения для ответа
  Допустимый тип данных: Число
companies.list

Описание: Получить список компаний
Входящие переменные:
Возвращаемые параметры:
• companies
  Описание:
  Массив списка компаний
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор компании
    Тип данных: Строка
  • name
    Описание:
    Название компании / ИП
    Тип данных: Строка
companies.get

Описание: Получить компанию
Входящие переменные:
companies.lookup

Описание: Получить данные компании по ИНН или названию
Входящие переменные:
• search
  Описание:
  поисковая строка по ИНН или названию
  Допустимый тип данных: Строка
Возвращаемые параметры:
• companies
  Описание:
  Массив списка компаний
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор компании
    Тип данных: Строка
  • entity_typeвсегда
    Описание:
    Тип компании: 1 - юр лицо, 2 - ИП
    Тип данных: Число
  • nameвсегда
    Описание:
    Название компании / ФИО ИП или СЗ
    Тип данных: Строка
  • director_name
    Описание:
    ФИЛ директора (для юр лица)
    Тип данных: Строка
  • innвсегда
    Описание:
    ИНН
    Тип данных: Строка
  • ogrnвсегда
    Описание:
    ОРГН ИЛИ ОГРНИП (для юр лица и ИП)
    Тип данных: Строка
  • addressвсегда
    Описание:
    Адрес строкой
    Тип данных: Строка
  • address_idвсегда
    Описание:
    КОД ФИАС адреса
    Тип данных: Строка
  • kpp
    Описание:
    КПП (для юр лиц)
    Тип данных: Строка
companies.add

Описание: Добавить компанию
Входящие переменные:
• entity_type обязательно
  Описание:
  Тип компании: 1 - юр лицо, 2 - ИП
  Допустимый тип данных: Число
• name обязательно
  Описание:
  Название компании / ФИО ИП или СЗ
  Допустимый тип данных: Строка
• director_name
  Описание:
  ФИЛ директора (для юр лица)
  Допустимый тип данных: Строка
• inn обязательно
  Описание:
  ИНН
  Допустимый тип данных: Строка
• ogrn обязательно
  Описание:
  ОРГН ИЛИ ОГРНИП (для юр лица и ИП)
  Допустимый тип данных: Строка
• address обязательно
  Описание:
  КОД ФИАС адреса
  Допустимый тип данных: Строка
• phone обязательно
  Описание:
  Телефон компании
  Допустимый тип данных: Строка
• kpp
  Описание:
  КПП (для юр лиц)
  Допустимый тип данных: Строка
• okup_contract
  Описание:
  Номер договора с РАО, ВОИС или ФМ
  Допустимый тип данных: Строка
• email обязательно
  Описание:
  Email
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• company_id
  Описание:
  ID созданной компании
  Тип данных: Строка
• error
  Описание:
  Ошибка. Если result=false, то значение ошибки:
  • name - не заполнено имя
  • address - неверный адрес
  • phone - неверный телефон или не заполнен
  • email - неверный email или не заполнен
  • inn - неверный ИНН или не заполнен
  • director_name - неверное имя директора или не заполнен
  • entity_type - не указан тип компании
  • ogrn - не указан ОГРН или неверный
  
  Тип данных: Строка
companies.edit

Описание: Редактировать компанию
Входящие переменные:
competitions.add

Описание: Добавление пресета соревнования (системного или клубного)
Входящие переменные:
• name
  Описание:
  Название пресета
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
• settings
  Описание:
  Настройки соревнования
  Допустимый тип данных: Объект
• display_settings
  Описание:
  Настройки отображения (screen, data, controlData, volume)
  Допустимый тип данных: Объект
• system
  Описание:
  Системный пресет (только для администратора)
  Допустимый тип данных: Логическое выражение
• club_ids
  Описание:
  ID клубов для клубного пресета
  Допустимый тип данных: Массив строк
• order
  Описание:
  Порядок сортировки
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
competitions.edit

Описание: Редактирование пресета соревнования
Входящие переменные:
• id
  Описание:
  ID пресета
  Допустимый тип данных: Строка
• name
  Описание:
  Название пресета
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
• settings
  Описание:
  Настройки соревнования
  Допустимый тип данных: Объект
• display_settings
  Описание:
  Настройки отображения (screen, data, controlData, volume)
  Допустимый тип данных: Объект
• club_ids
  Описание:
  ID клубов
  Допустимый тип данных: Массив строк
• order
  Описание:
  Порядок сортировки
  Допустимый тип данных: Число
• system
  Описание:
  Превратить в системный (только для администратора)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
competitions.remove

Описание: Удаление пресета соревнования
Входящие переменные:
• id
  Описание:
  ID пресета
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
competitions.bulkremove

Описание: Массовое удаление не-системных пресетов соревнований
Входящие переменные:
• ids
  Описание:
  Массив ID пресетов
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
• count
  Тип данных: Число
competitions.hideforclubs

Описание: Скрыть системные пресеты соревнований для указанных клубов
Входящие переменные:
• ids
  Описание:
  Массив ID пресетов
  Допустимый тип данных: Массив строк
• club_ids
  Описание:
  Массив ID клубов
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
competitions.unhideforclubs

Описание: Показать системные пресеты соревнований для указанных клубов
Входящие переменные:
• ids
  Описание:
  Массив ID пресетов
  Допустимый тип данных: Массив строк
• club_ids
  Описание:
  Массив ID клубов
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
competitions.list

Описание: Список пресетов соревнований для управления
Входящие переменные:
• club_id
  Описание:
  ID клуба для фильтрации
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры: system (boolean), sport_type (int), name (string)
  Допустимый тип данных: Объект
• limit
  Описание:
  Лимит записей (по умолчанию 50, макс 200)
  Допустимый тип данных: Число
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка: field (created_ts, updated_ts, system, name, order, sport_type), order (asc/desc)
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • name
    Тип данных: Строка
  • sport_type
    Тип данных: Число
  • settings
    Тип данных: Объект
  • display_settings
    Тип данных: Объект
  • system
    Тип данных: Логическое выражение
  • club_ids
    Тип данных: Массив строк
  • hidden_for_clubs
    Тип данных: Массив строк
  • order
    Тип данных: Число
  • created_ts
    Тип данных: Временной штамп (timestamp)
  • updated_ts
    Тип данных: Временной штамп (timestamp)
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
competitions.get

Описание: Получение конкретного пресета соревнования
Входящие переменные:
• id
  Описание:
  ID пресета
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• name
  Тип данных: Строка
• sport_type
  Тип данных: Число
• settings
  Тип данных: Объект
• display_settings
  Тип данных: Объект
• system
  Тип данных: Логическое выражение
• club_ids
  Тип данных: Массив строк
• hidden_for_clubs
  Тип данных: Массив строк
• order
  Тип данных: Число
• created_ts
  Тип данных: Временной штамп (timestamp)
• updated_ts
  Тип данных: Временной штамп (timestamp)
competitions.listforclub

Описание: Список пресетов соревнований для конкретного клуба (для использования во время тренировки)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Вид спорта для фильтрации
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • name
    Тип данных: Строка
  • sport_type
    Тип данных: Число
  • settings
    Тип данных: Объект
  • display_settings
    Тип данных: Объект
  • system
    Тип данных: Логическое выражение
  • order
    Тип данных: Число
competitions.copy

Описание: Копирование пресета соревнования в клуб
Входящие переменные:
• id
  Описание:
  ID исходного пресета
  Допустимый тип данных: Строка
• club_ids
  Описание:
  ID клубов для копии
  Допустимый тип данных: Массив строк
• name
  Описание:
  Название копии (опционально)
  Допустимый тип данных: Строка
• order
  Описание:
  Порядок сортировки (опционально)
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
competitions.reorder

Описание: Изменение порядка пресетов соревнований
Входящие переменные:
• items
  Описание:
  Массив объектов { id: string, order: int }
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
checkSubdomainAvailable

Описание: Проверка доступности поддомена
Входящие переменные:
• subdomain обязательно
  Описание:
  Поддомен для проверки
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба (для проверки что это текущий клуб)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• available
  Описание:
  Доступен ли поддомен
  Тип данных: Логическое выражение
• subdomain
  Описание:
  Нормализованный поддомен
  Тип данных: Строка
• error
  Описание:
  Код ошибки если недоступен
  Тип данных: Строка
setSubdomain

Описание: Установка/изменение поддомена клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• subdomain обязательно
  Описание:
  Поддомен для установки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• subdomain
  Описание:
  Установленный поддомен
  Тип данных: Строка
• status
  Описание:
  Статус поддомена (active или pending)
  Тип данных: Строка
• dns_created
  Описание:
  Создана ли DNS запись
  Тип данных: Логическое выражение
• warning
  Описание:
  Предупреждение если DNS не создан
  Тип данных: Строка
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
setCustomDomain

Описание: Установка кастомного домена
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• custom_domain обязательно
  Описание:
  Кастомный домен
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• custom_domain
  Описание:
  Установленный домен
  Тип данных: Строка
• verification_token
  Описание:
  Токен верификации
  Тип данных: Строка
• target_cname
  Описание:
  Целевой CNAME для DNS записи
  Тип данных: Строка
• instructions
  Описание:
  Инструкции по настройке DNS
  Тип данных: Объект
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
verifyCustomDomain

Описание: Проверка и верификация кастомного домена
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• verified
  Описание:
  Верифицирован ли домен
  Тип данных: Логическое выражение
• custom_domain
  Описание:
  Домен
  Тип данных: Строка
• message
  Описание:
  Сообщение о статусе
  Тип данных: Строка
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
removeCustomDomain

Описание: Удаление кастомного домена
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
getDomainSettings

Описание: Получение настроек доменов клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• settings
  Описание:
  Настройки доменов
  Тип данных: Объект
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
setDomainMeta

Описание: Установка метаданных домена (title, description, keywords)
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• title
  Описание:
  Заголовок страницы (до 200 символов)
  Допустимый тип данных: Строка
• description
  Описание:
  Описание страницы (до 500 символов)
  Допустимый тип данных: Строка
• keywords
  Описание:
  Ключевые слова (до 500 символов)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• domain_meta
  Описание:
  Установленные метаданные
  Тип данных: Объект
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
setAnalytics

Описание: Установка настроек аналитики для брендированного приложения
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• yandex_metrika_id
  Описание:
  ID счётчика Яндекс.Метрики
  Допустимый тип данных: Строка
• vk_pixel_id
  Описание:
  ID пикселя VK (Mail.ru Counter)
  Допустимый тип данных: Строка
• google_analytics_id
  Описание:
  ID Google Analytics (GA4)
  Допустимый тип данных: Строка
• google_tag_manager_id
  Описание:
  ID Google Tag Manager
  Допустимый тип данных: Строка
• facebook_pixel_id
  Описание:
  ID пикселя Facebook
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• analytics
  Описание:
  Установленные настройки аналитики
  Тип данных: Объект
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
setAppStores

Описание: Установка ссылок на приложения (только для админов с triderole=100)
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• google_play
  Описание:
  Ссылка на Google Play
  Допустимый тип данных: Строка
• app_store
  Описание:
  Ссылка на App Store
  Допустимый тип данных: Строка
• rustore
  Описание:
  Ссылка на RuStore
  Допустимый тип данных: Строка
• apk_direct
  Описание:
  Прямая ссылка на APK файл (file_id)
  Допустимый тип данных: Идентификатор файла - fileid
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• app_stores
  Описание:
  Установленные ссылки на магазины
  Тип данных: Объект
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
setClientsOnlyAuth

Описание: Установка ограничения входа только для клиентов клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• clients_only_auth обязательно
  Описание:
  Разрешить вход только клиентам клуба
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• clients_only_auth
  Описание:
  Установленное значение
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки если неудачно
  Тип данных: Строка
employees.list

Описание: Список сотрудников
Входящие переменные:
Возвращаемые параметры:
employees.add

Описание: Добавить сотрудника
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
employees.remove

Описание: Удалить сотрудника
Входящие переменные:
Возвращаемые параметры:
employees.edit

Описание: Изменить сотрудника
Входящие переменные:
Возвращаемые параметры:
employees.get

Описание: Получить сотрудника
Входящие переменные:
Возвращаемые параметры:
employee.card.get

Описание: Список клиентских тегов в клубе
Входящие переменные:
Возвращаемые параметры:
employee.card.list.public

Описание: Список клиентских тегов в клубе
Входящие переменные:
Возвращаемые параметры:
employee.card.get.public

Описание: Список клиентских тегов в клубе
Входящие переменные:
Возвращаемые параметры:
employee.card.edit

Описание: Список клиентских тегов в клубе
Входящие переменные:
Возвращаемые параметры:
employees.integrations.set

Описание:
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
employees.integrations.get

Описание:
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
employees.maplist

Описание: Список сотрудников (компактно) с внешними ID
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список сотрудников
  Тип данных: Массив объектов
  Вложенные элементы:
  • uid
    Описание:
    UID сотрудника
    Тип данных: Строка
  • avatar
    Описание:
    Аватар сотрудника (fileid)
    Тип данных: Строка
  • name
    Описание:
    Имя Фамилия
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Строка
employees.mapsave

Описание: Сохранить соответствия внешних ID для сотрудников (bulk)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• mappings
  Описание:
  Массив соответствий {uid, external_id}
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • uid
    Описание:
    UID сотрудника
    Тип данных: Число
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов: Число, Строка
Возвращаемые параметры:
• saved
  Описание:
  Статус сохранения
  Тип данных: Логическое выражение
• updated
  Описание:
  Количество обновлённых записей
  Тип данных: Число
employees.availability.get

Описание: Получить расписание доступности сотрудника
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  UID сотрудника
  Допустимый тип данных: Число
Возвращаемые параметры:
employees.availability.set

Описание: Сохранить расписание доступности сотрудника
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  UID сотрудника
  Допустимый тип данных: Число
• enabled
  Описание:
  Включить/выключить расписание
  Допустимый тип данных: Логическое выражение
• schedule
  Описание:
  Недельный график работы
  Допустимый тип данных: Объект
• buffer
  Описание:
  Буферное время между записями
  Допустимый тип данных: Объект
• limits
  Описание:
  Лимиты нагрузки
  Допустимый тип данных: Объект
• exceptions
  Описание:
  Исключения (конкретные даты)
  Допустимый тип данных: Массив объектов
• vacations
  Описание:
  Периоды отпуска
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
employees.availability.check

Описание: Проверить доступность сотрудника на конкретное время
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  UID сотрудника
  Допустимый тип данных: Число
• date обязательно
  Описание:
  Дата (YYYY-MM-DD)
  Допустимый тип данных: Строка
• start_time обязательно
  Описание:
  Время начала (HH:mm)
  Допустимый тип данных: Строка
• duration_minutes обязательно
  Описание:
  Длительность в минутах
  Допустимый тип данных: Число
• timezone
  Описание:
  Часовой пояс
  Допустимый тип данных: Строка
Возвращаемые параметры:
employees.availability.slots

Описание: Получить доступные слоты сотрудника на дату
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  UID сотрудника
  Допустимый тип данных: Число
• date обязательно
  Описание:
  Дата (YYYY-MM-DD)
  Допустимый тип данных: Строка
• slot_duration_minutes обязательно
  Описание:
  Длительность слота в минутах
  Допустимый тип данных: Число
• timezone
  Описание:
  Часовой пояс
  Допустимый тип данных: Строка
Возвращаемые параметры:
external_specialists.set

Описание: Установить/обновить статус «внешнего специалиста» для сотрудника хост-клуба
Входящие переменные:
• club_id обязательно
  Описание:
  ID хост-клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  UID сотрудника
  Допустимый тип данных: Число
• external_specialist обязательно
  Описание:
  Контракт: { enabled, trainer_club_id, rental:{mode,value,currency}, allowed_service_ids[], apply_to_packages, apply_to_balance, apply_to_bonus, apply_to_free, status, valid_from, valid_to }
  Допустимый тип данных: Объект
Возвращаемые параметры:
external_specialists.get

Описание: Получить текущий контракт «внешнего специалиста» для сотрудника
Входящие переменные:
• club_id обязательно
  Описание:
  ID хост-клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  UID сотрудника
  Допустимый тип данных: Число
Возвращаемые параметры:
external_specialists.trainer_candidates

Описание: Список клубов type:coach, где сотрудник является owner_uid (кандидаты для trainer_club_id)
Входящие переменные:
• club_id обязательно
  Описание:
  ID хост-клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  UID сотрудника
  Допустимый тип данных: Число
Возвращаемые параметры:
external_specialists.list

Описание: Список сотрудников хост-клуба с активным контрактом external_specialist
Входящие переменные:
• club_id обязательно
  Описание:
  ID хост-клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
external_specialists.my_host_clubs

Описание: Список хост-клубов, где текущий пользователь работает как внешний специалист
Входящие переменные:
Возвращаемые параметры:
engagement.feed

Описание: Лента взаимодействий (лайки и комментарии) для занятий клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• skip
  Описание:
  Пропустить N записей (для пагинации)
  Допустимый тип данных: Число
• limit
  Описание:
  Количество записей (макс 100, по умолчанию 20)
  Допустимый тип данных: Число
• event_types
  Описание:
  Фильтр по типам событий: ['like', 'comment']. По умолчанию оба типа
  Допустимый тип данных: Массив строк
• session_id
  Описание:
  Фильтр по конкретному занятию
  Допустимый тип данных: Строка
• from_ts
  Описание:
  Начало периода (unix timestamp)
  Допустимый тип данных: Число
• to_ts
  Описание:
  Конец периода (unix timestamp)
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Массив событий. Каждый объект: {id, type, created_ts, session: {id, name, planned_start_ts, sport_types}, author: {uid, firstname, lastname, display_name, avatar}, content}
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество событий
  Тип данных: Число
• skip
  Описание:
  Количество пропущенных записей
  Тип данных: Число
• limit
  Описание:
  Лимит записей на страницу
  Тип данных: Число
• has_more
  Описание:
  Есть ли ещё записи для загрузки
  Тип данных: Логическое выражение
faq.grid

Описание: Grid FAQ list with filters
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив объектов FAQ
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
faq.add

Описание: Добавить страницу помощи
Входящие переменные:
• club_ids обязательно
  Описание:
  Массив идентификаторов клубов
  Допустимый тип данных: Массив строк
• title обязательно
  Описание:
  Название страницы
  Допустимый тип данных: Строка
• description
  Описание:
  Краткое описание страницы
  Допустимый тип данных: Строка
• content
  Описание:
  Содержание страницы (markdown)
  Допустимый тип данных: Строка
• preview_image
  Описание:
  Картинка превью страницы
  Допустимый тип данных: Идентификатор файла - fileid
• status
  Описание:
  Включена ли страница
  Допустимый тип данных: Логическое выражение
• roles
  Описание:
  Роли пользователей
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
faq.edit

Описание: Редактировать страницу помощи
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор страницы помощи
  Допустимый тип данных: Строка
• club_ids обязательно
  Описание:
  Массив идентификаторов клубов
  Допустимый тип данных: Массив строк
• title обязательно
  Описание:
  Название страницы
  Допустимый тип данных: Строка
• description
  Описание:
  Краткое описание страницы
  Допустимый тип данных: Строка
• content
  Описание:
  Содержание страницы (markdown)
  Допустимый тип данных: Строка
• preview_image
  Описание:
  Картинка превью страницы
  Допустимый тип данных: Идентификатор файла - fileid
• status
  Описание:
  Включена ли страница
  Допустимый тип данных: Логическое выражение
• roles
  Описание:
  Роли пользователей
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
faq.get

Описание: Получить страницу помощи
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор страницы помощи
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• title
  Тип данных: Строка
• description
  Тип данных: Строка
• content
  Тип данных: Строка
• club_ids
  Тип данных: Массив объектов
• roles
  Тип данных: Массив чисел
• preview_image
  Тип данных: Идентификатор файла - fileid
• status
  Тип данных: Логическое выражение
faq.list

Описание: Получить список страниц помощи
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив объектов страниц помощи
  Тип данных: Массив объектов
faq.remove

Описание: Удалить страницу помощи
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор страницы помощи
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
faq.clientList

Описание: Получить список страниц помощи для клиента
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив объектов страниц помощи
  Тип данных: Массив объектов
faq.clientGet

Описание: Получить страницу помощи для клиента
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор страницы помощи
  Допустимый тип данных: Строка
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• title
  Тип данных: Строка
• description
  Тип данных: Строка
• content
  Тип данных: Строка
• club_ids
  Тип данных: Массив объектов
• roles
  Тип данных: Массив чисел
• preview_image
  Тип данных: Идентификатор файла - fileid
client_fields.add

Описание: Добавить пользовательское поле клиента
Входящие переменные:
• club_id
  Описание:
  ID клуба (автоматически резолвится для групп). Обязателен для клубных полей, не требуется для системных.
  Допустимый тип данных: Строка
• system
  Описание:
  Системное поле (доступно для всех клубов). Только для triderole=100.
  Допустимый тип данных: Логическое выражение
• type обязательно
  Описание:
  Тип поля: text | select | boolean | number | date
  Допустимый тип данных: Строка
• name
  Описание:
  Название поля на языке запроса
  Допустимый тип данных: Строка
• code
  Описание:
  Код поля для системных полей (weight, height и т.д.)
  Допустимый тип данных: Строка
• group
  Описание:
  Название группы
  Допустимый тип данных: Строка
• required
  Описание:
  Обязательное ли поле
  Допустимый тип данных: Логическое выражение
• enabled
  Описание:
  Включено ли поле (по умолчанию true)
  Допустимый тип данных: Логическое выражение
• showBooking
  Описание:
  Показывать в бронировании
  Допустимый тип данных: Логическое выражение
• showRegister
  Описание:
  Показывать в регистрации
  Допустимый тип данных: Логическое выражение
• showProfile
  Описание:
  Показывать в профиле
  Допустимый тип данных: Логическое выражение
• multiple
  Описание:
  Для select: множественный выбор
  Допустимый тип данных: Логическое выражение
• values
  Описание:
  Для select: список опций
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор опции (принимаются также value/code/name)
    Тип данных: Строка
  • name
    Описание:
    Название опции на языке запроса
    Тип данных: Строка
• decimals
  Описание:
  Для number: количество знаков после запятой (>=0)
  Допустимый тип данных: Число
• min
  Описание:
  Для number: минимальное значение
  Допустимый тип данных: Дробное число
• max
  Описание:
  Для number: максимальное значение
  Допустимый тип данных: Дробное число
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• id
  Описание:
  ID созданного поля
  Тип данных: Строка
• error
  Описание:
  Код ошибки (возможные значения):
  • wrong_club_id
  • no_permissions
  • wrong_type
  • db_error
  
  Тип данных: Строка
client_fields.edit

Описание: Редактировать пользовательское поле клиента
Входящие переменные:
• id обязательно
  Описание:
  ID поля
  Допустимый тип данных: Строка
• name
  Описание:
  Новое название
  Допустимый тип данных: Строка
• group
  Описание:
  Название группы
  Допустимый тип данных: Строка
• required
  Описание:
  Обязательное
  Допустимый тип данных: Логическое выражение
• enabled
  Описание:
  Включено
  Допустимый тип данных: Логическое выражение
• showBooking
  Описание:
  Показывать в бронировании
  Допустимый тип данных: Логическое выражение
• showRegister
  Описание:
  Показывать в регистрации
  Допустимый тип данных: Логическое выражение
• showProfile
  Описание:
  Показывать в профиле
  Допустимый тип данных: Логическое выражение
• type
  Описание:
  Смена типа: text | select | boolean | number | date (сбросит специфичные настройки)
  Допустимый тип данных: Строка
• multiple
  Описание:
  Для select: множественный выбор
  Допустимый тип данных: Логическое выражение
• values
  Описание:
  Для select: список опций
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор опции (принимаются также value/code/name)
    Тип данных: Строка
  • name
    Описание:
    Название опции
    Тип данных: Строка
• decimals
  Описание:
  Для number: количество знаков после запятой
  Допустимый тип данных: Число
• min
  Описание:
  Для number: минимум
  Допустимый тип данных: Дробное число
• max
  Описание:
  Для number: максимум
  Допустимый тип данных: Дробное число
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки (возможные значения):
  • wrong_id
  • not_found
  • no_permissions
  • wrong_type
  • db_error
  
  Тип данных: Строка
client_fields.remove

Описание: Удалить пользовательское поле клиента
Входящие переменные:
• id обязательно
  Описание:
  ID поля
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки (возможные значения):
  • wrong_id
  • not_found
  • no_permissions
  • db_error
  
  Тип данных: Строка
client_fields.hide

Описание: Скрыть системное поле для клуба
Входящие переменные:
• id обязательно
  Описание:
  ID системного поля
  Допустимый тип данных: Строка
• club_id обязательно
  Описание:
  ID клуба (автоматически резолвится для групп)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки (возможные значения):
  • wrong_id
  • wrong_club_id
  • not_found
  • not_system_field
  • no_permissions
  • db_error
  
  Тип данных: Строка
client_fields.unhide

Описание: Показать скрытое системное поле для клуба
Входящие переменные:
• id обязательно
  Описание:
  ID системного поля
  Допустимый тип данных: Строка
• club_id обязательно
  Описание:
  ID клуба (автоматически резолвится для групп)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки (возможные значения):
  • wrong_id
  • wrong_club_id
  • not_found
  • not_system_field
  • no_permissions
  • db_error
  
  Тип данных: Строка
client_fields.list

Описание: Список пользовательских полей клиента для админки
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба (автоматически резолвится для групп)
  Допустимый тип данных: Строка
• limit
  Описание:
  Лимит записей на страницу (по умолчанию 10, максимум 100)
  Допустимый тип данных: Число
• skip
  Описание:
  Смещение записей
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка {field, dir}
  Допустимый тип данных: Объект
  Вложенные элементы:
  • field
    Описание:
    Поле сортировки: name|type|enabled|required|created_ts
    Тип данных: Строка
  • dir
    Описание:
    Направление: asc|desc
    Тип данных: Строка
• filters
  Описание:
  Фильтры: type, enabled, required, name
  Допустимый тип данных: Объект
  Вложенные элементы:
  • type
    Описание:
    Тип поля для фильтрации
    Тип данных: Строка
  • enabled
    Описание:
    Только включенные/выключенные
    Тип данных: Логическое выражение
  • required
    Описание:
    Только обязательные/необязательные
    Тип данных: Логическое выражение
  • name
    Описание:
    Поиск по названию (подстрока, регистр не учитывается)
    Тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Поля с полным описанием
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID поля
    Тип данных: Строка
  • type
    Описание:
    Тип: text|select|boolean|number|date
    Тип данных: Строка
  • name
    Описание:
    Название поля
    Тип данных: Строка
  • code
    Описание:
    Код поля (для системных полей)
    Тип данных: Строка
  • required
    Описание:
    Обязательное
    Тип данных: Логическое выражение
  • enabled
    Описание:
    Включено
    Тип данных: Логическое выражение
  • system
    Описание:
    Системное поле (доступно для всех клубов)
    Тип данных: Логическое выражение
  • is_hidden
    Описание:
    Скрыто ли системное поле для данного клуба
    Тип данных: Логическое выражение
  • club_id
    Описание:
    ID клуба (резолвленный)
    Тип данных: Строка
  • select
    Описание:
    Настройки для типа select
    Тип данных: Объект
    Вложенные элементы:
    • values
      Описание:
      Опции выбора
      Тип данных: Массив объектов
      Вложенные элементы:
      • id
        Описание:
        ID опции
        Тип данных: Строка
      • name
        Описание:
        Название опции
        Тип данных: Строка
    • multiple
      Описание:
      Множественный выбор
      Тип данных: Логическое выражение
  • number
    Описание:
    Настройки для типа number
    Тип данных: Объект
    Вложенные элементы:
    • decimals
      Описание:
      Количество знаков после запятой
      Тип данных: Число
    • min
      Описание:
      Минимум
      Тип данных: Дробное число
    • max
      Описание:
      Максимум
      Тип данных: Дробное число
  • created_by
    Описание:
    Кем создано (uid)
    Тип данных: Строка
  • created_ts
    Описание:
    Время создания (unix)
    Тип данных: Временной штамп (timestamp)
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
client_fields.client_list

Описание: Список включенных пользовательских полей клиента c переводами для языка запроса
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба (автоматически резолвится для групп)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список пользовательских полей для формы клиента
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID поля
    Тип данных: Строка
  • type
    Описание:
    Тип: text|select|boolean|number|date
    Тип данных: Строка
  • name
    Описание:
    Название поля (с учетом перевода под язык запроса)
    Тип данных: Строка
  • required
    Описание:
    Обязательное
    Тип данных: Логическое выражение
  • values
    Описание:
    Опции для select (только для типа select)
    Тип данных: Массив объектов
    Вложенные элементы:
    • id
      Описание:
      ID опции
      Тип данных: Строка
    • name
      Описание:
      Название опции (локализованное)
      Тип данных: Строка
  • multiple
    Описание:
    Множественный выбор (только для select)
    Тип данных: Логическое выражение
  • decimals
    Описание:
    Количество знаков после запятой (только для number)
    Тип данных: Число
  • min
    Описание:
    Минимальное значение (только для number)
    Тип данных: Дробное число
  • max
    Описание:
    Максимальное значение (только для number)
    Тип данных: Дробное число
indoortv.playlists.add

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.playlists.list

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.playlists.edit

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.playlists.remove

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.playlists.get

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.schedule.add

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.schedule.edit

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.schedule.remove

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.schedule.list

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.schedule.get

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.chat.send

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.anouncements.add

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.anouncements.list

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.anouncements.remove

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.anouncements.edit

Описание: Добавить плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.music.playlists.list

Описание: Список музыкальных плейлистов
Входящие переменные:
Возвращаемые параметры:
indoortv.music.playlists.add

Описание: Добавить музыкальный плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.music.playlists.edit

Описание: Редактировать музыкальный плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.music.playlists.remove

Описание: Удалить музыкальный плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.music.playlists.get

Описание: Получить музыкальный плейлист
Входящие переменные:
Возвращаемые параметры:
indoortv.layouts.list

Описание: Получить список шаблонов
Входящие переменные:
Возвращаемые параметры:
indoortv.devices.list

Описание: Список экранов клуба
Входящие переменные:
Возвращаемые параметры:
indoortv.devices.update

Описание: Привязка экрана: Indoor TV, зона, имя
Входящие переменные:
Возвращаемые параметры:
polls.grid

Описание: Grid опросов с фильтрами
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба (опционально, используется если не указан фильтр clubs)
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив объектов опросов
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
polls.add

Описание: Создать опрос
Входящие переменные:
• club_ids обязательно
  Описание:
  Массив идентификаторов клубов
  Допустимый тип данных: Массив строк
• title обязательно
  Описание:
  Заголовок опроса
  Допустимый тип данных: Строка
• description
  Описание:
  Описание опроса
  Допустимый тип данных: Строка
• completion_message
  Описание:
  Сообщение после завершения
  Допустимый тип данных: Строка
• status
  Описание:
  Включен/выключен
  Допустимый тип данных: Логическое выражение
• start_ts
  Описание:
  Unix timestamp начала (int или null)
• end_ts
  Описание:
  Unix timestamp окончания (int или null)
• blocks
  Описание:
  Массив блоков опроса
  Допустимый тип данных: Массив (любые типы внутри)
• display_conditions
  Описание:
  Условия показа опроса
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
polls.edit

Описание: Редактировать опрос
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Массив идентификаторов клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок опроса
  Допустимый тип данных: Строка
• description
  Описание:
  Описание опроса
  Допустимый тип данных: Строка
• completion_message
  Описание:
  Сообщение после завершения
  Допустимый тип данных: Строка
• status
  Описание:
  Включен/выключен
  Допустимый тип данных: Логическое выражение
• start_ts
  Описание:
  Unix timestamp начала (int или null)
• end_ts
  Описание:
  Unix timestamp окончания (int или null)
• blocks
  Описание:
  Массив блоков опроса
  Допустимый тип данных: Массив (любые типы внутри)
• display_conditions
  Описание:
  Условия показа опроса
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
polls.remove

Описание: Удалить опрос
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
polls.get

Описание: Получить опрос по ID
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• club_ids
  Тип данных: Массив строк
• clubs
  Тип данных: Массив строк
• title
  Тип данных: Строка
• description
  Тип данных: Строка
• completion_message
  Тип данных: Строка
• status
  Тип данных: Логическое выражение
• start_ts
  Тип данных: Число
• end_ts
  Тип данных: Число
• blocks
  Тип данных: Массив (любые типы внутри)
• display_conditions
  Тип данных: Объект
• created_ts
  Тип данных: Число
• updated_ts
  Тип данных: Число
polls.responses

Описание: Получить ответы на опрос
Входящие переменные:
• poll_id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
• poll
  Тип данных: Объект
polls.stats

Описание: Получить статистику по опросу
Входящие переменные:
• poll_id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• total_responses
  Тип данных: Число
• blocks
  Тип данных: Массив объектов
polls.export

Описание: Экспорт результатов опроса в Excel
Входящие переменные:
• poll_id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• exported
  Тип данных: Логическое выражение
• url
  Тип данных: Строка
polls.clientList

Описание: Получить актуальный опрос для пользователя
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• user_type
  Описание:
  Тип пользователя: client или employee (по умолчанию client)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• poll
  Описание:
  Объект опроса или null если нет доступных
  Тип данных: Возможно несколько типов:
polls.clientGet

Описание: Получить конфигурацию опроса для отображения
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• title
  Тип данных: Строка
• description
  Тип данных: Строка
• completion_message
  Тип данных: Строка
• blocks
  Тип данных: Массив (любые типы внутри)
• allow_decline
  Тип данных: Логическое выражение
polls.clientSubmit

Описание: Отправить ответы на опрос
Входящие переменные:
• poll_id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• answers обязательно
  Описание:
  Массив ответов [{block_id, value}]
  Допустимый тип данных: Массив (любые типы внутри)
• shown_block_ids
  Описание:
  ID реально показанных блоков (для опросов с ветвлениями)
  Допустимый тип данных: Массив (любые типы внутри)
Возвращаемые параметры:
• success
  Тип данных: Логическое выражение
• completion_message
  Тип данных: Строка
polls.clientDecline

Описание: Отказаться от прохождения опроса
Входящие переменные:
• poll_id обязательно
  Описание:
  Идентификатор опроса
  Допустимый тип данных: Строка
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• success
  Тип данных: Логическое выражение
note_tags.add

Описание: Добавление тега для комментариев клиентов
Входящие переменные:
• name
  Описание:
  Название тега
  Допустимый тип данных: Строка
• color
  Описание:
  Цвет тега (hex код, по умолчанию #007bff)
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Массив ID клубов для тега (обязательно для не-админов)
  Допустимый тип данных: Массив (любые типы внутри)
• system
  Описание:
  Системный ли тег (только для админов)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• tag_id
  Описание:
  ID созданного тега
  Тип данных: Строка
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
note_tags.edit

Описание: Редактирование тега для комментариев клиентов
Входящие переменные:
• tag_id
  Описание:
  ID редактируемого тега
  Допустимый тип данных: Строка
• name
  Описание:
  Новое название тега
  Допустимый тип данных: Строка
• color
  Описание:
  Новый цвет тега (hex код)
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Новый массив ID клубов для тега
  Допустимый тип данных: Массив (любые типы внутри)
• system
  Описание:
  Системный ли тег (только для админов)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
note_tags.remove

Описание: Удаление тега для комментариев клиентов
Входящие переменные:
• tag_id
  Описание:
  ID удаляемого тега
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
note_tags.hide

Описание: Скрытие системного тега для комментариев клиентов
Входящие переменные:
• tag_id
  Описание:
  ID скрываемого системного тега
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба, для которого скрывается тег
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
note_tags.list

Описание: Список тегов для комментариев клиентов с подробной информацией
Входящие переменные:
• club_id
  Описание:
  ID клуба для получения тегов
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив тегов с полной информацией (id, name, color, club_ids, system, created_by, created_ts)
  Тип данных: Массив (любые типы внутри)
note_tags.list_simple

Описание: Простой список тегов для комментариев клиентов (только ID и название)
Входящие переменные:
• club_id
  Описание:
  ID клуба для получения тегов
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив тегов с базовой информацией (id, name)
  Тип данных: Массив (любые типы внутри)
note_tags.grid

Описание: Список тегов для Grid компонента с поддержкой фильтрации, сортировки и пагинации
Входящие переменные:
• club_id
  Описание:
  ID клуба для получения тегов
  Допустимый тип данных: Строка
• filters
  Описание:
  Объект фильтров (search, system)
  Допустимый тип данных: Объект
• order
  Описание:
  Объект сортировки (field, direction)
  Допустимый тип данных: Объект
• limit
  Описание:
  Лимит записей на страницу
  Допустимый тип данных: Число
• skip
  Описание:
  Количество записей для пропуска (offset)
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Массив тегов с полной информацией
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество записей
  Тип данных: Число
• skip
  Описание:
  Текущий offset
  Тип данных: Число
• limit
  Описание:
  Текущий лимит
  Тип данных: Число
note_tags.get

Описание: Получение одного тега по ID
Входящие переменные:
• tag_id
  Описание:
  ID тега
  Допустимый тип данных: Строка
Возвращаемые параметры:
• item
  Описание:
  Объект тега с полной информацией
  Тип данных: Объект
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
notify_providers.add

Описание: Добавить провайдера уведомлений для клуба
Входящие переменные:
• club_ids обязательно
  Описание:
  Массив идентификаторов клубов
  Допустимый тип данных: Массив строк
• name обязательно
  Описание:
  Название провайдера
  Допустимый тип данных: Строка
• channel_type обязательно
  Описание:
  Тип канала: sms, whatsapp, email, telegram_bot, telegram_auth
  Допустимый тип данных: Строка
• provider_name обязательно
  Описание:
  Имя провайдера: smsaero, twilio, 360dialog, smtp и т.д.
  Допустимый тип данных: Строка
• is_active
  Описание:
  Активен ли провайдер
  Допустимый тип данных: Логическое выражение
• is_default
  Описание:
  Провайдер по умолчанию для данного типа канала
  Допустимый тип данных: Логическое выражение
• priority
  Описание:
  Приоритет (меньше = выше приоритет)
  Допустимый тип данных: Число
• purposes
  Описание:
  Назначения: auth_code, notifications, marketing, transactional
  Допустимый тип данных: Массив строк
• credentials
  Описание:
  Учетные данные провайдера
  Допустимый тип данных: Объект
• sender_config
  Описание:
  Настройки отправителя: from, from_email, from_name, reply_to
  Допустимый тип данных: Объект
• routing
  Описание:
  Настройки маршрутизации: phone_prefixes, countries, exclude_prefixes
  Допустимый тип данных: Объект
• limits
  Описание:
  Лимиты: daily_limit, hourly_limit, rate_limit_per_second
  Допустимый тип данных: Объект
• features
  Описание:
  Функции: supports_templates, supports_voice, supports_unicode
  Допустимый тип данных: Объект
• templates
  Описание:
  Шаблоны сообщений для провайдера
  Допустимый тип данных: Объект
• system
  Описание:
  Системный провайдер (только для triderole=100)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• provider_id
  Тип данных: Строка
notify_providers.get

Описание: Получить провайдера уведомлений по ID
Входящие переменные:
• provider_id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
Возвращаемые параметры:
notify_providers.list

Описание: Получить список провайдеров уведомлений клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• channel_type
  Описание:
  Фильтр по типу канала
  Допустимый тип данных: Строка
• is_active
  Описание:
  Фильтр по активности
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
notify_providers.grid

Описание: Получить Grid-совместимый список провайдеров уведомлений
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка { field, order }
  Допустимый тип данных: Объект
• filters
  Описание:
  Фильтры Grid
  Допустимый тип данных: Объект
• include_system
  Описание:
  Включать системные провайдеры (только для triderole=100)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
notify_providers.edit

Описание: Редактировать провайдера уведомлений
Входящие переменные:
• provider_id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
• name
  Описание:
  Название провайдера
  Допустимый тип данных: Строка
• is_active
  Описание:
  Активен ли провайдер
  Допустимый тип данных: Логическое выражение
• is_default
  Описание:
  Провайдер по умолчанию
  Допустимый тип данных: Логическое выражение
• priority
  Описание:
  Приоритет
  Допустимый тип данных: Число
• purposes
  Описание:
  Назначения
  Допустимый тип данных: Массив строк
• credentials
  Описание:
  Учетные данные провайдера
  Допустимый тип данных: Объект
• sender_config
  Описание:
  Настройки отправителя
  Допустимый тип данных: Объект
• routing
  Описание:
  Настройки маршрутизации
  Допустимый тип данных: Объект
• limits
  Описание:
  Лимиты
  Допустимый тип данных: Объект
• features
  Описание:
  Функции
  Допустимый тип данных: Объект
• templates
  Описание:
  Шаблоны
  Допустимый тип данных: Объект
• club_ids
  Описание:
  Новые клубы для провайдера
  Допустимый тип данных: Массив строк
• system
  Описание:
  Системный провайдер (только для triderole=100)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
notify_providers.remove

Описание: Удалить провайдера уведомлений
Входящие переменные:
• provider_id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
notify_providers.set_default

Описание: Установить провайдера уведомлений по умолчанию
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• provider_id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
notify_providers.test

Описание: Тестовая отправка через провайдера уведомлений
Входящие переменные:
• provider_id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
• recipient обязательно
  Описание:
  Получатель (телефон, email, telegram_id в зависимости от типа провайдера)
  Допустимый тип данных: Строка
• message
  Описание:
  Тестовое сообщение
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• external_id
  Тип данных: Строка
• status
  Тип данных: Строка
notify_providers.stats

Описание: Получить статистику использования провайдера уведомлений
Входящие переменные:
• provider_id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
Возвращаемые параметры:
notify_providers.options

Описание: Получить доступные типы каналов и провайдеров
Входящие переменные:
Возвращаемые параметры:
• channel_types
  Тип данных: Массив строк
• provider_names
  Тип данных: Объект
• purposes
  Тип данных: Массив строк
notify_templates.add

Описание: Добавить шаблон уведомления для клуба
Входящие переменные:
• club_ids обязательно
  Описание:
  Массив идентификаторов клубов
  Допустимый тип данных: Массив строк
• notification_type обязательно
  Описание:
  Тип уведомления из реестра (membership_activated, booking_reminder и т.д.)
  Допустимый тип данных: Строка
• channel обязательно
  Описание:
  Канал отправки: email, sms, whatsapp, push, telegram
  Допустимый тип данных: Строка
• name
  Описание:
  Название шаблона
  Допустимый тип данных: Строка
• description
  Описание:
  Описание шаблона
  Допустимый тип данных: Строка
• content обязательно
  Описание:
  Контент шаблона {ru: {subject, body, push_title, push_body}, en: {...}}
  Допустимый тип данных: Объект
• send_settings
  Описание:
  Настройки отправки {enabled, priority, delay_seconds, retry_count, fallback_channel}
  Допустимый тип данных: Объект
• custom_params
  Описание:
  Дополнительные параметры
  Допустимый тип данных: Объект
• status
  Описание:
  Статус шаблона: active, inactive, draft
  Допустимый тип данных: Строка
• system
  Описание:
  Системный шаблон (только для triderole=100)
  Допустимый тип данных: Логическое выражение
• allow_duplicate
  Описание:
  Разрешить создание дубликата шаблона
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• template_id
  Тип данных: Строка
notify_templates.get

Описание: Получить шаблон уведомления по ID
Входящие переменные:
• template_id обязательно
  Описание:
  Идентификатор шаблона
  Допустимый тип данных: Строка
Возвращаемые параметры:
notify_templates.list

Описание: Получить список шаблонов уведомлений клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• category
  Описание:
  Фильтр по категории
  Допустимый тип данных: Строка
• channel
  Описание:
  Фильтр по каналу
  Допустимый тип данных: Строка
• notification_type
  Описание:
  Фильтр по типу уведомления
  Допустимый тип данных: Строка
• status
  Описание:
  Фильтр по статусу
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
notify_templates.grid

Описание: Получить Grid-совместимый список шаблонов уведомлений
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка { field, order }
  Допустимый тип данных: Объект
• filters
  Описание:
  Фильтры Grid
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
notify_templates.edit

Описание: Редактировать шаблон уведомления
Входящие переменные:
• template_id обязательно
  Описание:
  Идентификатор шаблона
  Допустимый тип данных: Строка
• name
  Описание:
  Название шаблона
  Допустимый тип данных: Строка
• description
  Описание:
  Описание
  Допустимый тип данных: Строка
• content
  Описание:
  Контент шаблона
  Допустимый тип данных: Объект
• send_settings
  Описание:
  Настройки отправки
  Допустимый тип данных: Объект
• custom_params
  Описание:
  Дополнительные параметры
  Допустимый тип данных: Объект
• status
  Описание:
  Статус
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Новые клубы для шаблона
  Допустимый тип данных: Массив строк
• system
  Описание:
  Системный шаблон (только для triderole=100)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
notify_templates.remove

Описание: Удалить шаблон уведомления
Входящие переменные:
• template_id обязательно
  Описание:
  Идентификатор шаблона
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• action
  Тип данных: Строка
notify_templates.clone

Описание: Клонировать системный шаблон для персонализации клубом
Входящие переменные:
• template_id обязательно
  Описание:
  Идентификатор исходного шаблона
  Допустимый тип данных: Строка
• club_id обязательно
  Описание:
  Идентификатор клуба для персонализации
  Допустимый тип данных: Строка
• name
  Описание:
  Название нового шаблона (опционально)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• template_id
  Тип данных: Строка
notify_templates.types

Описание: Получить список типов уведомлений для UI
Входящие переменные:
• locale
  Описание:
  Локаль (ru, en)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• types
  Тип данных: Массив объектов
• categories
  Тип данных: Массив объектов
• channels
  Тип данных: Массив объектов
notify_templates.preview

Описание: Предпросмотр шаблона с тестовыми данными
Входящие переменные:
• template_id обязательно
  Описание:
  Идентификатор шаблона
  Допустимый тип данных: Строка
• locale
  Описание:
  Локаль (ru, en)
  Допустимый тип данных: Строка
• test_params
  Описание:
  Тестовые параметры для подстановки
  Допустимый тип данных: Объект
Возвращаемые параметры:
• preview
  Тип данных: Объект
• params_used
  Тип данных: Объект
• available_params
  Тип данных: Объект
notify_templates.options

Описание: Получить доступные опции для шаблонов
Входящие переменные:
Возвращаемые параметры:
• statuses
  Тип данных: Массив строк
• categories
  Тип данных: Объект
• channels
  Тип данных: Объект
• purposes
  Тип данных: Объект
goods.list

Описание: Получить список товаров клуба
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив товаров
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
goods.get

Описание: Получить товар по ID
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор товара
  Допустимый тип данных: Строка
Возвращаемые параметры:
goods.add

Описание: Создать новый товар
Входящие переменные:
• name обязательно
  Описание:
  Название товара
  Допустимый тип данных: Строка
• club_ids
  Описание:
  ID клубов
  Допустимый тип данных: Массив строк
• category_ids обязательно
  Описание:
  ID категорий
  Допустимый тип данных: Массив строк
• type
  Описание:
  Тип товара: retail, merchandise, consumable
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  ID созданного товара
  Тип данных: Строка
goods.edit

Описание: Редактировать товар
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор товара
  Допустимый тип данных: Строка
Возвращаемые параметры:
goods.remove

Описание: Удалить товар
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор товара
  Допустимый тип данных: Строка
Возвращаемые параметры:
goods.adjustStock

Описание: Изменить количество товара на складе
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор товара
  Допустимый тип данных: Строка
• quantity обязательно
  Описание:
  Количество (может быть отрицательным)
  Допустимый тип данных: Число
• type
  Описание:
  Тип операции: adjustment, sale, return, restock
  Допустимый тип данных: Строка
• reason
  Описание:
  Причина изменения
  Допустимый тип данных: Строка
• location_id
  Описание:
  ID локации
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.list

Описание: Получить список инвентаря для аренды
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив инвентаря
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
inventory.get

Описание: Получить инвентарь по ID
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.add

Описание: Создать новый инвентарь для аренды
Входящие переменные:
• name обязательно
  Описание:
  Название инвентаря
  Допустимый тип данных: Строка
• club_ids
  Описание:
  ID клубов
  Допустимый тип данных: Массив строк
• category_ids обязательно
  Описание:
  ID категорий
  Допустимый тип данных: Массив строк
• type
  Описание:
  Тип: rental, equipment
  Допустимый тип данных: Строка
• rental_price
  Описание:
  Цена аренды
  Допустимый тип данных: Дробное число в строке всегда с 2 знаками после запятой
Возвращаемые параметры:
• id
  Описание:
  ID созданного инвентаря
  Тип данных: Строка
inventory.edit

Описание: Редактировать инвентарь
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.remove

Описание: Удалить инвентарь
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.units.list

Описание: Получить список единиц инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• status
  Описание:
  Фильтр по статусу
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.units.add

Описание: Добавить единицу инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• unit_number
  Описание:
  Номер единицы
  Допустимый тип данных: Строка
• serial_number
  Описание:
  Серийный номер
  Допустимый тип данных: Строка
• condition
  Описание:
  Состояние
  Допустимый тип данных: Строка
• notes
  Описание:
  Заметки
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.units.edit

Описание: Редактировать единицу инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• unit_id обязательно
  Описание:
  Идентификатор единицы
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.units.status

Описание: Изменить статус единицы инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• unit_id обязательно
  Описание:
  Идентификатор единицы
  Допустимый тип данных: Строка
• status обязательно
  Описание:
  Новый статус: available, maintenance, retired
  Допустимый тип данных: Строка
• notes
  Описание:
  Заметки
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.units.remove

Описание: Удалить единицу инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• unit_id обязательно
  Описание:
  Идентификатор единицы
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.units.history

Описание: История аренд единицы инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• unit_id обязательно
  Описание:
  Идентификатор единицы
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
Возвращаемые параметры:
inventory.rent

Описание: Арендовать единицу инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• unit_id обязательно
  Описание:
  Идентификатор единицы
  Допустимый тип данных: Строка
• user_id обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Строка
• start_date
  Описание:
  Дата начала аренды
  Допустимый тип данных: Дата в формате ISO
• end_date
  Описание:
  Дата окончания аренды
  Допустимый тип данных: Дата в формате ISO
Возвращаемые параметры:
inventory.return

Описание: Вернуть единицу инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• unit_id обязательно
  Описание:
  Идентификатор единицы
  Допустимый тип данных: Строка
• return_date
  Описание:
  Дата возврата
  Допустимый тип данных: Дата в формате ISO
• condition
  Описание:
  Состояние при возврате
  Допустимый тип данных: Строка
• damages
  Описание:
  Описание повреждений
  Допустимый тип данных: Строка
Возвращаемые параметры:
inventory.available

Описание: Получить доступные единицы на период
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• start_date обязательно
  Описание:
  Дата начала периода
  Допустимый тип данных: Дата в формате ISO
• end_date обязательно
  Описание:
  Дата окончания периода
  Допустимый тип данных: Дата в формате ISO
Возвращаемые параметры:
inventory.rentalHistory

Описание: История аренд инвентаря
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор инвентаря
  Допустимый тип данных: Строка
• page
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
• status
  Допустимый тип данных: Строка
• date_from
  Допустимый тип данных: Дата в формате ISO
• date_to
  Допустимый тип данных: Дата в формате ISO
Возвращаемые параметры:
products.dashboard

Описание: Получить статистику продуктов для дашборда
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
products.list

Описание: Получиьь список продуктов в клубе
Входящие переменные:
Возвращаемые параметры:
products.categories.list

Описание: Получить список категорий продуктов
Входящие переменные:
Возвращаемые параметры:
products.categories.list.public

Описание: Получиьь список продуктов в клубе
Входящие переменные:
Возвращаемые параметры:
products.list.public

Описание: Получиьь список продуктов в клубе
Входящие переменные:
Возвращаемые параметры:
products.remove

Описание: Получиьь список продуктов в клубе
Входящие переменные:
Возвращаемые параметры:
products.get

Описание: Получиьь список продуктов в клубе
Входящие переменные:
Возвращаемые параметры:
products.edit

Описание: Получиьь список продуктов в клубе
Входящие переменные:
Возвращаемые параметры:
products.add

Описание: Получиьь список продуктов в клубе
Входящие переменные:
Возвращаемые параметры:
products.categories.add

Описание: Добавить категорию продуктов
Входящие переменные:
Возвращаемые параметры:
products.categories.edit

Описание: Редактировать категорию продуктов
Входящие переменные:
Возвращаемые параметры:
products.categories.remove

Описание: Удалить категорию продуктов
Входящие переменные:
Возвращаемые параметры:
products.categories.get

Описание: Получить категорию продуктов
Входящие переменные:
Возвращаемые параметры:
products.categories.tree

Описание: Получить дерево категорий
Входящие переменные:
Возвращаемые параметры:
products.categories.move

Описание: Переместить категорию
Входящие переменные:
Возвращаемые параметры:
products.categories.reorder

Описание: Изменить порядок категорий
Входящие переменные:
Возвращаемые параметры:
packages.list

Описание: Получить список пакетов клуба
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив пакетов
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
packages.get

Описание: Получить пакет по ID
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор пакета
  Допустимый тип данных: Строка
Возвращаемые параметры:
packages.add

Описание: Создать новый пакет
Входящие переменные:
Возвращаемые параметры:
• id
  Описание:
  ID созданного пакета
  Тип данных: Строка
packages.edit

Описание: Редактировать пакет
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор пакета
  Допустимый тип данных: Строка
Возвращаемые параметры:
packages.remove

Описание: Удалить пакет
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор пакета
  Допустимый тип данных: Строка
Возвращаемые параметры:
memberships.list

Описание: Получить список членств клуба
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив членств
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
memberships.get

Описание: Получить членство по ID
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор членства
  Допустимый тип данных: Строка
Возвращаемые параметры:
memberships.add

Описание: Создать новое членство
Входящие переменные:
Возвращаемые параметры:
• id
  Описание:
  ID созданного членства
  Тип данных: Строка
memberships.edit

Описание: Редактировать членство
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор членства
  Допустимый тип данных: Строка
Возвращаемые параметры:
memberships.remove

Описание: Удалить членство
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор членства
  Допустимый тип данных: Строка
Возвращаемые параметры:
products.assist

Описание: AI помощник для редактирования продуктов (членств/пакетов)
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• prompt обязательно
  Описание:
  Запрос пользователя для изменения продукта
  Допустимый тип данных: Строка
• product обязательно
  Описание:
  Текущее состояние продукта
  Допустимый тип данных: Объект
• product_type
  Описание:
  Тип продукта: membership или package
  Допустимый тип данных: Строка
Возвращаемые параметры:
• changes
  Описание:
  Изменения для применения к продукту
  Тип данных: Объект
• error
  Описание:
  Код ошибки если что-то пошло не так
  Тип данных: Строка
products.generateDescription

Описание: Генерация описания продукта на основе его параметров
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• product обязательно
  Описание:
  Данные продукта
  Допустимый тип данных: Объект
• product_type
  Описание:
  Тип продукта: membership или package
  Допустимый тип данных: Строка
• style
  Описание:
  Стиль описания: marketing, technical, short
  Допустимый тип данных: Строка
Возвращаемые параметры:
• description
  Описание:
  Сгенерированное описание с полями title, short_description, full_description, features
  Тип данных: Объект
• error
  Описание:
  Код ошибки если что-то пошло не так
  Тип данных: Строка
products.maplist

Описание: Список продуктов (компактно) с внешними ID для сопоставления
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• product_type
  Описание:
  Фильтр по типу продукта (membership, package, good)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список продуктов
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID продукта
    Тип данных: Строка
  • name
    Описание:
    Название продукта
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов: Число, Строка
  • product_type
    Описание:
    Тип продукта
    Тип данных: Строка
  • status
    Описание:
    Статус активности
    Тип данных: Логическое выражение
  • price
    Описание:
    Цена
    Тип данных: Строка
products.mapsave

Описание: Сохранить соответствия внешних ID для продуктов (bulk)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• mappings
  Описание:
  Массив соответствий {id, external_id}
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID продукта
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов: Число, Строка
Возвращаемые параметры:
• saved
  Описание:
  Статус сохранения
  Тип данных: Логическое выражение
• updated
  Описание:
  Количество обновлённых записей
  Тип данных: Число
prolongationProducts.list

Описание: Список продуктов, доступных для выбора в product_relations (продление, обязательные, исключающие)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• exclude_id
  Описание:
  ID продукта, который нужно исключить из списка
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список продуктов
  Тип данных: Массив объектов
memberships.zones.list

Описание: Список зон клуба для выбора в accessible_zones членства/пакета
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список зон
  Тип данных: Массив объектов
products.calculatePrice

Описание: Расчёт итоговой стоимости продукта с учётом скидок, промокода и прочих модификаторов
Входящие переменные:
• product_id обязательно
  Описание:
  ID продукта
  Допустимый тип данных: Строка
• user_id
  Описание:
  ID клиента (для персональных скидок)
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• promocode
  Описание:
  Промокод
  Допустимый тип данных: Строка
• quantity
  Описание:
  Количество единиц
  Допустимый тип данных: Число
Возвращаемые параметры:
• final_price
  Описание:
  Итоговая цена
  Тип данных: Дробное число в строке
• original_price
  Описание:
  Базовая цена
  Тип данных: Дробное число в строке
• discount_amount
  Описание:
  Сумма скидки
  Тип данных: Дробное число в строке
• discount_percent
  Описание:
  Процент скидки
  Тип данных: Дробное число
products.categories.maplist

Описание: Список категорий продуктов (компактно) с внешними ID для сопоставления
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список категорий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID категории
    Тип данных: Строка
  • name
    Описание:
    Название категории
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов: Число, Строка
  • type
    Описание:
    Тип категории
    Тип данных: Строка
products.categories.mapsave

Описание: Сохранить соответствия внешних ID для категорий продуктов (bulk)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• mappings
  Описание:
  Массив соответствий {id, external_id}
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID категории
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов: Число, Строка
Возвращаемые параметры:
• saved
  Описание:
  Статус сохранения
  Тип данных: Логическое выражение
• updated
  Описание:
  Количество обновлённых записей
  Тип данных: Число
purchases.list

Описание: Список клиентских тегов в клубе
Входящие переменные:
Возвращаемые параметры:
purchases.make

Описание: Оформление покупки продукта в магазине
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• product_id обязательно
  Описание:
  Идентификатор продукта
  Допустимый тип данных: Строка
• referer
  Описание:
  URL для возврата после оплаты
  Допустимый тип данных: Строка
• promo_code
  Описание:
  Код промокода (опционально)
  Допустимый тип данных: Строка
• gift
  Описание:
  Данные подарочного сертификата (опционально)
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Описание:
  Успешность операции
  Тип данных: Логическое выражение
• url
  Описание:
  URL для оплаты
  Тип данных: Строка
• order_id
  Описание:
  ID заказа
  Тип данных: Строка
• external
  Описание:
  Внешняя оплата
  Тип данных: Логическое выражение
purchases.cancel

Описание: Отмена членства/подписки пользователя
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• purchase_id обязательно
  Описание:
  Идентификатор членства (membership_id)
  Допустимый тип данных: Строка
• reason
  Описание:
  Причина отмены
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешность операции
  Тип данных: Логическое выражение
• membership_id
  Описание:
  ID отменённого членства
  Тип данных: Строка
• status
  Описание:
  Новый статус
  Тип данных: Строка
• refund_amount
  Описание:
  Сумма возврата
  Тип данных: Строка
• cancellation_fee
  Описание:
  Штраф за отмену
  Тип данных: Строка
payee.info.get

Описание: Получение информации о получателе платежа
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• payee_type
  Описание:
  Тип получателя: platform, direct, external, club
  Тип данных: Строка
• payee_name
  Описание:
  Полное наименование получателя
  Тип данных: Строка
• payee_short
  Описание:
  Короткое имя получателя для текста согласия
  Тип данных: Строка
• payee_details
  Описание:
  Реквизиты получателя платежа
  Тип данных: Объект
purchases.check_external_status

Описание: Проверка статуса внешней покупки после закрытия платёжного окна
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• order_id
  Описание:
  Идентификатор заказа (опционально)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешность операции
  Тип данных: Логическое выражение
• status
  Описание:
  Статус: purchased, pending, no_integration
  Тип данных: Строка
• has_new_purchase
  Описание:
  Есть ли новая покупка
  Тип данных: Логическое выражение
• purchase
  Описание:
  Информация о покупке
  Тип данных: Объект
sessions.competition.top

Описание: Последние занятия клиента
Входящие переменные:
Возвращаемые параметры:
clients.last.sessions

Описание: Последние занятия клиента
Входящие переменные:
Возвращаемые параметры:
clients.upcoming.sessions

Описание: Ближайшие занятия клиента
Входящие переменные:
Возвращаемые параметры:
employee.last.sessions

Описание: Последние занятия сотрудника
Входящие переменные:
Возвращаемые параметры:
employee.upcoming.sessions

Описание: Ближайшие занятия сотрудника
Входящие переменные:
Возвращаемые параметры:
sessions.photos.add

Описание: Добавить фото в тренировку
Входящие переменные:
• session_id
  Допустимый тип данных: Строка
• sport_type
  Допустимый тип данных: Число
• fileid
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.photos.list

Описание: Список фото в тренировке
Входящие переменные:
• session_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.like

Описание: Поставить/снять лайк к занятию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• liked
  Описание:
  Текущее состояние лайка (true - лайкнуто, false - не лайкнуто)
  Тип данных: Логическое выражение
• likes_count
  Описание:
  Общее количество лайков к занятию
  Тип данных: Число
• id
  Описание:
  Идентификатор занятия
  Тип данных: Строка
sessions.likes.status

Описание: Получить статус лайков занятия (легковесный метод для polling)
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• liked
  Описание:
  Лайкнул ли текущий пользователь
  Тип данных: Логическое выражение
• likes_count
  Описание:
  Общее количество лайков к занятию
  Тип данных: Число
• session_id
  Описание:
  Идентификатор занятия
  Тип данных: Строка
sessions.rate

Описание: Поставить оценку занятию и/или тренеру (1..5)
Входящие переменные:
• session_id обязательно
  Допустимый тип данных: Строка
• rate_session
  Описание:
  Оценка занятия 1..5
  Допустимый тип данных: Число
• rate_coach
  Описание:
  Оценка тренера 1..5
  Допустимый тип данных: Число
• coach_id
  Описание:
  UID тренера (для оценки тренера)
  Допустимый тип данных: Число
Возвращаемые параметры:
sessions.comments.add

Описание: Добавить комментарий к занятию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор занятия
  Допустимый тип данных: Строка
• text обязательно
  Описание:
  Текст комментария
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор созданного комментария
  Тип данных: Строка
• created_ts
  Описание:
  Unix timestamp создания комментария
  Тип данных: Число
sessions.comments.remove

Описание: Удалить комментарий к занятию (автор, тренер занятия или сотрудник с правами schedule:editall/sessions:controlall)
Входящие переменные:
• comment_id обязательно
  Описание:
  Идентификатор комментария
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  Результат удаления
  Тип данных: Логическое выражение
sessions.comments.list

Описание: Список комментариев к занятию с пагинацией
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор занятия
  Допустимый тип данных: Строка
• skip
  Описание:
  Пропустить N записей (для пагинации)
  Допустимый тип данных: Число
• limit
  Описание:
  Количество записей на страницу (макс 100, по умолчанию 20)
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Массив комментариев. Каждый объект: {id: string, text: string, created_ts: int, uid: int, user: {uid: int, firstname: string, lastname: string, nickname: string, avatar: string}}
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество комментариев
  Тип данных: Число
• skip
  Описание:
  Количество пропущенных записей
  Тип данных: Число
• limit
  Описание:
  Лимит записей на страницу
  Тип данных: Число
sessions.restore

Описание: Восстановить удаленное занятие
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• restored
  Тип данных: Логическое выражение
sessions.feed

Описание: Лента занятий для сотрудников (в обратном хронологическом порядке)
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• skip
  Описание:
  Пропустить N записей (для пагинации)
  Допустимый тип данных: Число
• limit
  Описание:
  Количество записей на страницу (макс 100, по умолчанию 20)
  Допустимый тип данных: Число
• filters
  Описание:
  Фильтры (sport_types, session_types, coach_ids, show_removed)
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив занятий. Каждый объект содержит: id, name, planned_start_ts, duration, sport_types, started, finished, ready, coaches, participants_total, participants_registered, participants_present, prep_time, actual_duration, photos, likes_count, comments_count
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество занятий
  Тип данных: Число
• skip
  Описание:
  Количество пропущенных записей
  Тип данных: Число
• limit
  Описание:
  Лимит записей на страницу
  Тип данных: Число
schedule.list.public

Описание: Публичное расписание занятий для клиентов
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• start_ts
  Описание:
  Начало периода (unix timestamp)
  Допустимый тип данных: Число
• end_ts
  Описание:
  Конец периода (unix timestamp)
  Допустимый тип данных: Число
• session_types
  Описание:
  Массив ID видов занятий для фильтрации
  Допустимый тип данных: Массив строк
• coach_ids
  Описание:
  Массив ID тренеров для фильтрации
  Допустимый тип данных: Массив чисел
• zone_ids
  Описание:
  Массив ID зон для фильтрации
  Допустимый тип данных: Массив строк
• limit
  Описание:
  Ограничение количества результатов
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Массив занятий с полной информацией для отображения в клиентском расписании
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество занятий
  Тип данных: Число
• coaches
  Описание:
  Список доступных тренеров
  Тип данных: Массив объектов
• session_types
  Описание:
  Список видов занятий
  Тип данных: Массив объектов
• zones
  Описание:
  Список зон
  Тип данных: Массив объектов
sessiontypes.add

Описание: Добавить вид занятия
Входящие переменные:
• name
  Описание:
  Название занятия
  Допустимый тип данных: Строка
• description
  Описание:
  Описание занятия
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
  Допустимый тип данных: Число
• minutes
  Описание:
  Минуты занятия
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Описание:
  ID типа занятия
  Тип данных: Строка
• name
  Описание:
  Название занятия
  Тип данных: Строка
• description
  Описание:
  Описание занятия
  Тип данных: Строка
• sport_type
  Описание:
  Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
  Тип данных: Число
• minutes
  Описание:
  Минуты занятия
  Тип данных: Число
sessiontypes.grid

Описание: Grid list of session types with filters
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Список занятий
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
sessiontypes.listpublic

Описание: Список видов занятия
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• service_type
  Описание:
  Тип услуги (group_class, personal_training и др.)
  Допустимый тип данных: Строка
• schedule
  Описание:
  Отображение в расписании
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Описание:
  Список занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID типа занятия
    Тип данных: Строка
  • name
    Описание:
    Название занятия
    Тип данных: Строка
  • description
    Описание:
    Описание занятия
    Тип данных: Строка
  • sport_type
    Описание:
    Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
    Тип данных: Число
  • minutes
    Описание:
    Минуты занятия
    Тип данных: Число
sessiontypes.getpublic

Описание: Список видов занятия
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• id
  Описание:
  ID вида занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  ID типа занятия
  Тип данных: Строка
• name
  Описание:
  Название занятия
  Тип данных: Строка
• description
  Описание:
  Описание занятия
  Тип данных: Строка
• sport_type
  Описание:
  Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
  Тип данных: Число
• minutes
  Описание:
  Минуты занятия
  Тип данных: Число
sessiontypes.list.multiclub

Описание: Список видов занятия
Входящие переменные:
• club_ids
  Описание:
  массив ID клубов
  Допустимый тип данных: Массив (любые типы внутри)
Возвращаемые параметры:
• items
  Описание:
  Список занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID типа занятия
    Тип данных: Строка
  • name
    Описание:
    Название занятия
    Тип данных: Строка
  • description
    Описание:
    Описание занятия
    Тип данных: Строка
  • sport_type
    Описание:
    Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
    Тип данных: Число
  • minutes
    Описание:
    Минуты занятия
    Тип данных: Число
  • club_id
    Описание:
    ID клуба
    Тип данных: Строка
  • club_name
    Описание:
    Название клуба
    Тип данных: Строка
sessiontypes.list

Описание: Список видов занятия
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID типа занятия
    Тип данных: Строка
  • name
    Описание:
    Название занятия
    Тип данных: Строка
  • description
    Описание:
    Описание занятия
    Тип данных: Строка
  • sport_type
    Описание:
    Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
    Тип данных: Число
  • minutes
    Описание:
    Минуты занятия
    Тип данных: Число
sessiontypes.edit

Описание: Изменить вид занятия
Входящие переменные:
• id
  Описание:
  ID типа занятия
  Допустимый тип данных: Строка
• name
  Описание:
  Название занятия
  Допустимый тип данных: Строка
• description
  Описание:
  Описание занятия
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
  Допустимый тип данных: Число
• minutes
  Описание:
  Минуты занятия
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Описание:
  ID типа занятия
  Тип данных: Строка
• name
  Описание:
  Название занятия
  Тип данных: Строка
• description
  Описание:
  Описание занятия
  Тип данных: Строка
• sport_type
  Описание:
  Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
  Тип данных: Число
• minutes
  Описание:
  Минуты занятия
  Тип данных: Число
sessiontypes.remove

Описание: Удалить вид занятия
Входящие переменные:
• id
  Описание:
  ID типа занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  Статус удаления
  Тип данных: Логическое выражение
sessiontypes.get

Описание: Получить вид занятия
Входящие переменные:
• id
  Описание:
  ID типа занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  ID типа занятия
  Тип данных: Строка
• name
  Описание:
  Название занятия
  Тип данных: Строка
• description
  Описание:
  Описание занятия
  Тип данных: Строка
• sport_type
  Описание:
  Тип спорта: 1 - cycle, 2 - гребля, 3 - функциональный тренинг, 4 - бег
  Тип данных: Число
• minutes
  Описание:
  Минуты занятия
  Тип данных: Число
sessiontypes.maplist

Описание: Список видов занятия (компактно) с внешними ID
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID типа занятия
    Тип данных: Строка
  • name
    Описание:
    Название занятия
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Строка
sessiontypes.mapsave

Описание: Сохранить соответствия внешних ID для видов занятий (bulk)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• mappings
  Описание:
  Массив соответствий {id, external_id}
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID типа занятия
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов: Число, Строка
Возвращаемые параметры:
• saved
  Описание:
  Статус сохранения
  Тип данных: Логическое выражение
• updated
  Описание:
  Количество обновлённых записей
  Тип данных: Число
serviceproducts.create

Описание: Создать новую услугу (ServiceProduct)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• is_system
  Описание:
  Системная услуга
  Допустимый тип данных: Логическое выражение
• name
  Описание:
  Название услуги
  Допустимый тип данных: Строка
• description
  Описание:
  Описание
  Допустимый тип данных: Строка
• service_type
  Описание:
  Тип услуги (group_class, personal_training, spa, etc.)
  Допустимый тип данных: Строка
• category_ids
  Описание:
  ID категорий
  Допустимый тип данных: Массив строк
• sport_types
  Описание:
  Типы спорта
  Допустимый тип данных: Массив чисел
• order
  Описание:
  Порядок сортировки
  Допустимый тип данных: Число
• presentation
  Описание:
  Настройки презентации (цвета, иконка)
  Допустимый тип данных: Объект
• features
  Описание:
  Особенности (bootcamp, online, autostart, etc.)
  Допустимый тип данных: Объект
• duration
  Описание:
  Настройки длительности
  Допустимый тип данных: Объект
• pricing
  Описание:
  Настройки ценообразования
  Допустимый тип данных: Объект
• staff_requirements
  Описание:
  Требования к персоналу
  Допустимый тип данных: Объект
• resource_requirements
  Описание:
  Требования к ресурсам
  Допустимый тип данных: Объект
• capacity
  Описание:
  Вместимость
  Допустимый тип данных: Объект
• booking_settings
  Описание:
  Настройки бронирования
  Допустимый тип данных: Объект
• override_settings
  Описание:
  Настройки кастомизации
  Допустимый тип данных: Объект
• is_bookable
  Описание:
  Доступно для бронирования
  Допустимый тип данных: Логическое выражение
• is_featured
  Описание:
  Рекомендуемая услуга
  Допустимый тип данных: Логическое выражение
• status
  Описание:
  Статус (draft, active, inactive, archived)
  Допустимый тип данных: Строка
• media
  Описание:
  Медиа-файлы
  Допустимый тип данных: Массив объектов
• metadata
  Описание:
  Метаданные
  Допустимый тип данных: Объект
• tags
  Описание:
  Теги
  Допустимый тип данных: Массив строк
• difficulty_level
  Описание:
  Уровень сложности (1-10)
  Допустимый тип данных: Число
• benefits
  Описание:
  Преимущества
  Допустимый тип данных: Массив строк
• seo
  Описание:
  SEO метаданные
  Допустимый тип данных: Объект
• tride_platform_settings
  Описание:
  Настройки TRIDE платформы
  Допустимый тип данных: Объект
• access_restrictions
  Описание:
  Ограничения доступа
  Допустимый тип данных: Объект
• timezone
  Описание:
  Таймзона
  Допустимый тип данных: Строка
• associations
  Описание:
  Связи с продуктами
  Допустимый тип данных: Объект
• profile
  Описание:
  Профиль тренировки (workout_ids, video_ids)
  Допустимый тип данных: Объект
• availability_schedule
  Описание:
  Расписание доступности услуги
  Допустимый тип данных: Массив объектов
• personal_booking_settings
  Описание:
  Настройки индивидуальной записи
  Допустимый тип данных: Объект
Возвращаемые параметры:
• id
  Описание:
  ID созданной услуги
  Тип данных: Строка
• result
  Описание:
  Данные созданной услуги
  Тип данных: Объект
serviceproducts.update

Описание: Обновить услугу (ServiceProduct)
Входящие переменные:
• id
  Описание:
  ID услуги
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• is_system
  Описание:
  Системная услуга (только для triderole=100)
  Допустимый тип данных: Логическое выражение
• name
  Описание:
  Название услуги
  Допустимый тип данных: Строка
• description
  Описание:
  Описание
  Допустимый тип данных: Строка
• service_type
  Описание:
  Тип услуги (group_class, personal_training, spa, massage, consultation, other)
  Допустимый тип данных: Строка
• category_ids
  Описание:
  ID категорий
  Допустимый тип данных: Массив строк
• sport_types
  Описание:
  Типы спорта
  Допустимый тип данных: Массив чисел
• order
  Описание:
  Порядок сортировки
  Допустимый тип данных: Число
• presentation
  Описание:
  Настройки презентации
  Допустимый тип данных: Объект
• features
  Описание:
  Особенности
  Допустимый тип данных: Объект
• duration
  Описание:
  Настройки длительности
  Допустимый тип данных: Объект
• pricing
  Описание:
  Настройки ценообразования
  Допустимый тип данных: Объект
• staff_requirements
  Описание:
  Требования к персоналу
  Допустимый тип данных: Объект
• resource_requirements
  Описание:
  Требования к ресурсам
  Допустимый тип данных: Объект
• capacity
  Описание:
  Вместимость
  Допустимый тип данных: Объект
• booking_settings
  Описание:
  Настройки бронирования
  Допустимый тип данных: Объект
• override_settings
  Описание:
  Настройки кастомизации
  Допустимый тип данных: Объект
• is_bookable
  Описание:
  Доступно для бронирования
  Допустимый тип данных: Логическое выражение
• is_featured
  Описание:
  Рекомендуемая услуга
  Допустимый тип данных: Логическое выражение
• status
  Описание:
  Статус
  Допустимый тип данных: Строка
• media
  Описание:
  Медиа-файлы
  Допустимый тип данных: Массив объектов
• metadata
  Описание:
  Метаданные
  Допустимый тип данных: Объект
• tags
  Описание:
  Теги
  Допустимый тип данных: Массив строк
• difficulty_level
  Описание:
  Уровень сложности
  Допустимый тип данных: Число
• benefits
  Описание:
  Преимущества
  Допустимый тип данных: Массив строк
• seo
  Описание:
  SEO метаданные
  Допустимый тип данных: Объект
• tride_platform_settings
  Описание:
  Настройки TRIDE платформы
  Допустимый тип данных: Объект
• access_restrictions
  Описание:
  Ограничения доступа
  Допустимый тип данных: Объект
• timezone
  Описание:
  Таймзона
  Допустимый тип данных: Строка
• associations
  Описание:
  Связи с продуктами
  Допустимый тип данных: Объект
• profile
  Описание:
  Профиль тренировки
  Допустимый тип данных: Объект
• availability_schedule
  Описание:
  Расписание доступности услуги
  Допустимый тип данных: Массив объектов
• personal_booking_settings
  Описание:
  Настройки индивидуальной записи
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Описание:
  Обновленные данные услуги
  Тип данных: Объект
serviceproducts.delete

Описание: Удалить услугу (ServiceProduct)
Входящие переменные:
• id
  Описание:
  ID услуги
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  Статус удаления
  Тип данных: Логическое выражение
serviceproducts.get

Описание: Получить услугу по ID
Входящие переменные:
• id
  Описание:
  ID услуги
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба (для проверки прав)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Данные услуги
  Тип данных: Объект
serviceproducts.grid

Описание: Grid список услуг с фильтрами и пагинацией
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• limit
  Описание:
  Количество на странице
  Допустимый тип данных: Число
• skip
  Описание:
  Пропустить
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка
  Допустимый тип данных: Объект
• filters
  Описание:
  Фильтры (включая service_type)
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Список услуг
  Тип данных: Массив объектов
• total
  Описание:
  Всего записей
  Тип данных: Число
• limit
  Описание:
  Лимит
  Тип данных: Число
• skip
  Описание:
  Пропущено
  Тип данных: Число
serviceproducts.list

Описание: Список всех услуг клуба
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• sport_types
  Описание:
  Фильтр по типам спорта
  Допустимый тип данных: Массив чисел
• category_ids
  Описание:
  Фильтр по категориям
  Допустимый тип данных: Массив строк
• status
  Описание:
  Фильтр по статусу
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список услуг
  Тип данных: Массив объектов
serviceproducts.hide_system

Описание: Скрыть системную услугу для клуба
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• service_id
  Описание:
  ID системной услуги
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
serviceproducts.unhide_system

Описание: Показать системную услугу для клуба
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• service_id
  Описание:
  ID системной услуги
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
serviceproducts.listpublic

Описание: Публичный список услуг клуба для клиентского приложения
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Массив ID клубов
  Допустимый тип данных: Массив строк
• sport_types
  Описание:
  Фильтр по типам спорта
  Допустимый тип данных: Массив чисел
• service_type
  Описание:
  Фильтр по типу услуги
  Допустимый тип данных: Строка
• favorite_only
  Описание:
  Только избранные
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Описание:
  Список услуг
  Тип данных: Массив объектов
serviceproducts.maplist

Описание: Список услуг для маппинга с внешними системами интеграции
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список услуг с external_id
  Тип данных: Массив объектов
serviceproducts.mapsave

Описание: Сохранение маппинга external_id для услуг
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• mappings
  Описание:
  Массив соответствий {id, external_id}
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID услуги
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов:
Возвращаемые параметры:
• saved
  Описание:
  Статус сохранения
  Тип данных: Логическое выражение
• updated
  Описание:
  Количество обновлённых записей
  Тип данных: Число
serviceproducts.multiclublist

Описание: Список услуг из нескольких клубов (для мультиклубных интерфейсов)
Входящие переменные:
• club_ids обязательно
  Описание:
  Массив ID клубов
  Допустимый тип данных: Массив строк
• service_type
  Описание:
  Фильтр по типу услуги
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список услуг
  Тип данных: Массив объектов
serviceproducts.getpublic

Описание: Получить публичную информацию об услуге
Входящие переменные:
• id
  Описание:
  ID услуги
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Данные услуги
  Тип данных: Объект
skills.create

Описание: Создание нового навыка.
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название навыка
  Допустимый тип данных: Строка
• description
  Описание:
  Описание навыка
  Допустимый тип данных: Строка
• status
  Описание:
  Статус активности навыка (по умолчанию true)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• skill_id
  Тип данных: Строка
• name
  Тип данных: Строка
skills.edit

Описание: Редактирование существующего навыка.
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• skill_id обязательно
  Описание:
  Идентификатор навыка
  Допустимый тип данных: Строка
• name
  Описание:
  Новое название навыка
  Допустимый тип данных: Строка
• description
  Описание:
  Новое описание навыка
  Допустимый тип данных: Строка
• status
  Описание:
  Новый статус навыка
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• skill_id
  Тип данных: Строка
• name
  Тип данных: Строка
• status
  Тип данных: Логическое выражение
skills.remove

Описание: Удаление (пометка как удалённого) навыка.
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• skill_id обязательно
  Описание:
  Идентификатор навыка
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
skills.list

Описание: Получение списка навыков клуба.
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• skills
  Описание:
  Массив объектов навыков
  Тип данных: Массив (любые типы внутри)
skills.grid

Описание: Список навыков для Grid компонента с поддержкой фильтрации, сортировки и пагинации
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Объект фильтров (search, status)
  Допустимый тип данных: Объект
• order
  Описание:
  Объект сортировки (field, direction)
  Допустимый тип данных: Объект
• limit
  Описание:
  Лимит записей на страницу
  Допустимый тип данных: Число
• skip
  Описание:
  Количество записей для пропуска (offset)
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Массив навыков с полной информацией
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество записей
  Тип данных: Число
• skip
  Описание:
  Текущий offset
  Тип данных: Число
• limit
  Описание:
  Текущий лимит
  Тип данных: Число
skills.get

Описание: Получение одного навыка по ID
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• skill_id обязательно
  Описание:
  Идентификатор навыка
  Допустимый тип данных: Строка
Возвращаемые параметры:
• item
  Описание:
  Объект навыка с полной информацией
  Тип данных: Объект
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
levels.create

Описание: Создание нового уровня навыков.
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• number обязательно
  Описание:
  Номер уровня
  Допустимый тип данных: Число
• name обязательно
  Описание:
  Название уровня
  Допустимый тип данных: Строка
• color обязательно
  Описание:
  Цветовое обозначение (например, "#BB1E1E")
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• level_id
  Тип данных: Строка
• number
  Тип данных: Число
• name
  Тип данных: Строка
• color
  Тип данных: Строка
levels.edit

Описание: Редактирование существующего уровня навыков.
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• level_id обязательно
  Описание:
  Идентификатор уровня
  Допустимый тип данных: Строка
• number
  Описание:
  Новый номер уровня
  Допустимый тип данных: Число
• name
  Описание:
  Новое название уровня
  Допустимый тип данных: Строка
• color
  Описание:
  Новый цвет уровня
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• level_id
  Тип данных: Строка
• number
  Тип данных: Число
• name
  Тип данных: Строка
• color
  Тип данных: Строка
levels.remove

Описание: Удаление (пометка как удалённого) уровня навыков.
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• level_id обязательно
  Описание:
  Идентификатор уровня
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
levels.list

Описание: Получение списка уровней навыков для клуба.
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• levels
  Описание:
  Массив объектов уровней
  Тип данных: Массив (любые типы внутри)
levels.grid

Описание: Список уровней навыков для Grid компонента с поддержкой фильтрации, сортировки и пагинации
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Объект фильтров (search)
  Допустимый тип данных: Объект
• order
  Описание:
  Объект сортировки (field, direction)
  Допустимый тип данных: Объект
• limit
  Описание:
  Лимит записей на страницу
  Допустимый тип данных: Число
• skip
  Описание:
  Количество записей для пропуска (offset)
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Массив уровней с полной информацией
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество записей
  Тип данных: Число
• skip
  Описание:
  Текущий offset
  Тип данных: Число
• limit
  Описание:
  Текущий лимит
  Тип данных: Число
levels.get

Описание: Получение одного уровня по ID
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• level_id обязательно
  Описание:
  Идентификатор уровня
  Допустимый тип данных: Строка
Возвращаемые параметры:
• item
  Описание:
  Объект уровня с полной информацией
  Тип данных: Объект
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
smiles.add

Описание: Добавление смайлика (системного или клубного)
Входящие переменные:
• fileid
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• system
  Допустимый тип данных: Логическое выражение
• club_ids
  Допустимый тип данных: Массив строк
• order
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
• shortcode
  Тип данных: Строка
smiles.edit

Описание: Редактирование смайлика
Входящие переменные:
• id
  Допустимый тип данных: Строка
• fileid
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• club_ids
  Допустимый тип данных: Массив строк
• order
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
smiles.remove

Описание: Удаление смайлика
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
smiles.bulkremove

Описание: Массовое удаление не-системных смайликов
Входящие переменные:
• ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
• count
  Тип данных: Число
smiles.hideforclubs

Описание: Скрыть системные смайлики для указанных клубов
Входящие переменные:
• ids
  Допустимый тип данных: Массив строк
• club_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
smiles.unhideforclubs

Описание: Показать системные смайлики для указанных клубов
Входящие переменные:
• ids
  Допустимый тип данных: Массив строк
• club_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
smiles.list

Описание: Список смайликов для управления
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• filters
  Допустимый тип данных: Объект
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • fileid
    Тип данных: Строка
  • name
    Тип данных: Строка
  • shortcode
    Тип данных: Строка
  • system
    Тип данных: Логическое выражение
  • club_ids
    Тип данных: Массив строк
  • hidden_for_clubs
    Тип данных: Массив строк
  • order
    Тип данных: Число
  • usage_count
    Тип данных: Число
  • updated_ts
    Тип данных: Временной штамп (timestamp)
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
smiles.get

Описание: Получение конкретного смайлика
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• fileid
  Тип данных: Строка
• name
  Тип данных: Строка
• shortcode
  Тип данных: Строка
• system
  Тип данных: Логическое выражение
• club_ids
  Тип данных: Массив строк
• hidden_for_clubs
  Тип данных: Массив строк
• order
  Тип данных: Число
• usage_count
  Тип данных: Число
smiles.listforclub

Описание: Список смайликов для конкретного клуба (для использования)
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
stickers.add

Описание: Добавление стикера (системного или клубного)
Входящие переменные:
• fileid
  Допустимый тип данных: Строка
• system
  Допустимый тип данных: Логическое выражение
• club_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
stickers.edit

Описание: Редактирование стикера
Входящие переменные:
• id
  Допустимый тип данных: Строка
• fileid
  Допустимый тип данных: Строка
• club_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
stickers.remove

Описание: Удаление стикера
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
stickers.bulkremove

Описание: Массовое удаление не-системных стикеров
Входящие переменные:
• ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
• count
  Тип данных: Число
stickers.hideforclubs

Описание: Скрыть системные стикеры для указанных клубов
Входящие переменные:
• ids
  Допустимый тип данных: Массив строк
• club_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
stickers.unhideforclubs

Описание: Показать системные стикеры для указанных клубов
Входящие переменные:
• ids
  Допустимый тип данных: Массив строк
• club_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
stickers.list

Описание: Список стикеров для управления
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• filters
  Допустимый тип данных: Объект
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • fileid
    Тип данных: Строка
  • system
    Тип данных: Логическое выражение
  • club_ids
    Тип данных: Массив строк
  • hidden_for_clubs
    Тип данных: Массив строк
  • updated_ts
    Тип данных: Временной штамп (timestamp)
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
zones.maplist

Описание: Список помещений/зон (компактно) с внешними ID для сопоставления
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список зон
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID зоны
    Тип данных: Строка
  • name
    Описание:
    Название зоны
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов: Число, Строка
zones.mapsave

Описание: Сохранить соответствия внешних ID для помещений/зон (bulk)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• mappings
  Описание:
  Массив соответствий {id, external_id}
  Допустимый тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID зоны
    Тип данных: Строка
  • external_id
    Описание:
    Внешний ID
    Тип данных: Возможно несколько типов: Число, Строка
Возвращаемые параметры:
• saved
  Описание:
  Статус сохранения
  Тип данных: Логическое выражение
• updated
  Описание:
  Количество обновлённых записей
  Тип данных: Число
zones.mylist

Описание: Получить список всех доступных пользователю зон и клубов
Входящие переменные:
Возвращаемые параметры:
• zones
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор зоны
    Тип данных: Строка
  • name
    Описание:
    Название зоны
    Тип данных: Строка
  • club_id
    Описание:
    Идентификатор клуба
    Тип данных: Строка
  • club_name
    Описание:
    Название клуба
    Тип данных: Строка
zones.get

Описание:
Входящие переменные:
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• name
  Тип данных: Строка
• status
  Тип данных: Логическое выражение
• settings
  Тип данных: Объект
• sport_types
  Тип данных: Массив чисел
• main_sport_type
  Тип данных: Число
• autopull_hr_sensors
  Описание:
  Автоматически подтягивать зарегистрированные пульсометры клуба как участников
  Тип данных: Логическое выражение
zones.savemap

Описание:
Входящие переменные:
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• map
  Описание:
  Карта зоны
  Тип данных: Объект
zones.getmap

Описание:
Входящие переменные:
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• map
  Описание:
  Карта зоны
  Тип данных: Объект
zones.add

Описание: Добавить зону
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• name
  Описание:
  Название зоны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Статус добавления
  Тип данных: Логическое выражение
• zone_id
  Описание:
  Идентификатор зоны
  Тип данных: Строка
• name
  Описание:
  Название зоны
  Тип данных: Строка
• status
  Описание:
  Статус зоны
  Тип данных: Логическое выражение
zones.edit

Описание: Изменить зону
Входящие переменные:
• zone_id
  Описание:
  ID зоны
  Допустимый тип данных: Строка
• name
  Описание:
  Название зоны
  Допустимый тип данных: Строка
• status
  Описание:
  Статус зоны
  Допустимый тип данных: Логическое выражение
• autopull_hr_sensors
  Описание:
  Автоматически подтягивать зарегистрированные пульсометры клуба как участников
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  Статус изменения
  Тип данных: Логическое выражение
• zone_id
  Описание:
  Идентификатор зоны
  Тип данных: Строка
zones.getintegration

Описание: Изменить зону
Входящие переменные:
• zone_id
  Описание:
  ID зоны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Статус изменения
  Тип данных: Логическое выражение
zones.editintegration

Описание: Изменить зону
Входящие переменные:
• zone_id
  Описание:
  ID зоны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Статус изменения
  Тип данных: Логическое выражение
zones.list

Описание: Получить список зон
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• zones
  Тип данных: Массив объектов
  Вложенные элементы:
  • zone_id
    Описание:
    Идентификатор зоны
    Тип данных: Строка
  • name
    Описание:
    Название зоны
    Тип данных: Строка
  • status
    Описание:
    Статус зоны
    Тип данных: Логическое выражение
zones.grid

Описание: Получить список зон для Grid компонента с поддержкой фильтров, сортировки и пагинации
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры для поиска
  Допустимый тип данных: Объект
• order
  Описание:
  Сортировка {field, order}
  Допустимый тип данных: Объект
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Список зон
  Тип данных: Массив объектов
  Вложенные элементы:
  • zone_id
    Описание:
    Идентификатор зоны
    Тип данных: Строка
  • name
    Описание:
    Название зоны
    Тип данных: Строка
  • status
    Описание:
    Статус зоны
    Тип данных: Логическое выражение
  • sport_types
    Описание:
    Типы спорта
    Тип данных: Массив чисел
  • main_sport_type
    Описание:
    Основной тип спорта
    Тип данных: Число
  • self_training
    Описание:
    Самостоятельные тренировки
    Тип данных: Логическое выражение
  • devices_count
    Описание:
    Количество устройств
    Тип данных: Число
  • devices_online
    Описание:
    Количество устройств онлайн
    Тип данных: Число
  • devices
    Описание:
    Список устройств
    Тип данных: Массив объектов
    Вложенные элементы:
    • id
      Описание:
      ID устройства
      Тип данных: Строка
    • name
      Описание:
      Название устройства
      Тип данных: Строка
    • is_online
      Описание:
      Устройство онлайн
      Тип данных: Логическое выражение
• total
  Описание:
  Общее количество записей
  Тип данных: Число
• skip
  Описание:
  Смещение
  Тип данных: Число
• limit
  Описание:
  Лимит
  Тип данных: Число
zones.remove

Описание: Удалить зону
Входящие переменные:
• zone_id
  Описание:
  ID зоны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Статус удаления
  Тип данных: Логическое выражение
payment_providers.list

Описание: Получить список платёжных провайдеров клуба
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• is_active
  Описание:
  Фильтр по активности
  Допустимый тип данных: Логическое выражение
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Массив провайдеров
  Тип данных: Массив объектов
• total
  Тип данных: Число
payment_providers.get

Описание: Получить платёжный провайдер по ID
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
Возвращаемые параметры:
payment_providers.add

Описание: Добавить платёжный провайдер для клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• name
  Описание:
  Название провайдера
  Допустимый тип данных: Строка
• provider_type обязательно
  Описание:
  Тип провайдера (cloudpayments, yookassa, payu, tinkoff)
  Допустимый тип данных: Строка
• payment_mode
  Описание:
  Режим оплаты (platform, direct)
  Допустимый тип данных: Строка
• is_active
  Описание:
  Активен ли провайдер
  Допустимый тип данных: Логическое выражение
• is_default
  Описание:
  Провайдер по умолчанию
  Допустимый тип данных: Логическое выражение
• supported_methods
  Описание:
  Поддерживаемые методы оплаты
  Допустимый тип данных: Массив строк
• credentials
  Описание:
  Реквизиты подключения к провайдеру
  Допустимый тип данных: Объект
• fees
  Описание:
  Настройки комиссий
  Допустимый тип данных: Объект
• limits
  Описание:
  Лимиты транзакций
  Допустимый тип данных: Объект
• features
  Описание:
  Возможности провайдера
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• provider_id
  Тип данных: Строка
payment_providers.edit

Описание: Редактировать платёжный провайдер
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
payment_providers.remove

Описание: Удалить платёжный провайдер
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
payment_providers.set_default

Описание: Установить провайдер по умолчанию для клуба
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
payment_providers.test

Описание: Тестировать подключение к платёжному провайдеру
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор провайдера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• test_result
  Тип данных: Объект
payment_providers.enable_platform

Описание: Включить оплату через платформу TRIDE
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• provider_id
  Тип данных: Строка
payment_providers.disable_platform

Описание: Отключить оплату через платформу TRIDE
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
paymentWebhooksCloudPayments

Описание: Webhook от CloudPayments — подтверждение оплаты
Входящие переменные:
paymentWebhooksPayU

Описание: Webhook от PayU (YPMN) — подтверждение оплаты
Входящие переменные:
paymentWebhooksYookassa

Описание: Webhook от ЮKassa — подтверждение оплаты
Входящие переменные:
paymentWebhooksTinkoff

Описание: Webhook от Тинькофф (T-Bank) — подтверждение оплаты
Входящие переменные:
paymentWebhooksRetry

Описание: Повторная обработка неудачных webhook
Входящие переменные:
• provider_type
  Допустимый тип данных: Строка
paymentWebhooksStats

Описание: Статистика по webhook
Входящие переменные:
• provider_type
  Допустимый тип данных: Строка
• date_from
  Допустимый тип данных: Строка
• date_to
  Допустимый тип данных: Строка
promocodes.list

Описание: Получить список промокодов клуба
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив промокодов
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
promocodes.get

Описание: Получить промокод по ID
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор промокода
  Допустимый тип данных: Строка
Возвращаемые параметры:
promocodes.add

Описание: Создать новый промокод
Входящие переменные:
• club_ids обязательно
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• code обязательно
  Описание:
  Код промокода
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название промокода
  Допустимый тип данных: Строка
• description
  Описание:
  Описание промокода
  Допустимый тип данных: Строка
• discount_type обязательно
  Описание:
  Тип скидки: percentage, fixed, free_shipping
  Допустимый тип данных: Строка
• discount_value обязательно
  Описание:
  Значение скидки
  Допустимый тип данных: Дробное число
• max_discount_amount
  Описание:
  Максимальная сумма скидки
  Допустимый тип данных: Строка
• valid_from обязательно
  Описание:
  Дата начала действия
  Допустимый тип данных: Дата в формате ISO
• valid_to обязательно
  Описание:
  Дата окончания действия
  Допустимый тип данных: Дата в формате ISO
• usage_limits
  Описание:
  Лимиты использования
  Допустимый тип данных: Объект
• applicable_to
  Описание:
  Применимость промокода
  Допустимый тип данных: Объект
• conditions
  Описание:
  Условия применения
  Допустимый тип данных: Объект
• stacking_rules
  Описание:
  Правила комбинирования
  Допустимый тип данных: Объект
• is_active
  Описание:
  Активен ли промокод
  Допустимый тип данных: Логическое выражение
• is_public
  Описание:
  Публичный ли промокод
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Описание:
  ID созданного промокода
  Тип данных: Строка
promocodes.edit

Описание: Редактировать промокод
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор промокода
  Допустимый тип данных: Строка
Возвращаемые параметры:
promocodes.remove

Описание: Удалить промокод
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор промокода
  Допустимый тип данных: Строка
Возвращаемые параметры:
promocodes.validate

Описание: Проверить валидность промокода
Входящие переменные:
• code обязательно
  Описание:
  Код промокода
  Допустимый тип данных: Строка
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• user_id
  Описание:
  Идентификатор пользователя
  Допустимый тип данных: Строка
• cart_amount
  Описание:
  Сумма корзины (для проверки минимума)
  Допустимый тип данных: Строка
• product_types
  Описание:
  Типы продуктов в корзине
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• valid
  Описание:
  Валиден ли промокод
  Тип данных: Логическое выражение
• reason
  Описание:
  Причина невалидности
  Тип данных: Строка
• promo_code
  Описание:
  Данные промокода
  Тип данных: Объект
• discount
  Описание:
  Рассчитанная скидка
  Тип данных: Объект
promocodes.apply

Описание: Применить промокод (увеличить счетчик использований)
Входящие переменные:
• code обязательно
  Описание:
  Код промокода
  Допустимый тип данных: Строка
• user_id
  Описание:
  Идентификатор пользователя
  Допустимый тип данных: Строка
Возвращаемые параметры:
promocodes.has_active

Описание: Проверить наличие активных промокодов в клубе
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• has_active_promocodes
  Описание:
  Есть ли активные промокоды
  Тип данных: Логическое выражение
promocodes.check

Описание: Проверить промокод для продукта в магазине
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• code обязательно
  Описание:
  Код промокода
  Допустимый тип данных: Строка
• product_id обязательно
  Описание:
  Идентификатор продукта
  Допустимый тип данных: Строка
Возвращаемые параметры:
• valid
  Описание:
  Валиден ли промокод
  Тип данных: Логическое выражение
• reason
  Описание:
  Причина невалидности
  Тип данных: Строка
• discount
  Описание:
  Информация о скидке
  Тип данных: Объект
• promo_code
  Описание:
  Данные промокода для отображения
  Тип данных: Объект
legal.get

Описание: Получить юридическую информацию клуба
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• documents
  Описание:
  Документы клуба (каждый документ имеет type: text|link и content)
  Тип данных: Объект
• entity_type
  Описание:
  Тип юр. лица: legal (ООО/АО) или individual (ИП)
  Тип данных: Строка
• legal_entity
  Описание:
  Данные юрлица (ООО/АО)
  Тип данных: Объект
• individual_entrepreneur
  Описание:
  Данные ИП
  Тип данных: Объект
• actual_address
  Описание:
  Адрес фактического оказания услуг
  Тип данных: Строка
• dadata_id
  Описание:
  ID организации в DaData
  Тип данных: Строка
legal.edit

Описание: Сохранить юридическую информацию клуба
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• documents
  Описание:
  Документы клуба (каждый документ имеет type: text|link и content)
  Допустимый тип данных: Объект
• entity_type
  Описание:
  Тип юр. лица: legal или individual
  Допустимый тип данных: Строка
• legal_entity
  Описание:
  Данные юрлица
  Допустимый тип данных: Объект
• individual_entrepreneur
  Описание:
  Данные ИП
  Допустимый тип данных: Объект
• actual_address
  Описание:
  Адрес фактического оказания услуг
  Допустимый тип данных: Строка
• dadata_id
  Описание:
  ID организации в DaData
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат сохранения
  Тип данных: Логическое выражение
legal.public.get

Описание: Публичное получение юридической информации клуба для чекаута
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• club_name
  Описание:
  Название клуба
  Тип данных: Строка
• documents
  Описание:
  Документы клуба (каждый: type, content, has_content)
  Тип данных: Объект
• executor
  Описание:
  Реквизиты исполнителя
  Тип данных: Объект
• contacts
  Описание:
  Контакты клуба (phone, email, website)
  Тип данных: Объект
• working_hours
  Описание:
  Рабочие часы клуба
  Тип данных: Объект
• has_executor_data
  Описание:
  Флаг заполненности реквизитов
  Тип данных: Логическое выражение
legal.lookup

Описание: Поиск организации по ОГРН/ИНН/названию через DaData
Входящие переменные:
• search обязательно
  Описание:
  Поисковый запрос (ОГРН, ИНН или название)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Найденные организации
  Тип данных: Массив объектов
segments.list

Описание: Получение списка сегментов клуба
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• status
  Описание:
  Фильтр по статусу (active, draft, archived)
  Допустимый тип данных: Строка
• include_archived
  Описание:
  Включать архивные сегменты
  Допустимый тип данных: Логическое выражение
segments.grid

Описание: Grid метод для получения сегментов с фильтрацией и пагинацией
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
• order
  Описание:
  Сортировка
  Допустимый тип данных: Объект
• limit
  Описание:
  Лимит
  Допустимый тип данных: Число
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
segments.get

Описание: Получение сегмента по ID
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
segments.add

Описание: Создание нового сегмента
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название сегмента
  Допустимый тип данных: Строка
• description
  Описание:
  Описание сегмента
  Допустимый тип данных: Строка
• color
  Описание:
  Цвет сегмента (hex)
  Допустимый тип данных: Строка
• icon
  Описание:
  Иконка сегмента
  Допустимый тип данных: Строка
• conditions обязательно
  Описание:
  Условия сегмента
  Допустимый тип данных: Объект
• scope_club_ids
  Описание:
  ID клубов для анализа (для групп)
  Допустимый тип данных: Массив строк
• recalculation
  Описание:
  Настройки пересчёта
  Допустимый тип данных: Объект
• status
  Описание:
  Статус сегмента (draft, active)
  Допустимый тип данных: Строка
segments.edit

Описание: Редактирование сегмента
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
• name
  Описание:
  Название сегмента
  Допустимый тип данных: Строка
• description
  Описание:
  Описание сегмента
  Допустимый тип данных: Строка
• color
  Описание:
  Цвет сегмента
  Допустимый тип данных: Строка
• icon
  Описание:
  Иконка сегмента
  Допустимый тип данных: Строка
• conditions
  Описание:
  Условия сегмента
  Допустимый тип данных: Объект
• scope_club_ids
  Описание:
  ID клубов для анализа
  Допустимый тип данных: Массив строк
• recalculation
  Описание:
  Настройки пересчёта
  Допустимый тип данных: Объект
• status
  Описание:
  Статус сегмента
  Допустимый тип данных: Строка
segments.remove

Описание: Удаление сегмента
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
segments.recalculate

Описание: Ручной пересчёт сегмента
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
segments.conditions

Описание: Получение конфигурации условий для сегментации
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба (для загрузки динамических данных)
  Допустимый тип данных: Строка
segments.members

Описание: Получение списка клиентов в сегменте
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
• search
  Описание:
  Поиск по имени/email/телефону
  Допустимый тип данных: Строка
segments.members.grid

Описание: Grid метод для получения клиентов сегмента
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
• order
  Описание:
  Сортировка
  Допустимый тип данных: Объект
• limit
  Описание:
  Лимит
  Допустимый тип данных: Число
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
segments.history

Описание: Получение истории пересчётов сегмента
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
segments.preview

Описание: Предпросмотр сегмента (создаёт задачу для расчёта)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• conditions обязательно
  Описание:
  Условия сегмента
  Допустимый тип данных: Объект
• scope_club_ids
  Описание:
  ID клубов для анализа
  Допустимый тип данных: Массив строк
• limit
  Описание:
  Лимит результатов для превью
  Допустимый тип данных: Число
segments.preview.result

Описание: Получение результата preview задачи
Входящие переменные:
• job_id обязательно
  Описание:
  ID задачи preview
  Допустимый тип данных: Строка
segments.activate

Описание: Активация сегмента (включает автопересчёт)
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
segments.archive

Описание: Архивация сегмента
Входящие переменные:
• segment_id обязательно
  Описание:
  ID сегмента
  Допустимый тип данных: Строка
segments.loadDataSource

Описание: Загрузка данных для выбора в условиях (продукты, услуги и т.п.)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• data_source обязательно
  Описание:
  Ключ источника данных
  Допустимый тип данных: Строка
segments.user.list

Описание: Получение сегментов, к которым относится пользователь (с учётом группы клубов)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
segments.listByClubs

Описание: Получение списка активных сегментов по нескольким клубам для использования в рассылках
Входящие переменные:
• club_ids обязательно
  Описание:
  Массив ID клубов
  Допустимый тип данных: Массив строк
load.current

Описание: Получение текущей загрузки клуба в реальном времени
Входящие переменные:
• club_id
  Описание:
  ID клуба (опционально, берётся из request)
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны для фильтрации (опционально)
  Допустимый тип данных: Строка
• include_forecast
  Описание:
  Включить прогноз на ближайшие часы
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• club_id
  Описание:
  ID клуба
  Тип данных: Строка
• timestamp
  Описание:
  Время запроса
  Тип данных: Дата в формате ISO
• day_of_week
  Описание:
  День недели (0-6)
  Тип данных: Число
• hour
  Описание:
  Текущий час
  Тип данных: Число
• current
  Описание:
  Текущие данные
  Тип данных: Объект
• last_hour_stats
  Описание:
  Статистика за последний час
  Тип данных: Объект
• pattern
  Описание:
  Типичный паттерн для текущего времени
  Тип данных: Объект
• forecast
  Описание:
  Прогноз на ближайшие часы
  Тип данных: Массив объектов
load.statistics

Описание: Получение статистики загрузки за период
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны для фильтрации
  Допустимый тип данных: Строка
• period_type
  Описание:
  Тип периода: hourly, daily, weekly
  Допустимый тип данных: Строка
• from_date
  Описание:
  Дата начала периода
  Допустимый тип данных: Дата в формате ISO
• to_date
  Описание:
  Дата окончания периода
  Допустимый тип данных: Дата в формате ISO
• day_of_week
  Описание:
  Фильтр по дню недели (0-6)
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Записи статистики
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество записей
  Тип данных: Число
load.heatmap

Описание: Получение тепловой карты загрузки (день недели × час)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны для фильтрации
  Допустимый тип данных: Строка
• weeks
  Описание:
  За сколько недель анализировать (по умолчанию 8)
  Допустимый тип данных: Число
Возвращаемые параметры:
• heatmap
  Описание:
  Матрица 7×24 с данными загрузки
  Тип данных: Объект
• thresholds
  Описание:
  Пороги уровней загрузки
  Тип данных: Объект
• max_occupancy
  Описание:
  Максимальная зафиксированная загрузка
  Тип данных: Дробное число
load.pattern

Описание: Получение паттерна загрузки для конкретного дня/часа
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• day_of_week обязательно
  Описание:
  День недели (0-6, 0 = воскресенье)
  Допустимый тип данных: Число
• hour обязательно
  Описание:
  Час (0-23)
  Допустимый тип данных: Число
• zone_id
  Описание:
  ID зоны для фильтрации
  Допустимый тип данных: Строка
Возвращаемые параметры:
• pattern
  Описание:
  Паттерн загрузки
  Тип данных: Объект
load.patterns

Описание: Получение всех паттернов загрузки клуба в виде матрицы
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны для фильтрации
  Допустимый тип данных: Строка
Возвращаемые параметры:
• patterns_matrix
  Описание:
  Матрица паттернов по дням и часам
  Тип данных: Объект
• patterns_count
  Описание:
  Количество паттернов
  Тип данных: Число
load.forecast

Описание: Получение прогноза загрузки на ближайшие часы
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны для фильтрации
  Допустимый тип данных: Строка
• hours
  Описание:
  На сколько часов вперёд (по умолчанию 24)
  Допустимый тип данных: Число
Возвращаемые параметры:
• forecast
  Описание:
  Прогноз по часам
  Тип данных: Массив объектов
load.trends

Описание: Получение трендов загрузки (сравнение с прошлым периодом)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны для фильтрации
  Допустимый тип данных: Строка
• compare_weeks
  Описание:
  За сколько недель сравнивать (по умолчанию 4)
  Допустимый тип данных: Число
Возвращаемые параметры:
• current_week
  Описание:
  Статистика текущей недели
  Тип данных: Объект
• previous_week
  Описание:
  Статистика прошлой недели
  Тип данных: Объект
• changes
  Описание:
  Изменения в процентах
  Тип данных: Объект
• trend_direction
  Описание:
  Направление тренда: up, down, stable
  Тип данных: Строка
load.zones

Описание: Получение загрузки по зонам клуба
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• date
  Описание:
  Дата (по умолчанию сегодня)
  Допустимый тип данных: Дата в формате ISO
• hour
  Описание:
  Час (по умолчанию текущий)
  Допустимый тип данных: Число
Возвращаемые параметры:
• zones
  Описание:
  Загрузка по зонам
  Тип данных: Массив объектов
load.peakHours

Описание: Получение пиковых и наименее загруженных часов
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны для фильтрации
  Допустимый тип данных: Строка
• top_count
  Описание:
  Количество результатов (по умолчанию 5)
  Допустимый тип данных: Число
Возвращаемые параметры:
• peak_hours
  Описание:
  Самые загруженные часы
  Тип данных: Массив объектов
• low_hours
  Описание:
  Наименее загруженные часы
  Тип данных: Массив объектов
load.recommendations

Описание: Получение рекомендаций по оптимальному времени посещения
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны для фильтрации
  Допустимый тип данных: Строка
• preferred_days
  Описание:
  Предпочтительные дни недели (0-6)
  Допустимый тип данных: Массив чисел
• preferred_hours
  Описание:
  Предпочтительные часы { from: 0-23, to: 0-23 }
  Допустимый тип данных: Объект
Возвращаемые параметры:
• recommendations
  Описание:
  Рекомендованные временные слоты
  Тип данных: Массив объектов
• message
  Описание:
  Сообщение с рекомендацией
  Тип данных: Строка
load.dashboard

Описание: Получение всех данных для dashboard загрузки
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• current
  Описание:
  Текущая загрузка
  Тип данных: Объект
• trends
  Описание:
  Тренды
  Тип данных: Объект
• peak_hours
  Описание:
  Пиковые часы
  Тип данных: Объект
• heatmap_summary
  Описание:
  Сводка по heatmap
  Тип данных: Объект
load.recalculatePatterns

Описание: Ручной пересчёт паттернов загрузки (требуются права)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• weeks
  Описание:
  За сколько недель анализировать
  Допустимый тип данных: Число
• include_zones
  Описание:
  Включить пересчёт по зонам
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• patterns_updated
  Описание:
  Количество обновлённых паттернов
  Тип данных: Число
• duration_ms
  Описание:
  Время выполнения в мс
  Тип данных: Число
load.aggregateHours

Описание: Ручная агрегация данных за последние N часов (требуются права)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• hours_back
  Описание:
  За сколько часов назад агрегировать (макс 168)
  Допустимый тип данных: Число
Возвращаемые параметры:
• processed_hours
  Описание:
  Обработано часов
  Тип данных: Число
• errors_count
  Описание:
  Количество ошибок
  Тип данных: Число
banners.grid

Описание: Grid banners list with filters
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив объектов баннеров
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
session.events

Описание: Получить список событий по занятию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив объектов событий занятия
  Тип данных: Массив объектов
roles.list

Описание: Список ролей клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив объектов ролей клуба
  Тип данных: Массив объектов
roles.add

Описание: Добавить роль
Входящие переменные:
• club_ids обязательно
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• name
  Описание:
  Название роли
  Допустимый тип данных: Строка
Возвращаемые параметры:
roles.edit

Описание: Изменить роль
Входящие переменные:
• role_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
roles.remove

Описание: Удалить роль
Входящие переменные:
• role_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
roles.hide

Описание: Удалить роль
Входящие переменные:
• role_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
rent.history

Описание:
Входящие переменные:
Возвращаемые параметры:
employee_categories.list

Описание: Список категорий клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив объектов ролей клуба
  Тип данных: Массив объектов
employee_categories.grid

Описание: Grid-совместимый список категорий сотрудников с пагинацией и фильтрами
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
• skip
  Описание:
  Смещение
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка {field, order}
  Допустимый тип данных: Объект
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив категорий сотрудников
  Тип данных: Массив объектов
• total
  Описание:
  Общее количество
  Тип данных: Число
• limit
  Описание:
  Лимит
  Тип данных: Число
• skip
  Описание:
  Смещение
  Тип данных: Число
employee_categories.add

Описание: Добавить категорию сотрудника
Входящие переменные:
• club_ids обязательно
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• name обязательно
  Описание:
  Название категории
  Допустимый тип данных: Строка
• external_id
  Описание:
  Внешний идентификатор
  Допустимый тип данных: Строка
Возвращаемые параметры:
employee_categories.edit

Описание: Изменить категорию сотрудника
Входящие переменные:
• category_id обязательно
  Описание:
  Идентификатор категории
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• name
  Описание:
  Название категории
  Допустимый тип данных: Строка
• external_id
  Описание:
  Внешний идентификатор
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба для системной категории
  Допустимый тип данных: Строка
Возвращаемые параметры:
employee_categories.remove

Описание: Удалить категорию
Входящие переменные:
• category_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
check.active

Описание: Проверить оплачен ли клуб и являается действующим
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• active
  Описание:
  true - клуб активен, false - неактивен
  Тип данных: Логическое выражение
sessions.listequipment

Описание: Получить файл счета
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
add

Описание: Добавить клуб
Входящие переменные:
• name обязательно
  Описание:
  Название клуба
  Допустимый тип данных: Строка
• avatar
  Описание:
  Аватар клуба, идентификатор файла
  Допустимый тип данных: Строка
• address обязательно
  Описание:
  Код ФИАС адреса клуба
  Допустимый тип данных: Строка
• show_on_map
  Описание:
  Показывать на карте
  Допустимый тип данных: Логическое выражение
• phone обязательно
  Описание:
  Телефон клуба
  Допустимый тип данных: Строка
• website
  Описание:
  Сайт клуба
  Допустимый тип данных: Строка
• instagram
  Описание:
  Instagram клуба
  Допустимый тип данных: Строка
• facebook
  Описание:
  Facebook клуба
  Допустимый тип данных: Строка
• vk
  Описание:
  VK клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• id
  Описание:
  ID созданного клуба
  Тип данных: Строка
• error
  Описание:
  Ошибка. Если result=false, то значение ошибки:
  • name - не заполнено имя
  • address - неверный адрес
  • phone - неверный телефон или не заполнен
  
  Тип данных: Строка
edit

Описание: Редактировать клуб
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название клуба
  Допустимый тип данных: Строка
• address обязательно
  Описание:
  КОД ФИАС адреса клуба
  Допустимый тип данных: Строка
• show_on_map
  Описание:
  Показывать на карте
  Допустимый тип данных: Логическое выражение
• phone обязательно
  Описание:
  Телефон клуба
  Допустимый тип данных: Строка
• website
  Описание:
  Сайт клуба
  Допустимый тип данных: Строка
• instagram
  Описание:
  Instagram клуба
  Допустимый тип данных: Строка
• facebook
  Описание:
  Facebook клуба
  Допустимый тип данных: Строка
• vk
  Описание:
  VK клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• id
  Описание:
  ID созданного клуба
  Тип данных: Строка
• error
  Описание:
  Ошибка. Если result=false, то значение ошибки:
  • name - не заполнено имя
  • address - неверный адрес
  • phone - неверный телефон или не заполнен
  
  Тип данных: Строка
get.public

Описание: Получить данные клуба
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• idвсегда
  Описание:
  Идентификатор клуба
  Тип данных: Строка
• nameвсегда
  Описание:
  Название клуба
  Тип данных: Строка
• avatar
  Описание:
  Аватар клуба, идентификатор файла
  Тип данных: Строка
• addressвсегда
  Описание:
  Адрес клуба
  Тип данных: Объект
  Вложенные элементы:
  • coords
    Описание:
    Координаты [lat,lon]
    Тип данных: Массив (любые типы внутри)
  • long
    Описание:
    Адрес строкой
    Тип данных: Строка
  • id
    Описание:
    Идентификатор ФИАС
    Тип данных: Строка
• show_on_map
  Описание:
  Показывать на карте
  Тип данных: Логическое выражение
• phoneвсегда
  Описание:
  Телефон клуба
  Тип данных: Строка
• website
  Описание:
  Сайт клуба
  Тип данных: Строка
• instagram
  Описание:
  Instagram клуба
  Тип данных: Строка
• facebook
  Описание:
  Facebook клуба
  Тип данных: Строка
• vk
  Описание:
  VK клуба
  Тип данных: Строка
• auto_renew
  Описание:
  Автоматическое продление
  Тип данных: Логическое выражение
• subscription_status
  Описание:
  Состояние подписки клуба.
  • 1 - активна
  • 2 - истекает
  • 3 - не оплачено (завершена)
  • 4 - пробный период
• subscription_end
  Описание:
  Дата завершения подписки ДД.ММ.ГГГГ
  Тип данных: Строка
get

Описание: Получить данные клуба
Входящие переменные:
• id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• idвсегда
  Описание:
  Идентификатор клуба
  Тип данных: Строка
• nameвсегда
  Описание:
  Название клуба
  Тип данных: Строка
• avatar
  Описание:
  Аватар клуба, идентификатор файла
  Тип данных: Строка
• addressвсегда
  Описание:
  Адрес клуба
  Тип данных: Объект
  Вложенные элементы:
  • coords
    Описание:
    Координаты [lat,lon]
    Тип данных: Массив (любые типы внутри)
  • long
    Описание:
    Адрес строкой
    Тип данных: Строка
  • id
    Описание:
    Идентификатор ФИАС
    Тип данных: Строка
• show_on_map
  Описание:
  Показывать на карте
  Тип данных: Логическое выражение
• phoneвсегда
  Описание:
  Телефон клуба
  Тип данных: Строка
• website
  Описание:
  Сайт клуба
  Тип данных: Строка
• instagram
  Описание:
  Instagram клуба
  Тип данных: Строка
• facebook
  Описание:
  Facebook клуба
  Тип данных: Строка
• vk
  Описание:
  VK клуба
  Тип данных: Строка
• auto_renew
  Описание:
  Автоматическое продление
  Тип данных: Логическое выражение
• subscription_status
  Описание:
  Состояние подписки клуба.
  • 1 - активна
  • 2 - истекает
  • 3 - не оплачено (завершена)
  • 4 - пробный период
• subscription_end
  Описание:
  Дата завершения подписки ДД.ММ.ГГГГ
  Тип данных: Строка
list

Описание: Получить список клубов
Входящие переменные:
• subscription
  Описание:
  Состояние подписки клуба.
  • 0 - все (по умолчанию)
  • 1 - активна
  • 2 - истекает
  • 3 - не оплачено (завершена)
  • 4 - пробный период
  
  Допустимый тип данных: Число
• search
  Описание:
  Поиск клуба по названию
  Допустимый тип данных: Строка
Возвращаемые параметры:
• clubs
  Описание:
  Массив списка клубов
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор клуба
    Тип данных: Строка
  • name
    Описание:
    Название клуба
    Тип данных: Строка
  • auto_renew
    Описание:
    Автоматическое продление
    Тип данных: Логическое выражение
  • subscription_status
    Описание:
    Состояние подписки клуба.
    • 1 - активна
    • 2 - истекает
    • 3 - не оплачено (завершена)
    • 4 - пробный период
  • subscription_end
    Описание:
    Дата завершения подписки ДД.ММ.ГГГГ
    Тип данных: Строка
  • avatar
    Описание:
    Аватар клуба, идентификатор файла
    Тип данных: Строка
address.lookup

Описание: Получить подсказки по адресу
Входящие переменные:
• search
  Описание:
  поисковая строка адреса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• addresses
  Описание:
  Массив вариантов адреса
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор фиас данного адреса
    Тип данных: Строка
  • name
    Описание:
    Полное название адреса
    Тип данных: Строка
address.getcoords

Описание: Получить координаты по адресу
Входящие переменные:
• id
  Описание:
  Идентификатор фиас данного адреса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор фиас данного адреса
  Тип данных: Строка
• name
  Описание:
  Полное название адреса
  Тип данных: Строка
• coords
  Описание:
  Координаты адреса [lng,lat]
  Тип данных: Массив (любые типы внутри)
coaches.list

Описание:
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• club_ids
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Число
  • firstname
    Тип данных: Строка
  • lastname
    Тип данных: Строка
coaches.list.public

Описание:
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• club_ids
  Допустимый тип данных: Массив строк
• schedule
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Число
  • firstname
    Тип данных: Строка
  • lastname
    Тип данных: Строка
  • avatar
    Тип данных: Строка
  • display_name
    Тип данных: Строка
equipment.add

Описание: Добавить оборудование (тренажер)
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• type
  Описание:
  Тип тренажера из справочника
  Допустимый тип данных: Строка
• num
  Описание:
  Номер байка
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
• sensors
  Описание:
  Объект датчиков
  Допустимый тип данных: Объект
Возвращаемые параметры:
• id
  Описание:
  ID тренажера
  Тип данных: Строка
• type
  Описание:
  Тип тренажера из справочника
  Тип данных: Строка
• num
  Описание:
  Номер байка
  Тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны
  Тип данных: Строка
• sensors
  Описание:
  Объект датчиков
  Тип данных: Объект
equipment.bulkadd

Описание: Массовое добавление оборудования (тренажеры, пульсометры)
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• type обязательно
  Описание:
  Тип тренажера из справочника (общий для всех)
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны (общий, для тренажеров)
  Допустимый тип данных: Строка
• items обязательно
  Описание:
  Массив элементов [{num, sensors}]
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• items
  Описание:
  Массив созданных элементов [{id, num}]
  Тип данных: Массив объектов
• created
  Описание:
  Количество созданных элементов
  Тип данных: Число
equipment.free

Описание: Освободить аренду датчика
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
equipment.rent

Описание: Установить аренду датчика
Входящие переменные:
• id
  Допустимый тип данных: Строка
• phone
  Описание:
  Номер телефона пользователя
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• rent_start_ts
  Описание:
  Время начала аренды
  Допустимый тип данных: Временной штамп (timestamp)
• rent_end_ts
  Описание:
  Время завершения аренды или 0
  Допустимый тип данных: Возможно несколько типов: Число, Временной штамп (timestamp)
• rent_for_session
  Описание:
  Аренда только на 1 занятие
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
equipment.multilist

Описание: Список видов занятия
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• sport_types
  Допустимый тип данных: Массив чисел
Возвращаемые параметры:
• items
  Описание:
  Список занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID тренажера
    Тип данных: Строка
  • type
    Описание:
    Тип тренажера из справочника
    Тип данных: Строка
  • picture
    Описание:
    ID картинки
    Тип данных: Строка
  • brand
    Описание:
    Бренд
    Тип данных: Строка
  • model
    Описание:
    Модель
    Тип данных: Строка
  • num
    Описание:
    Номер байка
    Тип данных: Строка
  • zone_id
    Описание:
    Идентификатор зоны
    Тип данных: Строка
  • zone_name
    Описание:
    Название зоны
    Тип данных: Строка
  • sport_type
    Описание:
    Тип спорта
    Тип данных: Число
  • sensors
    Описание:
    Объект датчиков
    Тип данных: Объект
equipment.list

Описание: Список видов занятия
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• sport_types
  Допустимый тип данных: Массив чисел
• zone_ids
  Описание:
  Идентификаторы зон
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• items
  Описание:
  Список занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID тренажера
    Тип данных: Строка
  • type
    Описание:
    Тип тренажера из справочника
    Тип данных: Строка
  • picture
    Описание:
    ID картинки
    Тип данных: Строка
  • brand
    Описание:
    Бренд
    Тип данных: Строка
  • model
    Описание:
    Модель
    Тип данных: Строка
  • num
    Описание:
    Номер байка
    Тип данных: Строка
  • zone_id
    Описание:
    Идентификатор зоны
    Тип данных: Строка
  • zone_name
    Описание:
    Название зоны
    Тип данных: Строка
  • sport_type
    Описание:
    Тип спорта
    Тип данных: Число
  • sensors
    Описание:
    Объект датчиков
    Тип данных: Объект
info.timezone

Описание: Получить временную зону клуба
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• timezone
  Тип данных: Строка
equipment.edit

Описание: Изменить вид занятия
Входящие переменные:
• id
  Описание:
  ID тренажера
  Допустимый тип данных: Строка
• type
  Описание:
  Тип тренажера из справочника
  Допустимый тип данных: Строка
• num
  Описание:
  Номер байка
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
• sensors
  Описание:
  Объект датчиков
  Допустимый тип данных: Объект
• enabled
  Описание:
  Статус тренажера
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• updated
  Описание:
  Статус изменения
  Тип данных: Логическое выражение
equipment.remove

Описание: Удалить вид занятия
Входящие переменные:
• id
  Описание:
  ID типа занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  Статус удаления
  Тип данных: Логическое выражение
equipment.get

Описание: Получить вид занятия
Входящие переменные:
• id
  Описание:
  ID типа занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  ID тренажера
  Тип данных: Строка
• type
  Описание:
  Тип тренажера из справочника
  Тип данных: Строка
• picture
  Описание:
  ID картинки
  Тип данных: Строка
• brand
  Описание:
  Бренд
  Тип данных: Строка
• model
  Описание:
  Модель
  Тип данных: Строка
• num
  Описание:
  Номер байка
  Тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны
  Тип данных: Строка
• sensors
  Описание:
  Объект датчиков
  Тип данных: Объект
• zone_name
  Описание:
  Название зоны
  Тип данных: Строка
• sport_type
  Описание:
  Тип спорта
  Тип данных: Число
• enabled
  Описание:
  Статус тренажера
  Тип данных: Логическое выражение
sensors.scan

Описание: Получить список датчиков актуальный
Входящие переменные:
• zone_id
  Описание:
  ID зоны или коробочки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  ID датчика
  Тип данных: Строка
• type
  Описание:
  Тип датчика
  Тип данных: Строка
• value
  Описание:
  Значение датчика
  Тип данных: Строка
equipment_types.list

Описание: Получить список типов оборудования
Входящие переменные:
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Описание:
  ID датчика
  Тип данных: Строка
• picture
  Описание:
  Изображение
  Тип данных: Строка
• brand
  Описание:
  Бренд
  Тип данных: Строка
• model
  Описание:
  Модель
  Тип данных: Строка
• sensors
  Описание:
  Объект датчиков
  Тип данных: Массив (любые типы внутри)
sessions.self_training_check

Описание: Получить возможность и настройки самостоятельного занятия
Входящие переменные:
• zone_key
  Описание:
  Ключ зоны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• zone_id
  Описание:
  Идентификатор зоны
  Тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба
  Тип данных: Строка
• sport_types
  Описание:
  Доступные виды спорта
  Тип данных: undefined
• available_time
  Описание:
  Доступное время на тренировку в минутах
  Тип данных: Число
• error
  Описание:
  Ошибка
  Тип данных: Строка
sessions.self_training_start

Описание: Запустить самостоятельное занятие
Входящие переменные:
• zone_key
  Описание:
  Ключ зоны
  Допустимый тип данных: Строка
• workout_id
  Описание:
  Идентификатор программы
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор тренировочной сессии
  Тип данных: Строка
• error
  Описание:
  Ошибка
  Тип данных: Строка
schedule.duplicate

Описание: Дублировать расписание текущей недели
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• start_ts
  Допустимый тип данных: Число
Возвращаемые параметры:
sessions.add

Описание: Создать занятие в расписании
Входящие переменные:
• club_ids
  Описание:
  ID клубов
  Допустимый тип данных: Массив строк
• session_type обязательно
  Описание:
  ID вида занятия (ServiceProduct). Обязательный параметр.
  Допустимый тип данных: Строка
• sport_types
  Описание:
  Виды спорта (массив)
  Допустимый тип данных: Массив чисел
• duration
  Описание:
  Длительность занятия (минут)
  Допустимый тип данных: Число
• coach_ids
  Описание:
  Идентификаторы тренеров (uid)
  Допустимый тип данных: Массив чисел
• workout_id
  Описание:
  Идентификатор профиля тренировки
  Допустимый тип данных: Строка
• zone_ids
  Описание:
  ID зон клуба
  Допустимый тип данных: Массив строк
• planned_start_ts
  Описание:
  Дата начала по расписанию (unix timestamp)
  Допустимый тип данных: Число
• color
  Описание:
  Цвет занятия (hex)
  Допустимый тип данных: Строка
• autostart
  Описание:
  Автозапуск занятия
  Допустимый тип данных: Логическое выражение
• bootcamp
  Описание:
  Режим буткемпа
  Допустимый тип данных: Логическое выражение
• startafter
  Описание:
  Сразу перейти к запуску занятия
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Описание:
  ID занятия
  Тип данных: Строка
• session_type
  Описание:
  Вид занятия
  Тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Тип данных: Число
• coach_ids
  Описание:
  Идентификаторы тренеров
  Тип данных: Массив (любые типы внутри)
• workout_id
  Описание:
  Идентификатор схемы тренировки
  Тип данных: Строка
• zone_id
  Описание:
  ID зоны или коробочки
  Тип данных: Строка
• planned_start_ts
  Описание:
  Дата начала по расписанию
  Тип данных: Число
• color
  Описание:
  Цвет занятия
  Тип данных: Строка
• autostart
  Тип данных: Логическое выражение
sessions.edit

Описание: Изменить занятие в расписании
Входящие переменные:
• id
  Описание:
  ID занятия
  Допустимый тип данных: Строка
• session_type
  Описание:
  Вид занятия
  Допустимый тип данных: Строка
• duration
  Описание:
  Длительность занятия (минут)
  Допустимый тип данных: Число
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
• coach_ids
  Описание:
  Идентификаторы тренеров
  Допустимый тип данных: Массив (любые типы внутри)
• workout_id
  Описание:
  Идентификатор схемы тренировки
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны или коробочки
  Допустимый тип данных: Строка
• planned_start_ts
  Описание:
  Дата начала по расписанию
  Допустимый тип данных: Число
• color
  Описание:
  Цвет занятия
  Допустимый тип данных: Строка
• autostart
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• updated
  Описание:
  Обновлено
  Тип данных: Логическое выражение
sessions.addduration

Описание: Добавить длительность занятия
Входящие переменные:
• id
  Описание:
  ID занятия
  Допустимый тип данных: Строка
• duration
  Описание:
  Длительность занятия (минут)
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Описание:
  Обновлено
  Тип данных: Логическое выражение
• duration
  Тип данных: Число
sessions.get

Описание: Получить занятие в расписании
Входящие переменные:
• id
  Описание:
  ID занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  ID занятия
  Тип данных: Строка
• session_type
  Описание:
  Вид занятия
  Тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Тип данных: Число
• coach_ids
  Описание:
  Идентификаторы тренеров
  Тип данных: Массив (любые типы внутри)
• workout_id
  Описание:
  Идентификатор схемы тренировки
  Тип данных: Строка
• zone_id
  Описание:
  ID зоны или коробочки
  Тип данных: Строка
• duration
  Описание:
  Длительность занятия (минут)
  Тип данных: Число
• planned_start_ts
  Описание:
  Дата начала по расписанию
  Тип данных: Число
• color
  Описание:
  Цвет занятия
  Тип данных: Строка
• autostart
  Тип данных: Логическое выражение
sessions.graphs

Описание: Получить графики по занятию
Входящие переменные:
• id
  Описание:
  ID занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• graphs
  Описание:
  Данные графиков
  Тип данных: Объект
  Вложенные элементы:
  • power
    Тип данных: Массив (любые типы внутри)
  • cadence
    Тип данных: Массив (любые типы внутри)
  • hr
    Тип данных: Массив (любые типы внутри)
banners.add

Описание: Добавить баннер в клуб
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок баннера
  Допустимый тип данных: Строка
• fileid
  Описание:
  Идентификатор файла
  Допустимый тип данных: Строка
• islink
  Описание:
  Баннер является ссылкой
  Допустимый тип данных: Логическое выражение
• body
  Описание:
  Текст баннера
  Допустимый тип данных: Строка
• order
  Описание:
  Порядок показа
  Допустимый тип данных: Число
• showmoretext
  Описание:
  Текст 'Показать больше'
  Допустимый тип данных: Строка
• showmorelink
  Описание:
  Ссылка 'Показать больше'
  Допустимый тип данных: Строка
• openinapp
  Описание:
  Открывать ссылку в приложении
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• id
  Описание:
  Идентификатор баннера
  Тип данных: Строка
news.client.get

Описание: Добавить новость в клубе(ах)
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок уведомления
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
news.read

Описание: Добавить новость в клубе(ах)
Входящие переменные:
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
news.client.list

Описание: Добавить новость в клубе(ах)
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок уведомления
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
news.remove

Описание: Добавить новость в клубе(ах)
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок уведомления
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
news.get

Описание: Добавить новость в клубе(ах)
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок уведомления
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
news.list

Описание: Добавить новость в клубе(ах)
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок уведомления
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
news.edit

Описание: Добавить новость в клубе(ах)
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок уведомления
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
news.add

Описание: Добавить новость в клубе(ах)
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок новости
  Допустимый тип данных: Строка
• description
  Описание:
  Описание новости
  Допустимый тип данных: Строка
• body
  Описание:
  Тело новости
  Допустимый тип данных: Строка
• fileid
  Описание:
  Идентификатор файла обложки
  Допустимый тип данных: Строка
• date
  Описание:
  Дата публикации новости
  Допустимый тип данных: Дата (формат дд.мм.гггг)
• roles
  Описание:
  Роли пользователей, которым будет видна новость
  Допустимый тип данных: Массив (любые типы внутри)
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
notify.add

Описание: Добавить задачу на уведомление в клубе(ах)
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок уведомления
  Допустимый тип данных: Строка
• message
  Описание:
  Текст уведомления
  Допустимый тип данных: Строка
• roles
  Описание:
  Роли получателей (1 — клиенты, остальные — сотрудники/роли клуба)
  Допустимый тип данных: Массив (любые типы внутри)
• platforms
  Описание:
  Платформы: 2 — Android, 3 — iOS
  Допустимый тип данных: Массив чисел
• planned_send_ts
  Описание:
  Плановое время отправки (Unix timestamp)
  Допустимый тип данных: Число
• banner_id
  Описание:
  Открыть баннер по нажатию
  Допустимый тип данных: Строка
• news_id
  Описание:
  Открыть новость по нажатию
  Допустимый тип данных: Строка
• gender
  Описание:
  Пол: 0 — любой, 1 — мужской, 2 — женский
  Допустимый тип данных: Число
• age_min
  Описание:
  Минимальный возраст
  Допустимый тип данных: Число
• age_max
  Описание:
  Максимальный возраст
  Допустимый тип данных: Число
• sport_types
  Описание:
  Типы спорта, которые клиент посещал
  Допустимый тип данных: Массив чисел
• last_session_before
  Описание:
  Последнее занятие ранее (Unix timestamp)
  Допустимый тип данных: Число
• last_session_after
  Описание:
  Последнее занятие позже (Unix timestamp)
  Допустимый тип данных: Число
• only_visited
  Описание:
  Учитывать только клиентов, у которых были посещения
  Допустимый тип данных: Логическое выражение
• visited_club_ids
  Описание:
  Клубы, в которых должны быть посещения
  Допустимый тип данных: Массив строк
• session_types_visited
  Описание:
  Виды занятий (session_types), которые клиент посещал
  Допустимый тип данных: Массив строк
• session_types_not_visited
  Описание:
  Виды занятий (session_types), которые клиент не посещал
  Допустимый тип данных: Массив строк
• last_visit_before
  Описание:
  Последнее посещение клуба ранее (Unix timestamp)
  Допустимый тип данных: Число
• last_visit_after
  Описание:
  Последнее посещение клуба позже (Unix timestamp)
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Описание:
  Идентификатор задачи
  Тип данных: Строка
banners.edit

Описание: Добавить баннер в клуб
Входящие переменные:
• id
  Описание:
  Идентификатор баннера
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Описание:
  Заголовок баннера
  Допустимый тип данных: Строка
• fileid
  Описание:
  Идентификатор файла
  Допустимый тип данных: Строка
• showmoretext
  Описание:
  Текст 'Показать больше'
  Допустимый тип данных: Строка
• islink
  Описание:
  Баннер является ссылкой
  Допустимый тип данных: Логическое выражение
• body
  Описание:
  Текст баннера
  Допустимый тип данных: Строка
• order
  Описание:
  Порядок следования баннеров
  Допустимый тип данных: Число
• showmorelink
  Описание:
  Ссылка 'Показать больше'
  Допустимый тип данных: Строка
• openinapp
  Описание:
  Открывать ссылку в приложении
  Допустимый тип данных: Логическое выражение
• status
  Описание:
  Статус баннера
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  результат операции
  Тип данных: Логическое выражение
notify.edit

Описание: Изменить уведомление
Входящие переменные:
• id
  Описание:
  Идентификатор баннера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  результат операции
  Тип данных: Логическое выражение
banners.get

Описание: Получить баннер
Входящие переменные:
• id
  Описание:
  Идентификатор баннера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор баннера
  Тип данных: Строка
• club_ids
  Описание:
  Идентификаторы клубов
  Тип данных: Массив строк
• order
  Описание:
  Порядок следования баннеров
  Тип данных: Число
• title
  Описание:
  Заголовок баннера
  Тип данных: Строка
• fileid
  Описание:
  Идентификатор файла
  Тип данных: Строка
• islink
  Описание:
  Баннер является ссылкой
  Тип данных: Логическое выражение
• body
  Описание:
  Текст баннера
  Тип данных: Строка
• showmoretext
  Описание:
  Текст 'Показать больше'
  Тип данных: Строка
• showmorelink
  Описание:
  Ссылка 'Показать больше'
  Тип данных: Строка
• openinapp
  Описание:
  Открывать ссылку в приложении
  Тип данных: Логическое выражение
• status
  Описание:
  Статус баннера
  Тип данных: Логическое выражение
notify.get

Описание: Получить баннер
Входящие переменные:
• id
  Описание:
  Идентификатор задачи
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор баннера
  Тип данных: Строка
banners.clientList

Описание: Получить список баннеров в клубе
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор баннера
    Тип данных: Строка
  • title
    Описание:
    Заголовок баннера
    Тип данных: Строка
  • fileid
    Описание:
    Идентификатор файла
    Тип данных: Строка
  • islink
    Описание:
    Баннер является ссылкой
    Тип данных: Логическое выражение
  • body
    Описание:
    Текст баннера
    Тип данных: Строка
  • showmoretext
    Описание:
    Текст 'Показать больше'
    Тип данных: Строка
  • showmorelink
    Описание:
    Ссылка 'Показать больше'
    Тип данных: Строка
  • openinapp
    Описание:
    Открывать ссылку в приложении
    Тип данных: Логическое выражение
sessions.next

Описание: Получить информацию о ближайшей тренировке(ах)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор занятия
    Тип данных: Строка
  • title
    Описание:
    Заголовок баннера
    Тип данных: Строка
  • sport_types
    Описание:
    Виды спорта
    Тип данных: Массив чисел
  • planned_start_ts
    Описание:
    Время начала планируемое
    Тип данных: Число
  • color
    Описание:
    Цветовое кодирование занятия
    Тип данных: Строка
  • coaches
    Описание:
    Тренер, который ведет занятие
    Тип данных: Массив объектов
    Вложенные элементы:
    • id
      Описание:
      Идентификатор пользователя
      Тип данных: Число
    • firstname
      Тип данных: Строка
    • lastname
      Тип данных: Строка
banners.list

Описание: Получить список баннеров в клубе
Входящие переменные:
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор баннера
    Тип данных: Строка
  • clubs
    Описание:
    Идентификаторы клубов
    Тип данных: Массив строк
  • title
    Описание:
    Заголовок баннера
    Тип данных: Строка
  • order
    Описание:
    Порядок следования баннеров
    Тип данных: Число
  • fileid
    Описание:
    Файл картинки
    Тип данных: Строка
  • status
    Описание:
    Статус баннера
    Тип данных: Логическое выражение
notify.list

Описание: Получить список уведомлений в клубе
Входящие переменные:
Возвращаемые параметры:
notify.grid

Описание: Получить список уведомлений в клубе
Входящие переменные:
Возвращаемые параметры:
banners.remove

Описание: Удалить баннер в клубе
Входящие переменные:
• id
  Описание:
  Идентификатор баннера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  результат операции
  Тип данных: Логическое выражение
notify.remove

Описание: Удалить задачу на уведомления
Входящие переменные:
• id
  Описание:
  Идентификатор баннера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  результат операции
  Тип данных: Логическое выражение
notify.personal.add

Описание: Создать персональное уведомление для пользователя
Входящие переменные:
• uid обязательно
  Описание:
  ID пользователя
  Допустимый тип данных: Число
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив строк
• title
  Допустимый тип данных: Строка
• message
  Допустимый тип данных: Строка
• platforms
  Описание:
  2-Android,3-iOS
  Допустимый тип данных: Массив чисел
• banner_id
  Допустимый тип данных: Строка
• news_id
  Допустимый тип данных: Строка
• planned_send_ts
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
clients.communications

Описание: Список последних коммуникаций пользователя
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• uid обязательно
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
clients.communications.grid

Описание: Грид-список коммуникаций пользователя
Входящие переменные:
• club_id обязательно
  Допустимый тип данных: Строка
• uid обязательно
  Допустимый тип данных: Число
• limit
  Допустимый тип данных: Число
• skip
  Допустимый тип данных: Число
• order
  Допустимый тип данных: Объект
• filters
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
notify.viewed

Описание: Сообщить о прочтении уведомления
Входящие переменные:
• notify_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
reels.create

Описание: Создать рилс
Входящие переменные:
• title
  Описание:
  Заголовок рилса
  Допустимый тип данных: Строка
• roles
  Описание:
  Роли пользователей, которым будет видна новость
  Допустимый тип данных: Массив (любые типы внутри)
• description
  Описание:
  Описание рилса
  Допустимый тип данных: Строка
• body
  Описание:
  Тело рилса
  Допустимый тип данных: Строка
• date
  Описание:
  Дата публикации рилса
  Допустимый тип данных: Дата (формат дд.мм.гггг)
• fileid
  Описание:
  Идентификатор файла обложки
  Допустимый тип данных: Строка
• thumbnailFileId
  Описание:
  Идентификатор файла для блока на главной
  Допустимый тип данных: Строка
• transitionType
  Описание:
  Тип перехода: 1 — при нажатии на рилс, 2 — отдельная кнопка, 0 — без перехода
  Допустимый тип данных: Строка
• buttonPosition
  Описание:
  Расположение кнопки, top - сверху, bottom - снизу
  Допустимый тип данных: Строка
• buttonText
  Описание:
  Текст кнопки
  Допустимый тип данных: Строка
• buttonColor
  Описание:
  Цвет кнопки
  Допустимый тип данных: Строка
• buttonTextColor
  Описание:
  Цвет текста кнопки
  Допустимый тип данных: Строка
• actionType
  Описание:
  Действие при нажатии на рилс/кнопку
  Допустимый тип данных: Строка
• actionTargetId
  Описание:
  ID объекта
  Допустимый тип данных: Строка
• actionUrl
  Описание:
  URL для внешнего действия
  Допустимый тип данных: Строка
• date_start
  Описание:
  Дата начала рилса (Unix timestamp)
  Допустимый тип данных: Число
• date_end
  Описание:
  Дата окончания рилса (Unix timestamp)
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Описание:
  Идентификатор рилса
  Тип данных: Строка
reels.edit

Описание: Редактироавть рилс
Входящие переменные:
• id
  Описание:
  Идентификатор рилса
  Допустимый тип данных: Строка
• title
  Описание:
  Заголовок рилса
  Допустимый тип данных: Строка
• roles
  Описание:
  Роли
  Допустимый тип данных: Массив (любые типы внутри)
• description
  Описание:
  Описание рилса
  Допустимый тип данных: Строка
• body
  Описание:
  Тело рилса
  Допустимый тип данных: Строка
• date
  Описание:
  Дата публикации рилса
  Допустимый тип данных: Дата (формат дд.мм.гггг)
• fileid
  Описание:
  Идентификатор файла рилса
  Допустимый тип данных: Строка
• thumbnailFileId
  Описание:
  Идентификатор файла для блока на главной
  Допустимый тип данных: Строка
• status
  Описание:
  Статус рилса
  Допустимый тип данных: Логическое выражение
• club_ids
  Описание:
  Идентификаторы клубов
  Допустимый тип данных: Массив (любые типы внутри)
• transitionType
  Описание:
  Тип перехода: 1 — при нажатии на рилс, 2 — отдельная кнопка, 0 — без перехода
  Допустимый тип данных: Строка
• buttonPosition
  Описание:
  Расположение кнопки, top - сверху, bottom - снизу
  Допустимый тип данных: Строка
• buttonText
  Описание:
  Текст кнопки
  Допустимый тип данных: Строка
• buttonColor
  Описание:
  Цвет кнопки
  Допустимый тип данных: Строка
• buttonTextColor
  Описание:
  Цвет текста кнопки
  Допустимый тип данных: Строка
• actionType
  Описание:
  Действие при нажатии на рилс/кнопку
  Допустимый тип данных: Строка
• actionTargetId
  Описание:
  ID объекта
  Допустимый тип данных: Строка
• actionUrl
  Описание:
  URL для внешнего действия
  Допустимый тип данных: Строка
• date_start
  Описание:
  Дата начала рилса (Unix timestamp)
  Допустимый тип данных: Число
• date_end
  Описание:
  Дата окончания рилса (Unix timestamp)
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Описание:
  Идентификатор рилса
  Тип данных: Строка
reels.view

Описание: Получить рилс
Входящие переменные:
• id
  Описание:
  ID рилса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор рилса
  Тип данных: Строка
• title
  Описание:
  Заголовок рилса
  Тип данных: Строка
• body
  Описание:
  Тело рилса
  Тип данных: Строка
• roles
  Описание:
  Роли пользователей, которым будет виден рилс
  Тип данных: Массив (любые типы внутри)
• club_ids
  Описание:
  Идентификатор клубов
  Тип данных: Массив (любые типы внутри)
• date
  Описание:
  Дата публикация рилса
  Тип данных: Дата (формат дд.мм.гггг)
• fileid
  Описание:
  Идентификатор файла рилса
  Тип данных: Строка
• status
  Описание:
  Статус рилса
  Тип данных: Логическое выражение
• thumbnailFileId
  Описание:
  Идентификатор файла для блока на главной
  Тип данных: Строка
• transitionType
  Описание:
  Тип перехода: 1 — при нажатии на рилс, 2 — отдельная кнопка, 0 — без перехода
  Тип данных: Строка
• buttonPosition
  Описание:
  Расположение кнопки, top - сверху, bottom - снизу
  Тип данных: Строка
• buttonText
  Описание:
  Текст кнопки
  Тип данных: Строка
• buttonColor
  Описание:
  Цвет кнопки
  Тип данных: Строка
• buttonTextColor
  Описание:
  Цвет текста кнопки
  Тип данных: Строка
• actionType
  Описание:
  Действие при нажатии на рилс/кнопку
  Тип данных: Строка
• actionTargetId
  Описание:
  ID объекта
  Тип данных: Строка
• actionUrl
  Описание:
  URL для внешнего действия
  Тип данных: Строка
• date_start
  Описание:
  Дата начала рилса (Unix timestamp)
  Тип данных: Число
• date_end
  Описание:
  Дата окончания рилса (Unix timestamp)
  Тип данных: Число
reels.list

Описание: Получить список рилсов в клубе с поддержкой Grid системы
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• limit
  Описание:
  Количество записей на странице (1-200)
  Допустимый тип данных: Число
• skip
  Описание:
  Количество пропущенных записей
  Допустимый тип данных: Число
• order
  Описание:
  Параметры сортировки {field, order}
  Допустимый тип данных: Объект
• filters
  Описание:
  Объект фильтров
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Описание:
  Массив рилсов
  Тип данных: Массив (любые типы внутри)
• total
  Описание:
  Общее количество записей
  Тип данных: Число
• skip
  Описание:
  Количество пропущенных записей
  Тип данных: Число
• limit
  Описание:
  Количество записей на странице
  Тип данных: Число
reels.clientList

Описание: Получить список рилсов для клиента с учетом сегментов и ролей
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив рилсов
  Тип данных: Массив (любые типы внутри)
reels.like

Описание: Поставить или убрать лайк на рилс
Входящие переменные:
• reel_id
  Описание:
  ID рилса для лайка/дизлайка
  Допустимый тип данных: Строка
Возвращаемые параметры:
reels.remove

Описание: Удалить рилс
Входящие переменные:
• id
  Описание:
  Идентификатор рилса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
sessions.stats

Описание: Получить данные статистики по участникам занятия
Входящие переменные:
• id
  Описание:
  ID занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
sessions.rem

Описание: Удалить занятие в расписании
Входящие переменные:
• id
  Описание:
  ID занятия
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  Удалено
  Тип данных: Логическое выражение
sessions.list

Описание: Получить занятие в расписании
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• zone_id
  Допустимый тип данных: Строка
• session_type
  Описание:
  Вид занятия
  Допустимый тип данных: Строка
• sport_types
  Допустимый тип данных: Массив (любые типы внутри)
• coach_ids
  Допустимый тип данных: Массив (любые типы внутри)
• only_own
  Допустимый тип данных: Логическое выражение
• from_ts
  Допустимый тип данных: Число
• to_ts
  Допустимый тип данных: Число
Возвращаемые параметры:
• sessions
  Описание:
  Занятия
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID занятия
    Тип данных: Строка
  • session_type
    Описание:
    Вид занятия
    Тип данных: Строка
  • session_type_name
    Описание:
    Вид занятия
    Тип данных: Строка
  • sport_type
    Описание:
    Вид спорта
    Тип данных: Число
  • coaches
    Описание:
    Идентификаторы тренеров
    Тип данных: Массив объектов
    Вложенные элементы:
    • id
      Тип данных: Строка
    • firstname
      Тип данных: Строка
    • lastname
      Тип данных: Строка
  • duration
    Описание:
    Длительность занятия (минут)
    Тип данных: Число
  • box_name
    Описание:
    Название зоны или коробочки
    Тип данных: Строка
  • planned_start_ts
    Описание:
    Дата начала по расписанию
    Тип данных: Число
  • color
    Описание:
    Цвет занятия
    Тип данных: Строка
  • is_paid
    Тип данных: Логическое выражение
• session_types
  Описание:
  Виды занятия
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID типа занятия
    Тип данных: Строка
  • name
    Тип данных: Строка
• coaches
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • firstname
    Тип данных: Строка
  • lastname
    Тип данных: Строка
• boxes
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • name
    Тип данных: Строка
get.device.token

Описание: Зарегистрировать устройство под клубом
Входящие переменные:
• club_id
  Описание:
  ID клуба. Необходимо передать для первоначальной привязки оборудования к клубу
  Допустимый тип данных: Строка
• hw_id обязательно
  Описание:
  Идентификатор оборудования
  Допустимый тип данных: Строка
• os обязательно
  Описание:
  Операционная система
  Допустимый тип данных: Строка
• os_version обязательно
  Описание:
  Версия операционной системы
  Допустимый тип данных: Строка
• current_version обязательно
  Описание:
  Текущая версия ПО Трайд
  Допустимый тип данных: Строка
Возвращаемые параметры:
• access_token
  Описание:
  Токен авторизации устройства клуба
  Тип данных: Строка
integrations.get

Описание: Получить настройки интеграций
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
integrations.update

Описание: Изменить настройки интеграций
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
group.edit

Описание: Изменить настройки интеграций
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
integrations.keys

Описание: Получить список ключей интеграции
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
integrations.sync_settings.get

Описание: Получить настройки синхронизации интеграции
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
integrations.sync_settings.update

Описание: Обновить настройки синхронизации интеграции
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• sync_settings обязательно
  Описание:
  Настройки синхронизации по типам объектов
  Допустимый тип данных: Объект
Возвращаемые параметры:
integrations.operations.get

Описание: Получить настройки операций интеграции
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
integrations.operations.update

Описание: Обновить настройки операций интеграции
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• operations обязательно
  Описание:
  Настройки операций (bookings, cancellations, purchases, payments, extensions)
  Допустимый тип данных: Объект
Возвращаемые параметры:
integrations.sync_status.get

Описание: Получить статус синхронизации для всех типов объектов
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
integrations.sync.trigger

Описание: Принудительный запуск синхронизации для указанного типа
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• sync_type обязательно
  Описание:
  Тип синхронизации (employees, zones, session_types, products, и т.д.)
  Допустимый тип данных: Строка
Возвращаемые параметры:
integrations.all_settings.get

Описание: Получить все настройки интеграции (объединённый метод)
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
feedback.session.grid

Описание: Грид оценок занятий
Входящие переменные:
• club_id
• filters
• order
• limit
• skip
Возвращаемые параметры:
feedback.coach.grid

Описание: Грид оценок тренеров
Входящие переменные:
• club_id
• filters
• order
• limit
• skip
Возвращаемые параметры:
smartdevices.grid

Описание: Grid умных устройств клуба с фильтрами, сортировкой и пагинацией
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
• order
  Описание:
  Сортировка { field, order }
  Допустимый тип данных: Объект
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• skip
  Тип данных: Число
• limit
  Тип данных: Число
smartdevices.list

Описание: Список умных устройств клуба (опционально по зоне/группе)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Фильтр по зоне
  Допустимый тип данных: Строка
• group_id
  Описание:
  Фильтр по группе
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
smartdevices.get

Описание: Получение умного устройства по идентификатору
Входящие переменные:
• device_id
  Описание:
  Идентификатор устройства
  Допустимый тип данных: Строка
• id
  Описание:
  Идентификатор устройства (альтернатива)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• device
  Тип данных: Объект
smartdevices.add

Описание: Создание умного устройства
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
• group_id
  Описание:
  Идентификатор группы
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название устройства
  Допустимый тип данных: Строка
• kind
  Описание:
  Тип: bulb или strip
  Допустимый тип данных: Строка
• transport
  Описание:
  Транспорт управления (tuya_local)
  Допустимый тип данных: Строка
• tuya
  Описание:
  Параметры Tuya { device_id, local_key, ip, protocol_version, category }
  Допустимый тип данных: Объект
• caps
  Описание:
  Возможности { onoff, brightness, color_temp, rgb }
  Допустимый тип данных: Объект
• order
  Описание:
  Порядок сортировки
  Допустимый тип данных: Число
• status
  Описание:
  Включено в системе
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
smartdevices.edit

Описание: Редактирование умного устройства
Входящие переменные:
• device_id
  Описание:
  Идентификатор устройства
  Допустимый тип данных: Строка
• id
  Описание:
  Идентификатор устройства (альтернатива)
  Допустимый тип данных: Строка
• zone_id
  Допустимый тип данных: Строка
• group_id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• kind
  Допустимый тип данных: Строка
• transport
  Допустимый тип данных: Строка
• tuya
  Допустимый тип данных: Объект
• caps
  Допустимый тип данных: Объект
• order
  Допустимый тип данных: Число
• status
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
smartdevices.remove

Описание: Удаление умного устройства
Входящие переменные:
• device_id
  Описание:
  Идентификатор устройства
  Допустимый тип данных: Строка
• id
  Описание:
  Идентификатор устройства (альтернатива)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• removed
  Тип данных: Логическое выражение
smartdevices.groups.list

Описание: Список групп умных устройств (опционально по зоне)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Фильтр по зоне
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
smartdevices.groups.add

Описание: Создание группы умных устройств
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название группы
  Допустимый тип данных: Строка
• order
  Описание:
  Порядок сортировки
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• id
  Тип данных: Строка
smartdevices.groups.edit

Описание: Редактирование группы умных устройств
Входящие переменные:
• group_id
  Описание:
  Идентификатор группы
  Допустимый тип данных: Строка
• id
  Описание:
  Идентификатор группы (альтернатива)
  Допустимый тип данных: Строка
• zone_id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• order
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
smartdevices.groups.remove

Описание: Удаление группы умных устройств
Входящие переменные:
• group_id
  Описание:
  Идентификатор группы
  Допустимый тип данных: Строка
• id
  Описание:
  Идентификатор группы (альтернатива)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• removed
  Тип данных: Логическое выражение
smartdevices.setstate

Описание: Ручное управление умными устройствами зоны (устройство/группа/зона)
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
• target обязательно
  Описание:
  Цель { type: 'device'|'group'|'zone', id }
  Допустимый тип данных: Объект
• state
  Описание:
  Состояние { power, brightness, color, color_temp }
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение

Модуль challenges

Общая информация

draft

Описание: Создать черновик челленджа
Входящие переменные:
Возвращаемые параметры:
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• teams
  Описание:
  Массив данных команд участвующих в челлендже
  Тип данных: Массив объектов
• error
  Описание:
  Если ошибка, то сообщение об ошибке, одно из следующих:
  • no_permission - нет прав
  
  Тип данных: Строка
save

Описание: Сохранить челлендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Список идентификаторов клубов челленджа. Может быть пустым - тогда без клуба
  Допустимый тип данных: Массив строк
• aim_type обязательно
  Описание:
  Тип цели, возможные значения:
  • distance - по общей дистанции в км
  • calories - по общим сожженным калориям
  • points - по количеству набранных балов
  
  Допустимый тип данных: Строка
• aim_description
  Описание:
  Описание цели
  Допустимый тип данных: Строка
• date_start обязательно
  Описание:
  Дата начала челленджа (Unix timestamp)
  Допустимый тип данных: Число
• date_end обязательно
  Описание:
  Дата окончания челленджа (Unix timestamp)
  Допустимый тип данных: Число
• use_params
  Описание:
  Параметры отображаемые и необходимые для челленджа. Возможные значения: weight
  Допустимый тип данных: Массив (любые типы внутри)
• name
  Описание:
  Название челенджа
  Допустимый тип данных: Строка
• description
  Описание:
  Описание челенджа
  Допустимый тип данных: Строка
• picture_fileid
  Описание:
  Идентификатор файла аватарки челленджа
  Допустимый тип данных: Строка
• autojoin
  Описание:
  Признак автоматического присоединения участников к челленджу
  Допустимый тип данных: Логическое выражение
• coach_allowed
  Описание:
  Признак могут ли участвовать сотрудники
  Допустимый тип данных: Логическое выражение
• challenge_type
  Описание:
  Вид челленджа: individual - индивидуальный челлендж, teams - комендный, group - индивидуальный по автоматическим группам по возрасту и(или) полу
  Допустимый тип данных: Строка
• team_jointype
  Описание:
  choose - пользователь сам выбирает команду, auto - по критериям возраста и пола, random - случайным образом автоматом
  Допустимый тип данных: Строка
• privacy_level
  Описание:
  Уровень доступа к челленджу:
  • 1 (по умолчанию если указан клуб) виден и доступен для присоединения только клиентам клуба
  • 2 (по умолчанию если клуб не указан) виден и доступен всем пользователям трайд
  • 3 - закрытый челлендж, доступен только по ссылке-приглашению и путем добавления участников
  • 4 - Челлендж проводится между всеми пользователями которые являются членами хотя бы 1 клубе (может устанвить только администратор трайд)
  
  Допустимый тип данных: Число
• activity_club_ids
  Описание:
  Список клубов, активности из которых учитываются в челлендже (опционально, для закрытых челленджей privacy_level=3)
  Допустимый тип данных: Массив строк
• club_competition_mode
  Описание:
  Включить клубный зачёт (рейтинг клубов по суммарным результатам их участников)
  Допустимый тип данных: Логическое выражение
• count_all_activities
  Описание:
  Учитывать все активности участников вне зависимости от момента вступления в челлендж
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• updated
  Описание:
  Сохранено
  Тип данных: Логическое выражение
• club_ids
  Описание:
  Список идентификаторов клубов челленджа. Может быть пустым - тогда без клуба
  Тип данных: Массив строк
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• name
  Описание:
  Название челенджа
  Тип данных: Строка
• aim_type
  Описание:
  Тип цели, возможные значения:
  • distance - по общей дистанции в км
  • calories - по общим сожженным калориям
  • points - по количеству набранных балов
  
  Тип данных: Строка
• aim_description
  Описание:
  Описание цели
  Тип данных: Строка
• date_start
  Описание:
  Дата начала челленджа (Unix timestamp)
  Тип данных: Число
• date_end
  Описание:
  Дата окончания челленджа (Unix timestamp)
  Тип данных: Число
• description
  Описание:
  Описание челенджа
  Тип данных: Строка
• picture_fileid
  Описание:
  Идентификатор файла аватарки челленджа
  Тип данных: Строка
• privacy_level
  Описание:
  Уровень доступа к челленджу:
  • 1 (по умолчанию если указан клуб) виден и доступен для присоединения только клиентам клуба
  • 2 (по умолчанию если клуб не указан) виден и доступен всем пользователям трайд
  • 3 - закрытый челлендж, доступен только по ссылке-приглашению и путем добавления участников
  • 4 - челлендж среди всех участников трайд членов клубов
  
  Тип данных: Число
• autojoin
  Описание:
  Автовступление в челлендж для клубных челленджей
  Тип данных: Логическое выражение
• coach_allowed
  Описание:
  Признак могут ли участвовать сотрудники
  Тип данных: Логическое выражение
• challenge_type
  Описание:
  Вид челленджа: individual - индивидуальный челлендж, teams - комендный, group - индивидуальный по автоматическим группам по возрасту и(или) полу
  Тип данных: Строка
• team_jointype
  Описание:
  choose - пользователь сам выбирает команду, auto - по критериям возраста и пола, random - случайным образом автоматом
  Тип данных: Строка
• invite_link_key
  Описание:
  Ключ для ссылки-приглашения в челендже
  Тип данных: Строка
• invite_link_club_key
  Описание:
  Ключ для ссылки-приглашения в челендже
  Тип данных: Строка
• published
  Описание:
  Челендж включен и опубликован (true чтобы сделать доступным в списке и по ссылке)
  Тип данных: Логическое выражение
remove

Описание: Удалить челлендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  удалено
  Тип данных: Логическое выражение
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
get

Описание: Получить информацию о челендже
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• key
  Описание:
  Ключ из ссылки-приглашения в челендже
  Допустимый тип данных: Строка
• club_key
  Описание:
  Ключ из ссылки-приглашения клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• aim_type
  Описание:
  Тип цели, возможные значения:
  • distance - по общей дистанции в км
  • calories - по общим сожженным калориям
  • points - по количеству набранных балов
  
  Тип данных: Строка
• aim_description
  Описание:
  Описание цели
  Тип данных: Строка
• date_start
  Описание:
  Дата начала челленджа (Unix timestamp)
  Тип данных: Число
• date_end
  Описание:
  Дата окончания челленджа (Unix timestamp)
  Тип данных: Число
• use_params
  Описание:
  Параметры отображаемые и необходимые для челленджа. Возможные значения: weight
  Тип данных: Массив (любые типы внутри)
• name
  Описание:
  Название челенджа
  Тип данных: Строка
• description
  Описание:
  Описание челенджа
  Тип данных: Строка
• picture_fileid
  Описание:
  Идентификатор файла аватарки челленджа
  Тип данных: Строка
• finished
  Описание:
  Челендж завершен
  Тип данных: Логическое выражение
• started
  Описание:
  Челендж начался
  Тип данных: Логическое выражение
• joined
  Описание:
  Текущий пользователь присоединилися (участвует, участвовал) в челлендже
  Тип данных: Логическое выражение
• can_join
  Описание:
  Текущий пользователь может вступить в челендж
  Тип данных: Логическое выражение
• can_join_club
  Описание:
  Возможно присоединение клубом
  Тип данных: Логическое выражение
• can_edit
  Описание:
  Текущий пользователь может редактировать челендж
  Тип данных: Логическое выражение
• invited
  Описание:
  Текущий пользователь приглашен в челлендж и требуется вступление
  Тип данных: Логическое выражение
• missing_params
  Описание:
  Массив недостающих параметров. Может содержать: weight, birthdate, nickname,gender
  Тип данных: Массив (любые типы внутри)
• my_team
  Описание:
  Идентификатор команды текущего пользователя. Пусто - если не вступил в челлендж
  Тип данных: Строка
• my_place
  Описание:
  Место в рейтинге команды
  Тип данных: Число
• teams
  Описание:
  Список команд / групп
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор команды
    Тип данных: Строка
  • name
    Описание:
    Название команды
    Тип данных: Строка
  • gender
    Описание:
    Пол. 1 - межской, 0 - любой, 2 - женский
    Тип данных: Число
  • age_from
    Описание:
    Начиная с какого возраста (0 - не установлено)
    Тип данных: Число
  • age_to
    Описание:
    Какой максимальный возраст (0 - не установлено)
    Тип данных: Число
• prizes
  Описание:
  Список призов
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор приза
    Тип данных: Строка
  • name
    Описание:
    Название приза
    Тип данных: Строка
  • avatar_id
    Описание:
    Идентификатор аватарки приза
    Тип данных: Строка
• privacy_level
  Описание:
  Уровень доступа к челленджу:
  • 1 (по умолчанию если указан клуб) виден и доступен для присоединения только клиентам клуба
  • 2 (по умолчанию если клуб не указан) виден и доступен всем пользователям трайд
  • 3 - закрытый челлендж, доступен только по ссылке-приглашению и путем добавления участников
  
  Тип данных: Число
• invite_link_key
  Описание:
  Ключ для ссылки-приглашения в челендже
  Тип данных: Строка
• invite_link_club_key
  Описание:
  Ключ для ссылки-приглашения клуба
  Тип данных: Строка
• published
  Описание:
  Челендж включен и опубликован
  Тип данных: Логическое выражение
• clubs
  Описание:
  Список клубов-участников
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор клуба
    Тип данных: Строка
  • value
    Описание:
    Название клуба
    Тип данных: Строка
• invited_clubs
  Описание:
  Список клубов-участников, которые присоединились к челленджу по приглашению
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор клуба
    Тип данных: Строка
  • value
    Описание:
    Название клуба
    Тип данных: Строка
• autojoin
  Описание:
  Добавлять участников автоматически
  Тип данных: Логическое выражение
• coach_allowed
  Описание:
  Признак могут ли участвовать сотрудники
  Тип данных: Логическое выражение
• challenge_type
  Описание:
  Вид челленджа: individual - индивидуальный челлендж, teams - комендный, group - индивидуальный по автоматическим группам по возрасту и(или) полу
  Тип данных: Строка
• team_jointype
  Описание:
  choose - пользователь сам выбирает команду, auto - по критериям возраста и пола, random - случайным образом автоматом
  Тип данных: Строка
• activity_club_ids
  Описание:
  Список клубов, активности из которых учитываются в челлендже (для закрытых челленджей)
  Тип данных: Массив строк
• activity_clubs
  Описание:
  Список клубов для учёта активностей с названиями
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор клуба
    Тип данных: Строка
  • value
    Описание:
    Название клуба
    Тип данных: Строка
• club_competition_mode
  Описание:
  Включён ли клубный зачёт
  Тип данных: Логическое выражение
list

Описание: Получить список челленджей
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• show_past
  Описание:
  Если передан данный параметр равный true - то вернется список прощадших а не текущих челленджей
  Допустимый тип данных: Логическое выражение
• оке
  Описание:
  Максимальное количество челенджей в выдаче
  Допустимый тип данных: Число
• skip
  Описание:
  Начиная с какого челленджа показывать
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Описание:
  Общее количество челленджей в соответствии с фильтрами
  Тип данных: Число
• challenges
  Описание:
  Массив объектов челленджей
  Тип данных: Массив объектов
  Вложенные элементы:
  • challenge_id
    Описание:
    Идентификатор челленджа
    Тип данных: Строка
  • aim_type
    Описание:
    Тип цели, возможные значения:
    • distance - по общей дистанции в км
    • calories - по общим сожженным калориям
    • points - по количеству набранных балов
    
    Тип данных: Строка
  • aim_description
    Описание:
    Описание цели
    Тип данных: Строка
  • date_start
    Описание:
    Дата начала челленджа (Unix timestamp)
    Тип данных: Число
  • date_end
    Описание:
    Дата окончания челленджа (Unix timestamp)
    Тип данных: Число
  • name
    Описание:
    Название челенджа
    Тип данных: Строка
  • description
    Описание:
    Описание челенджа
    Тип данных: Строка
  • picture_fileid
    Описание:
    Идентификатор файла аватарки челленджа
    Тип данных: Строка
  • finished
    Описание:
    Челендж завершен
    Тип данных: Логическое выражение
  • started
    Описание:
    Челендж начался
    Тип данных: Логическое выражение
  • joined
    Описание:
    Текущий пользователь присоединилися (участвует, участвовал) в челлендже
    Тип данных: Логическое выражение
  • invited
    Описание:
    Текущий пользователь приглашен в челлендж и требуется вступление
    Тип данных: Логическое выражение
  • my_team
    Описание:
    Идентификатор команды текущего пользователя. Пусто - если не вступил в челлендж
    Тип данных: Строка
  • my_place
    Описание:
    Место в рейтинге команды
    Тип данных: Число
  • coach_allowed
    Описание:
    Признак могут ли участвовать сотрудники
    Тип данных: Логическое выражение
  • challenge_type
    Описание:
    Вид челленджа: individual - индивидуальный челлендж, teams - комендный, group - индивидуальный по автоматическим группам по возрасту и(или) полу
    Тип данных: Строка
  • published
    Описание:
    Челендж включен и опубликован
    Тип данных: Логическое выражение
  • participants_count
    Описание:
    Количество участников челленджа
    Тип данных: Число
set.published

Описание: Опубликовать снять с публикации челендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• published обязательно
  Описание:
  Опубликовать (true) или снять с публикации (false)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• published
  Описание:
  Статус публикации челенджа
  Тип данных: Логическое выражение
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
export

Описание: Экспортировать в Excel
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
Возвращаемые параметры:
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• exported
  Тип данных: Логическое выражение
• url
  Тип данных: Строка
• error
  Описание:
  Если ошибка, то сообщение об ошибке, одно из следующих:
  • no_permission - нет прав
  
  Тип данных: Строка
invite

Описание: Пригласить пользователя в челлендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• phone обязательно
  Описание:
  Номер телефона для приглашения в челлендж в формате 7XXXYYYYYYY
  Допустимый тип данных: Строка
Возвращаемые параметры:
• invited
  Описание:
  Успешно приглашен
  Тип данных: Логическое выражение
• error
  Описание:
  Сообщение об ошибке (невозможности приглашения):
  • finished - челлендж уже завершен
  • phone - неверно указан номер телефона
  • privacy - неверный уровень приватности
  • already - уже присоединился к челленджу этому или уже приглашен
  
  Тип данных: Строка
team.results

Описание: Получить результаты команд в челлендже
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
Возвращаемые параметры:
• challenge_id
  Тип данных: Строка
• aim_type
  Тип данных: Строка
• teams
  Описание:
  Список команд с результатами
  Тип данных: Массив объектов
  Вложенные элементы:
  • team_id
    Тип данных: Строка
  • name
    Тип данных: Строка
  • avatar
    Тип данных: Строка
  • place
    Тип данных: Число
  • result
    Тип данных: Строка
  • members_count
    Тип данных: Число
  • totals
    Описание:
    Суммарные показатели
    Тип данных: Объект
    Вложенные элементы:
    • distance
      Тип данных: Строка
    • calories
      Тип данных: Число
    • points
      Тип данных: Число
club.results

Описание: Получить результаты клубов в челлендже (клубный зачёт)
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
Возвращаемые параметры:
• challenge_id
  Тип данных: Строка
• aim_type
  Тип данных: Строка
• clubs
  Описание:
  Список клубов с результатами
  Тип данных: Массив объектов
  Вложенные элементы:
  • club_id
    Тип данных: Строка
  • name
    Тип данных: Строка
  • logo
    Тип данных: Строка
  • place
    Тип данных: Число
  • result
    Тип данных: Строка
  • members_count
    Тип данных: Число
  • totals
    Описание:
    Суммарные показатели
    Тип данных: Объект
    Вложенные элементы:
    • distance
      Тип данных: Строка
    • calories
      Тип данных: Число
    • points
      Тип данных: Число
rating.get

Описание: Получить текущий рейтинг в челендже
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• team_id
  Описание:
  Идентификатор команды
  Допустимый тип данных: Строка
• place_start
  Описание:
  Место, с которого начать отчет, 1 по умолчанию
  Допустимый тип данных: Число
• limit
  Описание:
  Количество участников рейтинга в одной выдаче, 10 по умолчанию
  Допустимый тип данных: Число
• search
  Описание:
  Строка поиска участника: по нику — для всех, по телефону — только при праве редактирования челленджа
  Допустимый тип данных: Строка
Возвращаемые параметры:
• my_place
  Описание:
  На каком месте текущий пользователь. -1 если пользователь не в челендже
  Тип данных: Число
• joined
  Описание:
  Пользователь участвует в челлендже
  Тип данных: Логическое выражение
• total
  Описание:
  Количество всего позиций в рейтинге
  Тип данных: Число
• particpants
  Описание:
  Список участников рейтинга
  Тип данных: Массив объектов
  Вложенные элементы:
  • place
    Описание:
    Место
    Тип данных: Число
  • nickname
    Описание:
    Никнейм
    Тип данных: Строка
  • result
    Описание:
    Результат
    Тип данных: Строка
join

Описание: Вступить в челлендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• key
  Описание:
  Ключ для вступления в челленлдж
  Допустимый тип данных: Строка
Возвращаемые параметры:
• joined
  Описание:
  Успешно вступил
  Тип данных: Логическое выражение
• team_id
  Описание:
  Идентификатор команды
  Тип данных: Строка
• team_name
  Описание:
  Название команды
  Тип данных: Строка
• error
  Описание:
  Сообщение об ошибке (невозможности участия):
  • finished - челлендж уже завершен
  • no_team - нет подходящей команды
  • no_age - не указан возраст у пользователя
  • no_weight - не указан вес пользователя
  • no_gender - не указан пол пользователя
  • already - уже присоединился к челленджу этому
  
  Тип данных: Строка
remove.club

Описание: Удалить приглашенный клуб
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  удалено
  Тип данных: Логическое выражение
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
join.club

Описание: Вступить в челлендж своим клубом (принять приглашение)
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• club_ids обязательно
  Описание:
  Идентификатор(ы) клуба(ов)
  Допустимый тип данных: Массив строк
• club_key
  Описание:
  Ключ-приглашение
  Допустимый тип данных: Строка
Возвращаемые параметры:
• joined
  Описание:
  Успешно вступил
  Тип данных: Логическое выражение
• error
  Описание:
  Сообщение об ошибке (невозможности участия):
  • finished - челлендж уже завершен
  • no_permission - нет прав, приглашения или неверный челлендж
  • no_age - не указан возраст у пользователя
  • no_weight - не указан вес пользователя
  • no_gender - не указан пол пользователя
  • already - уже присоединился к челленджу этому
  
  Тип данных: Строка
exit

Описание: Выйти из челленджа
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
Возвращаемые параметры:
• left
  Описание:
  Успешно вышел
  Тип данных: Логическое выражение
kick

Описание: Удалить из челленджа
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  Идентификатор участника
  Допустимый тип данных: Число
Возвращаемые параметры:
• removed
  Описание:
  Успешно удален
  Тип данных: Логическое выражение
ban

Описание: Забанить из челленджа
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  Идентификатор участника
  Допустимый тип данных: Число
Возвращаемые параметры:
• removed
  Описание:
  Успешно удален
  Тип данных: Логическое выражение
unban

Описание: Снять бан с пользователя челленджа
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  Идентификатор участника
  Допустимый тип данных: Число
Возвращаемые параметры:
• removed
  Описание:
  Успешно удален
  Тип данных: Логическое выражение
activities.add

Описание: Добавить ручную активность участнику в челлендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  Идентификатор участника
  Допустимый тип данных: Число
• title
  Описание:
  Название/комментарий активности
  Допустимый тип данных: Строка
• distance
  Описание:
  Дистанция в км
  Допустимый тип данных: Дробное число
• calories
  Описание:
  Калории
  Допустимый тип данных: Число
• points
  Описание:
  Баллы
  Допустимый тип данных: Число
• ts
  Описание:
  Unix timestamp, время активности (по умолчанию сейчас)
  Допустимый тип данных: Число
Возвращаемые параметры:
• added
  Тип данных: Логическое выражение
• activity_id
  Описание:
  Идентификатор созданной активности
  Тип данных: Строка
• error
  Тип данных: Строка
activities.remove

Описание: Удалить активность участника из челленджа
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  Идентификатор участника
  Допустимый тип данных: Число
• activity_id
  Описание:
  Идентификатор активности
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
activities.list

Описание: Получить список активностей челленджа
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  Идентификатор участника
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
reprocessuser

Описание: Пересчитать челлендж по конкрутеному участнику
Входящие переменные:
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
reprocess

Описание: Пересчитать челлендж
Входящие переменные:
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
import.parse.text

Описание: Парсинг текстового списка телефонов для импорта участников
Входящие переменные:
• text обязательно
  Описание:
  Текст с номерами телефонов (разделители: новая строка, запятая, точка с запятой)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• phones
  Описание:
  Массив распознанных телефонов
  Тип данных: Массив объектов
• errors
  Описание:
  Массив ошибок парсинга
  Тип данных: Массив объектов
• total
  Описание:
  Количество распознанных телефонов
  Тип данных: Число
• errorCount
  Описание:
  Количество ошибок
  Тип данных: Число
import.parse

Описание: Парсинг файла импорта участников (Excel/CSV)
Входящие переменные:
• fileid обязательно
  Описание:
  Идентификатор загруженного файла
  Допустимый тип данных: Строка
Возвращаемые параметры:
• headers
  Описание:
  Заголовки колонок с примерами данных
  Тип данных: Массив объектов
• autoMapping
  Описание:
  Автоматически определенный маппинг полей
  Тип данных: Объект
• rowCount
  Описание:
  Количество строк данных
  Тип данных: Число
• preview
  Описание:
  Превью первых 10 строк
  Тип данных: Массив объектов
• allRows
  Описание:
  Все строки данных
  Тип данных: Массив объектов
import.execute

Описание: Выполнить массовое приглашение участников в челлендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• phones обязательно
  Описание:
  Массив объектов с телефонами [{phone: "7XXXYYYYYYY"}]
  Допустимый тип данных: Массив объектов
• create_users
  Описание:
  Создавать пользователей если не найдены по телефону
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• success
  Описание:
  Импорт выполнен успешно
  Тип данных: Логическое выражение
• results
  Описание:
  Результаты импорта
  Тип данных: Объект
• total_invited
  Описание:
  Общее количество приглашенных после импорта
  Тип данных: Число
prizes.add

Описание: Добавить приз в челендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название приза
  Допустимый тип данных: Строка
• avatar_id
  Описание:
  Идентификатор аватара
  Допустимый тип данных: Строка
Возвращаемые параметры:
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• prize_id
  Описание:
  Идентификатор приза
  Тип данных: Строка
• name
  Описание:
  Название приза
  Тип данных: Строка
• avatar_id
  Описание:
  Идентификатор аватара
  Тип данных: Строка
prizes.edit

Описание: Изменить приз в челендже
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• prize_id обязательно
  Описание:
  Идентификатор приза
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название приза
  Допустимый тип данных: Строка
• avatar_id
  Описание:
  Идентификатор аватара
  Допустимый тип данных: Строка
Возвращаемые параметры:
• updated
  Описание:
  приз был изменен
  Тип данных: Логическое выражение
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• prize_id
  Описание:
  Идентификатор приза
  Тип данных: Строка
• name
  Описание:
  Название приза
  Тип данных: Строка
• avatar_id
  Описание:
  Идентификатор аватара
  Тип данных: Строка
prizes.remove

Описание: Удалить приз в челендже
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• prize_id обязательно
  Описание:
  Идентификатор приза
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  приз был удален
  Тип данных: Логическое выражение
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• prize_id
  Описание:
  Идентификатор приза
  Тип данных: Строка
prizes.move

Описание: Поменять порядковый номер приза
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• prize_id обязательно
  Описание:
  Идентификатор приза
  Допустимый тип данных: Строка
• prize_order обязательно
  Описание:
  Новый порядковый номер приза в массиве
  Допустимый тип данных: Число
Возвращаемые параметры:
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• prize_id
  Описание:
  Идентификатор приза
  Тип данных: Строка
• prize_order
  Описание:
  Новый порядковый номер приза в массиве
  Тип данных: Число
teams.add

Описание: Добавить команду в челендж
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название команды
  Допустимый тип данных: Строка
• gender
  Описание:
  Пол. 1 - межской, 0 - любой (по умолчанию), 2 - женский
  Допустимый тип данных: Число
• age_from
  Описание:
  Начиная с какого возраста (0 - не установлено, по умолчанию)
  Допустимый тип данных: Число
• age_to
  Описание:
  Какой максимальный возраст (0 - не установлено, по умолчанию)
  Допустимый тип данных: Число
Возвращаемые параметры:
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• team_id
  Описание:
  Идентификатор команды
  Тип данных: Строка
• name
  Описание:
  Название команды
  Тип данных: Строка
• gender
  Описание:
  Пол. 1 - межской, 0 - любой, 2 - женский
  Тип данных: Число
• age_from
  Описание:
  Начиная с какого возраста (0 - не установлено)
  Тип данных: Число
• age_to
  Описание:
  Какой максимальный возраст (0 - не установлено)
  Тип данных: Число
teams.edit

Описание: Изменить команду в челендже
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• team_id обязательно
  Описание:
  Идентификатор команды
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название команды
  Допустимый тип данных: Строка
• gender
  Описание:
  Пол. 1 - межской, 0 - любой (по умолчанию), 2 - женский
  Допустимый тип данных: Число
• age_from
  Описание:
  Начиная с какого возраста (0 - не установлено, по умолчанию)
  Допустимый тип данных: Число
• age_to
  Описание:
  Какой максимальный возраст (0 - не установлено, по умолчанию)
  Допустимый тип данных: Число
Возвращаемые параметры:
• updated
  Описание:
  Команда была изменена
  Тип данных: Логическое выражение
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• team_id
  Описание:
  Идентификатор команды
  Тип данных: Строка
• name
  Описание:
  Название команды
  Тип данных: Строка
• gender
  Описание:
  Пол. 1 - межской, 0 - любой, 2 - женский
  Тип данных: Число
• age_from
  Описание:
  Начиная с какого возраста (0 - не установлено)
  Тип данных: Число
• age_to
  Описание:
  Какой максимальный возраст (0 - не установлено)
  Тип данных: Число
teams.remove

Описание: Удалить команду в челендже
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• team_id обязательно
  Описание:
  Идентификатор команды
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Описание:
  Команда была удалена
  Тип данных: Логическое выражение
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• team_id
  Описание:
  Идентификатор команды
  Тип данных: Строка
teams.move

Описание: Поменять порядковый номер команды
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• team_id обязательно
  Описание:
  Идентификатор команды
  Допустимый тип данных: Строка
• team_order обязательно
  Описание:
  Новый порядковый номер команды в массиве
  Допустимый тип данных: Число
Возвращаемые параметры:
• challenge_id
  Описание:
  Идентификатор челленджа
  Тип данных: Строка
• team_id
  Описание:
  Идентификатор команды
  Тип данных: Строка
• team_order
  Описание:
  Новый порядковый номер команды в массиве
  Тип данных: Число
rating.manage

Описание: Рейтинг для раздела управления челленджем (только для редакторов): все участники с показателем и количеством учтённых активностей, с сортировкой
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• team_id
  Описание:
  Фильтр по команде (id команды)
  Допустимый тип данных: Строка
• sort_by
  Описание:
  Сортировка: result (по показателю) или activities (по числу активностей), по умолчанию result
  Допустимый тип данных: Строка
• sort_dir
  Описание:
  Направление сортировки: asc или desc, по умолчанию desc
  Допустимый тип данных: Строка
• skip
  Описание:
  Сколько участников пропустить, 0 по умолчанию
  Допустимый тип данных: Число
• limit
  Описание:
  Количество участников в выдаче, 20 по умолчанию
  Допустимый тип данных: Число
• search
  Описание:
  Строка поиска участника по нику или телефону
  Допустимый тип данных: Строка
Возвращаемые параметры:
• total
  Описание:
  Всего участников (после фильтра/поиска)
  Тип данных: Число
• aim_type
  Описание:
  Тип показателя челленджа
  Тип данных: Строка
• items
  Описание:
  Список участников
  Тип данных: Массив объектов
  Вложенные элементы:
  • uid
    Описание:
    Идентификатор участника
    Тип данных: Число
  • place
    Описание:
    Место по показателю челленджа
    Тип данных: Число
  • nickname
    Описание:
    Никнейм
    Тип данных: Строка
  • firstname
    Описание:
    Имя
    Тип данных: Строка
  • lastname
    Описание:
    Фамилия
    Тип данных: Строка
  • phone
    Описание:
    Телефон участника
    Тип данных: Строка
  • avatar
    Описание:
    Аватар
    Тип данных: Строка
  • result
    Описание:
    Результат по показателю челленджа
    Тип данных: Строка
  • activities_count
    Описание:
    Количество учтённых активностей
    Тип данных: Число
  • team_id
    Описание:
    Идентификатор команды
    Тип данных: Строка
  • team_name
    Описание:
    Название команды
    Тип данных: Строка
  • issued_prize
    Описание:
    Активный выданный приз участника (null если нет)
    Тип данных: Объект
    Вложенные элементы:
    • id
      Описание:
      Идентификатор выданного приза
      Тип данных: Строка
    • title
      Описание:
      Заголовок приза
      Тип данных: Строка
    • text
      Описание:
      Текст приза
      Тип данных: Строка
    • file_url
      Описание:
      Подписанная ссылка на файл приза (S3)
      Тип данных: Строка
    • file_name
      Описание:
      Имя файла
      Тип данных: Строка
    • file_kind
      Описание:
      Тип файла: image, file или пусто
      Тип данных: Строка
awards.draw

Описание: Предпросмотр награждения (без сохранения): режим random — случайный выбор по условиям; режим rating — отбор мест из рейтинга
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• mode
  Описание:
  Режим отбора: random (случайно по условиям) или rating (по местам рейтинга), по умолчанию random
  Допустимый тип данных: Строка
• winners_count обязательно
  Описание:
  Количество награждаемых (для scope=team — на каждую команду)
  Допустимый тип данных: Число
• scope
  Описание:
  Область розыгрыша: all (среди всех) или team (в каждой команде), по умолчанию all
  Допустимый тип данных: Строка
• offset
  Описание:
  Сколько первых мест рейтинга пропустить сверху (для mode=rating), 0 по умолчанию
  Допустимый тип данных: Число
• min_metric
  Описание:
  Минимальное значение показателя челленджа, необязательно (mode=random)
  Допустимый тип данных: Дробное число в строке
• min_activities
  Описание:
  Минимальное количество учтённых активностей, необязательно (mode=random)
  Допустимый тип данных: Число
• exclude_top
  Описание:
  Сколько первых мест основного рейтинга исключить из розыгрыша (0 по умолчанию, mode=random)
  Допустимый тип данных: Число
Возвращаемые параметры:
• aim_type
  Описание:
  Тип показателя челленджа
  Тип данных: Строка
• eligible_count
  Описание:
  Количество участников, прошедших условия
  Тип данных: Число
• winners
  Описание:
  Выбранные победители (предпросмотр)
  Тип данных: Массив объектов
  Вложенные элементы:
  • uid
    Описание:
    Идентификатор участника
    Тип данных: Число
  • nickname
    Описание:
    Никнейм
    Тип данных: Строка
  • firstname
    Описание:
    Имя
    Тип данных: Строка
  • lastname
    Описание:
    Фамилия
    Тип данных: Строка
  • avatar
    Описание:
    Аватар
    Тип данных: Строка
  • phone
    Описание:
    Телефон победителя
    Тип данных: Строка
  • team_id
    Описание:
    Идентификатор команды
    Тип данных: Строка
  • team_name
    Описание:
    Название команды
    Тип данных: Строка
  • place
    Описание:
    Место по показателю челленджа
    Тип данных: Число
  • result
    Описание:
    Результат по показателю челленджа
    Тип данных: Строка
  • activities_count
    Описание:
    Количество учтённых активностей
    Тип данных: Число
awards.confirm

Описание: Подтверждение розыгрыша наград: сохранение результата в данных челленджа
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• title обязательно
  Описание:
  Заголовок розыгрыша
  Допустимый тип данных: Строка
• description
  Описание:
  Описание розыгрыша (необязательно)
  Допустимый тип данных: Строка
• winner_uids обязательно
  Описание:
  Идентификаторы выбранных победителей (из предпросмотра)
  Допустимый тип данных: Массив чисел
• mode
  Описание:
  Режим отбора: random или rating
  Допустимый тип данных: Строка
• winners_count
  Описание:
  Количество награждаемых из условий
  Допустимый тип данных: Число
• scope
  Описание:
  Область розыгрыша: all или team
  Допустимый тип данных: Строка
• offset
  Описание:
  Сколько первых мест рейтинга пропущено сверху (mode=rating)
  Допустимый тип данных: Число
• min_metric
  Описание:
  Минимальное значение показателя челленджа
  Допустимый тип данных: Дробное число в строке
• min_activities
  Описание:
  Минимальное количество учтённых активностей
  Допустимый тип данных: Число
• exclude_top
  Описание:
  Сколько первых мест рейтинга было исключено
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Описание:
  Признак успеха
  Тип данных: Логическое выражение
• award
  Описание:
  Сохранённый розыгрыш
  Тип данных: Объект
awards.edit

Описание: Редактирование заголовка/описания сохранённого розыгрыша
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• award_id обязательно
  Описание:
  Идентификатор розыгрыша
  Допустимый тип данных: Строка
• title
  Описание:
  Новый заголовок (необязательно)
  Допустимый тип данных: Строка
• description
  Описание:
  Новое описание (необязательно)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Признак успеха
  Тип данных: Логическое выражение
awards.remove

Описание: Удаление сохранённого розыгрыша
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• award_id обязательно
  Описание:
  Идентификатор розыгрыша
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Признак успеха
  Тип данных: Логическое выражение
my

Описание: Список челленджей, в которых участвовал пользователь, с его местом, результатом и попаданием в награждения
Требуется предварительная авторизация: Да
Входящие переменные:
• limit
  Описание:
  Количество в выдаче, 20 по умолчанию
  Допустимый тип данных: Число
• skip
  Описание:
  Сколько пропустить, 0 по умолчанию
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Описание:
  Всего челленджей пользователя
  Тип данных: Число
• challenges
  Описание:
  Список челленджей пользователя
  Тип данных: Массив объектов
  Вложенные элементы:
  • challenge_id
    Описание:
    Идентификатор челленджа
    Тип данных: Строка
  • name
    Описание:
    Название
    Тип данных: Строка
  • picture_fileid
    Описание:
    Обложка
    Тип данных: Строка
  • date_start
    Описание:
    Дата начала (unix)
    Тип данных: Число
  • date_end
    Описание:
    Дата конца (unix)
    Тип данных: Число
  • aim_type
    Описание:
    Тип показателя челленджа
    Тип данных: Строка
  • aim_description
    Описание:
    Описание цели
    Тип данных: Строка
  • show_participants_count
    Описание:
    Показывать количество участников
    Тип данных: Логическое выражение
  • participants_count
    Описание:
    Количество участников
    Тип данных: Число
  • started
    Описание:
    Челлендж начат
    Тип данных: Логическое выражение
  • finished
    Описание:
    Челлендж завершён
    Тип данных: Логическое выражение
  • my_place
    Описание:
    Место пользователя в рейтинге
    Тип данных: Число
  • my_result
    Описание:
    Результат пользователя по показателю челленджа
    Тип данных: Строка
  • my_awards
    Описание:
    Награждения, в которые попал пользователь
    Тип данных: Массив объектов
    Вложенные элементы:
    • id
      Описание:
      Идентификатор награждения
      Тип данных: Строка
    • title
      Описание:
      Заголовок награждения
      Тип данных: Строка
    • result
      Описание:
      Результат пользователя в награждении
      Тип данных: Строка
    • place
      Описание:
      Место пользователя в награждении
      Тип данных: Число
  • my_prize
    Описание:
    Выданный пользователю электронный приз (null если нет)
    Тип данных: Объект
    Вложенные элементы:
    • id
      Описание:
      Идентификатор выданного приза
      Тип данных: Строка
    • title
      Описание:
      Заголовок приза
      Тип данных: Строка
    • text
      Описание:
      Текст приза (промокод/инструкция)
      Тип данных: Строка
    • file_url
      Описание:
      Подписанная ссылка на файл приза (S3)
      Тип данных: Строка
    • file_name
      Описание:
      Имя файла
      Тип данных: Строка
    • file_kind
      Описание:
      Тип файла: image, file или пусто
      Тип данных: Строка
prize.issue

Описание: Выдать электронный приз участнику челленджа (с пушем и уведомлением). Только для редакторов
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• uid обязательно
  Описание:
  Идентификатор участника-получателя
  Допустимый тип данных: Число
• title обязательно
  Описание:
  Заголовок приза
  Допустимый тип данных: Строка
• text
  Описание:
  Текст приза (промокод/инструкция, необязательно)
  Допустимый тип данных: Строка
• file_id
  Описание:
  Идентификатор загруженного файла (необязательно)
  Допустимый тип данных: Строка
• file_name
  Описание:
  Имя файла (необязательно)
  Допустимый тип данных: Строка
• file_kind
  Описание:
  Тип файла: image (картинка) или file (PDF/документ)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Признак успеха
  Тип данных: Логическое выражение
• id
  Описание:
  Идентификатор созданной выдачи
  Тип данных: Строка
prize.edit

Описание: Изменить выданный приз (заголовок/текст/файл). Без повторного пуша. Только для редакторов
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• prize_id обязательно
  Описание:
  Идентификатор выданного приза
  Допустимый тип данных: Строка
• title
  Описание:
  Новый заголовок (необязательно)
  Допустимый тип данных: Строка
• text
  Описание:
  Новый текст (необязательно)
  Допустимый тип данных: Строка
• file_id
  Описание:
  Новый файл (необязательно)
  Допустимый тип данных: Строка
• file_name
  Описание:
  Имя нового файла
  Допустимый тип данных: Строка
• file_kind
  Описание:
  Тип нового файла: image или file
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Признак успеха
  Тип данных: Логическое выражение
prize.revoke

Описание: Отозвать выданный приз. Только для редакторов
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
• prize_id обязательно
  Описание:
  Идентификатор выданного приза
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Признак успеха
  Тип данных: Логическое выражение
prize.list

Описание: Список выданных призов челленджа с получателями. Только для редакторов
Требуется предварительная авторизация: Да
Входящие переменные:
• challenge_id обязательно
  Описание:
  Идентификатор челленджа
  Допустимый тип данных: Строка
Возвращаемые параметры:
• total
  Описание:
  Всего выданных призов
  Тип данных: Число
• items
  Описание:
  Список выданных призов
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор выданного приза
    Тип данных: Строка
  • uid
    Описание:
    Идентификатор получателя
    Тип данных: Число
  • nickname
    Описание:
    Никнейм
    Тип данных: Строка
  • firstname
    Описание:
    Имя
    Тип данных: Строка
  • lastname
    Описание:
    Фамилия
    Тип данных: Строка
  • avatar
    Описание:
    Аватар
    Тип данных: Строка
  • title
    Описание:
    Заголовок приза
    Тип данных: Строка
  • text
    Описание:
    Текст приза (промокод/инструкция)
    Тип данных: Строка
  • file_url
    Описание:
    Подписанная ссылка на файл приза (S3)
    Тип данных: Строка
  • file_name
    Описание:
    Имя файла
    Тип данных: Строка
  • file_kind
    Описание:
    Тип файла: image, file или пусто
    Тип данных: Строка
  • created_ts
    Описание:
    Время выдачи (unix)
    Тип данных: Число

Модуль club.frontend

Общая информация

Название: Club Frontend API
Описание:
API для получения конфигурации клуба по домену (для frontend-middleware)
getConfigByDomain

Описание:
Входящие переменные:
• domain обязательно
  Описание:
  Домен для поиска клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• config
  Описание:
  Конфигурация клуба
  Тип данных: Объект
• cached
  Описание:
  Получено из кэша
  Тип данных: Логическое выражение

Модуль club.mobile

Общая информация

Название: Club Mobile App Settings
Описание:
Управление настройками мобильных приложений клубов
getMobileAppSettings

Описание: Получение настроек мобильного приложения клуба
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• settings
  Описание:
  Настройки мобильного приложения
  Тип данных: Объект
setMobileAppSettings

Описание: Сохранение основных настроек мобильного приложения
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• app_name
  Описание:
  Название приложения (макс. 30 символов)
  Допустимый тип данных: Строка
• display_name
  Описание:
  Полное название приложения (макс. 50 символов)
  Допустимый тип данных: Строка
• app_id
  Описание:
  Package ID для Android (например, ru.club.app)
  Допустимый тип данных: Строка
• bundle_id
  Описание:
  Bundle ID для iOS (например, ru.club.app)
  Допустимый тип данных: Строка
• version
  Описание:
  Версия приложения
  Допустимый тип данных: Строка
• build_number
  Описание:
  Номер сборки
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• settings
  Описание:
  Обновленные настройки
  Тип данных: Объект
setAppIcon

Описание: Установка иконки приложения
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• file_id обязательно
  Описание:
  ID файла с иконкой
  Допустимый тип данных: Строка
• icon_type
  Описание:
  Тип иконки (main, adaptive_foreground)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• settings
  Описание:
  Обновленные настройки
  Тип данных: Объект
setAppIconBackground

Описание: Установка цвета фона для adaptive icon
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• background_color обязательно
  Описание:
  Цвет фона в hex формате
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• settings
  Описание:
  Обновленные настройки
  Тип данных: Объект
setSplashSettings

Описание: Установка настроек Splash Screen
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• theme
  Описание:
  Тема (light или dark), по умолчанию light
  Допустимый тип данных: Строка
• background_color
  Описание:
  Цвет фона
  Допустимый тип данных: Строка
• logo_file_id
  Описание:
  ID файла с логотипом
  Допустимый тип данных: Строка
• show_spinner
  Описание:
  Показывать ли spinner
  Допустимый тип данных: Логическое выражение
• spinner_color
  Описание:
  Цвет spinner
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• settings
  Описание:
  Обновленные настройки
  Тип данных: Объект
setStoreSettings

Описание: Установка данных для магазинов приложений
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• store обязательно
  Описание:
  Магазин (google_play, app_store, rustore)
  Допустимый тип данных: Строка
• title
  Описание:
  Название приложения в магазине
  Допустимый тип данных: Строка
• subtitle
  Описание:
  Подзаголовок (только App Store)
  Допустимый тип данных: Строка
• short_description
  Описание:
  Короткое описание (Google Play, RuStore)
  Допустимый тип данных: Строка
• full_description
  Описание:
  Полное описание (Google Play, RuStore)
  Допустимый тип данных: Строка
• description
  Описание:
  Описание (App Store)
  Допустимый тип данных: Строка
• keywords
  Описание:
  Ключевые слова (App Store)
  Допустимый тип данных: Строка
• category
  Описание:
  Категория приложения
  Допустимый тип данных: Строка
• screenshots
  Описание:
  Массив ID файлов скриншотов
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• settings
  Описание:
  Обновленные настройки
  Тип данных: Объект

Модуль competitions

Общая информация

Название: Competitions
save

Описание: Сохранить челлендж
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• club_ids
  Описание:
  Список идентификаторов клубов челленджа. Может быть пустым - тогда без клуба
  Допустимый тип данных: Массив строк
• planned_start_ts обязательно
  Описание:
  Дата начала соревнования (Unix timestamp)
  Допустимый тип данных: Число
• name
  Описание:
  Название соревнования
  Допустимый тип данных: Строка
• description
  Описание:
  Описание соревнования
  Допустимый тип данных: Строка
• picture_fileid
  Описание:
  Идентификатор файла аватарки соревнования
  Допустимый тип данных: Строка
• privacy_level
  Описание:
  Уровень доступа к соревнованию:
  • 1 Выбранные клубы
  • 2 Все клубы компании
  • 3 Все пользователи трайд
  
  Допустимый тип данных: Число
• individual
  Описание:
  Индивидуальное соревнование
  Допустимый тип данных: Логическое выражение
• self_join
  Описание:
  Возможность самостоятельно присоединяться
  Допустимый тип данных: Логическое выражение
• invite_join
  Описание:
  Возможность самостоятельно присоединяться по ссылке
  Допустимый тип данных: Логическое выражение
• teams_type
  Описание:
  Виды команд. auto - автоматически по паараметрам, manual - вручную
  Допустимый тип данных: Строка
• self_team_choose
  Описание:
  Возможность самостоятельго выбирать команду
  Допустимый тип данных: Логическое выражение
• locations
  Описание:
  Места проведения. online, clubs
  Допустимый тип данных: Массив строк
• results_type
  Описание:
  Как определеяются места в соревновании. 1 Среднее место среди мест в этапах 2 Общая дистанция по сумме этапов 3 Общее время по сумме этапов
  Допустимый тип данных: Число
Возвращаемые параметры:
• competition_id
  Описание:
  Идентификатор соревнования
  Тип данных: Строка
list

Описание: Добавить команду
Входящие переменные:
Возвращаемые параметры:
get

Описание: Добавить команду
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
remove

Описание: Удалить соревнование
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
teams.add

Описание: Добавить команду
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• name
  Описание:
  Название команды
  Допустимый тип данных: Строка
Возвращаемые параметры:
• teams
  Тип данных: Массив объектов
teams.edit

Описание: Добавить команду
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• team_id
  Допустимый тип данных: Строка
• name
  Описание:
  Название команды
  Допустимый тип данных: Строка
Возвращаемые параметры:
• teams
  Тип данных: Массив объектов
teams.remove

Описание: Удалить команду
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• team_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• teams
  Тип данных: Массив объектов
categories.add

Описание: Добавить категорию
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• name
  Описание:
  Название Категории
  Допустимый тип данных: Строка
Возвращаемые параметры:
• categories
  Тип данных: Массив объектов
categories.edit

Описание: Изменить Категорию
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• category_id
  Допустимый тип данных: Строка
• name
  Описание:
  Название команды
  Допустимый тип данных: Строка
Возвращаемые параметры:
• categories
  Тип данных: Массив объектов
categories.remove

Описание: Удалить категорию
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• category_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• categories
  Тип данных: Массив объектов
participants.edit

Описание: Изменить участника
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• participants
  Тип данных: Массив объектов
participants.add

Описание: Добавить участника
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• participants
  Тип данных: Массив объектов
participants.removeall

Описание:
Входящие переменные:
• competition_id обязательно
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
teams.removeall

Описание:
Входящие переменные:
• competition_id обязательно
  Допустимый тип данных: Строка
participants.remove

Описание: Удалить участника
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• uid
  Допустимый тип данных: Число
Возвращаемые параметры:
• participants
  Тип данных: Массив объектов
finish

Описание: Завершить соревнование
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
steps.finish

Описание: Завершить этап соревнования
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
waves.restart

Описание: Перезапустить волну
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• wave
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
live.team.results

Описание: Получить данные по команде
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• step
  Допустимый тип данных: Число
• team_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
live.participant.results

Описание: Получить данные по участнику
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• step
  Допустимый тип данных: Число
• uid
  Допустимый тип данных: Число
Возвращаемые параметры:
waves.start

Описание: Начать волну
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• wave
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
start

Описание: Начать соревнование
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
teams.setresult

Описание: Установить результаты команды
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• distance
  Тип данных: Строка
join

Описание: Вступить в соревнование
Входящие переменные:
• competition_id обязательно
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• key
  Описание:
  Ключ для вступления (invite_link_key)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• joined
  Описание:
  Успешно вступил
  Тип данных: Логическое выражение
• team_id
  Описание:
  Идентификатор команды
  Тип данных: Строка
• team_name
  Описание:
  Название команды
  Тип данных: Строка
• error
  Описание:
  Сообщение об ошибке (невозможности участия):
  • not_found - соревнование не найдено/недоступно
  • competition_started - соревнование уже началось
  • finished - соревнование уже завершено
  • no_team - нет подходящей команды
  • no_age - не указан возраст у пользователя
  • no_weight - не указан вес пользователя
  • no_gender - не указан пол пользователя
  • already - уже присоединился
  • max - достигнут лимит участников
  
  Тип данных: Строка
exit

Описание: Выйти из соревнования
Входящие переменные:
• competition_id обязательно
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• left
  Описание:
  Успешно вышел
  Тип данных: Логическое выражение
participants.setresult

Описание: Установить результаты участника
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• distance
  Тип данных: Строка
results

Описание: Удалить участника
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• results
  Тип данных: Объект
  Вложенные элементы:
  • teams
    Тип данных: Массив объектов
  • participants
    Тип данных: Массив объектов
results.export

Описание: Удалить участника
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• results
  Тип данных: Объект
  Вложенные элементы:
  • teams
    Тип данных: Массив объектов
  • participants
    Тип данных: Массив объектов
live.results

Описание: Данные в лайве
Входящие переменные:
Возвращаемые параметры:
• results
  Тип данных: Объект
  Вложенные элементы:
  • teams
    Тип данных: Массив объектов
  • participants
    Тип данных: Массив объектов
live.test

Описание: Данные в лайве
Входящие переменные:
• event_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• started
  Описание:
  Стартовал ли событие
  Допустимый тип данных: Логическое выражение
• groups
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• results
  Тип данных: Объект
  Вложенные элементы:
  • teams
    Тип данных: Массив объектов
  • participants
    Тип данных: Массив объектов
public.get

Описание: Получить данные соревнования
Входящие переменные:
• competition_id
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
Возвращаемые параметры:
import.parse

Описание: Парсинг файла импорта участников (Excel/CSV)
Входящие переменные:
• fileid обязательно
  Описание:
  Идентификатор загруженного файла
  Допустимый тип данных: Строка
Возвращаемые параметры:
• headers
  Описание:
  Заголовки колонок с примерами данных
  Тип данных: Массив объектов
• autoMapping
  Описание:
  Автоматически определенный маппинг полей
  Тип данных: Объект
• rowCount
  Описание:
  Количество строк данных
  Тип данных: Число
• preview
  Описание:
  Превью первых 10 строк
  Тип данных: Массив объектов
import.execute

Описание: Выполнить импорт участников
Входящие переменные:
• competition_id обязательно
  Описание:
  Идентификатор соревнования
  Допустимый тип данных: Строка
• mapping обязательно
  Описание:
  Маппинг полей: {phone: 0, firstname: 1, ...}
  Допустимый тип данных: Объект
• rows обязательно
  Описание:
  Массив строк для импорта
  Допустимый тип данных: Массив объектов
• create_users
  Описание:
  Создавать пользователей если не найдены
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• success
  Тип данных: Логическое выражение
• results
  Описание:
  Результаты импорта
  Тип данных: Объект
• total_participants
  Описание:
  Общее количество участников после импорта
  Тип данных: Число
teams.import.parse

Описание: Парсинг файла импорта команд (Excel/CSV)
Входящие переменные:
• fileid обязательно
  Описание:
  Идентификатор загруженного файла
  Допустимый тип данных: Строка
Возвращаемые параметры:
• headers
  Тип данных: Массив объектов
• autoMapping
  Тип данных: Объект
• rowCount
  Тип данных: Число
• preview
  Тип данных: Массив объектов
teams.import.execute

Описание: Выполнить импорт команд
Входящие переменные:
• competition_id обязательно
  Допустимый тип данных: Строка
• mapping обязательно
  Допустимый тип данных: Объект
• rows обязательно
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• success
  Тип данных: Логическое выражение
• results
  Тип данных: Объект
• total_teams
  Тип данных: Число
teams.transfer

Описание: Перенести команды из одного соревнования в другое
Входящие переменные:
• source_competition_id обязательно
  Описание:
  ID исходного соревнования
  Допустимый тип данных: Строка
• target_competition_id обязательно
  Описание:
  ID целевого соревнования
  Допустимый тип данных: Строка
• team_ids
  Описание:
  ID команд для переноса (если пусто — ТОП-N по рейтингу)
  Допустимый тип данных: Массив строк
• top_count
  Описание:
  Количество лучших команд для переноса
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• transferred_count
  Тип данных: Число
participants.transfer

Описание: Перенести топ-N индивидуальных участников по категориям из одного соревнования в другое
Входящие переменные:
• source_competition_id обязательно
  Описание:
  ID исходного соревнования
  Допустимый тип данных: Строка
• target_competition_id обязательно
  Описание:
  ID целевого соревнования
  Допустимый тип данных: Строка
• top_count обязательно
  Описание:
  Количество лучших участников из каждой категории
  Допустимый тип данных: Число
• category_ids
  Описание:
  ID категорий для переноса (если пусто — все не-кастомные)
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• transferred_count
  Тип данных: Число

Модуль content

Общая информация

Название: content
search.guess

Описание:
Входящие переменные:
Возвращаемые параметры:
images.list

Описание:
Входящие переменные:
Возвращаемые параметры:
updategps

Описание:
Входящие переменные:
Возвращаемые параметры:
genprogram

Описание:
Входящие переменные:
Возвращаемые параметры:
genblock

Описание:
Входящие переменные:
Возвращаемые параметры:
genavatar

Описание:
Входящие переменные:
Возвращаемые параметры:
genimage

Описание:
Входящие переменные:
Возвращаемые параметры:
genIcon

Описание: Генерация SVG иконки через AI
Входящие переменные:
• prompt
  Описание:
  Описание иконки для генерации
  Допустимый тип данных: Строка
• style
  Описание:
  Стиль иконки (опционально)
  Допустимый тип данных: Строка
Возвращаемые параметры:
like

Описание:
Входящие переменные:
• type
  Допустимый тип данных: Строка
• id
  Допустимый тип данных: Возможно несколько типов: Строка, Число
Возвращаемые параметры:
• id
  Тип данных: Возможно несколько типов: Число, Строка
• liked
  Тип данных: Логическое выражение
tags.list

Описание:
Входящие переменные:
• type обязательно
  Допустимый тип данных: Число
Возвращаемые параметры:
• tags
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Тип данных: Строка
  • name
    Тип данных: Строка
translate

Описание:
Входящие переменные:
• phrase
  Допустимый тип данных: Строка
• to_lang
  Допустимый тип данных: Строка
Возвращаемые параметры:
• phrase
  Тип данных: Строка
music.get

Описание:
Входящие переменные:
Возвращаемые параметры:
• id
  Тип данных: Строка
• title
  Тип данных: Строка
• artist
  Тип данных: Строка
• album
  Тип данных: Строка
• bpm
  Тип данных: Число
• duration
  Тип данных: Число
music.search

Описание:
Входящие переменные:
• search
  Допустимый тип данных: Строка
• min_bpm
  Допустимый тип данных: Число
• max_bpm
  Допустимый тип данных: Число
• min_duration
  Допустимый тип данных: Число
• max_duration
  Допустимый тип данных: Число
• genres
  Допустимый тип данных: Массив чисел
• favorite
  Допустимый тип данных: Логическое выражение
• artist
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• title
  Тип данных: Строка
• artist
  Тип данных: Строка
• fileid
  Тип данных: Число
• bpm
  Тип данных: Число
• duration
  Тип данных: Число
music.import

Описание:
Входящие переменные:
Возвращаемые параметры:
• id
  Тип данных: Строка
• duration
  Тип данных: Число
music.list

Описание:
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
music.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
music.rem

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
catalog.music.charts

Описание:
Входящие переменные:
catalog.music.charts.get

Описание:
Входящие переменные:
music.playlists.add

Описание:
Входящие переменные:
Возвращаемые параметры:
music.playlists.get

Описание:
Входящие переменные:
Возвращаемые параметры:
music.playlists.list

Описание:
Входящие переменные:
Возвращаемые параметры:
music.playlists.addtrack

Описание:
Входящие переменные:
Возвращаемые параметры:
music.playlists.edit

Описание:
Входящие переменные:
Возвращаемые параметры:
music.playlists.remove

Описание:
Входящие переменные:
Возвращаемые параметры:
generate.music.start

Описание:
Входящие переменные:
• with_lyrics
  Описание:
  Со словами
  Допустимый тип данных: Логическое выражение
• lyrics
  Описание:
  Текст композиации
  Допустимый тип данных: Строка
• style
  Описание:
  Стиль
  Допустимый тип данных: Строка
• name
  Описание:
  Название композиции
  Допустимый тип данных: Строка
Возвращаемые параметры:
• task_id
  Описание:
  ID задачи
  Тип данных: Строка
generate.music.status

Описание:
Входящие переменные:
• task_id
  Описание:
  ID задачи
  Допустимый тип данных: Строка
Возвращаемые параметры:
• status
  Описание:
  Статус задачи
  Тип данных: Строка
• items
  Тип данных: Массив объектов
generate.music.draft

Описание:
Входящие переменные:
• with_lyrics
  Описание:
  Со словами
  Допустимый тип данных: Логическое выражение
• description
  Описание:
  Краткое описание композиции
  Допустимый тип данных: Строка
• style_hints
  Описание:
  Подсказки по стилю
  Допустимый тип данных: Строка
Возвращаемые параметры:
• lyrics
  Описание:
  Сгенерированный текст песни
  Тип данных: Строка
• style
  Описание:
  Сгенерированный стиль/промпт
  Тип данных: Строка
• name
  Описание:
  Предложенное название композиции
  Тип данных: Строка
generate.music.count

Описание:
Входящие переменные:
getvideotostore

Описание:
Входящие переменные:
Возвращаемые параметры:
setvideostored

Описание:
Входящие переменные:
Возвращаемые параметры:
youtube.add

Описание: Добавить видео по ссылке из Youtube
Входящие переменные:
• external_id
  Допустимый тип данных: Строка
• thumbnail_url
  Допустимый тип данных: Строка
• duration
  Допустимый тип данных: Число
• name
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• result
  Тип данных: Логическое выражение
video.get

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• name
  Тип данных: Строка
• description
  Тип данных: Строка
• fileid
  Тип данных: Число
• relief_data
  Тип данных: Массив (любые типы внутри)
• duration
  Тип данных: Число
externalvideos.search

Описание:
Входящие переменные:
• search
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• name
  Тип данных: Строка
• external_id
  Тип данных: Строка
• thumbnail_url
  Тип данных: Строка
• type
  Тип данных: Строка
• duration
  Тип данных: Число
videos.getuploadlink

Описание:
Входящие переменные:
• name
  Описание:
  Название видео
  Допустимый тип данных: Строка
Возвращаемые параметры:
• url
  Описание:
  Ссылка на загрузку через TUS
  Тип данных: Строка
• id
  Описание:
  Идентификатор видео
  Тип данных: Строка
• token
  Описание:
  Токен для загрузки
  Тип данных: Строка
videos.add

Описание:
Входящие переменные:
• fileid обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
videos.update

Описание:
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• gps_data
  Допустимый тип данных: Объект
• relief_data
  Допустимый тип данных: Объект
• speed_data
  Допустимый тип данных: Объект
• enabled
  Допустимый тип данных: Логическое выражение
• tags
  Допустимый тип данных: Массив (любые типы внутри)
• name
  Допустимый тип данных: Строка
• description
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
videos.get

Описание:
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• idвсегда
  Тип данных: Строка
• fileid
  Тип данных: Строка
• duration
  Тип данных: Число
• size
  Тип данных: Число
• gps_data
  Тип данных: Объект
• relief_data
  Тип данных: Объект
• speed_data
  Тип данных: Объект
• enabled
  Тип данных: Логическое выражение
• tags
  Тип данных: Массив (любые типы внутри)
• name
  Тип данных: Строка
• description
  Тип данных: Строка
videos.setgps

Описание: set video gps and relief data
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
• geodata
  Допустимый тип данных: Строка
• format
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
videos.remove

Описание:
Входящие переменные:
• id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• removed
  Тип данных: Логическое выражение
videos.list.local

Описание:
Входящие переменные:
• session_id обязательно
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив строк
videos.list

Описание:
Входящие переменные:
• tags
  Допустимый тип данных: Массив (любые типы внутри)
• minduration
  Допустимый тип данных: Число
• maxduration
  Допустимый тип данных: Число
• search
  Допустимый тип данных: Строка
Возвращаемые параметры:
• videos
  Тип данных: Массив объектов
  Вложенные элементы:
  • idвсегда
    Тип данных: Строка
  • fileid
    Тип данных: Строка
  • duration
    Тип данных: Число
  • size
    Тип данных: Число
  • relief_data
    Тип данных: Объект
  • has_gps
    Тип данных: Логическое выражение
  • has_relief
    Тип данных: Логическое выражение
  • has_speed
    Тип данных: Логическое выражение
  • enabled
    Тип данных: Логическое выражение
  • tags
    Тип данных: Массив (любые типы внутри)
  • name
    Тип данных: Строка
videos.grid

Описание: Grid список видео с фильтрами и пагинацией
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• sport_types
  Описание:
  Типы спорта
  Допустимый тип данных: Массив чисел
• categories
  Описание:
  Категории
  Допустимый тип данных: Массив строк
• tags
  Описание:
  Теги
  Допустимый тип данных: Массив строк
• search
  Описание:
  Поиск по названию
  Допустимый тип данных: Строка
• minduration
  Описание:
  Минимальная длительность
  Допустимый тип данных: Число
• maxduration
  Описание:
  Максимальная длительность
  Допустимый тип данных: Число
• privacy
  Описание:
  Уровень приватности
  Допустимый тип данных: Число
• limit
  Описание:
  Лимит
  Допустимый тип данных: Число
• skip
  Описание:
  Пропустить
  Допустимый тип данных: Число
• sort
  Описание:
  Сортировка
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список видео
  Тип данных: Массив объектов
• total
  Описание:
  Всего записей
  Тип данных: Число
videos.set_download

Описание:
Входящие переменные:
Возвращаемые параметры:
videos.get_download_url

Описание:
Входящие переменные:
Возвращаемые параметры:

Модуль cycle

Общая информация

Название: Cycle
getworkout

Описание:
Входящие переменные:
data

Описание: Получение данных с устройств
Входящие переменные:
• type
  Описание:
  Тип данных
  Допустимый тип данных: Строка
• value
  Описание:
  Значение
  Допустимый тип данных: Строка
• devid
  Описание:
  Идентификатор устройства
  Допустимый тип данных: Строка
Возвращаемые параметры:
hrdata

Описание: Получение данных с устройств
Входящие переменные:
Возвращаемые параметры:
shortdata

Описание: Получение данных с устройств
Входящие переменные:
Возвращаемые параметры:
fulldata

Описание: Получение данных с устройств
Входящие переменные:
Возвращаемые параметры:
testupdate

Описание: Промежуточное обновление состояния FTP-теста от клиентского терминала
Входящие переменные:
Возвращаемые параметры:
multidata

Описание: Получение данных с устройств
Входящие переменные:
Возвращаемые параметры:
getgraphfordata

Описание:
Входящие переменные:
• data
  Допустимый тип данных: Массив (любые типы внутри)
• width
  Допустимый тип данных: Число
• height
  Допустимый тип данных: Число
Возвращаемые параметры:
listmyclubs

Описание:
Входящие переменные:
Возвращаемые параметры:
setmydata

Описание:
Входящие переменные:
• firstname
  Описание:
  Имя
  Допустимый тип данных: Строка
• lastname
  Описание:
  Фамилия
  Допустимый тип данных: Строка
• nickname
  Описание:
  Ник
  Допустимый тип данных: Строка
• gender
  Описание:
  Пол (1-муж, 2-жен)
  Допустимый тип данных: Число
• registered
  Описание:
  Завершен процесс регистрации
  Допустимый тип данных: Логическое выражение
• birthdate
  Описание:
  Дата рождения
  Допустимый тип данных: Строка
• email
  Описание:
  Email
  Допустимый тип данных: Строка
• weight
  Описание:
  Вес
  Допустимый тип данных: Строка
• height
  Описание:
  Рост
  Допустимый тип данных: Возможно несколько типов: Число, Строка
• ftp
  Описание:
  FTP сайкл
  Допустимый тип данных: Число
• rowing_ftp
  Описание:
  FTP гребля
  Допустимый тип данных: Число
• maxhr
  Описание:
  Максимальный пульс
  Допустимый тип данных: Число
• about
  Описание:
  О себе
  Допустимый тип данных: Строка
• predictftp
  Описание:
  Подстраивать FTP автоматически
  Допустимый тип данных: Логическое выражение
• avatar
  Описание:
  fileid аватарки
  Допустимый тип данных: Строка
• avatar_options
  Описание:
  Объект настроек аватарки
  Допустимый тип данных: Объект
• social
  Описание:
  Ссылки на социальные сети
  Допустимый тип данных: Объект
  Вложенные элементы:
  • instagram
    Описание:
    Инстаграм
    Тип данных: Строка
  • vk
    Описание:
    VK
    Тип данных: Строка
  • telegram
    Описание:
    Телеграм
    Тип данных: Строка
• club_id
  Описание:
  ID клуба для сохранения данных доп. полей (опционально)
  Допустимый тип данных: Строка
• club_fields
  Описание:
  Объект значений доп. полей клуба по ключу id поля. Применяется только если передан club_id
  Допустимый тип данных: Объект
Возвращаемые параметры:
getmydata

Описание:
Входящие переменные:
• club_id
  Описание:
  ID клуба для возврата данных доп. полей (опционально)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• firstname
  Описание:
  Имя
  Тип данных: Строка
• lastname
  Описание:
  Фамилия
  Тип данных: Строка
• nickname
  Описание:
  Ник
  Тип данных: Строка
• birthdate
  Описание:
  Дата рождения
  Тип данных: Строка
• email
  Описание:
  Email
  Тип данных: Строка
• gender
  Описание:
  Пол (1-муж, 2-жен)
  Тип данных: Число
• registered
  Описание:
  Завершен процесс регистрации
  Тип данных: Логическое выражение
• weight
  Описание:
  Вес
  Тип данных: Строка
• height
  Описание:
  Рост
  Тип данных: Число
• ftp
  Описание:
  FTP сайкл
  Тип данных: Число
• rowing_ftp
  Описание:
  FTP гребля
  Тип данных: Число
• maxhr
  Описание:
  Максимальный пульс
  Тип данных: Число
• about
  Описание:
  О себе
  Тип данных: Строка
• predictftp
  Описание:
  Подстраивать FTP автоматически
  Тип данных: Логическое выражение
• avatar
  Описание:
  fileid аватарки
  Тип данных: Строка
• avatar_options
  Описание:
  Объект настроек аватарки
  Тип данных: Объект
• social
  Описание:
  Ссылки на социальные сети
  Тип данных: Объект
  Вложенные элементы:
  • instagram
    Описание:
    Инстаграм
    Тип данных: Строка
  • vk
    Описание:
    VK
    Тип данных: Строка
  • telegram
    Описание:
    Телеграм
    Тип данных: Строка
• club_fields
  Описание:
  Объект с данными доп. полей клуба по ключу id поля. Возвращается только если передан club_id
  Тип данных: Объект
remworkout

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Тип данных: Строка
• result
  Тип данных: Логическое выражение
setuser

Описание: Установить пользователя
Входящие переменные:
• uid
  Описание:
  UID
  Допустимый тип данных: Число
• weight
  Описание:
  Вес
  Допустимый тип данных: Строка
• ftp
  Описание:
  ftp
  Допустимый тип данных: Число
• name
  Описание:
  имя
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба для сохранения данных доп. полей (опционально)
  Допустимый тип данных: Строка
• club_fields
  Описание:
  Объект значений доп. полей клуба по ключу id поля. Применяется только если передан club_id
  Допустимый тип данных: Объект
Возвращаемые параметры:
stopcoachupdates

Описание: Получать обновления
Входящие переменные:
• session_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
getcoachupdates

Описание: Получать обновления
Входящие переменные:
• session_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
getuserupdates

Описание: Получать обновления
Входящие переменные:
• session_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
sensors.list.hr

Описание: Получить список устройств (датчиков пульса), видимых в клубе
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• sensors
  Описание:
  Массив объектов данных по датчикам
  Тип данных: Массив объектов
  Вложенные элементы:
  • sensor_id
    Описание:
    Идентификатор устройства
    Тип данных: Строка
  • value
    Описание:
    Крайнее переданное датчиком значение пульса
    Тип данных: Число
year_wrapped.options

Описание: Получить доступные опции (роли и клубы) для Year in Review
Входящие переменные:
• year
  Описание:
  Год для статистики
  Допустимый тип данных: Число
Возвращаемые параметры:
• available_options
  Описание:
  Доступные опции по ролям
  Тип данных: Объект
• needs_switcher
  Описание:
  Нужен ли pre-intro switcher
  Тип данных: Логическое выражение
• total_combinations
  Описание:
  Общее количество доступных комбинаций роль+клуб
  Тип данных: Число
year_wrapped.get

Описание: Получить данные Year in Review для текущего пользователя
Входящие переменные:
• year
  Описание:
  Год для статистики
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба для фильтрации (опционально, null для глобальной статистики)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• role
  Описание:
  Основная роль пользователя (client, coach, admin)
  Тип данных: Строка
• client_stats
  Описание:
  Статистика клиента (если есть)
  Тип данных: Объект
• coach_stats
  Описание:
  Статистика тренера (если есть)
  Тип данных: Объект
• admin_stats
  Описание:
  Статистика администратора (если есть)
  Тип данных: Объект
• available_clubs
  Описание:
  Доступные клубы с данными
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    ID клуба
    Тип данных: Строка
  • name
    Описание:
    Название клуба
    Тип данных: Строка
• available_roles
  Описание:
  Доступные роли для текущих фильтров
  Тип данных: Массив строк
• current_club_id
  Описание:
  Текущий выбранный клуб
  Тип данных: Строка
• has_data
  Описание:
  Есть ли данные за указанный год
  Тип данных: Логическое выражение
year_wrapped.ai_insights

Описание: Получить AI-генерированные инсайты для Year in Review
Входящие переменные:
• year
  Описание:
  Год для статистики
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба для фильтрации (опционально)
  Допустимый тип данных: Строка
• role
  Описание:
  Роль для кеширования AI инсайтов (client/coach/admin)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• welcome_text
  Описание:
  Приветственный текст
  Тип данных: Строка
• achievement_texts
  Описание:
  Тексты для достижений по ключу achievement_id
  Тип данных: Объект
• progression_text
  Описание:
  Текст про прогрессию
  Тип данных: Строка
• prediction_text
  Описание:
  Предсказание на следующий год
  Тип данных: Строка
• finale_text
  Описание:
  Финальный текст
  Тип данных: Строка
year_wrapped.club_dashboard

Описание: Получить админский dashboard Year in Review для клуба
Входящие переменные:
• year
  Описание:
  Год для статистики
  Допустимый тип данных: Число
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• club_id
  Описание:
  ID клуба
  Тип данных: Строка
• club_name
  Описание:
  Название клуба
  Тип данных: Строка
• parent_id
  Описание:
  ID родительского клуба (группы)
  Тип данных: Строка
• is_group
  Описание:
  Является ли группой клубов
  Тип данных: Логическое выражение
• dashboard_data
  Описание:
  Данные dashboard
  Тип данных: Объект
• group_data
  Описание:
  Агрегированные данные группы (если есть)
  Тип данных: Объект

Модуль hw

Общая информация

Название: hw
sync

Описание: произвести оценку лага
Входящие переменные:
Возвращаемые параметры:
• delta
  Тип данных: Число
runping

Описание: произвести оценку лага
Входящие переменные:
• key
  Допустимый тип данных: Строка
• myts
  Допустимый тип данных: Число
• nmyts
  Допустимый тип данных: Число
• sts
  Допустимый тип данных: Число
Возвращаемые параметры:
• delta
  Тип данных: Число
getmyclubid

Описание: Получить идентификатор привязанного клуба
Входящие переменные:
Возвращаемые параметры:
• club_id
  Тип данных: Строка
setmylocalip

Описание: Установить айпи устройства в локальной сети
Входящие переменные:
• ip
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
initping

Описание: Инициализировать пинг
Входящие переменные:
• myts
  Допустимый тип данных: Число
Возвращаемые параметры:
• sts
  Тип данных: Число
• myts
  Тип данных: Число
getmysensors

Описание: Получить данные по датчикам и их соответствию устройствам
Входящие переменные:
Возвращаемые параметры:
• radios
  Тип данных: Массив (любые типы внутри)
• sensors
  Тип данных: Массив (любые типы внутри)
• equipment
  Тип данных: Массив объектов
getmysmartdevices

Описание: Получить реестр умных устройств зоны (свет/ленты) с параметрами Tuya для локального управления
Входящие переменные:
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• devices
  Тип данных: Массив объектов
• groups
  Тип данных: Массив объектов
reportsmartdevicestatus

Описание: Отчёт о статусе умных устройств зоны (last_seen_ts с зонального Electron)
Входящие переменные:
• devices
  Описание:
  Массив { id, online?, last_seen_ts? }
  Допустимый тип данных: Массив объектов
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
getscreenstate

Описание:
Входящие переменные:
Возвращаемые параметры:
• mode
  Тип данных: Строка
• main
  Тип данных: Строка
• down
  Тип данных: Строка
• up
  Тип данных: Строка
• order
  Тип данных: Строка
devices.register

Описание:
Входящие переменные:
• hw_id
  Описание:
  идентификатор устройства (привязка к железу)
  Допустимый тип данных: Строка
• type обязательно
  Описание:
  Тип устройства: tridegate,tridepc,trideboxing,triderunn
  Допустимый тип данных: Строка
• hw_password
  Описание:
  пароль устройства
  Допустимый тип данных: Строка
• rudesktop_id
  Описание:
  идентификатор RUDESKTOP
  Допустимый тип данных: Строка
• rudesktop_password
  Описание:
  пароль RUDESKTOP
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  идентификатор устройства в TRIDE
  Тип данных: Число
devices.lookup

Описание:
Входящие переменные:
• id
  Описание:
  идентификатор устройства цифровой
  Допустимый тип данных: Число
• hw_id
  Описание:
  идентификатор устройства (привязка к железу)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  идентификатор устройства в TRIDE
  Тип данных: Строка
• hw_id
  Описание:
  идентификатор устройства (привязка к железу)
  Тип данных: Строка
• hw_password
  Описание:
  пароль устройства
  Тип данных: Строка
• type
  Описание:
  Тип устройства: tridegate,tridepc,trideboxing,triderunn
  Тип данных: Строка
• authed
  Описание:
  true, если устройство авторизовано в TRIDE
  Тип данных: Логическое выражение
• club_id
  Описание:
  идентификатор клуба, к которому привязано устройство
  Тип данных: Строка
• club_name
  Описание:
  название клуба, к которому привязано устройство
  Тип данных: Строка
• zone_id
  Описание:
  идентификатор зоны, к которой привязано устройство
  Тип данных: Строка
• zone_name
  Описание:
  название зоны, к которой привязано устройство
  Тип данных: Строка
• online
  Описание:
  true, если устройство в сети
  Тип данных: Логическое выражение
• local_ip
  Описание:
  айпи устройства в локальной сети (если оно уже онлайн)
  Тип данных: Строка
devices.setclub

Описание:
Входящие переменные:
• id обязательно
  Описание:
  идентификатор устройства цифровой
  Допустимый тип данных: Число
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• zone_id обязательно
  Описание:
  идентификатор зоны
  Допустимый тип данных: Строка
• custom_name
  Описание:
  Имя устройства в клубе (кастомное если нужно)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• dev_id
  Описание:
  идентификатор устройства в TRIDE
  Тип данных: Число
• valid
  Описание:
  true, если устройство привязано к клубу и зоне
  Тип данных: Логическое выражение
• confirmed
  Описание:
  true, если устройство подтверждено привязку к клубу и зоне
  Тип данных: Логическое выражение

Модуль personal

Общая информация

Название: personal
sessions.prepare

Описание: Выбрать тренировку
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
• video_id
  Описание:
  Идентификатор видео
  Допустимый тип данных: Строка
• workout_id
  Описание:
  Идентификатор схемы тренировки
  Допустимый тип данных: Строка
• zone_id
  Описание:
  ID зоны или коробочки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  ID занятия
  Тип данных: Строка

Модуль pulse

Общая информация

Название: Pulse
getDailyStats

Описание: Получить дневную статистику пульса пользователя
Входящие переменные:
• day
  Описание:
  День в формате YYYYMMDD
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба (опционально, null = общая статистика)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• sessions_count
  Описание:
  Количество сессий за день
  Тип данных: Число
• total_duration
  Описание:
  Общая длительность (секунды)
  Тип данных: Число
• avg_hr
  Описание:
  Средний пульс за день
  Тип данных: Число
• max_hr
  Описание:
  Максимальный пульс за день
  Тип данных: Число
• min_hr
  Описание:
  Минимальный пульс за день
  Тип данных: Число
• resting_hr
  Описание:
  Пульс покоя
  Тип данных: Число
• time_in_zones
  Описание:
  Время в зонах пульса
  Тип данных: Объект
• total_calories
  Описание:
  Общие калории за день
  Тип данных: Число
• total_points
  Описание:
  Общие баллы за день
  Тип данных: Число
• day_graph
  Описание:
  График пульса за день
  Тип данных: Массив (любые типы внутри)
• estimated_vo2max
  Описание:
  Оценка VO2max
  Тип данных: Дробное число
• training_load
  Описание:
  Тренировочная нагрузка
  Тип данных: Дробное число
• fatigue_index
  Описание:
  Индекс усталости 0-100
  Тип данных: Дробное число
• readiness_score
  Описание:
  Готовность к тренировке 0-100
  Тип данных: Дробное число
getClubRanking

Описание: Получить рейтинг клуба по пульсу
Входящие переменные:
• club_id обязательно
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• day
  Описание:
  День в формате YYYYMMDD (опционально, по умолчанию сегодня)
  Допустимый тип данных: Число
• type
  Описание:
  Тип рейтинга: points или calories
  Допустимый тип данных: Строка
• limit
  Описание:
  Количество записей (максимум 100)
  Допустимый тип данных: Число
Возвращаемые параметры:
• items
  Описание:
  Топ участников
  Тип данных: Массив объектов
  Вложенные элементы:
  • uid
    Описание:
    ID пользователя
    Тип данных: Число
  • nickname
    Описание:
    Имя пользователя
    Тип данных: Строка
  • avatar
    Описание:
    Аватар пользователя
    Тип данных: Строка
  • points
    Описание:
    Баллы
    Тип данных: Число
  • calories
    Описание:
    Калории
    Тип данных: Число
  • rank
    Описание:
    Позиция в рейтинге
    Тип данных: Число
• my_position
  Описание:
  Позиция текущего пользователя
  Тип данных: Объект
• total_participants
  Описание:
  Всего участников
  Тип данных: Число
• total_sessions
  Описание:
  Всего сессий
  Тип данных: Число
• avg_points_per_user
  Описание:
  Средние баллы на пользователя
  Тип данных: Дробное число
• avg_calories_per_user
  Описание:
  Средние калории на пользователя
  Тип данных: Дробное число
getDayGraph

Описание: Получить график пульса за день
Входящие переменные:
• day
  Описание:
  День в формате YYYYMMDD
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба (опционально)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• graph
  Описание:
  График пульса [{ts, hr}, ...]
  Тип данных: Массив (любые типы внутри)
importExternalData

Описание: Импортировать данные пульса из внешних источников
Входящие переменные:
• date обязательно
  Описание:
  Дата (ISO format или YYYY-MM-DD)
  Допустимый тип данных: Строка
• source обязательно
  Описание:
  Источник данных (garmin, strava, apple_health и т.д.)
  Допустимый тип данных: Строка
• hr_data обязательно
  Описание:
  Массив данных пульса [{ts, hr}, ...]
  Допустимый тип данных: Массив (любые типы внутри)
• metadata
  Описание:
  Дополнительные метаданные
  Допустимый тип данных: Объект
Возвращаемые параметры:
• success
  Описание:
  Успешность импорта
  Тип данных: Логическое выражение
• session_id
  Описание:
  ID созданной сессии
  Тип данных: Строка
• imported_samples
  Описание:
  Количество импортированных показаний
  Тип данных: Число
• error
  Описание:
  Сообщение об ошибке (если есть)
  Тип данных: Строка
getAnalytics

Описание: Получить аналитику пульса за период
Входящие переменные:
• period
  Описание:
  Период: day, week, month
  Допустимый тип данных: Строка
Возвращаемые параметры:
• hrv_trend
  Описание:
  Тренд HRV
  Тип данных: Массив (любые типы внутри)
• vo2max
  Описание:
  Оценка VO2max
  Тип данных: Дробное число
• recovery_score
  Описание:
  Оценка восстановления
  Тип данных: Дробное число
• readiness
  Описание:
  Готовность к тренировке
  Тип данных: Дробное число
• training_load_chart
  Описание:
  График тренировочной нагрузки
  Тип данных: Массив (любые типы внутри)

Модуль psport

Общая информация

Название: psport
coaches.list

Описание: Получить список тренеров из системы
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
sessiontypes.list

Описание: Получить список видов занятий из системы
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
zones.list

Описание: Получить список залов из системы
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
check.org_id

Описание: Проверить org_id
Входящие переменные:
• org_id
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• name
  Тип данных: Строка
schedule.list

Описание: Получить расписание занятий из системы
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
product.categories

Описание: Получить список продуктов
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
products.list

Описание: Получить список продуктов
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
purchases.list

Описание: Получить список покупок
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• past
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• past
  Тип данных: Число

Модуль onec

Общая информация

Название: onec
coaches.list

Описание: Получить список тренеров из 1С:Фитнес
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
sessiontypes.list

Описание: Получить список видов занятий из 1С:Фитнес
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
zones.list

Описание: Получить список помещений из 1С:Фитнес
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
schedule.list

Описание: Получить расписание занятий из 1С:Фитнес
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
product.categories

Описание: Получить список категорий продуктов из 1С:Фитнес
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
products.list

Описание: Получить список продуктов из 1С:Фитнес
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
purchases.list

Описание: Получить список членств/пакетов пользователя из 1С:Фитнес
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
• past
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• past
  Тип данных: Число
check.url

Описание: Проверить настройки подключения к 1С:Фитнес
Входящие переменные:
• base_url
  Допустимый тип данных: Строка
• admin_login
  Допустимый тип данных: Строка
• admin_password
  Допустимый тип данных: Строка
• api_key
  Допустимый тип данных: Строка
• club_id_1c
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• error
  Тип данных: Строка

Модуль settings

Общая информация

Название: Settings
get

Описание:
Входящие переменные:
Возвращаемые параметры:
sport_types

Описание:
Входящие переменные:
• sport_type
  Допустимый тип данных: Число
Возвращаемые параметры:
country.get

Описание:
Входящие переменные:
Возвращаемые параметры:
permissions.list

Описание:
Входящие переменные:
Возвращаемые параметры:
uibuilder.registry

Описание: Получить реестр блоков/настроек UI Builder
Входящие переменные:
• section
  Описание:
  Опционально: конкретный раздел (schedule|team|session_types)
  Допустимый тип данных: Строка
Возвращаемые параметры:

Модуль support

Общая информация

Название: support
chat.get

Описание: Получить или создать чат поддержки клуба
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
messages.list

Описание: Получить историю сообщений (старые)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• first_id
  Описание:
  ID первого сообщения для пагинации
  Допустимый тип данных: Число в строке
• limit
  Описание:
  Лимит сообщений
  Допустимый тип данных: Число в строке
• source_filter
  Описание:
  Фильтр источника: app или all
  Допустимый тип данных: Строка
messages.new

Описание: Получить новые сообщения (после last_id)
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• last_id
  Описание:
  ID последнего известного сообщения
  Допустимый тип данных: Число в строке
• source_filter
  Описание:
  Фильтр источника: app или all
  Допустимый тип данных: Строка
messages.send

Описание: Отправить сообщение в чат поддержки
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• text
  Описание:
  Текст сообщения
  Допустимый тип данных: Строка
• attachments
  Описание:
  Вложения
  Допустимый тип данных: Массив объектов
• reply_to
  Описание:
  ID сообщения для ответа
  Допустимый тип данных: Число в строке
messages.read

Описание: Отметить сообщения прочитанными
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• last_read_id обязательно
  Описание:
  ID последнего прочитанного
  Допустимый тип данных: Число в строке
notification_settings.get

Описание: Получить настройки уведомлений поддержки
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
notification_settings.update

Описание: Обновить настройки уведомлений поддержки
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• enabled
  Описание:
  Включены ли уведомления
  Допустимый тип данных: Логическое выражение
• throttle_hours
  Описание:
  Минимальный интервал (часы)
  Допустимый тип данных: Число в строке
dashboard

Описание: Дашборд поддержки — статистика
Входящие переменные:
chats.list

Описание: Список чатов поддержки (для агентов)
Входящие переменные:
• filter
  Описание:
  Фильтр: my, unassigned, all
  Допустимый тип данных: Строка
• status
  Описание:
  Статус чата
  Допустимый тип данных: Строка
• tag
  Описание:
  Фильтр по тегу
  Допустимый тип данных: Строка
• search
  Описание:
  Поиск по названию клуба
  Допустимый тип данных: Строка
• sort
  Описание:
  Сортировка: last_message, unread
  Допустимый тип данных: Строка
• skip
  Описание:
  Пропустить N записей
  Допустимый тип данных: Число в строке
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число в строке
chats.get

Описание: Детали чата поддержки (для агентов)
Входящие переменные:
• chat_id
  Описание:
  ID чата
  Допустимый тип данных: Строка
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
chats.assign

Описание: Назначить/снять агента на чат
Входящие переменные:
• chat_id обязательно
  Описание:
  ID чата
  Допустимый тип данных: Строка
• agent_uid
  Описание:
  UID агента (по умолчанию — текущий)
  Допустимый тип данных: Строка
• action
  Описание:
  assign или unassign
  Допустимый тип данных: Строка
chats.tag

Описание: Управление тегами чата
Входящие переменные:
• chat_id обязательно
  Описание:
  ID чата
  Допустимый тип данных: Строка
• tag обязательно
  Описание:
  Тег
  Допустимый тип данных: Строка
• action
  Описание:
  add или remove
  Допустимый тип данных: Строка
agents.list

Описание: Список агентов поддержки
Входящие переменные:
• status
  Описание:
  Фильтр по статусу
  Допустимый тип данных: Строка
agents.search

Описание: Поиск пользователя по телефону для добавления в агенты
Входящие переменные:
• phone обязательно
  Описание:
  Номер телефона
  Допустимый тип данных: Строка
agents.add

Описание: Добавить агента поддержки
Входящие переменные:
• uid
  Описание:
  UID пользователя
  Допустимый тип данных: Строка
• phone
  Описание:
  Телефон пользователя
  Допустимый тип данных: Строка
• max_chats
  Описание:
  Лимит чатов
  Допустимый тип данных: Число в строке
• assigned_clubs
  Описание:
  Привязка к клубам
  Допустимый тип данных: Массив строк
agents.edit

Описание: Редактировать агента поддержки
Входящие переменные:
• agent_id обязательно
  Описание:
  ID записи агента
  Допустимый тип данных: Строка
• status
  Описание:
  Статус
  Допустимый тип данных: Строка
• max_chats
  Описание:
  Лимит чатов
  Допустимый тип данных: Число в строке
• assigned_clubs
  Описание:
  Привязка к клубам
  Допустимый тип данных: Массив строк
• notification_settings
  Описание:
  Настройки уведомлений агента
  Допустимый тип данных: Объект
agents.remove

Описание: Удалить агента поддержки
Входящие переменные:
• agent_id обязательно
  Описание:
  ID записи агента
  Допустимый тип данных: Строка
broadcast.send

Описание: Массовая отправка сообщения в чаты поддержки
Входящие переменные:
• text
  Описание:
  Текст сообщения
  Допустимый тип данных: Строка
• attachments
  Описание:
  Вложения
  Допустимый тип данных: Массив объектов
• club_ids
  Описание:
  ID клубов (пусто = всем)
  Допустимый тип данных: Массив строк
• tag
  Описание:
  Фильтр по тегу
  Допустимый тип данных: Строка
broadcast.history

Описание: История массовых рассылок
Входящие переменные:
• skip
  Описание:
  Пропустить N записей
  Допустимый тип данных: Число в строке
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число в строке

Модуль tride

Общая информация

Название: Tride
object.versions.list

Описание: Получить список версий объекта
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• object_type
  Допустимый тип данных: Строка
• object_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
object.versions.rename

Описание: Изменить название версии объекта
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• version_id
  Допустимый тип данных: Строка
• object_id
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
Возвращаемые параметры:
object.versions.revert

Описание: Вернуть версию объекта к предыдущей
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• version_id
  Допустимый тип данных: Строка
• object_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
screen.modes.add

Описание:
Входящие переменные:
• mode
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• tag
  Допустимый тип данных: Строка
• up
  Допустимый тип данных: Строка
• down
  Допустимый тип данных: Строка
• center
  Допустимый тип данных: Строка
• innerzone
  Допустимый тип данных: Строка
• outerzone
  Допустимый тип данных: Строка
• showavatar
  Допустимый тип данных: Логическое выражение
• showgraph
  Допустимый тип данных: Логическое выражение
• sport_type
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Тип данных: Строка
• mode
  Тип данных: Строка
• tag
  Тип данных: Строка
• up
  Тип данных: Строка
• down
  Тип данных: Строка
• center
  Тип данных: Строка
• innerzone
  Тип данных: Строка
• outerzone
  Тип данных: Строка
• showavatar
  Тип данных: Логическое выражение
• showgraph
  Тип данных: Логическое выражение
• sport_type
  Тип данных: Число
club.getconfig

Описание: Получить конфигурацию клуба
Входящие переменные:
• app_version
  Описание:
  Версия приложения
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентфикатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• theme
  Тип данных: Объект
• menu
  Тип данных: Объект
• pages
  Тип данных: Объект
• logos
  Тип данных: Объект
worlds.token.get

Описание:
Входящие переменные:
• session_id
  Описание:
  ID тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• token
  Тип данных: Строка
clubs.switch

Описание:
Входящие переменные:
Возвращаемые параметры:
sessions.checkfinished

Описание:
Входящие переменные:
Возвращаемые параметры:
qrcode.checkgeneric

Описание:
Входящие переменные:
Возвращаемые параметры:
qrcode.setgeneric

Описание:
Входящие переменные:
Возвращаемые параметры:
sessions.setsynced

Описание:
Входящие переменные:
Возвращаемые параметры:
sessions.getnotsynced

Описание:
Входящие переменные:
Возвращаемые параметры:
sessions.checksynced

Описание:
Входящие переменные:
Возвращаемые параметры:
mobile.checkupdate

Описание:
Входящие переменные:
Возвращаемые параметры:
sessions.syncparticipant

Описание:
Входящие переменные:
Возвращаемые параметры:
circles.remove

Описание: Получить список привязанных карт пользователя
Входящие переменные:
Возвращаемые параметры:
screenmodes.has_club

Описание: Получить список привязанных карт пользователя
Входящие переменные:
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
screenmodes.has_own

Описание: Получить список привязанных карт пользователя
Входящие переменные:
Возвращаемые параметры:
mybookings.listnext

Описание: Получить список ближайших бронирований
Входящие переменные:
Возвращаемые параметры:
mybookings.participants

Описание: Получить список участников бронирования
Входящие переменные:
Возвращаемые параметры:
checkusedble

Описание: Получить количество непрочитанных уведомлений пользователя
Входящие переменные:
• devid
  Описание:
  Идентификатор устройства
  Допустимый тип данных: Строка
Возвращаемые параметры:
ble.set

Описание: Получить количество непрочитанных уведомлений пользователя
Входящие переменные:
• devid
  Описание:
  Идентификатор устройства
  Допустимый тип данных: Строка
Возвращаемые параметры:
ble.setsession

Описание: Получить количество непрочитанных уведомлений пользователя
Входящие переменные:
• devid
  Описание:
  Идентификатор устройства
  Допустимый тип данных: Строка
Возвращаемые параметры:
ble.get

Описание: Получить количество непрочитанных уведомлений пользователя
Входящие переменные:
Возвращаемые параметры:
ble.clear

Описание: Отменить привязку персонального BLE датчика
Входящие переменные:
Возвращаемые параметры:
notifications.count

Описание: Получить количество непрочитанных уведомлений пользователя
Входящие переменные:
Возвращаемые параметры:
• total
  Описание:
  Количество непрочитанных уведомлений
  Тип данных: Число
notifications.read

Описание: Сообщить о прочтении уведомлений
Входящие переменные:
• ids
  Описание:
  Идентификаторы уведомлений
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• total
  Описание:
  Количество непрочитанных уведомлений
  Тип данных: Число
notifications.readall

Описание: Сообщить о прочтении уведомлений
Входящие переменные:
Возвращаемые параметры:
• total
  Описание:
  Количество непрочитанных уведомлений
  Тип данных: Число
notifications.remove

Описание: Удалить уведомление
Входящие переменные:
• id
  Описание:
  Идентификатор уведомления
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор уведомления
  Тип данных: Строка
• removed
  Описание:
  Удалено
  Тип данных: Логическое выражение
notifications.status

Описание: Изменить статус уведомленния (нажав на соответствующую кнопку)
Входящие переменные:
• id
  Описание:
  Идентификатор уведомления
  Допустимый тип данных: Строка
• status
  Описание:
  Новый статус уведомления
  Допустимый тип данных: Число
Возвращаемые параметры:
• id
  Описание:
  Идентификатор уведомления
  Тип данных: Строка
• ts
  Описание:
  Дата и время создания уведомления (unixtimestamp)
  Тип данных: Число
• data
  Описание:
  Данные уведомления
  Тип данных: Объект
• type
  Описание:
  Тип уведомления
  Тип данных: Строка
• read
  Описание:
  Статус прочтения уведомления
  Тип данных: Число
notifications.list

Описание: Получить список уведомлений пользователя
Входящие переменные:
• limit
  Описание:
  Количество уведомлений которое получаем за один раз
  Допустимый тип данных: Число
• skip
  Описание:
  Сколько уведомлений пропустить
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Описание:
  Количество уведомлений всего
  Тип данных: Число
• notifications
  Описание:
  Список уведомлений
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор уведомления
    Тип данных: Строка
  • ts
    Описание:
    Дата и время создания уведомления (unixtimestamp)
    Тип данных: Число
  • data
    Описание:
    Данные уведомления
    Тип данных: Объект
  • type
    Описание:
    Тип уведомления
    Тип данных: Строка
  • read
    Описание:
    Статус прочтения уведомления
    Тип данных: Число
sessions.ready

Описание: Подготовить к запуску тренировку
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• ready
  Тип данных: Логическое выражение
sessions.switchteam

Описание: Сменить команду в формате bootcamp
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• nextteam
  Тип данных: Логическое выражение
sessions.updates.apply

Описание: Применить изменения в программу тренировки
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• nextteam
  Тип данных: Логическое выражение
sessions.switchall

Описание: Сменить команду в формате bootcamp
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• nextteam
  Тип данных: Логическое выражение
sessions.switchcurrent

Описание: Сменить команду в формате bootcamp
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• nextteam
  Тип данных: Логическое выражение
sessions.cancellocalchallenge

Описание: Запустить прямую трансляцию тренера
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.nextwavelocalchallenge

Описание: Запустить прямую трансляцию тренера
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.localchallengeresults

Описание: Запустить прямую трансляцию тренера
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.publish

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• sdp_offer
  Допустимый тип данных: Строка
Возвращаемые параметры:
• publisher_id
  Тип данных: Строка
• sdp_answer
  Тип данных: Строка
sessions.publishaudio

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
• sdp_offer
  Допустимый тип данных: Строка
Возвращаемые параметры:
• publisher_id
  Тип данных: Строка
• sdp_answer
  Тип данных: Строка
sessions.listenaudio

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• sdp_offer
  Допустимый тип данных: Строка
Возвращаемые параметры:
• publisher_id
  Тип данных: Строка
• sdp_answer
  Тип данных: Строка
sessions.listpublishers

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.configurepublisher

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.mutepublisher

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.unmutepublisher

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.unmuteroom

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.muteroom

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.preparelisten

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• name
  Допустимый тип данных: Строка
Возвращаемые параметры:
• listener_id
  Тип данных: Строка
• sdp_offer
  Тип данных: Строка
sessions.listen

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• listener_id
  Допустимый тип данных: Строка
• sdp_answer
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.listenerice

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• listener_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.publisherice

Описание: Запустить прямую трансляцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• publisher_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.getzones

Описание: Получить данные по участвующим зонам
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.getcoaches

Описание: Получить данные по участвующим тренерам
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.finishlocalchallenge

Описание: Запустить прямую трансляцию тренера
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.startlocalchallenge

Описание: Запустить прямую трансляцию тренера
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
sessions.runlivecoach

Описание: Запустить прямую трансляцию тренера
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• ready
  Тип данных: Логическое выражение
• url
  Тип данных: Строка
sessions.stoplivecoach

Описание: Остановить прямую трансляцию тренера
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• stopped
  Тип данных: Логическое выражение
sessions.start

Описание: Запустить тренировку
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• started
  Тип данных: Логическое выражение
sessions.pause

Описание: На паузу тренировку
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• paused
  Тип данных: Логическое выражение
sessions.resetall

Описание: Установить тест
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• set
  Тип данных: Логическое выражение
sessions.competitionstarted

Описание: Установить тест
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• set
  Тип данных: Логическое выражение
sessions.disableall

Описание: Установить тест
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• set
  Тип данных: Логическое выражение
sessions.enableall

Описание: Установить тест
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• set
  Тип данных: Логическое выражение
sessions.unoccupyall

Описание: Освободить все места в сессии
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• set
  Тип данных: Логическое выражение
sessions.settest

Описание: Установить тест для участников сессии
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• test_id обязательно
  Описание:
  Идентификатор теста из реестра доступных тестов
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Тип спорта (1 — велосипед, 2 — гребля)
  Допустимый тип данных: Число
• pids
  Описание:
  Массив идентификаторов участников. Если не указан — используется all
  Допустимый тип данных: Массив строк
• all
  Описание:
  Применить ко всем участникам сессии
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• set
  Тип данных: Логическое выражение
sessions.starttest

Описание: Запустить назначенный тест для участников
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• pids
  Описание:
  Массив идентификаторов участников. Если не указан — используется all
  Допустимый тип данных: Массив строк
• all
  Описание:
  Применить ко всем участникам сессии
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• start
  Тип данных: Логическое выражение
sessions.stoptest

Описание: Остановить тест без расчёта результата
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• pids
  Описание:
  Массив идентификаторов участников. Если не указан — используется all
  Допустимый тип данных: Массив строк
• all
  Описание:
  Применить ко всем участникам сессии
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• stop
  Тип данных: Логическое выражение
sessions.finishtest

Описание: Принудительно завершить тест с расчётом результата на клиенте
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• pids
  Описание:
  Массив идентификаторов участников. Если не указан — используется all
  Допустимый тип данных: Массив строк
• all
  Описание:
  Применить ко всем участникам сессии
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• finish
  Тип данных: Логическое выражение
sessions.testresult

Описание: Принять результат FTP-теста от клиентского терминала
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• pid обязательно
  Описание:
  Идентификатор участника в сессии (например uid_12345)
  Допустимый тип данных: Строка
• uid
  Описание:
  UID участника — владельца результата теста
  Допустимый тип данных: Число
• test_id обязательно
  Описание:
  Идентификатор теста
  Допустимый тип данных: Строка
• result обязательно
  Описание:
  Рассчитанный FTP
  Допустимый тип данных: Число
• sport_type обязательно
  Описание:
  Тип спорта (1=cycling, 2=rowing)
  Допустимый тип данных: Число
• graphs
  Описание:
  Графы мощности за время теста
  Допустимый тип данных: Объект
• started_ts
  Описание:
  Начало теста
  Допустимый тип данных: Число
• finished_ts
  Описание:
  Конец теста
  Допустимый тип данных: Число
Возвращаемые параметры:
• saved
  Тип данных: Логическое выражение
sessions.finish

Описание: Завершить тренировку
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• finished
  Тип данных: Логическое выражение
sessions.addmusic

Описание: Добавить или включить музыку
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• music
  Допустимый тип данных: Объект
• action
  Описание:
  Действие. replace - включить вместо существующего плейлиста, add - добавить в плейлист
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.addmusiceffects

Описание: Добавить или включить музыку
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• musiceffects
  Допустимый тип данных: Объект
• action
  Описание:
  Действие. replace - включить вместо существующего плейлиста, add - добавить в плейлист
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.setmusicplaylist

Описание: Добавить или включить музыку
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.setmusiceffectsplaylist

Описание: Добавить или включить музыку
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.addvideo

Описание: Добавить или включить видео
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• video
  Допустимый тип данных: Объект
• action
  Описание:
  Действие. replace - включить вместо существующего плейлиста, add - добавить в плейлист
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.addcoachvideo

Описание: Добавить или включить видео тренера
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• video
  Допустимый тип данных: Объект
• action
  Описание:
  Действие. replace - включить вместо существующего плейлиста, add - добавить в плейлист
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
screen.getscreenmodes

Описание: Получить список режимов экрана
Входящие переменные:
• predefined
  Описание:
  Получить предустановленные
  Допустимый тип данных: Логическое выражение
• mode
  Описание:
  Вид режима (circles,groupcircles,table)
  Допустимый тип данных: Строка
• skip
  Допустимый тип данных: Число
• favorite
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
sessions.setscreendisplay

Описание: Изменить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• display
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.starttabata

Описание: Изменить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.finishtabata

Описание: Изменить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.setscreenvolume

Описание: Изменить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.setscreencontroldata

Описание: Изменить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.setscreendata

Описание: Изменить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.getscreendisplay

Описание: Получить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• display
  Тип данных: Объект
sessions.getscreenlocked

Описание: Получить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• display
  Тип данных: Объект
sessions.getscreenvolume

Описание: Получить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• volume
  Тип данных: Объект
sessions.getscreendata

Описание: Получить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• data
  Тип данных: Объект
sessions.getscreencontroldata

Описание: Получить режим экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• data
  Тип данных: Объект
sessions.setprofile

Описание: Установить профиль тренировки
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• workout_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.getgroupgraphs

Описание: Получить текущие данные графиков группы
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• ftppercent
  Тип данных: Массив чисел
• hrpercent
  Тип данных: Массив чисел
sessions.getcurrent

Описание: Получить текущие данные музыки видео профиля
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• current
  Тип данных: Объект
  Вложенные элементы:
  • music
    Тип данных: Объект
  • musiceffects
    Тип данных: Объект
  • video
    Тип данных: Объект
  • task
    Тип данных: Объект
sessions.getmyself

Описание: Изменить свои данные
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• eqid
  Описание:
  Идентификатор тренажера
  Тип данных: Строка
• nickname
  Описание:
  Имя пользователя
  Тип данных: Строка
• ftp
  Тип данных: Число
• weight
  Тип данных: Строка
• birthdate
  Тип данных: Строка
• gender
  Тип данных: Число
• maxhr
  Тип данных: Число
sessions.sendlike

Описание: Отправить лайк
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.sendreaction

Описание: Отправить реакцию
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
• reaction
  Описание:
  Текст реакции
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.makescreenshot

Описание: Сделать скриншот экрана
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• fileid
  Тип данных: Строка
sessions.screenshot_made

Описание: Сообщить о готовности скриншота
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• sport_type
  Описание:
  Вид спорта
  Допустимый тип данных: Число
• fileid обязательно
  Описание:
  Идентификатор скриншота
  Допустимый тип данных: Строка
• uid
  Описание:
  Для кого сделан скриншот
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.setmyself

Описание: Изменить свои данные
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.unsetmyself

Описание: Изменить свои данные
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• eqid
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.setparticipant

Описание: Изменить данные участника
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• eqid
  Описание:
  Идентификатор тренажера
  Допустимый тип данных: Строка
• uid
  Описание:
  Идентификатор пользователя
  Допустимый тип данных: Число
• nickname
  Описание:
  Имя пользователя
  Допустимый тип данных: Строка
• ftp
  Допустимый тип данных: Число
• weight
  Допустимый тип данных: Строка
• birthdate
  Допустимый тип данных: Строка
• gender
  Допустимый тип данных: Число
• maxhr
  Допустимый тип данных: Число
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• club_fields
  Описание:
  Значения кастомных полей клуба
  Допустимый тип данных: Объект
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.setparticipantenabled

Описание: Выключить участника
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• eqid
  Описание:
  Идентификатор тренажера
  Допустимый тип данных: Строка
• uid
  Описание:
  Идентификатор пользователя
  Допустимый тип данных: Число
• enabled
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.unsetparticipant

Описание: Освобдить тренажер
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• eqid
  Описание:
  Идентификатор тренажера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
sessions.get

Описание: Получить данные тренировки
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• session
  Тип данных: Объект
sessions.getbyeqid

Описание: Получить данные тренировки по идентификатору оборудования
Входящие переменные:
• eqid обязательно
  Описание:
  Идентификатор оборудования
  Допустимый тип данных: Строка
Возвращаемые параметры:
• session
  Тип данных: Объект
get.zonestate

Описание: Получить текущее состояние устройства в зоне клуба
Входящие переменные:
Возвращаемые параметры:
• session
  Тип данных: Объект
check.rentedSensor

Описание: Получить текущее состояние
Входящие переменные:
• session_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• available
  Тип данных: Логическое выражение
• num
  Тип данных: Строка
• id
  Тип данных: Строка
get.state

Описание: Получить текущее состояние
Входящие переменные:
Возвращаемые параметры:
• session
  Тип данных: Объект
get.participantstate

Описание: Получить текущее состояние
Входящие переменные:
Возвращаемые параметры:
• session
  Тип данных: Объект
sessions.getparticipants

Описание:
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• session
  Тип данных: Объект
sessions.getparticipant

Описание: Получить информацию участника
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• eqid
  Допустимый тип данных: Строка
• uid
  Допустимый тип данных: Число
Возвращаемые параметры:
• session
  Тип данных: Объект
sessions.getparticipantdata

Описание: Получить информацию участника
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• eqid
  Допустимый тип данных: Строка
• pid
  Допустимый тип данных: Строка
• uid
  Допустимый тип данных: Число
Возвращаемые параметры:
• session
  Тип данных: Объект
sessions.getparticipantsdata

Описание: Получить информацию участника
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• session
  Тип данных: Объект
sessions.getparticipantgraph

Описание: Получить график участника
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• eqid
  Допустимый тип данных: Строка
• uid
  Допустимый тип данных: Число
Возвращаемые параметры:
• session
  Тип данных: Объект
sessions.listequipment

Описание: Получить список оборудования доступный на тренировке
Входящие переменные:
• session_id обязательно
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• equipment
  Тип данных: Массив объектов
  Вложенные элементы:
  • eqid
    Описание:
    Идентификатор оборудования
    Тип данных: Строка
  • name
    Описание:
    Название/номер оборудования
    Тип данных: Строка
  • teams
    Описание:
    Объект данных о доступности оборудования в рамках разных команд. Ключи объекта это номера команд, значения true/false означающий занят ли тренажер, в рамках команды, true - уже занят (если команды актуальны)
    Тип данных: Объект
  • occupied
    Описание:
    Занят ли тренажер
    Тип данных: Логическое выражение
  • ismy
    Описание:
    Клиент уже зарегистрирован на данном оборудовании
    Тип данных: Логическое выражение
  • myteam
    Описание:
    Номер команды клиента (если команды актуальны)
    Тип данных: Число в строке
sensors.scan

Описание: Получить список датчиков актуальный
Входящие переменные:
• session_id
  Описание:
  ID тренировки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  ID датчика
  Тип данных: Строка
• type
  Описание:
  Тип датчика
  Тип данных: Строка
• value
  Описание:
  Значение датчика
  Тип данных: Строка
sport_types.get

Описание: Получить список видов спорта
Входящие переменные:
Возвращаемые параметры:
• sport_types
  Описание:
  Список видов спорта
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор вида спорта
    Тип данных: Число
  • name
    Описание:
    Название вида спорта
    Тип данных: Строка
versions.shown

Описание:
Входящие переменные:
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
versions.list

Описание:
Входящие переменные:
Возвращаемые параметры:
• versions
  Тип данных: Массив объектов
versions.get

Описание:
Входящие переменные:
• version
  Описание:
  Номер версии
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентфикатор версии
  Тип данных: Строка
• version
  Описание:
  Версия
  Тип данных: Строка
• body
  Описание:
  Описание изменений
  Тип данных: Строка
banners.has

Описание: Получить список баннеров пользоваетеля
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• club
  Тип данных: Логическое выражение
• tride
  Тип данных: Логическое выражение
banners.list

Описание: Получить список баннеров в клубе
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор баннера
    Тип данных: Строка
  • title
    Описание:
    Заголовок баннера
    Тип данных: Строка
  • fileid
    Описание:
    Идентификатор файла
    Тип данных: Строка
  • islink
    Описание:
    Баннер является ссылкой
    Тип данных: Логическое выражение
  • body
    Описание:
    Текст баннера
    Тип данных: Строка
  • showmoretext
    Описание:
    Текст 'Показать больше'
    Тип данных: Строка
  • showmorelink
    Описание:
    Ссылка 'Показать больше'
    Тип данных: Строка
  • openinapp
    Описание:
    Открывать ссылку в приложении
    Тип данных: Логическое выражение
banners.get

Описание: Получить список баннеров в клубе
Входящие переменные:
• id
  Описание:
  Идентификатор анонса
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор баннера
  Тип данных: Строка
• title
  Описание:
  Заголовок баннера
  Тип данных: Строка
• fileid
  Описание:
  Идентификатор файла
  Тип данных: Строка
• islink
  Описание:
  Баннер является ссылкой
  Тип данных: Логическое выражение
• body
  Описание:
  Текст баннера
  Тип данных: Строка
• showmoretext
  Описание:
  Текст 'Показать больше'
  Тип данных: Строка
• showmorelink
  Описание:
  Ссылка 'Показать больше'
  Тип данных: Строка
• openinapp
  Описание:
  Открывать ссылку в приложении
  Тип данных: Логическое выражение

Модуль user_stats

Общая информация

Название: user_stats
summary

Описание: Получить сводку метрик тренировочной нагрузки пользователя
Входящие переменные:
• uid
  Описание:
  ID пользователя (если не указан — текущий пользователь)
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба (опционально, без него — общая статистика)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• current_metrics
  Описание:
  Текущие метрики: ewma_7, ewma_28, acwr, acwr_status, monotony, strain, intensity_zones, weight_changes, ftp_changes
  Тип данных: Объект
• last_7_days
  Описание:
  Дневная статистика за последние 7 дней
  Тип данных: Массив объектов
• current_week
  Описание:
  Статистика текущей недели
  Тип данных: Объект
• current_month
  Описание:
  Статистика текущего месяца
  Тип данных: Объект
• plateau_info
  Описание:
  Информация о плато (если обнаружено)
  Тип данных: Объект
• rest_days
  Описание:
  Дней без тренировок подряд
  Тип данных: Число
daily

Описание: Получить дневную статистику пользователя за период
Входящие переменные:
• uid
  Описание:
  ID пользователя (если не указан — текущий пользователь)
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба (опционально)
  Допустимый тип данных: Строка
• from_date обязательно
  Описание:
  Начало периода (unix timestamp, секунды)
  Допустимый тип данных: Число
• to_date обязательно
  Описание:
  Конец периода (unix timestamp, секунды)
  Допустимый тип данных: Число
weekly

Описание: Получить недельную статистику пользователя
Входящие переменные:
• uid
  Описание:
  ID пользователя (если не указан — текущий пользователь)
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба (опционально)
  Допустимый тип данных: Строка
• year обязательно
  Описание:
  Год
  Допустимый тип данных: Число
• weeks
  Описание:
  Массив номеров недель (опционально, если не указан — все недели года)
  Допустимый тип данных: Массив чисел
monthly

Описание: Получить месячную статистику пользователя
Входящие переменные:
• uid
  Описание:
  ID пользователя (если не указан — текущий пользователь)
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба (опционально)
  Допустимый тип данных: Строка
• year обязательно
  Описание:
  Год
  Допустимый тип данных: Число
• months
  Описание:
  Массив номеров месяцев (опционально, если не указан — все месяцы года)
  Допустимый тип данных: Массив чисел
metrics

Описание: Получить историю метрик тренировочной нагрузки
Входящие переменные:
• uid
  Описание:
  ID пользователя (если не указан — текущий пользователь)
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба (опционально)
  Допустимый тип данных: Строка
• limit
  Описание:
  Количество записей (по умолчанию 30)
  Допустимый тип данных: Число
intensity

Описание: Получить распределение времени по зонам интенсивности (HR, Power, Cadence)
Входящие переменные:
• uid
  Описание:
  ID пользователя (если не указан — текущий пользователь)
  Допустимый тип данных: Число
• club_id
  Описание:
  ID клуба (опционально)
  Допустимый тип данных: Строка
• from_date обязательно
  Описание:
  Начало периода (unix timestamp, секунды)
  Допустимый тип данных: Число
• to_date обязательно
  Описание:
  Конец периода (unix timestamp, секунды)
  Допустимый тип данных: Число
clubs_comparison

Описание: Сравнить активность пользователя по разным клубам
Входящие переменные:
• uid
  Описание:
  ID пользователя (если не указан — текущий пользователь)
  Допустимый тип данных: Число
• from_date обязательно
  Описание:
  Начало периода (unix timestamp, секунды)
  Допустимый тип данных: Число
• to_date обязательно
  Описание:
  Конец периода (unix timestamp, секунды)
  Допустимый тип данных: Число
plateau_users

Описание: Получить список пользователей с обнаруженным тренировочным плато
Входящие переменные:
• club_id
  Описание:
  ID клуба
  Допустимый тип данных: Строка
• limit
  Описание:
  Максимальное количество результатов (по умолчанию 50)
  Допустимый тип данных: Число

Модуль versions

Общая информация

Название: versions
check

Описание: Проверить доступные версии для пользователя
Входящие переменные:
• app_id
  Описание:
  ID приложения
  Допустимый тип данных: Строка
• version
  Описание:
  Текущая версия
  Допустимый тип данных: Строка
• authed
  Описание:
  Авторизован ли пользователь
  Допустимый тип данных: Логическое выражение
• token
  Описание:
  Токен доступа
  Допустимый тип данных: Строка
• uid
  Описание:
  ID пользователя
  Допустимый тип данных: Строка
• platform
  Описание:
  Платформа (android, ios)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• version
  Тип данных: Строка
• auto
  Тип данных: Логическое выражение
• required
  Тип данных: Логическое выражение
• force
  Тип данных: Логическое выражение
• title
  Тип данных: Строка
• description
  Тип данных: Строка
• comment
  Тип данных: Строка

Модуль invoice

Общая информация

Название: invoice
get

Описание: Получить файл счета
Входящие переменные:
• invoice_id обязательно
  Описание:
  Идентификатор счета
  Допустимый тип данных: Строка
Возвращаемые параметры:
• invoice_id
  Описание:
  Идентификатор счета
  Тип данных: Строка
• fileid
  Описание:
  Идентификатор файла счета
  Тип данных: Строка
list

Описание: Получить список созданных счетов
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• date_from
  Описание:
  Дата начала
  Допустимый тип данных: Дата (формат дд.мм.гггг)
• date_to
  Описание:
  Дата окончания
  Допустимый тип данных: Дата (формат дд.мм.гггг)
Возвращаемые параметры:
• invoices
  Тип данных: Массив объектов
  Вложенные элементы:
  • invoice_id
    Описание:
    ID созданного счета
    Тип данных: Строка
  • paid
    Описание:
    Оплачено
    Тип данных: Логическое выражение
  • payment_type
    Описание:
    1 - банковская карта, 2 - банковский перевод
    Тип данных: Число
  • card_name
    Описание:
    Номер карты
    Тип данных: Строка
  • amount
    Описание:
    Сумма
    Тип данных: Дробное число в строке
  • date_invoice
    Описание:
    Дата создания счета
    Тип данных: Дата (формат дд.мм.гггг)
  • date_paid
    Описание:
    Дата оплаты
    Тип данных: Дата (формат дд.мм.гггг)
club.create.card

Описание: Выставить счет на оплату картой
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• year
  Описание:
  Выставить счет на оплату картой на год. true - год, false - месяц
  Допустимый тип данных: Логическое выражение
• savecard
  Описание:
  Сохранить карту. true - сохранить, false - не сохранить
  Допустимый тип данных: Логическое выражение
• auto_renew
  Описание:
  Автоматически проводить продление подписки данной картой
  Допустимый тип данных: Логическое выражение
• card_id
  Описание:
  Идентификатор карты
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• paid
  Описание:
  Оплачено
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  ID созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
club.create.company

Описание: Выставить счет на оплату банковским переводом
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• year
  Описание:
  Выставить счет на оплату картой на год. true - год, false - месяц
  Допустимый тип данных: Логическое выражение
• company_id обязательно
  Описание:
  Идентификатор компании
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  ID созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
club.create.balance

Описание: Выставить счет на оплату внутренним счетом
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• year
  Описание:
  Выставить счет на оплату картой на год. true - год, false - месяц
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  ID созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
club.recurrent

Описание: Переключить авто продление подписки
Входящие переменные:
options.create.card

Описание: Выставить счет на оплату картой
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• year
  Описание:
  Выставить счет на оплату картой на год. true - год, false - месяц
  Допустимый тип данных: Логическое выражение
• savecard
  Описание:
  Сохранить карту. true - сохранить, false - не сохранить
  Допустимый тип данных: Логическое выражение
• auto_renew
  Описание:
  Автоматически проводить продление подписки данной картой
  Допустимый тип данных: Логическое выражение
• card_id
  Описание:
  Идентификатор карты
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• paid
  Описание:
  Оплачено
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  ID созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
options.create.company

Описание: Выставить счет на оплату банковским переводом
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• year
  Описание:
  Выставить счет на оплату картой на год. true - год, false - месяц
  Допустимый тип данных: Логическое выражение
• company_id обязательно
  Описание:
  Идентификатор компании
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  ID созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
options.create.balance

Описание: Оплата расширения подписки внутренним счетом
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• year
  Описание:
  Выставить счет на оплату картой на год. true - год, false - месяц
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• result
  Описание:
  Успешно
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  ID созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
release.create.card

Описание: Выставить счет на оплату картой за подписку
Входящие переменные:
• subscription_id обязательно
  Описание:
  Идентификатор подписки
  Допустимый тип данных: Строка
• months обязательно
  Описание:
  Длительность подписки
  Допустимый тип данных: Число
• card_id
  Описание:
  Идентификатор карты
  Допустимый тип данных: Строка
• saveCard
  Описание:
  Сохранить карту
  Допустимый тип данных: Логическое выражение
• autoRenew
  Описание:
  Автоматически проводить продление подписки данной картой
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• paid
  Описание:
  Оплачено
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  Id созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
release.create.company

Описание: Выставить счет на оплату банковским переводом за подписку
Входящие переменные:
• subscription_id обязательно
  Описание:
  Идентификатор подписки
  Допустимый тип данных: Строка
• months обязательно
  Описание:
  Длительность подписки
  Допустимый тип данных: Число
• company_id обязательно
  Описание:
  Идентификатор компании
  Допустимый тип данных: Строка
Возвращаемые параметры:
• invoice_id
  Описание:
  Id созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
release.create.balance

Описание: Оплатить подписку на каталог внутренним счетом
Входящие переменные:
• subscription_id обязательно
  Описание:
  Идентификатор подписки
  Допустимый тип данных: Строка
• months обязательно
  Описание:
  Длительность подписки
  Допустимый тип данных: Число
Возвращаемые параметры:
• invoice_id
  Описание:
  Id созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
release.recurrent

Описание: Переключить авто продление подписки на каталог
Входящие переменные:
user.release.create.card

Описание: Выставить счет на оплату картой за подписку
Входящие переменные:
• subscription_id обязательно
  Описание:
  Идентификатор подписки
  Допустимый тип данных: Строка
• months обязательно
  Описание:
  Длительность подписки
  Допустимый тип данных: Число
• card_id
  Описание:
  Идентификатор карты
  Допустимый тип данных: Строка
• saveCard
  Описание:
  Сохранить карту
  Допустимый тип данных: Логическое выражение
• autoRenew
  Описание:
  Автоматически проводить продление подписки данной картой
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• paid
  Описание:
  Оплачено
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  Id созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
user.release.recurrent

Описание: Переключить авто продление подписки на каталог
Входящие переменные:
balance.create.card

Описание: Выставить счет на оплату картой за пополнение баланса
Входящие переменные:
• card_id
  Описание:
  Идентификатор карты
  Допустимый тип данных: Строка
• saveCard
  Описание:
  Сохранить карту
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• paid
  Описание:
  Оплачено
  Тип данных: Логическое выражение
• invoice_id
  Описание:
  Id созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка
balance.create.company

Описание: Выставить счет на оплату банковским переводом за пополнение баланса
Входящие переменные:
• company_id обязательно
  Описание:
  Идентификатор компании
  Допустимый тип данных: Строка
Возвращаемые параметры:
• invoice_id
  Описание:
  Id созданного счета
  Тип данных: Строка
• error
  Описание:
  Текст ошибки с невозможностью списания с карты
  Тип данных: Строка

Модуль pay

Общая информация

Название: pay
cards.list

Описание: Получить список привязанных карт пользователя
Входящие переменные:
Возвращаемые параметры:
• cards
  Описание:
  Список карт
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор карты
    Тип данных: Строка
  • name
    Описание:
    Название / номер карты
    Тип данных: Строка
  • type
    Описание:
    Тип карты (платежная система) - mastercard/visa/mir/unionpay
    Тип данных: Строка
cards.remove

Описание: Удалить карту
Входящие переменные:
pay

Описание: Уведомление о платеже от платежного шлюза
Входящие переменные:
• TransactionId
  Допустимый тип данных: Строка
• Amount
  Допустимый тип данных: Строка
• PaymentAmount
  Допустимый тип данных: Строка
• OperationType
  Допустимый тип данных: Строка
• InvoiceId
  Допустимый тип данных: Строка
• AccountId
  Допустимый тип данных: Строка
• SubscriptionId
  Допустимый тип данных: Строка
• Email
  Допустимый тип данных: Строка
• DateTime
  Допустимый тип данных: Строка
• CardType
  Допустимый тип данных: Строка
• CardExpDate
  Допустимый тип данных: Строка
• Token
  Допустимый тип данных: Строка
• CardLastFour
  Допустимый тип данных: Строка
• CardFirstSix
  Допустимый тип данных: Строка
Возвращаемые параметры:
• code
  Тип данных: Строка
check

Описание: Проверка оплаты
Входящие переменные:
paycompany

Описание: Уведомление о платеже от платежного шлюза
Входящие переменные:
• InvoiceId
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение

Модуль oauth

Общая информация

Название: OAuth Provider
authorize

Описание: Инициализация OAuth авторизации
Входящие переменные:
• response_type обязательно
  Описание:
  Тип ответа (только "code")
  Допустимый тип данных: Строка
• client_id обязательно
  Описание:
  Идентификатор OAuth приложения
  Допустимый тип данных: Строка
• redirect_uri обязательно
  Описание:
  URI для редиректа после авторизации
  Допустимый тип данных: Строка
• scope
  Описание:
  Запрашиваемые scopes (через пробел)
  Допустимый тип данных: Строка
• state
  Описание:
  Состояние для защиты от CSRF
  Допустимый тип данных: Строка
Возвращаемые параметры:
• consent_token
  Описание:
  Токен для страницы согласия
  Тип данных: Строка
• client
  Описание:
  Информация о приложении
  Тип данных: Объект
• scopes
  Описание:
  Запрашиваемые scopes
  Тип данных: Массив объектов
consent.info

Описание: Получение информации о consent токене
Входящие переменные:
• consent_token обязательно
  Описание:
  Consent токен
  Допустимый тип данных: Строка
Возвращаемые параметры:
• client
  Описание:
  Информация о приложении
  Тип данных: Объект
• scopes
  Описание:
  Запрашиваемые scopes
  Тип данных: Массив объектов
• new_scopes
  Описание:
  Новые scopes (ещё не разрешённые)
  Тип данных: Массив объектов
• redirect_uri
  Тип данных: Строка
• state
  Тип данных: Строка
• already_granted
  Описание:
  Все scopes уже разрешены
  Тип данных: Логическое выражение
consent

Описание: Обработка согласия пользователя на OAuth авторизацию
Входящие переменные:
• consent_token обязательно
  Описание:
  Consent токен
  Допустимый тип данных: Строка
• approve обязательно
  Описание:
  Согласие пользователя (true/false)
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• approved
  Тип данных: Логическое выражение
• redirect_uri
  Тип данных: Строка
• code
  Описание:
  Authorization code (если approve=true)
  Тип данных: Строка
• state
  Тип данных: Строка
• error
  Описание:
  Код ошибки (если approve=false)
  Тип данных: Строка
token

Описание: Получение/обновление OAuth токенов
Входящие переменные:
• grant_type обязательно
  Описание:
  Тип grant (authorization_code или refresh_token)
  Допустимый тип данных: Строка
• code
  Описание:
  Authorization code (для grant_type=authorization_code)
  Допустимый тип данных: Строка
• refresh_token
  Описание:
  Refresh token (для grant_type=refresh_token)
  Допустимый тип данных: Строка
• client_id обязательно
  Описание:
  Идентификатор OAuth приложения
  Допустимый тип данных: Строка
• client_secret обязательно
  Описание:
  Секрет OAuth приложения
  Допустимый тип данных: Строка
• redirect_uri
  Описание:
  Redirect URI (для grant_type=authorization_code)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• access_token
  Тип данных: Строка
• token_type
  Тип данных: Строка
• expires_in
  Тип данных: Число
• refresh_token
  Тип данных: Строка
• scope
  Тип данных: Строка
userinfo

Описание: Получение информации о пользователе по OAuth access_token
Входящие переменные:
• access_token
  Описание:
  Access token (альтернатива Authorization header)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• sub
  Описание:
  ID пользователя
  Тип данных: Строка
• firstname
  Тип данных: Строка
• lastname
  Тип данных: Строка
• nickname
  Тип данных: Строка
• avatar
  Тип данных: Строка
• email
  Тип данных: Строка
• phone
  Тип данных: Строка
revoke

Описание: Отзыв OAuth токена
Входящие переменные:
• token обязательно
  Описание:
  Токен для отзыва
  Допустимый тип данных: Строка
• token_type_hint
  Описание:
  Тип токена (access_token или refresh_token)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
token.generate

Описание: Генерация OAuth токена для доверенного приложения (без consent)
Входящие переменные:
• client_id обязательно
  Описание:
  Идентификатор доверенного OAuth приложения
  Допустимый тип данных: Строка
• scopes
  Описание:
  Запрашиваемые scopes через пробел (по умолчанию — auto_grant_scopes приложения)
  Допустимый тип данных: Строка
• redirect_url
  Описание:
  URL для редиректа (если указан — вернёт полный URL с токеном)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• access_token
  Описание:
  OAuth access token
  Тип данных: Строка
• token_type
  Описание:
  Тип токена (Bearer)
  Тип данных: Строка
• expires_in
  Описание:
  Время жизни токена в секундах
  Тип данных: Число
• scope
  Описание:
  Выданные scopes
  Тип данных: Строка
• redirect_url
  Описание:
  Полный URL для редиректа с токеном
  Тип данных: Строка
scopes

Описание: Получение списка доступных OAuth scopes
Входящие переменные:
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
clients.list

Описание: Получение списка OAuth приложений клуба
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Массив OAuth приложений
  Тип данных: Массив объектов
clients.grid

Описание: Grid список OAuth приложений клуба с пагинацией
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• limit
  Описание:
  Лимит записей
  Допустимый тип данных: Число
• skip
  Описание:
  Пропустить записей
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка {field, order}
  Допустимый тип данных: Объект
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
Возвращаемые параметры:
• items
  Тип данных: Массив объектов
• total
  Тип данных: Число
• limit
  Тип данных: Число
• skip
  Тип данных: Число
clients.get

Описание: Получение OAuth приложения по ID
Входящие переменные:
• app_id обязательно
  Описание:
  Идентификатор OAuth приложения
  Допустимый тип данных: Строка
Возвращаемые параметры:
• item
  Описание:
  OAuth приложение
  Тип данных: Объект
clients.add

Описание: Создание нового OAuth приложения
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• name обязательно
  Описание:
  Название приложения
  Допустимый тип данных: Строка
• description
  Описание:
  Описание приложения
  Допустимый тип данных: Строка
• redirect_uris обязательно
  Описание:
  Массив разрешённых redirect URI
  Допустимый тип данных: Массив строк
• allowed_scopes
  Описание:
  Массив разрешённых scopes
  Допустимый тип данных: Массив строк
• logo_file_id
  Описание:
  ID файла логотипа
  Допустимый тип данных: Строка
• website_url
  Описание:
  URL сайта приложения
  Допустимый тип данных: Строка
• privacy_policy_url
  Описание:
  URL политики конфиденциальности
  Допустимый тип данных: Строка
• trusted
  Описание:
  Доверенное приложение (автогенерация токенов без consent, только для суперадминов)
  Допустимый тип данных: Логическое выражение
• auto_grant_scopes
  Описание:
  Scopes для автоматической выдачи (подмножество allowed_scopes)
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• app_id
  Описание:
  ID созданного приложения
  Тип данных: Строка
• client_id
  Описание:
  Client ID для OAuth
  Тип данных: Строка
• client_secret
  Описание:
  Client Secret (показывается один раз!)
  Тип данных: Строка
clients.edit

Описание: Редактирование OAuth приложения
Входящие переменные:
• app_id обязательно
  Описание:
  Идентификатор OAuth приложения
  Допустимый тип данных: Строка
• name
  Описание:
  Название приложения
  Допустимый тип данных: Строка
• description
  Описание:
  Описание приложения
  Допустимый тип данных: Строка
• redirect_uris
  Описание:
  Массив разрешённых redirect URI
  Допустимый тип данных: Массив строк
• allowed_scopes
  Описание:
  Массив разрешённых scopes
  Допустимый тип данных: Массив строк
• logo_file_id
  Описание:
  ID файла логотипа
  Допустимый тип данных: Строка
• website_url
  Описание:
  URL сайта приложения
  Допустимый тип данных: Строка
• privacy_policy_url
  Описание:
  URL политики конфиденциальности
  Допустимый тип данных: Строка
• status
  Описание:
  Статус приложения (active/suspended)
  Допустимый тип данных: Строка
• trusted
  Описание:
  Доверенное приложение (только для суперадминов)
  Допустимый тип данных: Логическое выражение
• auto_grant_scopes
  Описание:
  Scopes для автоматической выдачи
  Допустимый тип данных: Массив строк
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
clients.remove

Описание: Удаление OAuth приложения
Входящие переменные:
• app_id обязательно
  Описание:
  Идентификатор OAuth приложения
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
clients.regenerate_secret

Описание: Перегенерация client_secret OAuth приложения
Входящие переменные:
• app_id обязательно
  Описание:
  Идентификатор OAuth приложения
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• client_secret
  Описание:
  Новый Client Secret (показывается один раз!)
  Тип данных: Строка

Модуль users

Общая информация

Название: Пользователи
addemailrequest

Описание: Отправить код на email для установки email адреса
Входящие переменные:
• email обязательно
  Описание:
  email адрес
  Допустимый тип данных: Email. Содержит @. и больше 5 символов
addemail

Описание: Добавить email адрес
Входящие переменные:
• code обязательно
  Описание:
  Код подтвеждения, из email сообщениея
  Допустимый тип данных: Строка
Возвращаемые параметры:
• email
  Описание:
  Email, который был добавлен
  Тип данных: Строка
setemailprimaryrequest

Описание: Отправить код на телефон для установки основного email адреса (Если такого email еще нет в списке адресов пользователя - он автоматически добавляется)
Входящие переменные:
• email обязательно
  Описание:
  email адрес
  Допустимый тип данных: Строка
setemailprimary

Описание: Установить email адрес основным
Входящие переменные:
• email обязательно
  Описание:
  email адрес
  Допустимый тип данных: Строка
• code обязательно
  Описание:
  Код подтвеждения, из смс
  Допустимый тип данных: Строка
Возвращаемые параметры:
• email
  Описание:
  Email, который был установлен основным
  Тип данных: Строка
removeemailrequest

Описание: Отправить код на телефон для удаления email адреса
Входящие переменные:
• email обязательно
  Описание:
  email адрес
  Допустимый тип данных: Строка
removeemail

Описание: Удалить email адрес
Входящие переменные:
• email обязательно
  Описание:
  email адрес
  Допустимый тип данных: Строка
• code обязательно
  Описание:
  Код подтвеждения, из смс
  Допустимый тип данных: Строка
Возвращаемые параметры:
• email
  Описание:
  Email, который был удалён
  Тип данных: Строка
strava.sync

Описание:
Входящие переменные:
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• count
  Тип данных: Число
strava.authurl

Описание:
Входящие переменные:
• redirect_uri
  Описание:
  Redirect URI to receive Strava code
  Допустимый тип данных: Строка
Возвращаемые параметры:
• url
  Описание:
  Authorization URL
  Тип данных: Строка
• token
  Описание:
  One-time state token
  Тип данных: Строка
strava.saveauth

Описание:
Входящие переменные:
• code
  Описание:
  Authorization code from Strava
  Допустимый тип данных: Строка
• redirect_uri
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
strava.exchange

Описание:
Входящие переменные:
• token
  Описание:
  One-time OAuth state token
  Допустимый тип данных: Строка
• code
  Описание:
  Authorization code from Strava
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
• error
  Тип данных: Строка
strava.disconnect

Описание:
Входящие переменные:
Возвращаемые параметры:
• result
  Тип данных: Логическое выражение
strava.syncStatus

Описание: Получить статус синхронизации активностей со Strava
Входящие переменные:
Возвращаемые параметры:
• sync_status
  Тип данных: Строка
• last_sync_ts
  Тип данных: Число
• sync_started_ts
  Тип данных: Число
• total_uploaded
  Тип данных: Число
• connected
  Тип данных: Логическое выражение
tables.setup.get

Описание:
Входящие переменные:
• table_id
  Описание:
  Иденттификатор таблицы
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• table_id
  Описание:
  Иденттификатор таблицы
  Тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба
  Тип данных: Строка
• columns
  Описание:
  Массив данным по колонкам
  Тип данных: Массив объектов
• filters
  Описание:
  Фильтры
  Тип данных: Объект
tables.setup.set

Описание:
Входящие переменные:
• table_id
  Описание:
  Иденттификатор таблицы
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• columns
  Описание:
  Массив данным по колонкам
  Допустимый тип данных: Массив объектов
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
Возвращаемые параметры:
tables.filters.list

Описание:
Входящие переменные:
• table_id
  Описание:
  Иденттификатор таблицы
  Допустимый тип данных: Строка
Возвращаемые параметры:
tables.filters.add

Описание:
Входящие переменные:
• table_id
  Описание:
  Иденттификатор таблицы
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
• name
  Описание:
  Имя фильтра
  Допустимый тип данных: Строка
Возвращаемые параметры:
tables.filters.edit

Описание:
Входящие переменные:
• id
  Описание:
  Иденттификатор фильтра
  Допустимый тип данных: Строка
• filters
  Описание:
  Фильтры
  Допустимый тип данных: Объект
• name
  Описание:
  Имя фильтра
  Допустимый тип данных: Строка
Возвращаемые параметры:
tables.filters.rem

Описание:
Входящие переменные:
• id
  Описание:
  Иденттификатор фильтра
  Допустимый тип данных: Строка
Возвращаемые параметры:
list

Описание:
Входящие переменные:
• search
  Описание:
  запрос на поиск (поиск можно делать по имени и фамилии)
  Допустимый тип данных: Строка
• role
  Описание:
  Роль пользователя
  Допустимый тип данных: Число
• club_id
  Описание:
  Идентификатор страны
  Допустимый тип данных: Строка
Возвращаемые параметры:
• users
  Описание:
  Массив объектов юзеров (профилей - соответствует профилю)
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор юзера
    Тип данных: Число
  • firstname
    Описание:
    Имя
    Тип данных: Строка
  • lastname
    Описание:
    Фамилия
    Тип данных: Строка
  • birthdate
    Описание:
    Дата рождения
    Тип данных: Дата (формат дд.мм.гггг)
  • avatar
    Описание:
    ID файла аватарки
    Тип данных: Строка
  • roles
    Описание:
    Массив ролей пользователя: 1 - клиент, 2 - тренер, 3 - администратор клуба, 100 - администратор трайд, 10 - сотрудник партнера
    Тип данных: Массив (любые типы внутри)
edit

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Число
• roles
  Описание:
  Роли пользователя
  Допустимый тип данных: Массив чисел
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• nickname
  Описание:
  Никнейм
  Допустимый тип данных: Строка
• firstname
  Описание:
  Имя
  Допустимый тип данных: Строка
• lastname
  Описание:
  Фамилия
  Допустимый тип данных: Строка
• birthdate
  Описание:
  Дата рождения в формате DD.MM.YYYY
  Допустимый тип данных: Строка
• gender
  Описание:
  Пол
  Допустимый тип данных: Число
Возвращаемые параметры:
• result
  Описание:
  Статус
  Тип данных: Логическое выражение
remclient

Описание:
Входящие переменные:
• id
  Допустимый тип данных: Число
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Статус
  Тип данных: Логическое выражение
getconnections

Описание:
Входящие переменные:
Возвращаемые параметры:
garmin.login

Описание: Вход в Garmin Connect по логину и паролю
Входящие переменные:
• username обязательно
  Описание:
  Email или имя пользователя Garmin Connect
  Допустимый тип данных: Строка
• password обязательно
  Описание:
  Пароль Garmin Connect
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• mfa_required
  Описание:
  Требуется ли MFA код
  Тип данных: Логическое выражение
• username
  Описание:
  Имя пользователя в Garmin Connect
  Тип данных: Строка
• error
  Описание:
  Код ошибки если есть
  Тип данных: Строка
garmin.loginMfa

Описание: Завершить вход в Garmin Connect с MFA кодом
Входящие переменные:
• mfa_code обязательно
  Описание:
  MFA код из приложения аутентификации или SMS
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• username
  Описание:
  Имя пользователя в Garmin Connect
  Тип данных: Строка
• error
  Описание:
  Код ошибки если есть
  Тип данных: Строка
garmin.disconnect

Описание: Отключить интеграцию Garmin Connect
Входящие переменные:
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки если есть
  Тип данных: Строка
garmin.syncStatus

Описание: Получить статус синхронизации активностей с Garmin Connect
Входящие переменные:
Возвращаемые параметры:
• connected
  Описание:
  Подключен ли Garmin Connect
  Тип данных: Логическое выражение
• sync_status
  Описание:
  Статус синхронизации (pending | syncing | completed)
  Тип данных: Строка
• last_sync_ts
  Описание:
  Timestamp последней синхронизации
  Тип данных: Число
• sync_started_ts
  Описание:
  Timestamp начала синхронизации
  Тип данных: Число
• total_uploaded
  Описание:
  Общее количество загруженных активностей
  Тип данных: Число
privacy.set

Описание: Установить настройки приватности пользователя
Входящие переменные:
• autojoin_challenges
  Описание:
  Разрешение автоматически добавлять в челленджи клубов
  Допустимый тип данных: Логическое выражение
• show_in_tops
  Описание:
  Разрешение показывать пользователей в топе клубов
  Допустимый тип данных: Логическое выражение
• show_profile
  Описание:
  Видимость профиля: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Допустимый тип данных: Число
• show_activities
  Описание:
  Видимость результатов моих тренировок: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Допустимый тип данных: Число
• show_achievments
  Описание:
  Видимость моих достижений: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Допустимый тип данных: Число
Возвращаемые параметры:
• autojoin_challenges
  Описание:
  Разрешение автоматически добавлять в челленджи клубов
  Тип данных: Логическое выражение
• show_in_tops
  Описание:
  Разрешение показывать пользователей в топе клубов
  Тип данных: Логическое выражение
• show_profile
  Описание:
  Видимость профиля: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Тип данных: Число
• show_activities
  Описание:
  Видимость результатов моих тренировок: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Тип данных: Число
• show_achievments
  Описание:
  Видимость моих достижений: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Тип данных: Число
privacy.get

Описание: Получить настройки приватности пользователя
Входящие переменные:
Возвращаемые параметры:
• autojoin_challenges
  Описание:
  Разрешение автоматически добавлять в челленджи клубов
  Тип данных: Логическое выражение
• show_in_tops
  Описание:
  Разрешение показывать пользователей в топе клубов
  Тип данных: Логическое выражение
• show_profile
  Описание:
  Видимость профиля: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Тип данных: Число
• show_activities
  Описание:
  Видимость результатов моих тренировок: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Тип данных: Число
• show_achievments
  Описание:
  Видимость моих достижений: 1 - всем, 2 - только авторизованным пользователям, 3 - только тем, кто со мной в одном клубе, 4 - только тем, кто у меня в контактах 5 - только тем кто у меня в контактах и кто со мной в одном клубе, 100 - никому
  Тип данных: Число
add

Описание:
Входящие переменные:
• role
  Описание:
  Роль пользователя
  Допустимый тип данных: Число
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• nickname
  Описание:
  Никнейм
  Допустимый тип данных: Строка
• firstname
  Описание:
  Имя
  Допустимый тип данных: Строка
• lastname
  Описание:
  Фамилия
  Допустимый тип данных: Строка
• birthdate
  Описание:
  Дата рождения в формате DD.MM.YYYY
  Допустимый тип данных: Строка
• gender
  Описание:
  Пол
  Допустимый тип данных: Число
• phone
  Описание:
  Телефон в формате 7XXXYYYYYYY
  Допустимый тип данных: Строка
• partner_id
  Описание:
  Идентификатор партнера
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Статус
  Тип данных: Логическое выражение
info

Описание:
Входящие переменные:
• uid
  Описание:
  Идентификатор пользователя
  Допустимый тип данных: Число
• phone
  Описание:
  Телефон в формате 7XXXYYYYYYY
  Допустимый тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба (опционально; при передаче в ответ добавляются club_fields)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• id
  Описание:
  Идентификатор юзера
  Тип данных: Число
• firstname
  Описание:
  Имя
  Тип данных: Строка
• lastname
  Описание:
  Фамилия
  Тип данных: Строка
• nickname
  Описание:
  Никнейм
  Тип данных: Строка
• birthdate
  Описание:
  Дата рождения
  Тип данных: Дата (формат дд.мм.гггг)
• avatar
  Описание:
  ID файла аватарки
  Тип данных: Строка
• roles
  Описание:
  Массив ролей пользователя: 1 - клиен, 2 - тренер, 3 - администратор клуба, 100 - администратор трайд
  Тип данных: Массив (любые типы внутри)
• gender
  Описание:
  Пол 1 мужчина, 2 женщина
  Тип данных: Число
• weight
  Описание:
  Вес
  Тип данных: Строка
• maxhr
  Описание:
  Максимальный пульс
  Тип данных: Строка
• ftp
  Описание:
  FTP
  Тип данных: Число
• height
  Описание:
  Рост
  Тип данных: Строка
• phone
  Описание:
  Телефон в формате 7XXXYYYYYYY
  Тип данных: Строка
• email
  Описание:
  Email
  Тип данных: Строка
• club_fields
  Описание:
  Объект с данными доп. полей клуба по ключу id поля. Возвращается только если передан club_id
  Тип данных: Объект
getsettings

Описание:
Входящие переменные:
setsettings

Описание:
Входящие переменные:
• key
  Допустимый тип данных: Строка
mwlogin

Описание:
Входящие переменные:
remaccount

Описание: Удалить учетную запись
Входящие переменные:
Возвращаемые параметры:
• result
  Описание:
  Профиль удален
  Тип данных: Логическое выражение
weight.history

Описание: Получить историю изменений веса
Входящие переменные:
• months
  Описание:
  Количество месяцев истории (по умолчанию 12)
  Допустимый тип данных: Число
Возвращаемые параметры:
• points
  Описание:
  Массив точек истории веса
  Тип данных: Массив объектов
  Вложенные элементы:
  • date
    Описание:
    Дата в формате DD.MM.YYYY
    Тип данных: Строка
  • date_ts
    Описание:
    Unix timestamp
    Тип данных: Число
  • weight
    Описание:
    Вес в кг
    Тип данных: Дробное число
• current_weight
  Описание:
  Текущий вес
  Тип данных: Дробное число
• stats
  Описание:
  Статистика
  Тип данных: Объект
  Вложенные элементы:
  • min_weight
    Описание:
    Минимальный вес за период
    Тип данных: Дробное число
  • max_weight
    Описание:
    Максимальный вес за период
    Тип данных: Дробное число
  • start_weight
    Описание:
    Вес в начале периода
    Тип данных: Дробное число
  • change
    Описание:
    Изменение веса
    Тип данных: Дробное число
  • change_percent
    Описание:
    Процент изменения веса
    Тип данных: Дробное число
ftp.history

Описание: Получить историю изменений FTP (сайкл и гребля)
Входящие переменные:
• months
  Описание:
  Количество месяцев истории (по умолчанию 12)
  Допустимый тип данных: Число
• club_id
  Описание:
  Идентификатор клуба (group-aware фильтр через getAllClubIds)
  Допустимый тип данных: Строка
• uid
  Описание:
  Идентификатор пользователя (для просмотра чужой истории нужен clients:view на club_id)
  Допустимый тип данных: Число
Возвращаемые параметры:
• cycling
  Описание:
  Данные FTP для сайкла
  Тип данных: Объект
  Вложенные элементы:
  • points
    Описание:
    Массив точек истории FTP
    Тип данных: Массив объектов
  • current_ftp
    Описание:
    Текущее значение FTP
    Тип данных: Число
  • has_data
    Описание:
    Достаточно данных для графика
    Тип данных: Логическое выражение
  • stats
    Описание:
    Статистика изменений
    Тип данных: Объект
• rowing
  Описание:
  Данные FTP для гребли
  Тип данных: Объект
  Вложенные элементы:
  • points
    Описание:
    Массив точек истории FTP
    Тип данных: Массив объектов
  • current_ftp
    Описание:
    Текущее значение FTP
    Тип данных: Число
  • has_data
    Описание:
    Достаточно данных для графика
    Тип данных: Логическое выражение
  • stats
    Описание:
    Статистика изменений
    Тип данных: Объект
ftp.tests

Описание: Получить историю пройденных FTP-тестов
Входящие переменные:
• limit
  Описание:
  Количество записей (по умолчанию 50)
  Допустимый тип данных: Число
• skip
  Описание:
  Пропустить записей (по умолчанию 0)
  Допустимый тип данных: Число
• sport_type
  Описание:
  Фильтр по типу спорта (1 — велосипед, 2 — гребля)
  Допустимый тип данных: Число
• club_id
  Описание:
  Идентификатор клуба (group-aware фильтр)
  Допустимый тип данных: Строка
• uid
  Описание:
  Идентификатор пользователя (для просмотра чужих тестов нужен clients:view на club_id)
  Допустимый тип данных: Число
Возвращаемые параметры:
• total
  Описание:
  Общее количество тестов
  Тип данных: Число
• items
  Описание:
  Массив результатов тестов
  Тип данных: Массив объектов

Модуль devices

Общая информация

Название: Устройства
register

Описание: Регистрация устройства в сокет сессии. Необходима для осуществления запросов, требующих авторизации.
Входящие переменные:
• access_token обязательно
  Описание:
  Идентификационный токен сессии пользователя
  Допустимый тип данных: Строка
• device_type обязательно
  Описание:
  Тип устройства. 1 - web, 2 - android, 3 - ios, 4 - winphone, 5 - server (application), 6 - desktop Windows, 7 - desktop MAC, 8 - desktop Linux
  Допустимый тип данных: Число
• name обязательно
  Описание:
  имя устройства или идентификатор. Например: Andrey's iPhone или Chrome 43.1..
  Допустимый тип данных: Строка
• regid
  Описание:
  GCM RegId для андроида или APNS token для ios, или windows ANID
  Допустимый тип данных: Строка
• id
  Описание:
  идентификатор устройства (привязка к железу, если доступно), например серийный номер телефона
  Допустимый тип данных: Строка
• locale
  Описание:
  ISO 639-1 2-буквенный код локали (языка устройства/системы). По умолчанию - ru
  Допустимый тип данных: Строка
• timezone
  Описание:
  Временная зонка устройства/системы. Разница (положительная, нулевая или отрицательная в минутах) относительно UTC
  Допустимый тип данных: Число
• brand
  Описание:
  Производитель клиентского устройства (в случае с моб приложением - производитель телефона, в случае с браузером - наименование браузера
  Допустимый тип данных: Строка
• model
  Описание:
  Модель клиентского устройства (в случае с моб приложением модель устройства, в случае с браузером - версия браузера
  Допустимый тип данных: Строка
• notify
  Описание:
  Присылать ли уведомления на данное подключение. По умолчанию включено (true).
  Допустимый тип данных: Логическое выражение
• build_version
  Описание:
  Версия сборки
  Допустимый тип данных: Строка
Возвращаемые параметры:
• result
  Описание:
  Результат регистрации. true - зарегистрировано. false - нет
  Тип данных: Логическое выражение
new_device

Описание: Уведомление о новом зарегистрированном устройстве
Входящие переменные:
Возвращаемые параметры:
• id
  Описание:
  Идентификатор устройства в системе
  Тип данных: Число
• dev_id
  Описание:
  Идентификатор устойства (серийный номер и т.п.)
  Тип данных: Строка
• name
  Описание:
  Имя устройства
  Тип данных: Строка
• type
  Описание:
  Тип устройства
  Тип данных: Число
• locale
  Описание:
  Локаль устройства
  Тип данных: Строка
• ip
  Описание:
  IP адрес устройства
  Тип данных: Строка
• timezone
  Описание:
  Таймзона (разница в минутах с UTC) устройства
  Тип данных: Число
• time_registered
  Описание:
  UNIX Timestamp регистрации устройства
  Тип данных: Число
• is_trusted
  Описание:
  Является ли устройство доверенным (ранее было внесено в белый список устройств)
  Тип данных: Логическое выражение
• risks
  Описание:
  Потенциальные угрозы. Массив. Возможнные значения:
  
  • location: заметное отличие расположения с точки зрения IP (новое место)
  • locale: нетипичная локаль
  • timezone: нетипичная временная зона
  • device: устройство, с которого ранее заходил другой пользователь
  • ip: нетипичное поведение с точки зрения айпи адреса
  
  Тип данных: Массив строк
getscreenmode

Описание: Текущее состояние режим экрана
Входящие переменные:
Возвращаемые параметры:
• club_id
  Тип данных: Строка
• zone_id
  Тип данных: Строка
• equipment_ids
  Тип данных: Массив строк
• status
  Тип данных: Логическое выражение
getupdatedata

Описание: Получить данные системы обновления устройства
Входящие переменные:
Возвращаемые параметры:
• autoupdate
  Тип данных: Логическое выражение
• weekdays
  Тип данных: Массив (любые типы внутри)
• time_from
  Тип данных: Строка
• time_to
  Тип данных: Строка
setscreenmode

Описание: Включить/выключить режим экрана
Входящие переменные:
• club_id
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• zone_id
  Описание:
  Идентификатор зоны
  Допустимый тип данных: Строка
• equipment_ids
  Описание:
  Идентификаторы тренажеров
  Допустимый тип данных: Массив строк
• status обязательно
  Описание:
  Включить/выключить режим экрана
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• club_id
  Тип данных: Строка
• zone_id
  Тип данных: Строка
• equipment_ids
  Тип данных: Массив строк
• status
  Тип данных: Логическое выражение
gettask

Описание: Получить задачу для текущего устройства
Входящие переменные:
Возвращаемые параметры:
• id
  Описание:
  ID задачи
  Тип данных: Строка
• type
  Описание:
  Тип задачи. updateversion - обновить версию, restart - перезагрузка, emulatedata - эмуляция данных
  Тип данных: Строка
• data
  Описание:
  Параметры задачи (для emulatedata: data_types и device_ids)
  Тип данных: Объект
tasksack

Описание: Подтвердить получение задачи
Входящие переменные:
• id
  Описание:
  ID задачи
  Допустимый тип данных: Строка
Возвращаемые параметры:
• ack
  Описание:
  ОК
  Тип данных: Логическое выражение
setversion

Описание: Установить данные версии и т.п.
Входящие переменные:
• version
  Допустимый тип данных: Строка
• nextversion
  Допустимый тип данных: Строка
• needsupdate
  Допустимый тип данных: Логическое выражение
Возвращаемые параметры:
• ack
  Описание:
  ОК
  Тип данных: Логическое выражение
setinfo

Описание: Установить данные версии и т.п.
Входящие переменные:
Возвращаемые параметры:
• ack
  Описание:
  ОК
  Тип данных: Логическое выражение
getgateways

Описание: Получиь список IP шлюзов в той же зоне
Входящие переменные:
• zone_id
  Допустимый тип данных: Строка
• club_id
  Допустимый тип данных: Строка
Возвращаемые параметры:
• items
  Описание:
  Список IP устройств в той же зоне
  Тип данных: Массив строк
getotherboxesips

Описание: Получиь список IP устойств в той же зоне
Входящие переменные:
Возвращаемые параметры:
• items
  Описание:
  Список IP устройств в той же зоне
  Тип данных: Массив строк
setlogmessage

Описание: Отправить сообщение лога
Входящие переменные:
Возвращаемые параметры:
• ack
  Описание:
  ОК
  Тип данных: Логическое выражение
setlastspeed

Описание: Установить данные качества связи
Входящие переменные:
Возвращаемые параметры:
• ack
  Описание:
  ОК
  Тип данных: Логическое выражение
setFiles

Описание: Принять информацию о списке видео на флэшке устройства
Входящие переменные:
Возвращаемые параметры:
• ack
  Описание:
  ОК
  Тип данных: Логическое выражение
getVideosToDownload

Описание: Получить список видео для загрузки в память устройства
Входящие переменные:
Возвращаемые параметры:
• videos
  Описание:
  Список видео
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор видео
    Тип данных: Строка
  • url
    Описание:
    URL видео
    Тип данных: Строка
  • filesize
    Описание:
    Размер файла видео
    Тип данных: Число
getMusicToDownload

Описание: Получить список музыки для загрузки в память устройства
Входящие переменные:
Возвращаемые параметры:
• music
  Описание:
  Список видео
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор видео
    Тип данных: Строка
setDownloadedVideos

Описание: Получить список видео для загрузки в память устройства
Входящие переменные:
• id
  Описание:
  Идентификатор видео
  Допустимый тип данных: Строка
• downloaded
  Описание:
  Флаг загрузки видео
  Допустимый тип данных: Логическое выражение
• progress
  Описание:
  Прогресс загрузки видео
  Допустимый тип данных: Число
Возвращаемые параметры:
• ack
  Тип данных: Логическое выражение
setDownloadedMusic

Описание:
Входящие переменные:
• downloaded
  Описание:
  Флаг загрузки видео
  Допустимый тип данных: Логическое выражение
• progress
  Описание:
  Прогресс загрузки видео
  Допустимый тип данных: Число
Возвращаемые параметры:
• ack
  Тип данных: Логическое выражение
getSchedule

Описание:
Входящие переменные:
Возвращаемые параметры:
getAnouncements

Описание:
Входящие переменные:
Возвращаемые параметры:
getClubChat

Описание:
Входящие переменные:
Возвращаемые параметры:
getClubChallenge

Описание: Получить рейтинг челленджей для ТВ
Входящие переменные:
Возвращаемые параметры:
getClubSchedule

Описание:
Входящие переменные:
Возвращаемые параметры:
getClubRating

Описание:
Входящие переменные:
Возвращаемые параметры:
fingerprint.save

Описание: Сохранение fingerprint устройства с привязкой к клубу для deferred deep linking
Входящие переменные:
• club_id обязательно
  Описание:
  Идентификатор клуба
  Допустимый тип данных: Строка
• ip
  Описание:
  IP адрес устройства
  Допустимый тип данных: Строка
• timezone
  Описание:
  Часовой пояс устройства (например: Europe/Moscow)
  Допустимый тип данных: Строка
• lang
  Описание:
  Язык устройства (например: ru-RU)
  Допустимый тип данных: Строка
• screen
  Описание:
  Разрешение экрана (например: 1920x1080)
  Допустимый тип данных: Строка
• os_version
  Описание:
  Версия операционной системы
  Допустимый тип данных: Строка
• platform
  Описание:
  Платформа устройства (ios, android, web)
  Допустимый тип данных: Строка
• pixel_ratio
  Описание:
  Device pixel ratio экрана
  Допустимый тип данных: Дробное число
Возвращаемые параметры:
• result
  Описание:
  Результат сохранения
  Тип данных: Логическое выражение
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка
fingerprint.check

Описание: Проверка наличия fingerprint и получение club_id для автоматического выбора клуба после установки
Входящие переменные:
• ip
  Описание:
  IP адрес устройства
  Допустимый тип данных: Строка
• timezone
  Описание:
  Часовой пояс устройства (например: Europe/Moscow)
  Допустимый тип данных: Строка
• lang
  Описание:
  Язык устройства (например: ru-RU)
  Допустимый тип данных: Строка
• screen
  Описание:
  Разрешение экрана (например: 1920x1080)
  Допустимый тип данных: Строка
• os_version
  Описание:
  Версия операционной системы
  Допустимый тип данных: Строка
• platform
  Описание:
  Платформа устройства (ios, android, web)
  Допустимый тип данных: Строка
• pixel_ratio
  Описание:
  Device pixel ratio экрана
  Допустимый тип данных: Дробное число
Возвращаемые параметры:
• result
  Описание:
  Результат выполнения запроса
  Тип данных: Логическое выражение
• found
  Описание:
  Найден ли соответствующий fingerprint
  Тип данных: Логическое выражение
• club_id
  Описание:
  Идентификатор клуба (если найден)
  Тип данных: Строка
• error
  Описание:
  Код ошибки при неудаче
  Тип данных: Строка

Модуль sessions

Общая информация

Название: Работа с сессиями
impersonate.start

Описание:
Входящие переменные:
• uid
  Описание:
  Идентификатор пользователя, под которым нужен просмотр
  Допустимый тип данных: Число
impersonate.stop

Описание:
Входящие переменные:
• access_token
  Описание:
  Опционально: токен impersonation-сессии для завершения
  Допустимый тип данных: Строка
ping

Описание:
Входящие переменные:
• away
• geo
• geochats
Возвращаемые параметры:
• active_sessions
  Описание:
  Количество активных сессий пользователя всего
  Тип данных: Число
logout

Описание: Произвести выход из текущей сессии
Входящие переменные:
Возвращаемые параметры:
• result
  Описание:
  Результат операции
  Тип данных: Логическое выражение

Модуль ex

Общая информация

Название: Ex
find.class

Описание: Найти занятие в расписании клуба, соответствующее заданным параметрам
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• external_class_type_id
  Описание:
  Идентификатор типа занятия во внешней системе
  Допустимый тип данных: Строка
• class_type_id
  Описание:
  Идентификатор типа занятия в TRIDE
  Допустимый тип данных: Строка
• time обязательно
  Описание:
  Дата и время занятия в расписании, в формате дд.мм.гггг чч:мм
  Допустимый тип данных: Дата и время (формат дд.мм.гггг чч:мм[:сс]
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_type - неверный тип занятия
  • wrong_time - неверное время
  
  Тип данных: Строка
• session_id
  Описание:
  Идентификатор занятия
  Тип данных: Строка
• use_teams
  Описание:
  Количество команд в занятии (больше 1 для занятий вида Bootcamp)
  Тип данных: Число
create.class

Описание: Создать занятие в расписании клуба. Должен обязательно быть какой-либо указатель на тренера (телефон или идентификатор), а также на вид занятия и время начала занятия
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• external_class_type_id
  Описание:
  Идентификатор типа занятия во внешней системе
  Допустимый тип данных: Строка
• class_type_id
  Описание:
  Идентификатор типа занятия в TRIDE, если известен
  Допустимый тип данных: Строка
• external_class_id
  Описание:
  Идентификатор занятия во внешней системе
  Допустимый тип данных: Строка
• time обязательно
  Описание:
  Дата и время занятия в расписании во временной зоне клуба, в формате дд.мм.гггг чч:мм
  Допустимый тип данных: Дата и время (формат дд.мм.гггг чч:мм[:сс]
• coach_id
  Описание:
  Идентификатор тренера в TRIDE (если известен)
  Допустимый тип данных: Число
• coach_external_id
  Описание:
  Идентификатор тренера во внешней системе (если был ранее присвоен)
  Допустимый тип данных: Строка
• max_capacity
  Описание:
  Максимальное количество участников занятия (если нужно переопределить значение из типа занятия)
  Допустимый тип данных: Число
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_session - неверное занятие
  • wrong_type - неверный тип занятия
  • wrong_coach_id - неверный идентификатор тренера
  • wrong_time - неверное время начала
  • another_session - наслаивание на другое занятие
  
  Тип данных: Строка
• session_id
  Описание:
  Идентификатор занятия
  Тип данных: Строка
edit.class

Описание: Изменить занятие. Возможно изменить только занятие, которое еще не началось. Обязательно указать какой либо идентификатор, а также время и какой-либо идентификатор тренера
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• external_session_id
  Описание:
  Идентификатор занятия во внешней системе
  Допустимый тип данных: Строка
• session_id
  Описание:
  Идентификатор занятия в TRIDE, если известен
  Допустимый тип данных: Строка
• time обязательно
  Описание:
  Дата и время занятия в расписании во временной зоне клуба, в формате дд.мм.гггг чч:мм
  Допустимый тип данных: Дата и время (формат дд.мм.гггг чч:мм[:сс]
• external_class_type_id
  Описание:
  Идентификатор типа занятия во внешней системе
  Допустимый тип данных: Строка
• class_type_id
  Описание:
  Идентификатор типа занятия в TRIDE, если известен
  Допустимый тип данных: Строка
• coach_id
  Описание:
  Идентификатор тренера в TRIDE (если известен)
  Допустимый тип данных: Число
• coach_external_id
  Описание:
  Идентификатор тренера во внешней системе (если был ранее присвоен)
  Допустимый тип данных: Строка
• max_capacity
  Описание:
  Максимальное количество участников занятия (если нужно обновить)
  Допустимый тип данных: Число
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_session - неверное занятие
  • wrong_coach_id - неверный идентификатор тренера
  • wrong_time - неверное время начала
  • another_session - наслаивание на другое занятие
  • previous_session - не закончилось предыдущее занятие
  
  Тип данных: Строка
• updated
  Описание:
  true если изменение успешно
  Тип данных: Логическое выражение
list.class.types

Описание: Получить список видов занятий в клубе
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
Возвращаемые параметры:
• types
  Описание:
  Массив объектов данных по типам занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • class_type_id
    Описание:
    Идентификатор вида занятия
    Тип данных: Строка
  • external_class_type_id
    Описание:
    Идентификатор вида занятия во внешней системе
    Тип данных: Строка
  • name
    Описание:
    Название вида занятия
    Тип данных: Строка
  • sport_types
    Описание:
    Массив объектов с данными по видам спорта
    Тип данных: Массив объектов
    Вложенные элементы:
    • id
      Описание:
      Идентификатор вида спорта
      Тип данных: Число
    • name
      Описание:
      Название вида спорта
      Тип данных: Строка
  • zones
    Описание:
    Массив объектов с данными по зонам в клубе
    Тип данных: Массив объектов
    Вложенные элементы:
    • id
      Описание:
      Идентификатор зоны
      Тип данных: Число
    • name
      Описание:
      Название зоны
      Тип данных: Строка
  • status
    Описание:
    Состояние типа занятия (вкл true, выкл false)
    Тип данных: Логическое выражение
check.auth

Описание: Произвести разовую идентификацию клиента
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• auth_id обязательно
  Описание:
  Ключ идентификации клиента
  Допустимый тип данных: Строка
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • not_found - неверные данные
  
  Тип данных: Строка
• client_id
  Описание:
  Идентификатор клиента в TRIDE
  Тип данных: Число
• external_client_id
  Описание:
  Идентификатор клиента во внешней системе
  Тип данных: Строка
• phone
  Описание:
  Номер телефона клиента
  Тип данных: Строка
• email
  Описание:
  Email клиента
  Тип данных: Строка
• club_id
  Описание:
  Идентификатор клуба в TRIDE
  Тип данных: Строка
remove.class

Описание: Удалить занятие. Возможно удалить только занятие, которое еще не началось. Обязательно указать какой либо идентификатор
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• external_session_id
  Описание:
  Идентификатор занятия во внешней системе
  Допустимый тип данных: Строка
• session_id
  Описание:
  Идентификатор занятия в TRIDE, если известен
  Допустимый тип данных: Строка
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_session - неверное занятие
  
  Тип данных: Строка
• removed
  Описание:
  true если удаление успешно
  Тип данных: Логическое выражение
listequipment

Описание: Получить список оборудования доступный на тренировке. Обязательно передать какой-либо идентификатор занятия
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• external_session_id
  Описание:
  Идентификатор занятия во внешней системе
  Допустимый тип данных: Строка
• session_id
  Описание:
  Идентификатор тренировки
  Допустимый тип данных: Строка
• external_client_id
  Описание:
  Идентификатор клиента во внешней системе
  Допустимый тип данных: Строка
• client_id
  Описание:
  Идентификатор клиента
  Допустимый тип данных: Число
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_session - неверное занятие
  • wrong_client - неверный клиент (если был указан клиент)
  
  Тип данных: Строка
• equipment
  Тип данных: Массив объектов
  Вложенные элементы:
  • eqid
    Описание:
    Идентификатор оборудования
    Тип данных: Строка
  • name
    Описание:
    Название/номер оборудования
    Тип данных: Строка
  • teams
    Описание:
    Объект данных о доступности оборудования в рамках разных команд. Ключи объекта это номера команд, значения true/false означающий занят ли тренажер, в рамках команды, true - уже занят (если команды актуальны)
    Тип данных: Объект
  • occupied
    Описание:
    Занят ли тренажер
    Тип данных: Логическое выражение
  • ismy
    Описание:
    Клиент уже зарегистрирован на данном оборудовании (если был передан идентификатор клиента)
    Тип данных: Логическое выражение
  • myteam
    Описание:
    Номер команды клиента (если команды актуальны) (если был передан идентификатор клиента)
    Тип данных: Число в строке
club.listequipment

Описание: Получить список оборудования в клубе
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
Возвращаемые параметры:
• equipment
  Тип данных: Массив объектов
  Вложенные элементы:
  • eqid
    Описание:
    Идентификатор оборудования
    Тип данных: Строка
  • name
    Описание:
    Название/номер оборудования
    Тип данных: Строка
  • enabled
    Описание:
    Включено ли оборудование (true/false)
    Тип данных: Логическое выражение
  • sport_type
    Описание:
    Идентификатор вида спорта (1 сайкл, 2 гребля)
    Тип данных: Число
  • zone_name
    Описание:
    Название зоны в клубе
    Тип данных: Строка
client.info

Описание: Получить данные клиента в системе Tride. Обязательно должен быть передан либо идентификатор клиента, либо номер телефона клиента
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• phone
  Описание:
  Номер телефона клиента в формате 79XXXXXXXXX
  Допустимый тип данных: Число в строке
• client_id
  Описание:
  Идентификатор клиента в системе Tride
  Допустимый тип данных: Число
• external_client_id
  Описание:
  Идентификатор клиента во внешней системе
  Допустимый тип данных: Строка
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • not_found - такого клиента нет
  • wrong_phone - неверно указан телефон (если был указан номер телефона)
  
  Тип данных: Строка
• client_id
  Описание:
  Идентификатор клиента в системе Tride
  Тип данных: Число
• phone
  Описание:
  Номер телефона клиента в формате 79XXXXXXXXX
  Тип данных: Число в строке
• firstname
  Описание:
  Имя клиента
  Тип данных: Строка
• lastname
  Описание:
  Фамилия клиента
  Тип данных: Строка
• nickname
  Описание:
  Отображаемое на экране имя
  Тип данных: Строка
• weight
  Описание:
  Вес клиента
  Тип данных: Дробное число в строке
• ftp
  Описание:
  FTP клиента
  Тип данных: Число
• height
  Описание:
  рост клиента
  Тип данных: Число
• birthdate
  Описание:
  Дата рождения клиента в формате ДД.ММ.ГГГГ
  Тип данных: Дата (формат дд.мм.гггг)
• maxhr
  Описание:
  Максимальный пульс для построения зон
• gender
  Описание:
  Пол клиента (1 - мужчина, 2 - женщина)
  Тип данных: Число
client.register

Описание: Зарегистрировать клиента в TRIDE
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• phone обязательно
  Описание:
  Номер телефона клиента в формате 79XXXXXXXXX
  Допустимый тип данных: Число в строке
• firstname
  Описание:
  Имя клиента
  Допустимый тип данных: Строка
• lastname
  Описание:
  Фамилия клиента
  Допустимый тип данных: Строка
• nickname
  Описание:
  Отображаемое на экране имя
  Допустимый тип данных: Строка
• weight
  Описание:
  Вес клиента (по умолчанию 50)
  Допустимый тип данных: Дробное число в строке
• ftp
  Описание:
  FTP клиента (по умолчанию 100)
  Допустимый тип данных: Число
• height
  Описание:
  рост клиента (по умолчанию 170)
  Допустимый тип данных: Число
• birthdate
  Описание:
  Дата рождения клиента в формате ДД.ММ.ГГГГ
  Допустимый тип данных: Дата (формат дд.мм.гггг)
• gender
  Описание:
  Пол клиента (1 - мужчина (по умолчанию), 2 - женщина)
  Допустимый тип данных: Число
• external_client_id
  Описание:
  Идентификатор клиента во внешней системе
  Допустимый тип данных: Строка
Возвращаемые параметры:
• client_id
  Описание:
  Идентификатор клиента в системе Tride
  Тип данных: Число
• error
  Описание:
  Код ошибки. Может быть:
  • client_exists - такой клиент уже зарегистрирован (в таком случае так же возвращается client_id)
  • wrong_birthdate - неверно указана дата рождения
  • wrong_gender - неверно указан пол клиента
  • wrong_nickname - неверно указан никнейм
  • wrong_phone - неверно указан телефон
  
  Тип данных: Строка
activities.list

Описание: Получить историю активностей клиента
Входящие переменные:
• limit
  Описание:
  Количество записей в 1 выдаче, максимум 30
  Допустимый тип данных: Число
• skip
  Описание:
  Сколько записей необходимо пропустить
  Допустимый тип данных: Число
• order
  Описание:
  Сортировка записей.'desc' в прошлое 'asc' в будущее
  Допустимый тип данных: Строка
• start_ts
  Описание:
  unixtimestamp начала периода
  Допустимый тип данных: Число
• end_ts
  Описание:
  unixtimestamp конца периода
  Допустимый тип данных: Число
• sport_type
  Описание:
  Идентификатор вида спорта
  Допустимый тип данных: Число
• client_id
  Описание:
  Идентификатор клиента
  Допустимый тип данных: Число
• external_client_id
  Описание:
  Идентификатор клиента во внешней системе
  Допустимый тип данных: Строка
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_client - нет такого клиента
  
  Тип данных: Строка
• total
  Описание:
  Всего записей отвечающих критериям запроса
  Тип данных: Число
• items
  Описание:
  Массив объектов записей занятий
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор активности (занятия)
    Тип данных: Строка
  • title
    Описание:
    Название занятия
    Тип данных: Строка
  • clubs
    Описание:
    Массив названий клубов
    Тип данных: Массив строк
  • sport_type
    Описание:
    Идентификатор вида спорта
    Тип данных: Число
  • coaches
    Описание:
    Массив объектов данных тренера
    Тип данных: Массив объектов
    Вложенные элементы:
    • firstname
      Описание:
      Имя тренера
      Тип данных: Строка
    • lastname
      Описание:
      Фамилия тренера
      Тип данных: Строка
    • uid
      Описание:
      Идентификатор тренера
      Тип данных: Число
  • color
    Описание:
    Цвет занятия, Если пустой то цвет не задан
    Тип данных: Строка
  • duration
    Описание:
    Длительность занятия в секундах
    Тип данных: Число
  • started_ts
    Описание:
    unixtimestamp начала занятия
    Тип данных: Число
  • totals
    Описание:
    Результаты занятия
    Тип данных: Объект
    Вложенные элементы:
    • distance
      Описание:
      Дистанция в км (для видов спорта 1,2)
      Тип данных: Строка
    • calories
      Описание:
      Калории
      Тип данных: Число
    • points
      Описание:
      Баллы
      Тип данных: Число
sensors.list.hr

Описание: Получить список устройств (датчиков пульса), видимых в клубе
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• session_id
  Описание:
  Идентификатор занятия в системе Tride
  Допустимый тип данных: Строка
• external_session_id
  Описание:
  Идентификатор занятия в во внешней системе
  Допустимый тип данных: Строка
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_session - нет такого занятия
  
  Тип данных: Строка
• sensors
  Описание:
  Массив объектов данных по датчикам
  Тип данных: Массив объектов
  Вложенные элементы:
  • id
    Описание:
    Идентификатор устройства
    Тип данных: Строка
  • name
    Описание:
    Название устройства
    Тип данных: Строка
  • serial
    Описание:
    Серийный номер устройства если есть
    Тип данных: Строка
  • protocol
    Описание:
    Протокол устройства (1 - ANT, 2 - BLE, 3 - WIFI)
    Тип данных: Число
  • value
    Описание:
    Крайнее переданное датчиком значение пульса
    Тип данных: Число
class.set.participant

Описание: Установить параметры клиента на занятие. Обязательно должен быть передан либо идентификатор клиента, либо номер телефона клиента.
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• equipment_id
  Описание:
  Идентификатор тренажера, полученный путем сканирования QR кода/NFC метки или выбора из списка
  Допустимый тип данных: Строка
• team_id
  Описание:
  Номер команды
  Допустимый тип данных: Число в строке
• hr_sensor_id
  Описание:
  Идентификатор датчика пульса (из найденных в зоне проведения занятия)
  Допустимый тип данных: Строка
• hr_equipment_id
  Описание:
  Идентификатор арендного датчика пульса
  Допустимый тип данных: Строка
• session_id
  Описание:
  Идентификатор занятия в TRIDE
  Допустимый тип данных: Строка
• external_session_id
  Описание:
  Идентификатор занятия во внешней системе
  Допустимый тип данных: Строка
• external_client_id
  Описание:
  Идентификатор клиента в во внешней системе
  Допустимый тип данных: Строка
• phone
  Описание:
  Номер телефона клиента
  Допустимый тип данных: Число в строке
• client_id
  Описание:
  Идентификатор клиента в системе Tride
  Допустимый тип данных: Число
• nickname
  Описание:
  Отображаемое на экране имя
  Допустимый тип данных: Строка
• weight
  Описание:
  Вес клиента
  Допустимый тип данных: Дробное число в строке
• height
  Описание:
  Рост клиента
  Допустимый тип данных: Число
• ftp
  Описание:
  FTP клиента для данного занятия (если актуально)
  Допустимый тип данных: Число
• birthdate
  Описание:
  Дата рождения (в формате DD.MM.YYYY)
  Допустимый тип данных: Строка
• gender
  Описание:
  Пол клиента (1 - мужчина, 2 - женщина)
  Допустимый тип данных: Число
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_session - нет такого занятия
  • wrong_equipment_id - неверно указан идентификатор оборудования (тренажера)
  • occupied_equipment_id - тренажер уже занят другим клиентом
  • wrong_hr_equipment_id - неверно указан идентификатор арендного пульсометра
  
  Тип данных: Строка
• session_id
  Описание:
  Идентификатор тренировки в TRIDE
  Тип данных: Строка
• client_id
  Описание:
  Идентификатор клиента в системе Tride
  Тип данных: Число
• result
  Описание:
  результат операции
  Тип данных: Логическое выражение
class.unset.participant

Описание: Снять участника занятия с тренажера и с занятия (освободить тренажер)
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• external_client_id
  Описание:
  Идентификатор клиента в во внешней системе
  Допустимый тип данных: Строка
• phone
  Описание:
  Номер телефона клиента
  Допустимый тип данных: Число в строке
• client_id
  Описание:
  Идентификатор клиента в системе Tride
  Допустимый тип данных: Число
• session_id
  Описание:
  Идентификатор занятия в TRIDE
  Допустимый тип данных: Строка
• external_session_id
  Описание:
  Идентификатор занятия во внешней системе
  Допустимый тип данных: Строка
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_session - нет такого занятия
  • wrong_equipment_id - неверно указан идентификатор оборудования (тренажера)
  
  Тип данных: Строка
• result
  Описание:
  результат операции
  Тип данных: Логическое выражение
activities.get

Описание:
Входящие переменные:
• key обязательно
  Описание:
  Ключ приложения
  Допустимый тип данных: Строка
• id обязательно
  Описание:
  Идентификатор активности
  Допустимый тип данных: Строка
Возвращаемые параметры:
• error
  Описание:
  Код ошибки. Может быть:
  • wrong_activity - нет такой активности
  
  Тип данных: Строка
• id
  Описание:
  Идентификатор активности
  Тип данных: Строка
• title
  Описание:
  Название активности
  Тип данных: Строка
• clubs
  Описание:
  Массив названий клубов, к которым принадлежит активность
  Тип данных: Массив строк
• sport_type
  Описание:
  Вид спорта
  Тип данных: Число
• coaches
  Описание:
  Массив данных тренеров
  Тип данных: Массив объектов
  Вложенные элементы:
  • firstname
    Описание:
    Имя тренера
    Тип данных: Строка
  • lastname
    Описание:
    Фамилия тренера
    Тип данных: Строка
  • uid
    Описание:
    Идентификатор тренера
    Тип данных: Строка
  • tracks
    Описание:
    Массив музыкальных треков
    Тип данных: Массив объектов
    Вложенные элементы:
    • title
      Описание:
      Название трека
      Тип данных: Строка
    • artist
      Описание:
      Исполнитель
      Тип данных: Строка
    • duration
      Описание:
      Длительность в секундах
      Тип данных: Число
  • totals
    Описание:
    Данные итоговой статистики
    Тип данных: Объект
  • averages
    Описание:
    Средние данные
    Тип данных: Объект
  • maximums
    Описание:
    Максимальные данные
    Тип данных: Объект
  • graphs
    Описание:
    Графики
    Тип данных: Объект
  • duration
    Описание:
    Продолжительность в секундах
    Тип данных: Число
  • started_ts
    Описание:
    Дата и время начала
    Тип данных: Временной штамп (timestamp)
matrix.ident

Описание: Method provides client identification knowing one of the possible client identifiers
Входящие переменные:
• rfid
  Описание:
  RFID identification code
  Допустимый тип данных: Строка
• user_id
  Описание:
  TRIDE Client ID if known (for possible future cases)
  Допустимый тип данных: Число
• phone
  Описание:
  Phone number provided by client (for possible future cases)
  Допустимый тип данных: Строка
Возвращаемые параметры:
• error_code
  Описание:
  Error code if any. 100 - client not found
  Тип данных: Число
• name
  Описание:
  First name and initials of the client
  Тип данных: Строка
• age
  Описание:
  Age of the client
  Тип данных: Число
• weight
  Описание:
  Weight of the client
  Тип данных: Дробное число
• height
  Описание:
  Height of the client
  Тип данных: Число
• gender
  Описание:
  Client's gender, M for male, F for female
  Тип данных: Строка
• units
  Описание:
  Client's units,Always 'metric'
  Тип данных: Строка
• user_id
  Описание:
  TRIDE Client ID
  Тип данных: Число
matrix.result

Описание: Method provides an endpoint for posting client's workout results
Входящие переменные:
• rfid
  Описание:
  RFID identification code
  Допустимый тип данных: Строка
• user_id
  Описание:
  TRIDE Client ID if known (for possible future cases)
  Допустимый тип данных: Число
• phone
  Описание:
  Phone number provided by client (for possible future cases)
  Допустимый тип данных: Строка
• average_heart_rate
  Описание:
  Client's average heart rate
  Допустимый тип данных: Число
• calories
  Описание:
  Client's total calories burned
  Допустимый тип данных: Число
• distance
  Описание:
  Client's total distance covered in meters
  Допустимый тип данных: Число
• duration
  Описание:
  Client's total duration in seconds
  Допустимый тип данных: Число
• max_heart_rate
  Описание:
  Client's maximum heart rate
  Допустимый тип данных: Число
• type
  Описание:
  Type of workout, e.g., 'run', 'walk', 'bike'
  Допустимый тип данных: Строка
• workout_time
  Описание:
  Workout date and time in UTC
  Допустимый тип данных: Дата и время (формат дд.мм.гггг чч:мм[:сс]
• machine_id
  Описание:
  Machine ID (equipment identifier)
  Допустимый тип данных: Строка
• machine_type
  Описание:
  Machine type (e.g., 'treadmill', 'ascent_trainer', 'elliptical','climbmill')
  Допустимый тип данных: Строка
• min_heart_rate
  Описание:
  Client's minimum heart rate
  Допустимый тип данных: Число
• average_speed
  Описание:
  Client's average speed in meters per second
  Допустимый тип данных: Дробное число
• max_speed
  Описание:
  Client's maximum speed in meters per second
  Допустимый тип данных: Дробное число
• average_cadence
  Описание:
  Client's average cadence in steps per minute
  Допустимый тип данных: Число
• max_cadence
  Описание:
  Client's maximum cadence in steps per minute
  Допустимый тип данных: Число
• average_incline
  Описание:
  Client's average incline in degrees
  Допустимый тип данных: Дробное число
• max_incline
  Описание:
  Client's maximum incline in degrees
  Допустимый тип данных: Дробное число
Возвращаемые параметры:
• ack
  Описание:
  Acknowledgment of successful submission
  Тип данных: Логическое выражение
• activity_id
  Описание:
  Activity ID assigned by TRIDE
  Тип данных: Строка

Модуль sms

Общая информация

Название: SMS Сообщения
sendmessage

Описание:
Входящие переменные:
• phone обязательно
  Описание:
  Номер телефона получателя
• message обязательно
  Описание:
  Текст сообщения для получения
• app_id
  Описание:
  Идентификатор приложения
• app_key
  Описание:
  Ключ приложения
• fake
  Описание:
  Не производить отправку (режим эмуляции)
  Допустимый тип данных: Логическое выражение
• from
  Описание:
  Отправитель смс-сообщения. Может быть: cox, mir, betrun. По умолчанию - cox
  Допустимый тип данных: Строка
send

Описание:
Входящие переменные:
• phone обязательно
• code обязательно
• app_id
  Описание:
  Идентификатор приложения
• app_key
  Описание:
  Ключ приложения
• fake
  Описание:
  Не производить отправку (режим эмуляции)
  Допустимый тип данных: Логическое выражение
• from
  Описание:
  Отправитель смс-сообщения. Может быть: cox, mir, betrun. По умолчанию - cox
  Допустимый тип данных: Строка