
Taal 🇳🇱 Nederlands
Aan de slag
Documentatie
API-referentie
Aggregatie
Auditlogs
Authenticatie
Blokkeren bij reactie
Controleer geblokkeerde reacties
Reacties
Reacties voor gebruiker
Domeinconfiguraties
E-mailsjablonen
Gebeurtenislogboek
Feedberichten
Reactie markeren
Gifs
Hashtags
Moderatie
Moderatoren
Aantal meldingen
Meldingen
Pagina-reacties
Pagina's
Wachtende webhookgebeurtenissen
Vraagconfiguraties
Vraagresultaten
Aggregatie van vraagresultaten
SSO-gebruikers
Abonnementen
Dagelijks gebruik van tenant
Tenant-pakketten
Tenantgebruikers
Tenants
Tickets
Vertalingen
Afbeelding uploaden
Voortgang gebruikersbadge
Gebruikersbadges
Gebruikersmeldingen
Aanwezigheidsstatus gebruiker
Gebruiker 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: "3.0.0")
]
Of in Xcode:
- Bestand > Pakketten toevoegen...
- 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 meerdere modules:
-
Clientmodule - API-client voor de FastComments REST-API's
- Volledige typedefinities voor alle API-modellen
- Geauthenticeerde (
DefaultAPI), openbare (PublicAPI) en moderatie (ModerationAPI) methoden - Volledige async/await-ondersteuning
- Zie client/README.md voor gedetailleerde API-documentatie
-
SSO-module - Server-side Single Sign-On-hulpmiddelen
- Veilige tokengeneratie voor gebruikersauthenticatie
- Ondersteuning voor zowel eenvoudige als beveiligde SSO-modi
- Op HMAC-SHA256 gebaseerde ondertekening van tokens met CryptoKit
Snel aan de slag 
Gebruik van de openbare API
import FastCommentsSwift
// 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
// Stel uw API-sleutel in op de gedeelde configuratie (verzonden als de x-api-key header)
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "your-api-key"
// Haal reacties op met geauthentiseerde API
do {
let response = try await DefaultAPI.getComments(
tenantId: "your-tenant-id",
options: .init(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)")
}
Gebruik van de moderatie-API
import FastCommentsSwift
// Moderatiemethoden zijn geautoriseerd met een `sso`-token voor de optredende moderator
// (genereer het met FastCommentsSSO, zie de SSO sectie hierboven).
do {
let response = try await ModerationAPI.getApiComments(
options: .init(
page: 0,
count: 30,
sso: ssoToken
)
)
print("Found \(response.comments.count) comments to moderate")
for comment in response.comments {
print("Comment ID: \(comment.id), Text: \(comment.commentHTML)")
}
} catch {
print("Error: \(error)")
}
Gebruik van SSO voor authenticatie
Veilige SSO (Aanbevolen voor productie)
import FastCommentsSwift
let apiKey = "your-api-key"
// Maak veilige SSO-gebruikersgegevens aan (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 ?? "")")
// Stuur dit token naar uw front‑end voor authenticatie
} catch {
print("Error creating SSO token: \(error)")
}
Eenvoudige SSO (Voor ontwikkeling/testen)
import FastCommentsSwift
// Maak eenvoudige SSO-gebruikersgegevens aan (geen API-sleutel nodig)
let userData = SimpleSSOUserData(
username: "johndoe",
email: "user@example.com",
avatar: "https://example.com/avatar.jpg"
)
// Genereer eenvoudige 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)")
}
API-clients 
The FastComments SDK provides three API clients:
PublicAPI - Client-Safe Methods
The PublicAPI contains methods that are safe to call from client-side code (iOS/macOS apps). These methods:
- Do not require an API key
- Can use SSO tokens for authentication
- Are rate-limited per user/device
- Are suitable for end-user facing applications
Example use case: Fetching and creating comments in your iOS app
DefaultAPI - Server-Side Methods
The DefaultAPI contains authenticated methods that require an API key. These methods:
- Require your FastComments API key
- Should ONLY be called from server-side code
- Provide full access to your FastComments data
- Are rate-limited per tenant
Example use case: Administrative operations, bulk data export, user management
ModerationAPI - Moderator Dashboard Methods
The ModerationAPI provides an extensive suite of live and fast moderation APIs. Every ModerationAPI method accepts an sso parameter and can authenticate via SSO or a FastComments.com session cookie.
Example use case: Building a moderation experience for moderators of your community
IMPORTANT: Never expose your API key in client-side code. API keys should only be used server-side.
API-aanroepen doen 
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 Niet-geautoriseerde fouten
Als je 401-fouten krijgt bij het gebruik van de geauthentiseerde API:
- Controleer je API‑sleutel: Zorg ervoor dat je de juiste API‑sleutel van je FastComments-dashboard gebruikt
- Verifieer de tenant‑ID: Zorg ervoor dat de tenant‑ID overeenkomt met je account
- API‑sleutelformaat: De API‑sleutel moet ingesteld worden als de
x-api-keyheader in de gedeelde configuratie:
FastCommentsSwiftAPIConfiguration.shared.customHeaders["x-api-key"] = "YOUR_API_KEY"
- Gebruik je de verkeerde API: Zorg ervoor dat je
DefaultAPI(nietPublicAPI) gebruikt voor geauthentificeerde oproepen
SSO‑tokenproblemen
Als SSO‑tokens niet werken:
- Gebruik de veilige modus voor productie: Gebruik altijd
FastCommentsSSO.createSecure()met je API‑sleutel voor productie - Alleen server‑side: Genereer veilige SSO‑tokens op je server, en exposeer je API‑sleutel nooit aan clients
- Controleer gebruikersgegevens: Zorg ervoor dat alle verplichte velden (id, e‑mail, gebruikersnaam) zijn opgegeven
- Token‑verval: 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 het Info.plist‑bestand van je app HTTPS‑verbindingen naar fastcomments.com toestaat
- Controleer of je geen App Transport Security‑uitzonderingen gebruikt die de verbinding kunnen blokkeren
Notities 
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 
Aggregates documents by grouping them (if groupBy is provided) and applying multiple operations.
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: AggregateResponse
Example

getAuditLogs 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| limit | number | query | No | |
| skip | number | query | No | |
| order | string | query | No | |
| after | number | query | No | |
| before | number | query | No |
Respons
Retourneert: GetAuditLogsResponse
Voorbeeld

logoutPublic 
Respons
Retourneert: APIEmptyResponse
Voorbeeld

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

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

checkedCommentsForBlocked 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | Een door komma's gescheiden lijst met comment-ids. |
| sso | string | query | Nee |
Antwoord
Retourneert: CheckBlockedCommentsResponse
Voorbeeld

blockUserFromComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: BlockSuccess
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 |
Respons
Retourneert: SaveCommentsResponseWithPresence
Voorbeeld

deleteComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| contextUserId | string | query | No | |
| isLive | boolean | query | No |
Respons
Retourneert: DeleteCommentResult
Voorbeeld

deleteCommentPublic 
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: PublicAPIDeleteCommentResponse
Voorbeeld

deleteCommentVote 
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: VoteDeleteResponse
Example

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: FlagCommentResponse
Voorbeeld

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

getComments 
Parameters
| Naam | Type | Locatie | Verplicht | 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 | |
| fromDate | integer | query | Nee | |
| toDate | integer | query | Nee |
Respons
Retourneert: APIGetCommentsResponse
Voorbeeld

getCommentsPublic 
req
tenantId
urlId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| page | integer | query | No | |
| direction | string | query | No | |
| sso | string | query | No | |
| skip | integer | query | No | |
| skipChildren | integer | query | No | |
| limit | integer | query | No | |
| limitChildren | integer | query | No | |
| countChildren | boolean | query | No | |
| fetchPageForCommentId | string | query | No | |
| includeConfig | boolean | query | No | |
| countAll | boolean | query | No | |
| includei10n | boolean | query | No | |
| locale | string | query | No | |
| modules | string | query | No | |
| isCrawler | boolean | query | No | |
| includeNotificationCount | boolean | query | No | |
| asTree | boolean | query | No | |
| maxTreeDepth | integer | query | No | |
| useFullTranslationIds | boolean | query | No | |
| parentId | string | query | No | |
| searchText | string | query | No | |
| hashTags | array | query | No | |
| userId | string | query | No | |
| customConfigStr | string | query | No | |
| afterCommentId | string | query | No | |
| beforeCommentId | string | query | No |
Response
Returns: GetCommentsResponseWithPresencePublicComment
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: PublicAPIGetCommentTextResponse
Voorbeeld

getCommentVoteUserNames 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| dir | integer | query | Yes | |
| sso | string | query | No |
Antwoord
Retourneert: GetCommentVoteUserNamesSuccessResponse
Voorbeeld

lockComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Antwoord
Retourneert: APIEmptyResponse
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
Retourneert: ChangeCommentPinStatusResponse
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 |
Respons
Retourneert: APISaveCommentResponse
Voorbeeld

saveCommentsBulk 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| sendEmails | boolean | query | No | |
| populateNotifications | boolean | query | No |
Respons
Retourneert: [SaveCommentsBulkResponse]
Voorbeeld

setCommentText 
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 |
Respons
Retourneert: PublicAPISetCommentTextResponse
Voorbeeld

unBlockUserFromComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Response
Returns: UnblockSuccess
Example

unFlagComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Respons
Retourneert: FlagCommentResponse
Voorbeeld

unLockComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | Yes | |
| sso | string | query | No |
Antwoord
Geeft terug: APIEmptyResponse
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: ChangeCommentPinStatusResponse
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 |
Response
Returns: APIEmptyResponse
Example

voteComment 
Parameters
| Naam | Type | Locatie | Verplicht | 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 |
Response
Retourneert: VoteResponse
Example

getCommentsForUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| userId | string | query | Nee | |
| direction | string | query | Nee | |
| repliesToUserId | string | query | Nee | |
| page | number | query | Nee | |
| includei10n | boolean | query | Nee | |
| locale | string | query | Nee | |
| isCrawler | boolean | query | Nee |
Respons
Retourneert: GetCommentsForUserResponse
Voorbeeld

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

deleteDomainConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| domain | string | path | Yes |
Antwoord
Retourneert: DeleteDomainConfigResponse
Voorbeeld

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

getDomainConfigs 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Geeft terug: GetDomainConfigsResponse
Voorbeeld

patchDomainConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Response
Retourneert: PatchDomainConfigResponse
Voorbeeld

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

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

deleteEmailTemplate 
Parameters
| Naam | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Geeft terug: APIEmptyResponse
Voorbeeld

deleteEmailTemplateRenderError 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Response
Retourneert: APIEmptyResponse
Voorbeeld

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

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

getEmailTemplateRenderErrors 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nee |
Respons
Geeft terug: GetEmailTemplateRenderErrorsResponse
Voorbeeld

getEmailTemplates 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetEmailTemplatesResponse
Voorbeeld

renderEmailTemplate 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nee |
Respons
Geeft terug: RenderEmailTemplateResponse
Voorbeeld

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

getEventLog 
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 | Nee |
Response
Retourneert: GetEventLogResponse
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 | Nee |
Antwoord
Retourneert: GetEventLogResponse
Voorbeeld

createFeedPost 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| broadcastId | string | query | No | |
| isLive | boolean | query | No | |
| doSpamCheck | boolean | query | No | |
| skipDupCheck | boolean | query | No |
Respons
Retourneert: CreateFeedPostsResponse
Voorbeeld

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

deleteFeedPostPublic 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: DeleteFeedPostPublicResponse
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 |
Respons
Retourneert: GetFeedPostsResponse
Voorbeeld

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

getFeedPostsStats 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nee |
Respons
Geeft terug: FeedPostsStatsResponse
Voorbeeld

getUserReactsPublic 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| postIds | array | query | No | |
| sso | string | query | No |
Response
Retourneert: UserReactsResponse
Example

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

updateFeedPost 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

updateFeedPostPublic 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: CreateFeedPostResponse
Voorbeeld

flagCommentPublic 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nee |
Respons
Geeft terug: APIEmptyResponse
Voorbeeld

getGifLarge 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Respons
Retourneert: GifGetLargeResponse
Voorbeeld

getGifsSearch 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nee | |
| rating | string | query | Nee | |
| page | number | query | Nee |
Respons
Retourneert: GetGifsSearchResponse
Voorbeeld

getGifsTrending 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| locale | string | query | Nee | |
| rating | string | query | Nee | |
| page | number | query | Nee |
Respons
Retourneert: GetGifsTrendingResponse
Voorbeeld

addHashTag 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Response
Retourneert: CreateHashTagResponse
Example

addHashTagsBulk 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Retourneert: BulkCreateHashTagsResponse
Example

deleteHashTag 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Response
Retourneert: APIEmptyResponse
Example

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

patchHashTag 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| tag | string | path | Yes |
Respons
Retourneert: UpdateHashTagResponse
Voorbeeld

deleteModerationVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: VoteDeleteResponse
Voorbeeld

getApiComments 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee | |
| count | number | query | Nee | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sorts | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPIGetCommentsResponse
Voorbeeld

getApiExportStatus 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| batchJobId | string | query | Nee | |
| sso | string | query | Nee |
Response
Returns: ModerationExportStatusResponse
Voorbeeld

getApiIds 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| byIPFromComment | string | query | No | |
| filters | string | query | No | |
| searchFilters | string | query | No | |
| afterId | string | query | No | |
| demo | boolean | query | No | |
| sso | string | query | No |
Response
Retourneert: ModerationAPIGetCommentIdsResponse
Voorbeeld

getBanUsersFromComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetBannedUsersFromCommentResponse
Voorbeeld

getCommentBanStatus 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: GetCommentBanStatusResponse
Voorbeeld

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

getCount 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filter | string | query | Nee | |
| searchFilters | string | query | Nee | |
| demo | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPICountCommentsResponse
Voorbeeld

getCounts 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: GetBannedUsersCountResponse
Voorbeeld

getLogs 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPIGetLogsResponse
Example

getManualBadges 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: GetTenantManualBadgesResponse
Example

getManualBadgesForUser 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgesUserId | string | query | Nee | |
| commentId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: GetUserManualBadgesResponse
Example

getModerationComment 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeEmail | boolean | query | Nee | |
| includeIP | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationAPICommentResponse
Voorbeeld

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

getPreBanSummary 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeByUserIdAndEmail | boolean | query | No | |
| includeByIP | boolean | query | No | |
| includeByEmailDomain | boolean | query | No | |
| sso | string | query | No |
Respons
Retourneert: PreBanSummary
Voorbeeld

getSearchCommentsSummary 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sso | string | query | Nee |
Response
Retour: ModerationCommentSearchResponse
Voorbeeld

getSearchPages 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationPageSearchResponse
Voorbeeld

getSearchSites 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationSiteSearchResponse
Voorbeeld

getSearchSuggest 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| text-search | string | query | No | |
| sso | string | query | No |
Respons
Returns: ModerationSuggestResponse
Voorbeeld

getSearchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| value | string | query | No | |
| sso | string | query | No |
Response
Retourneert: ModerationUserSearchResponse
Example

getTrustFactor 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: GetUserTrustFactorResponse
Voorbeeld

getUserBanPreference 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: APIModerateGetUserBanPreferencesResponse
Example

getUserInternalProfile 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: GetUserInternalProfileResponse
Voorbeeld

postAdjustCommentVotes 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: AdjustVotesResponse
Voorbeeld

postApiExport 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| byIPFromComment | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sorts | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationExportResponse
Voorbeeld

postBanUserFromComment 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| banEmail | boolean | query | No | |
| banEmailDomain | boolean | query | No | |
| banIP | boolean | query | No | |
| deleteAllUsersComments | boolean | query | No | |
| bannedUntil | string | query | No | |
| isShadowBan | boolean | query | No | |
| updateId | string | query | No | |
| banReason | string | query | No | |
| sso | string | query | No |
Response
Retourneert: BanUserFromCommentResult
Voorbeeld

postBanUserUndo 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

postBulkPreBanSummary 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| includeByUserIdAndEmail | boolean | query | Nee | |
| includeByIP | boolean | query | Nee | |
| includeByEmailDomain | boolean | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: BulkPreBanSummary
Voorbeeld

postCommentsByIds 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationAPIChildCommentsResponse
Voorbeeld

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

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

postRestoreDeletedComment 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Example

postSetCommentApprovalStatus 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| approved | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: SetCommentApprovedResponse
Voorbeeld

postSetCommentReviewStatus 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

postSetCommentSpamStatus 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| spam | boolean | query | Nee | |
| permNotSpam | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

postSetCommentText 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: SetCommentTextResponse
Voorbeeld

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

postVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: VoteResponse
Example

putAwardBadge 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgeId | string | query | Ja | |
| userId | string | query | Nee | |
| commentId | string | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: AwardUserBadgeResponse
Voorbeeld

putCloseThread 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Returns: APIEmptyResponse
Voorbeeld

putRemoveBadge 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| badgeId | string | query | Yes | |
| userId | string | query | No | |
| commentId | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: RemoveUserBadgeResponse
Voorbeeld

putReopenThread 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Returns: APIEmptyResponse
Voorbeeld

setTrustFactor 
Parameters
| Name | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| trustFactor | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: SetUserTrustFactorResponse
Voorbeeld

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

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

getModerator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Geeft terug: GetModeratorResponse
Voorbeeld

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

sendInvite 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

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

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

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

getNotificationCount 
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 |
Respons
Returns: GetNotificationCountResponse
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: GetNotificationsResponse
Voorbeeld

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

createV1PageReact 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nee |
Response
Retourneert: CreateV1PageReact
Voorbeeld

createV2PageReact 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nee |
Response
Retourneert: CreateV1PageReact
Voorbeeld

deleteV1PageReact 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Respons
Geeft terug: CreateV1PageReact
Voorbeeld

deleteV2PageReact 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Respons
Retourneert: CreateV1PageReact
Voorbeeld

getV1PageLikes 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Response
Retourneert: GetV1PageLikes
Example

getV2PageReacts 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja |
Respons
Retourneert: GetV2PageReacts
Voorbeeld

getV2PageReactUsers 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Antwoord
Geeft terug: GetV2PageReactUsersResponse
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

getOfflineUsers 
Past commenters on the page who are NOT currently online. Sorted by displayName.
Use this after exhausting /users/online to render a “Members” section.
Cursor pagination on commenterName: server walks the partial {tenantId, urlId, commenterName} index from afterName forward via $gt, no $skip cost.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Pagina-URL-identificatie (schoongemaakt server-side). |
| afterName | string | query | No | Cursor: geef nextAfterName door van de vorige response. |
| afterUserId | string | query | No | Cursor-onderbreker: geef nextAfterUserId door van de vorige response. Vereist wanneer afterName is ingesteld zodat naam-ties geen items laten vallen. |
Response
Returns: PageUsersOfflineResponse
Example

getOnlineUsers 
Currently-online viewers of a page: people whose websocket session is subscribed to the page right now.
Returns anonCount + totalCount (room-wide subscribers, including anon viewers we don't enumerate).
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | Pagina URL identifier (server-side opgeschoond). |
| afterName | string | query | Nee | Cursor: geef nextAfterName door van de vorige respons. |
| afterUserId | string | query | Nee | Cursor-tiebreaker: geef nextAfterUserId door van de vorige respons. Vereist wanneer afterName is ingesteld zodat naam-gelijkstanden geen items verliezen. |
Response
Returns: PageUsersOnlineResponse
Example

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

getPagesPublic 
List pagina's voor een tenant. Wordt gebruikt door de FChat desktopclient om de kamerlijst te vullen.
Vereist dat enableFChat true is in de opgeloste aangepaste configuratie voor elke pagina.
Pagina's die SSO vereisen worden gefilterd op basis van de groepsrechten van de verzoekende gebruiker.
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| cursor | string | query | Nee | Onduidelijke pagineringscursor geretourneerd als nextCursor van een eerdere aanvraag. Gekoppeld aan dezelfde sortBy. |
| limit | integer | query | Nee | 1..200, standaard 50 |
| q | string | query | Nee | Optionele hoofdletterongevoelige titelvoorvoegselfilter. |
| sortBy | string | query | Nee | Sorteervolgorde. updatedAt (standaard, nieuwste eerst), commentCount (meeste reacties eerst), of title (alfabetisch). |
| hasComments | boolean | query | Nee | Indien true, alleen pagina's teruggeven met ten minste één reactie. |
Response
Returns: GetPublicPagesResponse
Example

getUsersInfo 
Bulk gebruikersinformatie voor een tenant. Gegeven userIds, retourneert weergave-informatie van User / SSOUser. Wordt gebruikt door de commentaar-widget om gebruikers te verrijken die net zijn verschenen via een presence event. Geen pagina-context: privacy wordt uniform gehandhaafd (privéprofielen worden gemaskeerd).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | Door komma's gescheiden userIds. |
Antwoord
Retourneert: PageUsersInfoResponse
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 | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

getPendingWebhookEventCount 
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: GetPendingWebhookEventCountResponse
Voorbeeld

getPendingWebhookEvents 
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 |
Response
Retourneert: GetPendingWebhookEventsResponse
Example

createQuestionConfig 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Response
Retourneert: CreateQuestionConfigResponse
Voorbeeld

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

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

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

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

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

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

getQuestionResult 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Retourneert: GetQuestionResultResponse
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 |
Respons
Returns: GetQuestionResultsResponse
Voorbeeld

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

aggregateQuestionResults 
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 |
Response
Retourneert: AggregateQuestionResultsResponse
Example

bulkAggregateQuestionResults 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nee |
Respons
Retourneert: BulkAggregateQuestionResultsResponse
Voorbeeld

combineCommentsWithQuestionResults 
Parameters
| Naam | Type | Locatie | Verplicht | 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: CombineQuestionResultsWithCommentsResponse
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 | Yes | |
| id | string | path | Yes | |
| deleteComments | boolean | query | No | |
| commentDeleteMode | string | query | No |
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 | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | integer | query | Nee |
Antwoord
Retourneert: GetSSOUsersResponse
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 | Verplicht | 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

updateSubscription 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Antwoord
Retourneert: UpdateSubscriptionAPIResponse
Voorbeeld

getTenantDailyUsages 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Respons
Retourneert: GetTenantDailyUsagesResponse
Voorbeeld

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

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

getTenantPackage 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Retourneert: GetTenantPackageResponse
Voorbeeld

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

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

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

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

deleteTenantUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| deleteComments | string | query | No | |
| commentDeleteMode | string | query | No |
Respons
Retourneert: APIEmptyResponse
Example

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

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

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

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

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

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

deleteTenant 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld

getTenant 
Parameters
| Name | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Retourneert: GetTenantResponse
Voorbeeld

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

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

changeTicketState 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Response
Retourneert: ChangeTicketStateResponse
Example

createTicket 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Antwoord
Retourneert: CreateTicketResponse
Voorbeeld

getTicket 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nee |
Antwoord
Retourneert: GetTicketResponse
Voorbeeld

getTickets 
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 |
Response
Returns: GetTicketsResponse
Example

getTranslations 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| namespace | string | path | Yes | |
| component | string | path | Yes | |
| locale | string | query | No | |
| useFullTranslationIds | boolean | query | No |
Response
Retourneert: GetTranslationsResponse
Voorbeeld

uploadImage 
Afbeelding uploaden en schalen
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| sizePreset | string | query | No | Grootte‑voorinstelling: "Default" (1000x1000px) of "CrossPlatform" (maakt groottes voor populaire apparaten) |
| urlId | string | query | No | Pagina‑id vanwaar de upload plaatsvindt, om te configureren |
Response
Retourneert: UploadImageResponse
Voorbeeld

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

getUserBadgeProgressByUserId 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Respons
Geeft terug: APIGetUserBadgeProgressResponse
Voorbeeld

getUserBadgeProgressList 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Response
Retourneert: APIGetUserBadgeProgressListResponse
Voorbeeld

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

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

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

getUserBadges 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| badgeId | string | query | Nee | |
| type | number | query | Nee | |
| displayedOnComments | boolean | query | Nee | |
| limit | number | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: APIGetUserBadgesResponse
Voorbeeld

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

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

getUserNotifications 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | No | Wordt gebruikt om te bepalen of de huidige pagina geabonneerd is. |
| pageSize | integer | query | No | |
| afterId | string | query | No | |
| includeContext | boolean | query | No | |
| afterCreatedAt | integer | query | No | |
| unreadOnly | boolean | query | No | |
| dmOnly | boolean | query | No | |
| noDm | boolean | query | No | |
| includeTranslations | boolean | query | No | |
| includeTenantNotifications | boolean | query | No | |
| sso | string | query | No |
Response
Retourneert: GetMyNotificationsResponse
Example

resetUserNotificationCount 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: ResetUserNotificationsResponse
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 |
Response
Retourneert: ResetUserNotificationsResponse
Example

updateUserNotificationCommentSubscriptionStatus 
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 |
Antwoord
Geeft terug: UpdateUserNotificationCommentSubscriptionStatusResponse
Voorbeeld

updateUserNotificationPageSubscriptionStatus 
Schakel meldingen voor een pagina in of uit. Wanneer gebruikers op een pagina zijn geabonneerd, worden meldingen aangemaakt voor nieuwe root-opmerkingen, en ook
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: UpdateUserNotificationPageSubscriptionStatusResponse
Voorbeeld

updateUserNotificationStatus 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nee |
Respons
Retourneert: UpdateUserNotificationStatusResponse
Voorbeeld

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

searchUsers 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| usernameStartsWith | string | query | No | |
| mentionGroupIds | array | query | No | |
| sso | string | query | No | |
| searchSection | string | query | No |
Respons
Retourneert: SearchUsersResult
Voorbeeld

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

createVote 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Respons
Retourneert: VoteResponse
Voorbeeld

deleteVote 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nee |
Antwoord
Retourneert: VoteDeleteResponse
Voorbeeld

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

getVotesForUser 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Response
Retourneert: GetVotesForUserResponse
Example

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.