
Taal 🇳🇱 Nederlands
Aan de slag
Documentatie
API-referentie
Aggregatie
Auditlogs
Blokkeren van opmerking
Controleer geblokkeerde opmerkingen
Opmerkingen
Domeinconfiguraties
E-mailsjablonen
Gebeurtenislogboek
Feed-berichten
Opmerking markeren
Hashtags
Moderators
Aantal meldingen
Meldingen
Pagina's
Wachtende webhook-gebeurtenissen
Vraagconfiguraties
Vraagresultaten
Aggregatie van vraagresultaten
SSO-gebruikers
Abonnementen
Dagelijks gebruik van tenant
Tenant-pakketten
Tenant-gebruikers
Tenants
Afbeelding uploaden
Voortgang gebruikersbadge
Gebruikersbadges
Gebruikersmeldingen
Gebruikersaanwezigheidsstatus
Gebruikers zoeken
Gebruikers
Stemmen
FastComments Swift SDK
Dit is de officiële Swift SDK voor FastComments.
Officiële Swift SDK voor de FastComments API
Repository
Installatie 
Swift Package Manager
Voeg het volgende toe aan uw Package.swift-bestand:
dependencies: [
.package(url: "https://github.com/fastcomments/fastcomments-swift.git", from: "0.0.1")
]
Of in Xcode:
- Bestand > Voeg pakketten toe...
- Voer de repository-URL in:
https://github.com/fastcomments/fastcomments-swift.git - Selecteer de versie die u wilt gebruiken
Vereisten
- Swift 5.9+
- iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+
Bibliotheekinhoud 
De FastComments Swift SDK bestaat uit verschillende modules:
Client Module - Automatisch gegenereerde API-client voor de FastComments REST-API's
- Volledige typedefinities voor alle API-modellen
- Zowel geauthenticeerde (
DefaultAPI) als openbare (PublicAPI) endpoints - Volledige async/await-ondersteuning
- Zie client/README.md voor gedetailleerde API-documentatie
SSO Module - Server-side Single Sign-On-hulpmiddelen
- Beveiligde tokengeneratie voor gebruikersauthenticatie
- Ondersteuning voor zowel eenvoudige als beveiligde SSO-modi
- Op HMAC-SHA256 gebaseerde tokenondertekening met CryptoKit
Snelle start 
Gebruik van de openbare API
import FastCommentsSwift
// Maak API-client
let publicApi = PublicAPI()
// Haal reacties op voor een pagina
do {
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Found \(response.comments?.count ?? 0) comments")
for comment in response.comments ?? [] {
print("Comment: \(comment.comment ?? "")")
}
} catch {
print("Error fetching comments: \(error)")
}
Gebruik van de geauthenticeerde API
import FastCommentsSwift
// Maak configuratie met API-sleutel
let defaultApi = DefaultAPI()
defaultApi.apiKey = "your-api-key"
// Haal reacties op met de geauthenticeerde API
do {
let response = try await defaultApi.getComments(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
print("Total comments: \(response.count ?? 0)")
for comment in response.comments ?? [] {
print("Comment ID: \(comment.id ?? ""), Text: \(comment.comment ?? "")")
}
} catch {
print("Error: \(error)")
}
SSO gebruiken voor authenticatie
Beveiligde SSO (Aanbevolen voor productie)
import FastCommentsSwift
let apiKey = "your-api-key"
// Maak beveiligde SSO-gebruikergegevens (alleen server-side!)
let userData = SecureSSOUserData(
id: "user-123", // Gebruikers-ID
email: "user@example.com", // E-mail
username: "johndoe", // Gebruikersnaam
avatar: "https://example.com/avatar.jpg" // Avatar-URL
)
// Genereer SSO-token
do {
let sso = try FastCommentsSSO.createSecure(apiKey: apiKey, secureSSOUserData: userData)
let token = try sso.createToken()
print("SSO Token: \(token ?? "")")
// Geef dit token door aan je frontend voor authenticatie
} catch {
print("Error creating SSO token: \(error)")
}
Eenvoudige SSO (Voor ontwikkeling/testen)
import FastCommentsSwift
// Maak eenvoudige SSO-gebruikergegevens (geen API-sleutel nodig)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Genereer eenvoudig SSO-token
let sso = FastCommentsSSO.createSimple(simpleSSOUserData: userData)
do {
let token = try sso.createToken()
print("Simple SSO Token: \(token ?? "")")
} catch {
print("Error creating SSO token: \(error)")
}
Publieke vs beveiligde API's 
De FastComments SDK biedt twee typen API-eindpunten:
PublicAPI - Client-veilige eindpunten
De PublicAPI bevat eindpunten die veilig zijn om aan te roepen vanuit client-side code (iOS/macOS apps). Deze eindpunten:
- Vereisen geen API key
- Kunnen SSO tokens gebruiken voor authenticatie
- Hebben rate-limieten per gebruiker/apparaat
- Zijn geschikt voor toepassingen gericht op eindgebruikers
Voorbeeldgebruik: Het ophalen en aanmaken van reacties in je iOS app
DefaultAPI - Server-side eindpunten
De DefaultAPI bevat geauthenticeerde eindpunten die een API key vereisen. Deze eindpunten:
- Vereisen je FastComments API key
- Moeten ALLEEN worden aangeroepen vanuit server-side code
- Bieden volledige toegang tot je FastComments-gegevens
- Hebben rate-limieten per tenant
Voorbeeldgebruik: Administratieve bewerkingen, bulkgegevensexport, moderatietools
BELANGRIJK: Stel je API key nooit bloot in client-side code. API keys mogen alleen server-side worden gebruikt.
API-aanroepen maken 
De Swift SDK gebruikt moderne async/await-syntaxis voor alle API-aanroepen:
let response = try await publicApi.getCommentsPublic(
tenantId: "your-tenant-id",
urlId: "page-url-id"
)
Veelvoorkomende problemen 
401 Ongeautoriseerde fouten
Als je 401-fouten krijgt bij het gebruik van de geauthenticeerde API:
- Controleer je API-sleutel: Zorg ervoor dat je de juiste API-sleutel uit je FastComments-dashboard gebruikt
- Controleer de tenant-ID: Zorg dat de tenant-ID overeenkomt met je account
- API-sleutel formaat: De API-sleutel moet op de API-client worden ingesteld:
let defaultApi = DefaultAPI()
defaultApi.apiKey = "YOUR_API_KEY"
- Verkeerde API gebruiken: Zorg ervoor dat je
DefaultAPI(nietPublicAPI) gebruikt voor geauthenticeerde aanroepen
SSO-tokenproblemen
Als SSO-tokens niet werken:
- Gebruik veilige modus in productie: Gebruik altijd
FastCommentsSSO.createSecure()met je API-sleutel voor productie - Alleen server-side: Genereer veilige SSO-tokens op je server, maak je API-sleutel nooit openbaar aan clients
- Controleer gebruikersgegevens: Zorg ervoor dat alle vereiste velden (id, email, username) zijn meegegeven
- Tokenverval: Veilige SSO-tokens bevatten een tijdstempel en kunnen verlopen. Genereer indien nodig nieuwe tokens.
SSL/TLS-fouten
Als je SSL/TLS-fouten tegenkomt:
- Zorg ervoor dat de Info.plist van je app HTTPS-verbindingen naar fastcomments.com toestaat
- Controleer of je geen App Transport Security-uitzonderingen gebruikt die de verbinding kunnen blokkeren
Opmerkingen 
Broadcast-ID's
Je zult zien dat je een broadcastId moet doorgeven in sommige API-aanroepen. Wanneer je gebeurtenissen ontvangt, krijg je dit ID terug, zodat je weet dat 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 gebruikerservaring biedt). Geef hier een UUID door. Het ID moet uniek genoeg zijn om niet twee keer in één sessie voor te komen.
let broadcastId = UUID().uuidString
aggregate 
Aggregeert documenten door ze te groeperen (indien groupBy is opgegeven) en door 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

getAuditLogs 
Parameters
| Naam | Type | Locatie | Vereist | 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 |
Respons
Retourneert: GetAuditLogs200Response
Voorbeeld

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

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

checkedCommentsForBlocked 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentIds | string | query | Yes | Een door komma's gescheiden lijst met comment-ids. |
| sso | string | query | No |
Respons
Retourneert: CheckedCommentsForBlocked200Response
Voorbeeld

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

createCommentPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Reactie
Geeft terug: CreateCommentPublic200Response
Voorbeeld

deleteComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nee | |
| isLive | boolean | query | Nee |
Respons
Geeft terug: DeleteComment200Response
Voorbeeld

deleteCommentPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: DeleteCommentPublic200Response
Voorbeeld

deleteCommentVote 
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 |
Respons
Retourneert: DeleteCommentVote200Response
Voorbeeld

flagComment 
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

getComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Geeft terug: GetComment200Response
Voorbeeld

getComments 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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

getCommentsPublic 
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 |
Antwoord
Retourneert: GetCommentsPublic200Response
Voorbeeld

getCommentText 
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

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

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

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

saveComment 
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 |
Antwoord
Retourneert: SaveComment200Response
Voorbeeld

saveCommentsBulk 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respons
Retourneert: [SaveComment200Response]
Voorbeeld

setCommentText 
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 |
Antwoord
Retourneert: SetCommentText200Response
Voorbeeld

unBlockUserFromComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Geeft terug: UnBlockCommentPublic200Response
Voorbeeld

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

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

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

updateComment 
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 |
Antwoord
Retourneert: FlagCommentPublic200Response
Voorbeeld

voteComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: VoteComment200Response
Voorbeeld

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

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

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

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

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

putDomainConfig 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Respons
Geeft terug: GetDomainConfig200Response
Voorbeeld

createEmailTemplate 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Retourneert: CreateEmailTemplate200Response
Voorbeeld

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

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

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

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

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

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

renderEmailTemplate 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nee |
Respons
Geeft terug: RenderEmailTemplate200Response
Voorbeeld

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

getEventLog 
req tenantId urlId userIdWS
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Ja |
Response
Geeft terug: GetEventLog200Response
Voorbeeld

getGlobalEventLog 
req tenantId urlId userIdWS
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Ja |
Respons
Retourneert: GetEventLog200Response
Voorbeeld

createFeedPost 
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
Geeft terug: CreateFeedPost200Response
Voorbeeld

createFeedPostPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: CreateFeedPostPublic200Response
Voorbeeld

deleteFeedPostPublic 
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

getFeedPosts 
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 |
Response
Geeft terug: GetFeedPosts200Response
Voorbeeld

getFeedPostsPublic 
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 |
Respons
Geeft terug: GetFeedPostsPublic200Response
Voorbeeld

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

getUserReactsPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: GetUserReactsPublic200Response
Voorbeeld

reactFeedPostPublic 
Parameteren
| 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 |
Antwoord
Geeft terug: ReactFeedPostPublic200Response
Voorbeeld

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

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

flagCommentPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| isFlagged | boolean | query | Yes | |
| sso | string | query | No |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

addHashTag 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | No |
Response
Retourneert: AddHashTag200Response
Voorbeeld

addHashTagsBulk 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Nee |
Respons
Geeft terug: AddHashTagsBulk200Response
Voorbeeld

deleteHashTag 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tag | string | path | Ja | |
| tenantId | string | query | Nee |
Respons
Geeft terug: FlagCommentPublic200Response
Voorbeeld

getHashTags 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee |
Respons
Retourneert: GetHashTags200Response
Voorbeeld

patchHashTag 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tag | string | path | Ja | |
| tenantId | string | query | Nee |
Antwoord
Geeft terug: PatchHashTag200Response
Voorbeeld

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

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

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

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

sendInvite 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Antwoord
Geeft terug: FlagCommentPublic200Response
Voorbeeld

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

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

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

getNotificationCount 
Parameters
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No |
Respons
Retourneert: GetNotificationCount200Response
Voorbeeld

getNotifications 
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

updateNotification 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: FlagCommentPublic200Response
Voorbeeld

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

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

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

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

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

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

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

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

createQuestionConfig 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Geeft terug: CreateQuestionConfig200Response
Voorbeeld

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

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

getQuestionConfigs 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Antwoord
Geeft terug: GetQuestionConfigs200Response
Voorbeeld

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

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

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

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

getQuestionResults 
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
Geeft terug: GetQuestionResults200Response
Voorbeeld

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

aggregateQuestionResults 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Response
Retourneert: AggregateQuestionResults200Response
Voorbeeld

bulkAggregateQuestionResults 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nee |
Response
Retourneert: BulkAggregateQuestionResults200Response
Voorbeeld

combineCommentsWithQuestionResults 
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

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

deleteSSOUser 
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

getSSOUserByEmail 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| string | path | Yes |
Antwoord
Retourneert: GetSSOUserByEmailAPIResponse
Voorbeeld

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

getSSOUsers 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nee |
Respons
Geeft terug: GetSSOUsers200Response
Voorbeeld

patchSSOUser 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Response
Retourneert: PatchSSOUserAPIResponse
Voorbeeld

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

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

deleteSubscription 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Response
Retourneert: DeleteSubscriptionAPIResponse
Example

getSubscriptions 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee |
Respons
Retourneert: GetSubscriptionsAPIResponse
Voorbeeld

getTenantDailyUsages 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Respons
Geeft terug: GetTenantDailyUsages200Response
Voorbeeld

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

uploadImage 
Afbeelding uploaden en formaat aanpassen
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 |
Response
Retourneert: UploadImageResponse
Voorbeeld

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

getUserBadgeProgressByUserId 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Respons
Retourneert: GetUserBadgeProgressById200Response
Voorbeeld

getUserBadgeProgressList 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Antwoord
Retourneert: GetUserBadgeProgressList200Response
Voorbeeld

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

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

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

getUserBadges 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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 |
Respons
Retourneert: GetUserBadges200Response
Voorbeeld

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

getUserNotificationCount 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: GetUserNotificationCount200Response
Voorbeeld

getUserNotifications 
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
Geeft terug: GetUserNotifications200Response
Voorbeeld

resetUserNotificationCount 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: ResetUserNotifications200Response
Voorbeeld

resetUserNotifications 
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 |
Respons
Retourneert: ResetUserNotifications200Response
Voorbeeld

updateUserNotificationCommentSubscriptionStatus 
Meldingen voor een specifieke reactie in- of uitschakelen.
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
Geeft terug: UpdateUserNotificationStatus200Response
Voorbeeld

updateUserNotificationPageSubscriptionStatus 
Meldingen voor een pagina inschakelen of uitschakelen. Wanneer gebruikers op een pagina geabonneerd zijn, worden er meldingen aangemaakt voor nieuwe root-opmerkingen, en ook
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nee |
Antwoord
Geeft terug: UpdateUserNotificationStatus200Response
Voorbeeld

updateUserNotificationStatus 
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

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

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

getUser 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Geeft terug: GetUser200Response
Voorbeeld

createVote 
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 |
Response
Retourneert: VoteComment200Response
Voorbeeld

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

getVotes 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: GetVotes200Response
Voorbeeld

getVotesForUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| 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 Swift SDK, neem dan contact op via:
Bijdragen
Bijdragen zijn welkom! Bezoek de GitHub-repository voor richtlijnen voor bijdragen.