
Taal 🇳🇱 Nederlands
Aan de slag
Documentatie
Aggregatie
Auditlogs
Blokkeren van reactie
Geblokkeerde reacties controleren
Reacties
Domeinconfiguraties
E-mailsjablonen
Gebeurtenislogboek
Feedberichten
Reactie rapporteren
Hashtags
Moderators
Meldingsaantal
Meldingen
Pagina's
Wachtende webhookgebeurtenissen
Vraagconfiguraties
Vraagresultaten
Aggregatie van vraagresultaten
SSO-gebruikers
Abonnementen
Dagelijks gebruik per tenant
Tenantpakketten
Tenantgebruikers
Tenants
Tickets
Afbeelding uploaden
Voortgang gebruikersbadge
Gebruikersbadges
Gebruikersmeldingen
Aanwezigheidsstatus van gebruikers
Gebruikers zoeken
Gebruikers
Stemmen
FastComments Python SDK
Dit is de officiële Python SDK voor FastComments.
Officiële Python SDK voor de FastComments API
Repository
Installatie 
PyPI
pip install fastcomments
Bibliotheekinhoud
Deze bibliotheek bevat twee modules: de gegenereerde API-client en de core Python-bibliotheek die handgeschreven hulpprogramma's bevat om het werken met de API gemakkelijker te maken, inclusief SSO-ondersteuning.
Publieke 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/mobile device/etc zonder authenticatie kunnen worden uitgevoerd.
Snel aan de slag 
Gebruik van geauthenticeerde API's (DefaultApi)
Belangrijk: U moet uw API-sleutel instellen op de Configuration voordat u geauthenticeerde verzoeken doet. Als u dat niet doet, zullen verzoeken mislukken met een 401-fout.
from client import ApiClient, Configuration, DefaultApi
from client.models import CreateAPISSOUserData
# Maak en configureer de API-client
config = Configuration()
config.host = "https://fastcomments.com/api"
# VEREIST: Stel uw API-sleutel in (haal deze uit uw FastComments-dashboard)
config.api_key = {"ApiKeyAuth": "YOUR_API_KEY_HERE"}
# Maak de API-instantie met de geconfigureerde client
api_client = ApiClient(configuration=config)
api = DefaultApi(api_client)
# Nu kunt u geauthenticeerde API-aanroepen doen
try:
# Voorbeeld: Voeg een SSO-gebruiker toe
user_data = CreateAPISSOUserData(
id="user-123",
email="user@example.com",
display_name="John Doe"
)
response = api.add_sso_user(
tenant_id="YOUR_TENANT_ID",
create_apisso_user_data=user_data
)
print(f"User created: {response}")
except Exception as e:
print(f"Error: {e}")
# Veelvoorkomende fouten:
# - 401: API-sleutel ontbreekt of is ongeldig
# - 400: Verzoekvalidatie mislukt
Publieke API's gebruiken (PublicApi)
Publieke endpoints vereisen geen authenticatie:
from client import ApiClient, Configuration, PublicApi
config = Configuration()
config.host = "https://fastcomments.com/api"
api_client = ApiClient(configuration=config)
public_api = PublicApi(api_client)
try:
response = public_api.get_comments_public(
tenant_id="YOUR_TENANT_ID",
url_id="page-url-id"
)
print(response)
except Exception as e:
print(f"Error: {e}")
SSO gebruiken (Single Sign-On)
De SDK bevat hulpmiddelen voor het genereren van beveiligde SSO-tokens:
from sso import FastCommentsSSO, SecureSSOUserData
# Maak gebruikersgegevens aan
user_data = SecureSSOUserData(
user_id="user-123",
email="user@example.com",
username="johndoe",
avatar="https://example.com/avatar.jpg"
)
# Maak een SSO-instantie met uw API-secret
sso = FastCommentsSSO.new_secure(
api_secret="YOUR_API_SECRET",
user_data=user_data
)
# Genereer de SSO-token
sso_token = sso.create_token()
# Gebruik dit token in uw frontend of geef het door aan API-aanroepen
print(f"SSO Token: {sso_token}")
Voor eenvoudige SSO (minder veilig, voor testen):
from sso import FastCommentsSSO, SimpleSSOUserData
user_data = SimpleSSOUserData(
user_id="user-123",
email="user@example.com"
)
sso = FastCommentsSSO.new_simple(user_data)
sso_token = sso.create_token()
Veelvoorkomende problemen
- 401 "missing-api-key" foutmelding: Zorg ervoor dat u
config.api_key = {"ApiKeyAuth": "YOUR_KEY"}instelt voordat u de DefaultApi-instantie maakt. - Verkeerde API-klasse: Gebruik
DefaultApivoor server-side geauthenticeerde verzoeken,PublicApivoor client-side/publieke verzoeken. - Importfouten: Zorg ervoor dat u importeert uit het juiste module:
- API client:
from client import ... - SSO utilities:
from sso import ...
- API client:
Notities 
Broadcast-ID's
Je zult zien dat je een broadcast_id moet doorgeven in sommige API-aanroepen. Wanneer je gebeurtenissen ontvangt, krijg je deze ID terug, zodat je de gebeurtenis 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 door. De ID moet uniek genoeg zijn om niet twee keer voor te komen in een browsersessie.
Vereisten 
- Python >= 3.8
- urllib3 >= 1.25.3
- python-dateutil >= 2.8.2
- pydantic >= 2.0.0
- typing-extensions >= 4.0.0
Aggregatie 
Aggregeert documenten door ze te groeperen (als groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, enz.) worden ondersteund.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nee | |
| includeStats | boolean | query | Nee |
Response
Retourneert: AggregationResponse
Example

Auditlogs ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nee | |
| skip | number | query | Nee | |
| order | string | query | Nee | |
| after | number | query | Nee | |
| before | number | query | Nee |
Response
Retourneert: GetAuditLogs200Response
Voorbeeld

Gebruiker blokkeren vanuit publieke reactie 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: BlockFromCommentPublic200Response
Voorbeeld

Publieke reactie deblokkeren 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: UnBlockCommentPublic200Response
Voorbeeld

Controleren op geblokkeerde reacties 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | Een door komma's gescheiden lijst met comment-id's. |
| sso | string | query | No |
Response
Geeft terug: CheckedCommentsForBlocked200Response
Voorbeeld

Gebruiker blokkeren vanuit reactie 
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

Publieke reactie maken 
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 |
Response
Retourneert: CreateCommentPublic200Response
Voorbeeld

Reactie verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| isLive | boolean | query | Nee |
Respons
Retourneert: DeleteComment200Response
Voorbeeld

Publieke reactie verwijderen 
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: DeleteCommentPublic200Response
Voorbeeld

Stem op reactie verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Response
Retourneert: DeleteCommentVote200Response
Voorbeeld

Reactie rapporteren 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respons
Retourneert: FlagComment200Response
Voorbeeld

Reactie ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetComment200Response
Voorbeeld

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

Gebruikersnamen van stemmers op reactie ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetCommentVoteUserNames200Response
Voorbeeld

Reacties ophalen 
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 |
Antwoord
Retourneert: GetComments200Response
Voorbeeld

Publieke reacties ophalen 
req tenantId urlId
Parameters
| Naam | Type | Locatie | Verplicht | 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 |
Antwoord
Retourneert: GetCommentsPublic200Response
Voorbeeld

Reactie vergrendelen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Respons
Retourneert: LockComment200Response
Voorbeeld

Reactie vastpinnen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Geeft terug: PinComment200Response
Voorbeeld

Reactie opslaan 
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
Geeft terug: SaveComment200Response
Voorbeeld

Reacties in bulk opslaan 
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

Reactietekst instellen 
Parameters
| Naam | Type | Locatie | Verplicht | 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

Gebruiker deblokkeren vanuit reactie 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Antwoord
Retourneert: UnBlockCommentPublic200Response
Voorbeeld

Rapportage van reactie verwijderen 
Parameters
| Name | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Retourneert: FlagComment200Response
Voorbeeld

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

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

Reactie bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| isLive | boolean | query | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

Op reactie stemmen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: VoteComment200Response
Voorbeeld

Domeinconfig toevoegen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: AddDomainConfig200Response
Voorbeeld

Domeinconfig verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Respons
Retourneert: DeleteDomainConfig200Response
Voorbeeld

Domeinconfig ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Respons
Geeft terug: GetDomainConfig200Response
Voorbeeld

Domeinconfiguraties ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: GetDomainConfigs200Response
Voorbeeld

Domeinconfig gedeeltelijk bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Respons
Retourneert: GetDomainConfig200Response
Voorbeeld

Domeinconfig vervangen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Respons
Retourneert: GetDomainConfig200Response
Voorbeeld

E-mailsjabloon maken 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: CreateEmailTemplate200Response
Voorbeeld

E-mailsjabloon verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

Renderfout van e-mailsjabloon verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Respons
Geeft terug: FlagCommentPublic200Response
Voorbeeld

E-mailsjabloon ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetEmailTemplate200Response
Voorbeeld

Definities van e-mailsjablonen ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: GetEmailTemplateDefinitions200Response
Voorbeeld

Renderfouten van e-mailsjablonen ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nee |
Response
Retourneert: GetEmailTemplateRenderErrors200Response
Voorbeeld

E-mailsjablonen ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Response
Retourneert: GetEmailTemplates200Response
Voorbeeld

E-mailsjabloon renderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nee |
Respons
Geeft terug: RenderEmailTemplate200Response
Voorbeeld

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

Gebeurtenislogboek ophalen 
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

Globaal gebeurtenislogboek ophalen 
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 |
Respons
Retourneert: GetEventLog200Response
Voorbeeld

Feedbericht maken 
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 |
Response
Retourneert: CreateFeedPost200Response
Voorbeeld

Publiek feedbericht maken 
Parameters
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: CreateFeedPostPublic200Response
Voorbeeld

Publiek feedbericht verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: DeleteFeedPostPublic200Response
Voorbeeld

Feedberichten ophalen 
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
Geeft terug: GetFeedPosts200Response
Voorbeeld

Publieke feedberichten ophalen 
req tenantId afterId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Geeft terug: GetFeedPostsPublic200Response
Voorbeeld

Statistieken van feedberichten ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: GetFeedPostsStats200Response
Example

Publieke gebruikersreacties ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nee | |
| sso | string | query | Nee |
Response
Geeft terug: GetUserReactsPublic200Response
Voorbeeld

Reageren op publiek feedbericht 
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 |
Response
Retourneert: ReactFeedPostPublic200Response
Voorbeeld

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

Publiek feedbericht bijwerken 
Parameters
| Naam | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Geeft terug: CreateFeedPostPublic200Response
Voorbeeld

Publieke reactie rapporteren 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nee |
Response
Geeft terug: FlagCommentPublic200Response
Voorbeeld

Hashtag toevoegen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Nee |
Antwoord
Retourneert: AddHashTag200Response
Voorbeeld

Hashtags in bulk toevoegen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Nee |
Respons
Geeft terug: AddHashTagsBulk200Response
Voorbeeld

Hashtag verwijderen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tag | string | path | Ja | |
| tenantId | string | query | Nee |
Response
Retourneert: FlagCommentPublic200Response
Voorbeeld

Hashtags ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee |
Response
Geeft terug: GetHashTags200Response
Voorbeeld

Hashtag gedeeltelijk bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tag | string | path | Ja | |
| tenantId | string | query | Nee |
Respons
Retourneert: PatchHashTag200Response
Voorbeeld

Moderator maken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: CreateModerator200Response
Voorbeeld

Moderator verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nee |
Respons
Geeft terug: FlagCommentPublic200Response
Voorbeeld

Moderator ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetModerator200Response
Voorbeeld

Moderators ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Antwoord
Geeft terug: GetModerators200Response
Voorbeeld

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

Moderator bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

Meldingsaantal verwijderen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Geeft terug: FlagCommentPublic200Response
Voorbeeld

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

Meldingsaantal ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee |
Respons
Retourneert: GetNotificationCount200Response
Voorbeeld

Meldingen ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Antwoord
Retourneert: GetNotifications200Response
Voorbeeld

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

Pagina toevoegen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: AddPageAPIResponse
Voorbeeld

Pagina verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: DeletePageAPIResponse
Voorbeeld

Pagina ophalen op URL-id 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Antwoord
Geeft terug: GetPageByURLIdAPIResponse
Voorbeeld

Pagina's ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: GetPagesAPIResponse
Voorbeeld

Pagina gedeeltelijk bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: PatchPageAPIResponse
Voorbeeld

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

Aantal wachtende webhookgebeurtenissen ophalen 
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
Retourneert: GetPendingWebhookEventCount200Response
Voorbeeld

Wachtende webhookgebeurtenissen ophalen 
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 |
Antwoord
Retourneert: GetPendingWebhookEvents200Response
Voorbeeld

Vraagconfig maken 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Retourneert: CreateQuestionConfig200Response
Voorbeeld

Vraagconfig verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

Vraagconfig ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetQuestionConfig200Response
Voorbeeld

Vraagconfiguraties ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Response
Retourneert: GetQuestionConfigs200Response
Voorbeeld

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

Vraagresultaat maken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateQuestionResult200Response
Voorbeeld

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

Vraagresultaat ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Geeft terug: GetQuestionResult200Response
Voorbeeld

Vraagresultaten ophalen 
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 |
Antwoord
Retourneert: GetQuestionResults200Response
Voorbeeld

Vraagresultaat bijwerken 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Geeft terug: FlagCommentPublic200Response
Voorbeeld

Vraagresultaten aggregeren 
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 |
Antwoord
Geeft terug: AggregateQuestionResults200Response
Voorbeeld

Vraagresultaten in bulk aggregeren 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nee |
Antwoord
Retourneert: BulkAggregateQuestionResults200Response
Voorbeeld

Reacties combineren met vraagresultaten 
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 |
Respons
Retourneert: CombineCommentsWithQuestionResults200Response
Voorbeeld

SSO-gebruiker toevoegen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: AddSSOUserAPIResponse
Voorbeeld

SSO-gebruiker verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nee | |
| commentDeleteMode | string | query | Nee |
Antwoord
Retourneert: DeleteSSOUserAPIResponse
Voorbeeld

SSO-gebruiker ophalen op e-mail 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Antwoord
Geeft terug: GetSSOUserByEmailAPIResponse
Voorbeeld

SSO-gebruiker ophalen op id 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetSSOUserByIdAPIResponse
Voorbeeld

SSO-gebruikers ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nee |
Antwoord
Retourneert: GetSSOUsers200Response
Voorbeeld

SSO-gebruiker gedeeltelijk bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Antwoord
Retourneert: PatchSSOUserAPIResponse
Voorbeeld

SSO-gebruiker vervangen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Respons
Retourneert: PutSSOUserAPIResponse
Voorbeeld

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

Abonnement verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Antwoord
Geeft terug: DeleteSubscriptionAPIResponse
Voorbeeld

Abonnementen ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee |
Antwoord
Retourneert: GetSubscriptionsAPIResponse
Voorbeeld

Abonnement bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No |
Response
Retourneert: UpdateSubscriptionAPIResponse
Voorbeeld

Dagelijkse gebruiksgegevens per tenant ophalen 
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 |
Antwoord
Retourneert: GetTenantDailyUsages200Response
Voorbeeld

Tenantpakket aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Antwoord
Retourneert: CreateTenantPackage200Response
Voorbeeld

Tenantpakket verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

Tenantpakket ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: GetTenantPackage200Response
Voorbeeld

Tenantpakketten ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | number | query | No |
Respons
Retourneert: GetTenantPackages200Response
Voorbeeld

Tenantpakket vervangen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

Tenantpakket bijwerken 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

Tenantgebruiker aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Geeft terug: CreateTenantUser200Response
Voorbeeld

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

Tenantgebruiker ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Geeft terug: GetTenantUser200Response
Voorbeeld

Tenantgebruikers ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenantUsers200Response
Voorbeeld

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

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

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

Tenant aanmaken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateTenant200Response
Voorbeeld

Tenant verwijderen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nee |
Respons
Geeft terug: FlagCommentPublic200Response
Voorbeeld

Tenant ophalen 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Antwoord
Retourneert: GetTenant200Response
Voorbeeld

Tenants ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nee | |
| skip | number | query | Nee |
Reactie
Retourneert: GetTenants200Response
Voorbeeld

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

Ticketstatus wijzigen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Response
Retourneert: ChangeTicketState200Response
Voorbeeld

Ticket aanmaken 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Antwoord
Retourneert: CreateTicket200Response
Voorbeeld

Ticket ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Antwoord
Retourneert: GetTicket200Response
Voorbeeld

Tickets ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| state | number | query | Nee | |
| skip | number | query | Nee | |
| limit | number | query | Nee |
Antwoord
Retourneert: GetTickets200Response
Voorbeeld

Afbeelding uploaden 
Afbeelding uploaden en schalen
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Grootte-instelling: "Default" (1000x1000px) of "CrossPlatform" (maakt formaten voor populaire apparaten) |
| urlId | string | query | No | Pagina-id waarvandaan de upload plaatsvindt, om te configureren |
Antwoord
Geeft terug: UploadImageResponse
Voorbeeld

Voortgang gebruikersbadge ophalen op id 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetUserBadgeProgressById200Response
Voorbeeld

Voortgang gebruikersbadge ophalen op gebruikers-id 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Response
Geeft terug: GetUserBadgeProgressById200Response
Voorbeeld

Lijst met voortgang van gebruikersbadges ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetUserBadgeProgressList200Response
Voorbeeld

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

Gebruikersbadge verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: UpdateUserBadge200Response
Voorbeeld

Gebruikersbadge ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetUserBadge200Response
Voorbeeld

Gebruikersbadges ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Response
Retourneert: GetUserBadges200Response
Voorbeeld

Gebruikersbadge bijwerken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: UpdateUserBadge200Response
Voorbeeld

Gebruikersmeldingsaantal ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetUserNotificationCount200Response
Voorbeeld

Gebruikersmeldingen ophalen 
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 |
Respons
Retourneert: GetUserNotifications200Response
Voorbeeld

Gebruikersmeldingsaantal resetten 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ResetUserNotifications200Response
Voorbeeld

Gebruikersmeldingen resetten 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Respons
Retourneert: ResetUserNotifications200Response
Voorbeeld

Abonnementsstatus voor reactiemeldingen bijwerken 
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 |
Respons
Retourneert: UpdateUserNotificationStatus200Response
Voorbeeld

Abonnementsstatus voor paginameldingen bijwerken 
Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich abonneren op een pagina, worden meldingen aangemaakt voor nieuwe root-opmerkingen, en ook
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Response
Retourneert: UpdateUserNotificationStatus200Response
Voorbeeld

Meldingsstatus van gebruiker bijwerken 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UpdateUserNotificationStatus200Response
Voorbeeld

Aanwezigheidsstatussen van gebruikers ophalen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Response
Retourneert: GetUserPresenceStatuses200Response
Voorbeeld

Gebruikers zoeken 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nee | |
| mentionGroupIds | array | query | Nee | |
| sso | string | query | Nee | |
| searchSection | string | query | Nee |
Antwoord
Retourneert: SearchUsers200Response
Voorbeeld

Gebruiker ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: GetUser200Response
Voorbeeld

Stem aanmaken 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: VoteComment200Response
Voorbeeld

Stem verwijderen 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| editKey | string | query | No |
Antwoord
Retourneert: DeleteCommentVote200Response
Voorbeeld

Stemmen ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Response
Retourneert: GetVotes200Response
Voorbeeld

Stemmen voor gebruiker ophalen 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: GetVotesForUser200Response
Voorbeeld

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