
Taal 🇳🇱 Nederlands
Aan de slag
Documentatie
Gebruik
Aggregatie
Auditlogs
Blokkeren vanaf reactie
Controleer geblokkeerde reacties
Reacties
Domeinconfiguraties
E-mailsjablonen
Gebeurtenislogboek
Feed-berichten
Reactie markeren
Hashtags
Moderatoren
Aantal meldingen
Meldingen
Pagina's
Wachtende webhookgebeurtenissen
Vraagconfiguraties
Vraagresultaten
Aggregatie van vraagresultaten
SSO-gebruikers
Abonnementen
Dagelijks gebruik van tenant
Tenantpakketten
Tenantgebruikers
Tenants
Afbeelding uploaden
Voortgang gebruikersbadge
Gebruikersbadges
Gebruikersmeldingen
Gebruikersaanwezigheidsstatus
Gebruikers zoeken
Gebruikers
Stemmen
FastComments Ruby SDK
Dit is de officiële Ruby SDK voor FastComments.
Officiële Ruby SDK voor de FastComments API
Repository
Installatie 
Voeg deze regel toe aan het Gemfile van uw applicatie:
gem 'fastcomments'
En voer vervolgens uit:
bundle install
Of installeer het zelf met:
gem install fastcomments
Bibliotheekinhoud
Deze bibliotheek bevat de gegenereerde API-client en de SSO-hulpprogramma's om het werken met de API makkelijker te maken.
Openbare vs beveiligde API's
Voor de API-client zijn er twee klassen, DefaultApi en PublicApi. De DefaultApi bevat methoden die uw API-sleutel vereisen, en PublicApi bevat API-aanroepen die rechtstreeks vanuit een browser/mobiel apparaat/etc. kunnen worden gedaan zonder authenticatie.
Snelstart 
Geauthenticeerde API's gebruiken (DefaultApi)
Belangrijk: Je moet je API-sleutel instellen op de ApiClient voordat je geauthenticeerde verzoeken doet. Als je dat niet doet, mislukken verzoeken met een 401-fout.
require 'fastcomments-client'
# Maak en configureer de API-client
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# VEREIST: Stel je API-sleutel in (haal deze uit je FastComments-dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Maak de API-instantie met de geconfigureerde client
api = FastCommentsClient::DefaultApi.new(api_client)
# Nu kun je geauthenticeerde API-aanroepen doen
begin
# Voorbeeld: Voeg een SSO-gebruiker toe
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# Veelvoorkomende fouten:
# - 401: API-sleutel ontbreekt of is ongeldig
# - 400: Verzoekvalidatie mislukt
end
Gebruik van publieke API's (PublicApi)
Publieke eindpunten vereisen geen authenticatie:
require 'fastcomments-client'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
tenant_id: 'YOUR_TENANT_ID',
url_id: 'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Veelvoorkomende problemen
- 401 "missing-api-key" fout: Zorg ervoor dat je
config.api_key['x-api-key'] = 'YOUR_KEY'instelt voordat je de DefaultApi-instantie aanmaakt. - Verkeerde API-klasse: Gebruik
DefaultApivoor server-side geauthenticeerde verzoeken,PublicApivoor client-side/publieke verzoeken. - Null API-sleutel: De SDK zal authenticatie stilzwijgend overslaan als de API-sleutel null is, wat leidt tot 401-fouten.
Notities 
Broadcast-IDs
Je zult zien dat je in sommige API-aanroepen een broadcastId moet doorgeven. Wanneer je gebeurtenissen ontvangt, krijg je deze ID terug, zodat je het event kunt negeren als je van plan bent wijzigingen optimistisch op de client toe te passen (wat je waarschijnlijk wilt doen, omdat het de beste ervaring biedt). Geef hier een UUID op. De ID moet uniek genoeg zijn om niet twee keer in een browsersessie voor te komen.
SSO (Single Sign-On)
Voor SSO-voorbeelden, zie hieronder.
SSO-gebruik 
Eenvoudige SSO
require 'fastcomments'
require 'fastcomments-client'
# Maak een Simple SSO-token
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# Gebruik het SSO-token om een geauthenticeerde API-aanroep te doen
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
Veilige SSO
require 'fastcomments'
require 'fastcomments-client'
# Maak een Secure SSO-token
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# Gebruik het SSO-token om een geauthenticeerde API-aanroep te doen
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
aggregate 
Aggregeert documenten door ze te groeperen (als groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, etc.) worden ondersteund.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nee | |
| includeStats | boolean | query | Nee |
Respons
Retourneert: AggregationResponse
Voorbeeld

get_audit_logs 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nee | |
| skip | number | query | Nee | |
| order | string | query | Nee | |
| after | number | query | Nee | |
| before | number | query | Nee |
Antwoord
Retourneert: GetAuditLogs200Response
Voorbeeld

block_from_comment_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: BlockFromCommentPublic200Response
Voorbeeld

un_block_comment_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UnBlockCommentPublic200Response
Voorbeeld

checked_comments_for_blocked 
Parameters
| Name | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | Een door komma's gescheiden lijst met comment-id's. |
| sso | string | query | Nee |
Antwoord
Retourneert: CheckedCommentsForBlocked200Response
Voorbeeld

block_user_from_comment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: BlockFromCommentPublic200Response
Voorbeeld

create_comment_public 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Antwoord
Retourneert: CreateCommentPublic200Response
Voorbeeld

delete_comment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| isLive | boolean | query | Nee |
Respons
Geeft terug: DeleteComment200Response
Voorbeeld

delete_comment_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Reactie
Geeft terug: DeleteCommentPublic200Response
Voorbeeld

delete_comment_vote 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Antwoord
Retourneert: DeleteCommentVote200Response
Voorbeeld

flag_comment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Retourneert: FlagComment200Response
Voorbeeld

get_comment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetComment200Response
Voorbeeld

get_comment_text 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetCommentText200Response
Voorbeeld

get_comment_vote_user_names 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetCommentVoteUserNames200Response
Voorbeeld

get_comments 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | integer | query | Nee | |
| limit | integer | query | Nee | |
| skip | integer | query | Nee | |
| asTree | boolean | query | Nee | |
| skipChildren | integer | query | Nee | |
| limitChildren | integer | query | Nee | |
| maxTreeDepth | integer | query | Nee | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee | |
| contextUserId | string | query | Nee | |
| hashTag | string | query | Nee | |
| parentId | string | query | Nee | |
| direction | string | query | Nee |
Respons
Retourneert: GetComments200Response
Voorbeeld

get_comments_public 
req tenantId urlId
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nee | |
| direction | string | query | Nee | |
| sso | string | query | Nee | |
| skip | integer | query | Nee | |
| skipChildren | integer | query | Nee | |
| limit | integer | query | Nee | |
| limitChildren | integer | query | Nee | |
| countChildren | boolean | query | Nee | |
| fetchPageForCommentId | string | query | Nee | |
| includeConfig | boolean | query | Nee | |
| countAll | boolean | query | Nee | |
| includei10n | boolean | query | Nee | |
| locale | string | query | Nee | |
| modules | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeNotificationCount | boolean | query | Nee | |
| asTree | boolean | query | Nee | |
| maxTreeDepth | integer | query | Nee | |
| useFullTranslationIds | boolean | query | Nee | |
| parentId | string | query | Nee | |
| searchText | string | query | Nee | |
| hashTags | array | query | Nee | |
| userId | string | query | Nee | |
| customConfigStr | string | query | Nee | |
| afterCommentId | string | query | Nee | |
| beforeCommentId | string | query | Nee |
Respons
Geeft terug: GetCommentsPublic200Response
Voorbeeld

lock_comment 
Parameters
| Name | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: LockComment200Response
Voorbeeld

pin_comment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Antwoord
Geeft terug: PinComment200Response
Voorbeeld

save_comment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| sendEmails | boolean | query | Nee | |
| populateNotifications | boolean | query | Nee |
Respons
Retourneert: SaveComment200Response
Voorbeeld

save_comments_bulk 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| sendEmails | boolean | query | Nee | |
| populateNotifications | boolean | query | Nee |
Respons
Retourneert: Array<SaveComment200Response>
Voorbeeld

set_comment_text 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: SetCommentText200Response
Voorbeeld

un_block_user_from_comment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Retourneert: UnBlockCommentPublic200Response
Voorbeeld

un_flag_comment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: FlagComment200Response
Voorbeeld

un_lock_comment 
Parameters
| Naam | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Geeft terug: LockComment200Response
Voorbeeld

un_pin_comment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: PinComment200Response
Voorbeeld

update_comment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| isLive | boolean | query | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

vote_comment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | pad | Ja | |
| commentId | string | pad | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Geeft terug: VoteComment200Response
Voorbeeld

add_domain_config 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: AddDomainConfig200Response
Voorbeeld

delete_domain_config 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwoord
Retourneert: DeleteDomainConfig200Response
Voorbeeld

get_domain_config 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Antwoord
Retourneert: GetDomainConfig200Response
Voorbeeld

get_domain_configs 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Geeft terug: GetDomainConfigs200Response
Voorbeeld

patch_domain_config 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Response
Retourneert: GetDomainConfig200Response
Voorbeeld

put_domain_config 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Antwoord
Retourneert: GetDomainConfig200Response
Voorbeeld

create_email_template 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateEmailTemplate200Response
Voorbeeld

delete_email_template 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: FlagCommentPublic200Response
Voorbeeld

delete_email_template_render_error 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| errorId | string | path | Yes |
Respons
Geeft terug: FlagCommentPublic200Response
Voorbeeld

get_email_template 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: GetEmailTemplate200Response
Voorbeeld

get_email_template_definitions 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: GetEmailTemplateDefinitions200Response
Voorbeeld

get_email_template_render_errors 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetEmailTemplateRenderErrors200Response
Voorbeeld

get_email_templates 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Geeft terug: GetEmailTemplates200Response
Voorbeeld

render_email_template 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nee |
Response
Retourneert: RenderEmailTemplate200Response
Voorbeeld

update_email_template 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

get_event_log 
req tenantId urlId userIdWS
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Ja |
Antwoord
Geeft terug: GetEventLog200Response
Voorbeeld

get_global_event_log 
req tenantId urlId userIdWS
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Ja |
Response
Retourneert: GetEventLog200Response
Voorbeeld

create_feed_post 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nee | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| skipDupCheck | boolean | query | Nee |
Respons
Retourneert: CreateFeedPost200Response
Voorbeeld

create_feed_post_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: CreateFeedPostPublic200Response
Voorbeeld

delete_feed_post_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Geeft terug: DeleteFeedPostPublic200Response
Voorbeeld

get_feed_posts 
req tenantId afterId
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee |
Respons
Retourneert: GetFeedPosts200Response
Voorbeeld

get_feed_posts_public 
req tenantId afterId
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee | |
| sso | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeUserInfo | boolean | query | Nee |
Response
Retourneert: GetFeedPostsPublic200Response
Voorbeeld

get_feed_posts_stats 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetFeedPostsStats200Response
Voorbeeld

get_user_reacts_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nee | |
| sso | string | query | Nee |
Antwoord
Geeft terug: GetUserReactsPublic200Response
Voorbeeld

react_feed_post_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ReactFeedPostPublic200Response
Voorbeeld

update_feed_post 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

update_feed_post_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Response
Geeft terug: CreateFeedPostPublic200Response
Voorbeeld

flag_comment_public 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

add_hash_tag 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Nee |
Antwoord
Geeft terug: AddHashTag200Response
Voorbeeld

add_hash_tags_bulk 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Nee |
Antwoord
Geeft terug: AddHashTagsBulk200Response
Voorbeeld

delete_hash_tag 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

get_hash_tags 
Parameters
| Naam | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee |
Response
Retourneert: GetHashTags200Response
Voorbeeld

patch_hash_tag 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Ja | |
| tenantId | string | query | Nee |
Antwoord
Retourneert: PatchHashTag200Response
Voorbeeld

create_moderator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Geeft terug: CreateModerator200Response
Voorbeeld

delete_moderator 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nee |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

get_moderator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetModerator200Response
Voorbeeld

get_moderators 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Antwoord
Retourneert: GetModerators200Response
Voorbeeld

send_invite 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| fromName | string | query | Yes |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

update_moderator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

delete_notification_count 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Reactie
Retourneert: FlagCommentPublic200Response
Voorbeeld

get_cached_notification_count 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetCachedNotificationCount200Response
Voorbeeld

get_notification_count 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee |
Response
Retourneert: GetNotificationCount200Response
Voorbeeld

get_notifications 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetNotifications200Response
Voorbeeld

update_notification 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Response
Retourneert: FlagCommentPublic200Response
Voorbeeld

add_page 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: AddPageAPIResponse
Voorbeeld

delete_page 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwoord
Retourneert: DeletePageAPIResponse
Voorbeeld

get_page_by_urlid 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: GetPageByURLIdAPIResponse
Voorbeeld

get_pages 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: GetPagesAPIResponse
Voorbeeld

patch_page 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Geeft terug: PatchPageAPIResponse
Voorbeeld

delete_pending_webhook_event 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

get_pending_webhook_event_count 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| externalId | string | query | Nee | |
| eventType | string | query | Nee | |
| type | string | query | Nee | |
| domain | string | query | Nee | |
| attemptCountGT | number | query | Nee |
Respons
Geeft terug: GetPendingWebhookEventCount200Response
Voorbeeld

get_pending_webhook_events 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| externalId | string | query | Nee | |
| eventType | string | query | Nee | |
| type | string | query | Nee | |
| domain | string | query | Nee | |
| attemptCountGT | number | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetPendingWebhookEvents200Response
Voorbeeld

create_question_config 
Parameters
| Naam | Type | Location | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateQuestionConfig200Response
Voorbeeld

delete_question_config 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: FlagCommentPublic200Response
Voorbeeld

get_question_config 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Retourneert: GetQuestionConfig200Response
Voorbeeld

get_question_configs 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetQuestionConfigs200Response
Voorbeeld

update_question_config 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Geeft terug: FlagCommentPublic200Response
Voorbeeld

create_question_result 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Geeft terug: CreateQuestionResult200Response
Voorbeeld

delete_question_result 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

get_question_result 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetQuestionResult200Response
Voorbeeld

get_question_results 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| startDate | string | query | Nee | |
| questionId | string | query | Nee | |
| questionIds | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetQuestionResults200Response
Voorbeeld

update_question_result 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: FlagCommentPublic200Response
Voorbeeld

aggregate_question_results 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nee | |
| questionIds | array | query | Nee | |
| urlId | string | query | Nee | |
| timeBucket | string | query | Nee | |
| startDate | string | query | Nee | |
| forceRecalculate | boolean | query | Nee |
Respons
Retourneert: AggregateQuestionResults200Response
Voorbeeld

bulk_aggregate_question_results 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nee |
Respons
Geeft terug: BulkAggregateQuestionResults200Response
Voorbeeld

combine_comments_with_question_results 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nee | |
| questionIds | array | query | Nee | |
| urlId | string | query | Nee | |
| startDate | string | query | Nee | |
| forceRecalculate | boolean | query | Nee | |
| minValue | number | query | Nee | |
| maxValue | number | query | Nee | |
| limit | number | query | Nee |
Antwoord
Retourneert: CombineCommentsWithQuestionResults200Response
Voorbeeld

add_sso_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: AddSSOUserAPIResponse
Voorbeeld

delete_sso_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nee | |
| commentDeleteMode | string | query | Nee |
Respons
Retourneert: DeleteSSOUserAPIResponse
Voorbeeld

get_sso_user_by_email 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Antwoord
Retourneert: GetSSOUserByEmailAPIResponse
Voorbeeld

get_sso_user_by_id 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetSSOUserByIdAPIResponse
Voorbeeld

get_sso_users 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nee |
Antwoord
Retourneert: GetSSOUsers200Response
Voorbeeld

patch_sso_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Respons
Retourneert: PatchSSOUserAPIResponse
Voorbeeld

put_sso_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Antwoord
Retourneert: PutSSOUserAPIResponse
Voorbeeld

create_subscription 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateSubscriptionAPIResponse
Voorbeeld

delete_subscription 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Antwoord
Retourneert: DeleteSubscriptionAPIResponse
Voorbeeld

get_subscriptions 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee |
Response
Retourneert: GetSubscriptionsAPIResponse
Voorbeeld

get_tenant_daily_usages 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nee | |
| monthNumber | number | query | Nee | |
| dayNumber | number | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenantDailyUsages200Response
Voorbeeld

create_tenant_package 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateTenantPackage200Response
Voorbeeld

delete_tenant_package 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: FlagCommentPublic200Response
Voorbeeld

get_tenant_package 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Retourneert: GetTenantPackage200Response
Voorbeeld

get_tenant_packages 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Antwoord
Retourneert: GetTenantPackages200Response
Voorbeeld

replace_tenant_package 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: FlagCommentPublic200Response
Voorbeeld

update_tenant_package 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: FlagCommentPublic200Response
Voorbeeld

create_tenant_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Geeft terug: CreateTenantUser200Response
Voorbeeld

delete_tenant_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

get_tenant_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetTenantUser200Response
Voorbeeld

get_tenant_users 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Antwoord
Geeft terug: GetTenantUsers200Response
Voorbeeld

replace_tenant_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

send_login_link 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

update_tenant_user 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

create_tenant 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateTenant200Response
Voorbeeld

delete_tenant 
Parameters
| Naam | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

get_tenant 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetTenant200Response
Voorbeeld

get_tenants 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenants200Response
Voorbeeld

update_tenant 
Parameteren
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

upload_image 
Een afbeelding uploaden en formaat wijzigen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| sizePreset | string | query | Nee | Grootte-voorinstelling: "Default" (1000x1000px) of "CrossPlatform" (maakt formaten voor populaire apparaten) |
| urlId | string | query | Nee | Pagina-id waarvan de upload plaatsvindt, om te configureren |
Antwoord
Retourneert: UploadImageResponse
Voorbeeld

get_user_badge_progress_by_id 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetUserBadgeProgressById200Response
Voorbeeld

get_user_badge_progress_by_user_id 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Response
Geeft terug: GetUserBadgeProgressById200Response
Voorbeeld

get_user_badge_progress_list 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Respons
Retourneert: GetUserBadgeProgressList200Response
Voorbeeld

create_user_badge 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateUserBadge200Response
Voorbeeld

delete_user_badge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwoord
Retourneert: UpdateUserBadge200Response
Voorbeeld

get_user_badge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetUserBadge200Response
Voorbeeld

get_user_badges 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| badgeId | string | query | Nee | |
| type | number | query | Nee | |
| displayedOnComments | boolean | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Antwoord
Geeft terug: GetUserBadges200Response
Voorbeeld

update_user_badge 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: UpdateUserBadge200Response
Voorbeeld

get_user_notification_count 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetUserNotificationCount200Response
Voorbeeld

get_user_notifications 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| pageSize | integer | query | Nee | |
| afterId | string | query | Nee | |
| includeContext | boolean | query | Nee | |
| afterCreatedAt | integer | query | Nee | |
| unreadOnly | boolean | query | Nee | |
| dmOnly | boolean | query | Nee | |
| noDm | boolean | query | Nee | |
| includeTranslations | boolean | query | Nee | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetUserNotifications200Response
Voorbeeld

reset_user_notification_count 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Geeft terug: ResetUserNotifications200Response
Voorbeeld

reset_user_notifications 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nee | |
| afterCreatedAt | integer | query | Nee | |
| unreadOnly | boolean | query | Nee | |
| dmOnly | boolean | query | Nee | |
| noDm | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ResetUserNotifications200Response
Voorbeeld

update_user_notification_comment_subscription_status 
Schakel meldingen in of uit voor een specifieke reactie.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| optedInOrOut | string | path | Ja | |
| commentId | string | query | Ja | |
| sso | string | query | Nee |
Response
Geeft terug: UpdateUserNotificationStatus200Response
Voorbeeld

update_user_notification_page_subscription_status 
Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina abonneren, worden er meldingen aangemaakt voor nieuwe top-level reacties, en ook
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UpdateUserNotificationStatus200Response
Voorbeeld

update_user_notification_status 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UpdateUserNotificationStatus200Response
Voorbeeld

get_user_presence_statuses 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Antwoord
Retourneert: GetUserPresenceStatuses200Response
Voorbeeld

search_users 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Ja | |
| mentionGroupIds | array | query | Nee | |
| sso | string | query | Nee |
Respons
Geeft terug: SearchUsers200Response
Voorbeeld

get_user 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: GetUser200Response
Voorbeeld

create_vote 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: VoteComment200Response
Voorbeeld

delete_vote 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nee |
Antwoord
Retourneert: DeleteCommentVote200Response
Voorbeeld

get_votes 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwoord
Retourneert: GetVotes200Response
Voorbeeld

get_votes_for_user 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Retourneert: GetVotesForUser200Response
Voorbeeld

Hulp nodig?
Als u problemen ondervindt of vragen heeft over de Ruby SDK, neem dan:
Bijdragen
Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.