
Taal 🇳🇱 Nederlands
Aan de slag
Gebruik
Aggregaat
Auditlogboeken
Authenticatie
Blokkeer van commentaar
Controleer geblokkeerde commentaren
Reacties
Reacties voor gebruiker
Domeinconfiguraties
E-mail sjablonen
Gebeurtenislogboek
Feedberichten
Commentaar markeren
Gifs
Hashtags
Moderatie
Moderators
Meldingteller
Meldingen
Pagina reacties
Pagina's
In afwachting zijnde webhook events
Vraagconfiguraties
Vraagresultaten
Aggregatie van vraagresultaten
SSO-gebruikers
Abonnementen
Dagelijkse gebruik huurder
Huurder pakketten
Huurder gebruikers
Huurders
Tickets
Vertalingen
Afbeelding uploaden
Gebruiker insigne voortgang
Gebruiker insignes
Gebruiker meldingen
Gebruiker aanwezigheid status
Gebruikers zoeken
Gebruikers
Stemmen
FastComments Go SDK
Dit is de officiële Go SDK voor FastComments.
Officiële Go SDK voor de FastComments API
Repository
Installatie 
go get github.com/fastcomments/fastcomments-go
Gebruik van de API‑client
Openbare API (Geen authenticatie)
De PublicAPI staat ongeauthentiseerde toegang tot openbare eindpunten toe:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Haal reacties op met PublicAPI
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Standaard API (Vereist API‑sleutel)
De DefaultAPI vereist authenticatie met behulp van uw API‑sleutel:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Maak een geauthentiseerde context met API‑sleutel
auth := context.WithValue(
context.Background(),
client.ContextAPIKeys,
map[string]client.APIKey{
"api_key": {Key: "your-api-key-here"},
},
)
// Haal reacties op met geauthentiseerde DefaultAPI
response, httpResp, err := apiClient.DefaultAPI.GetComments(auth).
TenantId("your-tenant-id").
UrlId("your-page-url-id").
Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Moderatie‑API (Moderator‑dashboard)
De ModerationAPI biedt een uitgebreide reeks live‑ en snelle moderatie‑API’s. Alle moderatiemethoden accepteren een sso‑parameter en kunnen authenticeren via SSO of een FastComments.com‑sessiecookie:
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
)
func main() {
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
// Lijst met reacties voor moderatie met ModerationAPI
response, httpResp, err := apiClient.ModerationAPI.GetApiComments(
context.Background(),
).Sso("your-sso-token").Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Gebruik 
Eenvoudige SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Maak Eenvoudige SSO-token
user := &sso.SimpleSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Avatar: "https://example.com/avatar.jpg",
}
ssoInstance := sso.NewSimple(user)
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("SSO Token:", token)
// Gebruik het SSO-token om een geauthenticeerde API-aanroep te doen
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Beveiligde SSO
package main
import (
"context"
"fmt"
"github.com/fastcomments/fastcomments-go/client"
"github.com/fastcomments/fastcomments-go/sso"
)
func main() {
// Maak Beveiligde SSO-token
user := &sso.SecureSSOUserData{
UserID: "user-123",
Email: "user@example.com",
Username: "johndoe",
Avatar: "https://example.com/avatar.jpg",
}
apiKey := "your-api-key"
ssoInstance, err := sso.NewSecure(apiKey, user)
if err != nil {
panic(err)
}
token, err := ssoInstance.CreateToken()
if err != nil {
panic(err)
}
fmt.Println("Secure SSO Token:", token)
// Gebruik het SSO-token om een geauthenticeerde API-aanroep te doen
config := client.NewConfiguration()
apiClient := client.NewAPIClient(config)
response, httpResp, err := apiClient.PublicAPI.GetCommentsPublic(
context.Background(),
"your-tenant-id",
).UrlId("your-page-url-id").Sso(token).Execute()
if err != nil {
panic(err)
}
fmt.Printf("Status: %d\n", httpResp.StatusCode)
fmt.Printf("Comments: %+v\n", response)
}
Aggregaat 
Aggegregeert documenten door ze te groeperen (als groupBy is opgegeven) en meerdere bewerkingen toe te passen. Verschillende bewerkingen (bijv. sum, countDistinct, avg, enz.) worden ondersteund.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nee | |
| includeStats | boolean | query | Nee |
Antwoord
Retourneert: AggregateResponse
Voorbeeld

HaalAuditLogsOp 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nee | |
| skip | number | query | Nee | |
| order | string | query | Nee | |
| after | number | query | Nee | |
| before | number | query | Nee |
Antwoord
Geeft terug: GetAuditLogsResponse
Voorbeeld

UitloggenPubliek 
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

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

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

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

BlokkeerGebruikerVanCommentaar 
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: BlockSuccess
Voorbeeld

CreëerCommentaarPubliek 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| sessionId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: SaveCommentsResponseWithPresence
Voorbeeld

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

VerwijderCommentaarPubliek 
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 |
Respons
Retourneert: PublicAPIDeleteCommentResponse
Voorbeeld

VerwijderCommentaarStem 
Parameters
| Naam | Type | Locatie | Verplicht | 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: VoteDeleteResponse
Voorbeeld

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

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

HaalCommentarenOp 
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 | |
| fromDate | integer | query | Nee | |
| toDate | integer | query | Nee |
Respons
Retourneert: APIGetCommentsResponse
Voorbeeld

HaalCommentarenPubliekOp 
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 |
Response
Retourneert: GetCommentsResponseWithPresencePublicComment
Voorbeeld

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

HaalCommentaarStemGebruikersnamenOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetCommentVoteUserNamesSuccessResponse
Voorbeeld

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

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

SlaCommentaarOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| sendEmails | boolean | query | Nee | |
| populateNotifications | boolean | query | Nee |
Respons
Geeft terug: APISaveCommentResponse
Voorbeeld

SlaCommentarenBulkOp 
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: []SaveCommentsBulkResponse
Voorbeeld

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

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

VerwijderVlagVanCommentaar 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Antwoord
Geeft terug: FlagCommentResponse
Voorbeeld

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

OntpinCommentaar 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | pad | Ja | |
| commentId | string | pad | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nee |
Antwoord
Retourneert: ChangeCommentPinStatusResponse
Voorbeeld

WerkCommentaarBij 
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
Retourneert: APIEmptyResponse
Voorbeeld

StemOpCommentaar 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nee | |
| sso | string | query | Nee |
Antwoord
Geeft terug: VoteResponse
Voorbeeld

HaalCommentarenVoorGebruikerOp 
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 |
Antwoord
Retourneert: GetCommentsForUserResponse
Voorbeeld

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

VerwijderDomeinConfiguratie 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Response
Geeft terug: DeleteDomainConfigResponse
Voorbeeld

HaalDomeinConfiguratieOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Response
Retourneert: GetDomainConfigResponse
Voorbeeld

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

PasDomeinConfiguratieAan 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Respons
Retourneert: PatchDomainConfigResponse
Voorbeeld

ZetDomeinConfiguratie 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Antwoord
Retourneert: PutDomainConfigResponse
Voorbeeld

CreëerE-mailSjabloon 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateEmailTemplateResponse
Voorbeeld

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

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

HaalE-mailSjabloonOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Antwoord
Geeft terug: GetEmailTemplateResponse
Voorbeeld

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

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

HaalE-mailSjablonenOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetEmailTemplatesResponse
Voorbeeld

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

WerkE-mailSjabloonBij 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Response
Geeft terug: APIEmptyResponse
Voorbeeld

HaalGebeurtenislogboekOp 
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
Geeft terug: GetEventLogResponse
Voorbeeld

HaalGlobaalGebeurtenislogboekOp 
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 |
Antwoord
Retourneert: GetEventLogResponse
Voorbeeld

CreëerFeedBericht 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nee | |
| isLive | boolean | query | Nee | |
| doSpamCheck | boolean | query | Nee | |
| skipDupCheck | boolean | query | Nee |
Respons
Retourneert: CreateFeedPostsResponse
Voorbeeld

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

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

HaalFeedBerichtenOp 
req tenantId afterId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee |
Response
Geeft terug: GetFeedPostsResponse
Voorbeeld

HaalFeedBerichtenPubliekOp 
req tenantId afterId
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nee | |
| limit | integer | query | Nee | |
| tags | array | query | Nee | |
| sso | string | query | Nee | |
| isCrawler | boolean | query | Nee | |
| includeUserInfo | boolean | query | Nee |
Response
Retourneert: PublicFeedPostsResponse
Voorbeeld

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

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

ReageerOpFeedBerichtPubliek 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ReactFeedPostResponse
Voorbeeld

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

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

RapporteerCommentaarPubliek 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nee |
Response
Retourneert: APIEmptyResponse
Voorbeeld

HaalGifGrootOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| largeInternalURLSanitized | string | query | Ja |
Respons
Geeft terug: GifGetLargeResponse
Voorbeeld

ZoekGifs 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | pad | Ja | |
| search | string | query | Ja | |
| locale | string | query | Nee | |
| rating | string | query | Nee | |
| page | number | query | Nee |
Respons
Retourneert: GetGifsSearchResponse
Voorbeeld

HaalTrendingGifsOp 
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

VoegHashtagToe 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returns: CreateHashTagResponse
Voorbeeld

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

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

HaalHashtagsOp 
Parameteren
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nee |
Antwoord
Retourneert: GetHashTagsResponse
Voorbeeld

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

VerwijderModeratieStem 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| voteId | string | path | Ja | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Reactie
Retourneert: VoteDeleteResponse
Voorbeeld

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

HaalApiExportStatusOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| batchJobId | string | query | No | |
| sso | string | query | No |
Response
Retourneert: ModerationExportStatusResponse
Example

HaalApiIdsOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| 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 |
Respons
Returns: ModerationAPIGetCommentIdsResponse
Voorbeeld

HaalGebruikersBanVanCommentaarOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Respons
Returns: GetBannedUsersFromCommentResponse
Voorbeeld

HaalCommentaarBanStatusOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Respons
Retourneert: GetCommentBanStatusResponse
Voorbeeld

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

HaalAantalOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| 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

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

HaalLogboekenOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| sso | string | query | No |
Response
Retourneert: ModerationAPIGetLogsResponse
Example

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

HaalHandmatigeInsignesVoorGebruikerOp 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| badgesUserId | string | query | Nee | |
| commentId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: GetUserManualBadgesResponse
Voorbeeld

HaalModeratieCommentaarOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| includeEmail | boolean | query | No | |
| includeIP | boolean | query | No | |
| sso | string | query | No |
Respons
Retourneert: ModerationAPICommentResponse
Voorbeeld

HaalModeratieCommentaarTekstOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nee |
Response
Retourneert: GetCommentTextResponse
Example

HaalPreBanSamenvattingOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| includeByUserIdAndEmail | boolean | query | Nee | |
| includeByIP | boolean | query | Nee | |
| includeByEmailDomain | boolean | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: PreBanSummary
Example

HaalZoekCommentaarSamenvattingOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| filters | string | query | Nee | |
| searchFilters | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationCommentSearchResponse
Voorbeeld

HaalZoekPagina'sOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationPageSearchResponse
Example

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

HaalZoekSuggestiesOp 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| text-search | string | query | Nee | |
| sso | string | query | Nee |
Respons
Retourneert: ModerationSuggestResponse
Voorbeeld

HaalZoekGebruikersOp 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| value | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: ModerationUserSearchResponse
Voorbeeld

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

HaalGebruikersBanVoorkeurOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Response
Returns: APIModerateGetUserBanPreferencesResponse
Example

HaalGebruikerInternProfielOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nee | |
| sso | string | query | Nee |
Response
Retourneert: GetUserInternalProfileResponse
Voorbeeld

PasCommentaarStemmenAan 
Parameters
| Naam | Type | Locatie | Vereist | Omschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: AdjustVotesResponse
Voorbeeld

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

PostBanGebruikerVanCommentaar 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| 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
Returns: BanUserFromCommentResult
Example

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

PostBulkPreBanSamenvatting 
Parameters
| Naam | Type | Locatie | Vereist | 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

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

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

PostVerwijderCommentaar 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Retouneert: PostRemoveCommentApiResponse
Example

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

PostStelCommentaarGoedkeuringsStatusIn 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| approved | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: SetCommentApprovedResponse
Voorbeeld

PostStelCommentaarBeoordelingStatusIn 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| reviewed | boolean | query | Nee | |
| broadcastId | string | query | Nee | |
| sso | string | query | Nee |
Respons
Returns: APIEmptyResponse
Voorbeeld

PostStelCommentaarSpamStatusIn 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| spam | boolean | query | No | |
| permNotSpam | boolean | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Response
Returns: APIEmptyResponse
Example

PostStelCommentaarTekstIn 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: SetCommentTextResponse
Voorbeeld

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

PostStem 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| commentId | string | path | Yes | |
| direction | string | query | No | |
| broadcastId | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: VoteResponse
Voorbeeld

KenInsigneToe 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| 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: AwardUserBadgeResponse
Voorbeeld

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

VerwijderInsigne 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| 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
Returns: RemoveUserBadgeResponse
Voorbeeld

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

StelVertrouwensfactorIn 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| trustFactor | string | query | No | |
| sso | string | query | No |
Respons
Retourneert: SetUserTrustFactorResponse
Voorbeeld

CreëerModerator 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateModeratorResponse
Voorbeeld

VerwijderModerator 
Parameters
| Name | Type | Location | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nee |
Antwoord
Retourneert: APIEmptyResponse
Voorbeeld

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

HaalModeratorsOp 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Response
Retourneert: GetModeratorsResponse
Voorbeeld

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

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

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

HaalGebufferdeMeldingtellerOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Geeft terug: GetCachedNotificationCountResponse
Voorbeeld

HaalMeldingtellerOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee |
Antwoord
Retourneert: GetNotificationCountResponse
Voorbeeld

HaalMeldingenOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| urlId | string | query | Nee | |
| fromCommentId | string | query | Nee | |
| viewed | boolean | query | Nee | |
| type | string | query | Nee | |
| skip | number | query | Nee |
Response
Retourneert: GetNotificationsResponse
Voorbeeld

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

CreëerV1PaginaReactie 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| title | string | query | Nee |
Respons
Retourneert: CreateV1PageReact
Voorbeeld

CreëerV2PaginaReactie 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja | |
| title | string | query | Nee |
Respons
Retourneert: CreateV1PageReact
Voorbeeld

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

VerwijderV2PaginaReactie 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | |
| id | string | query | Yes |
Response
Retourneert: CreateV1PageReact
Example

HaalV1PaginaLikesOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes |
Response
Retourneert: GetV1PageLikes
Voorbeeld

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

HaalV2PaginaReactGebruikersOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| id | string | query | Ja |
Response
Retourneert: GetV2PageReactUsersResponse
Voorbeeld

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

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

HaalOfflineGebruikersOp 
Eerdere commentatoren op de pagina die NIET momenteel online zijn. Gesorteerd op displayName. Gebruik dit nadat u /users/online hebt uitgeput om een "Leden"-sectie weer te geven. Cursor-paginering op commenterName: de server loopt de partiële {tenantId, urlId, commenterName} index vanaf afterName voorwaarts via $gt, geen $skip-kosten.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Pagina-URL-identificatie (opgeschoond aan de serverzijde). |
| afterName | string | query | No | Cursor: geef nextAfterName door uit de vorige respons. |
| afterUserId | string | query | No | Cursor-tiebreaker: geef nextAfterUserId door uit de vorige respons. Vereist wanneer afterName is ingesteld zodat bij gelijke namen geen items wegvallen. |
Respons
Retourneert: PageUsersOfflineResponse
Voorbeeld

HaalOnlineGebruikersOp 
Momenteel online kijkers van een pagina: mensen wiens websocket-sessie op dit moment op de pagina is geabonneerd. Retourneert anonCount + totalCount (room-brede abonnees, inclusief anonieme kijkers die we niet afzonderlijk opsommen).
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| urlId | string | query | Yes | Pagina-URL-identificatie (op de server opgeschoond). |
| afterName | string | query | No | Cursor: geef nextAfterName door uit het vorige antwoord. |
| afterUserId | string | query | No | Tiebreaker voor cursor: geef nextAfterUserId door uit het vorige antwoord. Vereist wanneer afterName is ingesteld zodat bij gelijke namen geen vermeldingen wegvallen. |
Response
Retourneert: PageUsersOnlineResponse
Voorbeeld

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

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

HaalPagina'sPubliekOp 
Lijst met pagina's voor een tenant. Wordt gebruikt door de FChat-desktopclient om de kamerlijst te vullen.
Vereist dat enableFChat op true staat in de opgeloste aangepaste configuratie voor elke pagina.
Pagina's die SSO vereisen, worden gefilterd op basis van de groepstoegang van de aanvragende gebruiker.
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| cursor | string | query | No | Ondoorzichtige paginacursor teruggegeven als nextCursor van een eerdere aanvraag. Gebonden aan dezelfde sortBy. |
| limit | integer | query | No | 1..200, standaard 50 |
| q | string | query | No | Optionele case-insensitieve prefixfilter voor titels. |
| sortBy | string | query | No | Sorteervolgorde. updatedAt (standaard, nieuwste eerst), commentCount (meeste reacties eerst), of title (alfabetisch). |
| hasComments | boolean | query | No | Als true, retourneer alleen pagina's met ten minste één opmerking. |
Respons
Retourneert: GetPublicPagesResponse
Voorbeeld

HaalGebruikersInfoOp 
Bulk gebruikersinformatie voor een tenant. Gegeven userIds, retourneer weergavegegevens van User / SSOUser. Wordt gebruikt door de commentaar-widget om gebruikers aan te vullen die zojuist verschenen via een presence-evenement. Geen paginacontext: privacy wordt uniform afgedwongen (privéprofielen worden gemaskeerd).
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| ids | string | query | Yes | Door komma's gescheiden userIds. |
Response
Retourneert: PageUsersInfoResponse
Voorbeeld

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

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

HaalInAfwachtingZijndeWebhookEventAantalOp 
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

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

CreëerVraagConfiguratie 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Respons
Retourneert: CreateQuestionConfigResponse
Voorbeeld

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

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

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

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

CreëerVraagResultaat 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: CreateQuestionResultResponse
Voorbeeld

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

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

HaalVraagResultatenOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nee | |
| userId | string | query | Nee | |
| startDate | string | query | Nee | |
| questionId | string | query | Nee | |
| questionIds | string | query | Nee | |
| skip | number | query | Nee |
Respons
Retourneert: GetQuestionResultsResponse
Voorbeeld

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

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

BulkAggregateerVraagResultaten 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| forceRecalculate | boolean | query | Nee |
Respons
Retourneert: BulkAggregateQuestionResultsResponse
Voorbeeld

CombineerCommentaarMetVraagResultaten 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nee | |
| questionIds | array | query | Nee | |
| urlId | string | query | Nee | |
| startDate | string | query | Nee | |
| forceRecalculate | boolean | query | Nee | |
| minValue | number | query | Nee | |
| maxValue | number | query | Nee | |
| limit | number | query | Nee |
Antwoord
Geeft terug: CombineQuestionResultsWithCommentsResponse
Voorbeeld

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

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

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

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

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

PasSSOGebruikerAan 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nee |
Antwoord
Geeft terug: PatchSSOUserAPIResponse
Voorbeeld

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

CreëerAbonnement 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateSubscriptionAPIResponse
Voorbeeld

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

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

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

HaalHuurderDagelijkseGebruikOp 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| yearNumber | number | query | Nee | |
| monthNumber | number | query | Nee | |
| dayNumber | number | query | Nee | |
| skip | number | query | Nee |
Antwoord
Retourneert: GetTenantDailyUsagesResponse
Voorbeeld

CreëerHuurderPakket 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: CreateTenantPackageResponse
Voorbeeld

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

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

HaalHuurderPakkettenOp 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nee |
Respons
Retourneert: GetTenantPackagesResponse
Voorbeeld

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

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

CreëerHuurderGebruiker 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Retourneert: CreateTenantUserResponse
Voorbeeld

VerwijderHuurderGebruiker 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nee | |
| commentDeleteMode | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

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

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

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

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

WerkHuurderGebruikerBij 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nee |
Respons
Retourneert: APIEmptyResponse
Voorbeeld

CreëerHuurder 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes |
Antwoord
Retourneert: CreateTenantResponse
Voorbeeld

VerwijderHuurder 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nee |
Antwoord
Geeft terug: APIEmptyResponse
Voorbeeld

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

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

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

WijzigTicketStatus 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returneert: ChangeTicketStateResponse
Voorbeeld

CreëerTicket 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Respons
Geeft terug: CreateTicketResponse
Voorbeeld

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

HaalTicketsOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nee | |
| state | number | query | Nee | |
| skip | number | query | Nee | |
| limit | number | query | Nee |
Respons
Retourneert: GetTicketsResponse
Voorbeeld

HaalVertalingenOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| namespace | string | path | Ja | |
| component | string | path | Ja | |
| locale | string | query | Nee | |
| useFullTranslationIds | boolean | query | Nee |
Antwoord
Retourneert: GetTranslationsResponse
Voorbeeld

AfbeeldingUploaden 
Upload and resize an image
Parameters
| Naam | Type | Location | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| sizePreset | string | query | Nee | Groottevoorinstelling: "Default" (1000x1000px) of "CrossPlatform" (maakt formaten voor populaire apparaten) |
| urlId | string | query | Nee | Pagina-id waarvan de upload plaatsvindt, voor configuratie |
Response
Retourneert: UploadImageResponse
Voorbeeld

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

HaalGebruikerInsigneVoortgangOpGebruikerId 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Antwoord
Geeft terug: APIGetUserBadgeProgressResponse
Voorbeeld

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

CreëerGebruikerInsigne 
Parameters
| Naam | Type | Locatie | Verplicht | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Antwoord
Retourneert: APICreateUserBadgeResponse
Voorbeeld

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

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

HaalGebruikerInsignesOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| badgeId | string | query | No | |
| type | number | query | No | |
| displayedOnComments | boolean | query | No | |
| limit | number | query | No | |
| skip | number | query | No |
Reactie
Geeft terug: APIGetUserBadgesResponse
Voorbeeld

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

HaalGebruikerMeldingtellerOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nee |
Response
Geeft terug: GetUserNotificationCountResponse
Voorbeeld

HaalGebruikerMeldingenOp 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nee | Wordt gebruikt om te bepalen of de huidige pagina is geabonneerd. |
| 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 | |
| includeTenantNotifications | boolean | query | Nee | |
| sso | string | query | Nee |
Antwoord
Retourneert: GetMyNotificationsResponse
Voorbeeld

ResetGebruikerMeldingteller 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| sso | string | query | No |
Respons
Retourneert: ResetUserNotificationsResponse
Voorbeeld

ResetGebruikerMeldingen 
Parameters
| Naam | Type | Locatie | Verplicht | 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 |
Antwoord
Geeft terug: ResetUserNotificationsResponse
Voorbeeld

WerkGebruikerMeldingCommentaarAbboStatusBij 
Schakelt meldingen voor een specifieke reactie in of uit.
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| optedInOrOut | string | path | Yes | |
| commentId | string | query | Yes | |
| sso | string | query | No |
Antwoord
Geeft terug: UpdateUserNotificationCommentSubscriptionStatusResponse
Voorbeeld

WerkGebruikerMeldingPaginaAbboStatusBij 
Schakel meldingen voor een pagina in of uit. Wanneer gebruikers zich op een pagina hebben geabonneerd, worden meldingen aangemaakt voor nieuwe rootreacties, en ook
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| urlId | string | query | Yes | |
| url | string | query | Yes | |
| pageTitle | string | query | Yes | |
| subscribedOrUnsubscribed | string | path | Yes | |
| sso | string | query | No |
Response
Retourneert: UpdateUserNotificationPageSubscriptionStatusResponse
Voorbeeld

WerkGebruikerMeldingStatusBij 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| notificationId | string | path | Yes | |
| newStatus | string | path | Yes | |
| sso | string | query | No |
Response
Geeft terug: UpdateUserNotificationStatusResponse
Voorbeeld

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

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

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

CreëerStem 
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 |
Antwoord
Retourneert: VoteResponse
Voorbeeld

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

HaalStemmenOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Respons
Geeft terug: GetVotesResponse
Voorbeeld

HaalStemmenVoorGebruikerOp 
Parameters
| Naam | Type | Locatie | Vereist | Beschrijving |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nee | |
| anonUserId | string | query | Nee |
Antwoord
Retourneert: GetVotesForUserResponse
Voorbeeld

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