
Sprog 🇩🇰 Dansk
Kom godt i gang
Dokumentation
Brug
Aggregering
Revisionslog
Bloker fra kommentar
Kontroller blokerede kommentarer
Kommentarer
Domænekonfigurationer
E-mail-skabeloner
Hændelseslog
Feed-indlæg
Rapportér kommentar
Hashtags
Moderatorer
Notifikationstælling
Notifikationer
Sider
Ventende webhook-hændelser
Spørgsmålskonfigurationer
Spørgsmålresultater
Aggregering af spørgsmålresultater
SSO-brugere
Abonnementer
Lejer dagligt forbrug
Lejerpakker
Lejerbrugere
Lejere
Billetter
Upload billede
Brugerbadge-fremgang
Brugerbadges
Brugernotifikationer
Brugertilstedeværelsesstatus
Brugersøgning
Brugere
Stemmer
FastComments Ruby SDK
Dette er den officielle Ruby SDK for FastComments.
Officiel Ruby SDK til FastComments API'en
Repository
Installation 
Tilføj denne linje til din applikations Gemfile:
gem 'fastcomments'
Og kør derefter:
bundle install
Eller installer den selv som:
gem install fastcomments
Bibliotekets indhold
Dette bibliotek indeholder den genererede API-klient og SSO-værktøjer, der gør det lettere at arbejde med API'et.
Offentlige vs beskyttede API'er
For API-klienten er der to klasser, DefaultApi og PublicApi. DefaultApi indeholder metoder, der kræver din API-nøgle, og PublicApi indeholder API-opkald
der kan foretages direkte fra en browser/mobil enhed/etc uden autentificering.
Hurtigstart 
Brug af godkendte API'er (DefaultApi)
Vigtigt: Du skal sætte din API-nøgle på ApiClient, inden du foretager godkendte anmodninger. Hvis du ikke gør det, vil anmodninger mislykkes med en 401-fejl.
require 'fastcomments-client'
# Opret og konfigurer API-klienten
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
# KRÆVET: Angiv din API-nøgle (find den på dit FastComments-dashboard)
config.api_key['x-api-key'] = 'YOUR_API_KEY_HERE'
# Opret API-forekomsten med den konfigurerede klient
api = FastCommentsClient::DefaultApi.new(api_client)
# Nu kan du foretage godkendte API-opkald
begin
# Eksempel: Tilføj en SSO-bruger
user_data = {
id: 'user-123',
email: 'user@example.com',
displayName: 'John Doe'
}
response = api.add_sso_user('YOUR_TENANT_ID', user_data)
puts "User created: #{response}"
rescue FastCommentsClient::ApiError => e
puts "Error: #{e.response_body}"
# Almindelige fejl:
# - 401: API-nøglen mangler eller er ugyldig
# - 400: Anmodningsvalidering mislykkedes
end
Brug af offentlige API'er (PublicApi)
Offentlige endpoints kræver ikke godkendelse:
require 'fastcomments-client'
public_api = FastCommentsClient::PublicApi.new
begin
response = public_api.get_comments_public(
tenant_id: 'YOUR_TENANT_ID',
url_id: 'page-url-id'
)
puts response
rescue FastCommentsClient::ApiError => e
puts e.message
end
Almindelige problemer
- 401 "missing-api-key" fejl: Sørg for at sætte
config.api_key['x-api-key'] = 'YOUR_KEY'før du opretter DefaultApi-instansen. - Forkert API-klasse: Brug
DefaultApifor server-side godkendte anmodninger,PublicApifor klient-side/offentlige anmodninger. - Null API-nøgle: SDK'en vil stiltiende springe autentificering over, hvis API-nøglen er null, hvilket fører til 401-fejl.
Noter 
Broadcast-id'er
Du vil se, at du skal sende et broadcastId i nogle API-opkald. Når du modtager hændelser, får du dette ID tilbage, så du ved, at du skal ignorere hændelsen, hvis du har tænkt dig at anvende ændringer optimistisk på klienten
(hvilket du sandsynligvis vil gøre, da det giver den bedste oplevelse). Send en UUID her. ID'et bør være tilstrækkeligt unikt til ikke at forekomme to gange i en browsersession.
SSO (Single Sign-On)
For SSO-eksempler, se nedenfor.
Brug af SSO 
Simpel SSO
require 'fastcomments'
require 'fastcomments-client'
# Create Simple SSO token
user = FastComments::SSO::SimpleSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
avatar: 'https://example.com/avatar.jpg'
)
sso = FastComments::SSO::FastCommentsSSO.new_simple(user)
token = sso.create_token
puts "SSO Token: #{token}"
# Use the SSO token to make an authenticated API call
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
Sikker SSO
require 'fastcomments'
require 'fastcomments-client'
# Create Secure SSO token
user = FastComments::SSO::SecureSSOUserData.new(
user_id: 'user-123',
email: 'user@example.com',
username: 'johndoe',
avatar: 'https://example.com/avatar.jpg'
)
api_key = 'your-api-key'
sso = FastComments::SSO::FastCommentsSSO.new_secure(api_key, user)
token = sso.create_token
puts "Secure SSO Token: #{token}"
# Use the SSO token to make an authenticated API call
config = FastCommentsClient::Configuration.new
api_client = FastCommentsClient::ApiClient.new(config)
public_api = FastCommentsClient::PublicApi.new(api_client)
response = public_api.get_comments_public(
tenant_id: 'your-tenant-id',
url_id: 'your-page-url-id',
sso: token
)
puts "Status: #{response}"
Aggreger 
Aggregerer dokumenter ved at gruppere dem (hvis groupBy er angivet) og anvende flere operationer. Forskellige operationer (f.eks. sum, countDistinct, avg osv.) understøttes.
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| parentTenantId | string | query | Nej | |
| includeStats | boolean | query | Nej |
Svar
Returnerer: AggregationResponse
Eksempel

Hent revisionslog 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| limit | number | query | Nej | |
| skip | number | query | Nej | |
| order | string | query | Nej | |
| after | number | query | Nej | |
| before | number | query | Nej |
Respons
Returnerer: GetAuditLogs200Response
Eksempel

Bloker fra kommentar (offentlig) 
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Response
Returnerer: BlockFromCommentPublic200Response
Eksempel

Ophæv blokering af kommentar (offentlig) 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UnBlockCommentPublic200Response
Eksempel

Kontroller kommentarer for blokerede 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentIds | string | query | Ja | A comma separated list of comment ids. |
| sso | string | query | Nej |
Respons
Returnerer: CheckedCommentsForBlocked200Response
Eksempel

Bloker bruger fra kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: BlockFromCommentPublic200Response
Eksempel

Opret offentlig kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateCommentPublic200Response
Eksempel

Slet kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| isLive | boolean | query | Nej |
Svar
Returnerer: DeleteComment200Response
Eksempel

Slet offentlig kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: DeleteCommentPublic200Response
Eksempel

Slet stemme på kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Yes | |
| commentId | string | path | Yes | |
| voteId | string | path | Yes | |
| urlId | string | query | Yes | |
| broadcastId | string | query | Yes | |
| editKey | string | query | No | |
| sso | string | query | No |
Svar
Returnerer: DeleteCommentVote200Response
Eksempel

Rapportér kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: FlagComment200Response
Eksempel

Hent kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetComment200Response
Eksempel

Hent kommentartekst 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentText200Response
Eksempel

Hent brugernavne for kommentarstemmer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| dir | integer | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetCommentVoteUserNames200Response
Eksempel

Hent kommentarer 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| page | integer | query | No | |
| limit | integer | query | No | |
| skip | integer | query | No | |
| asTree | boolean | query | No | |
| skipChildren | integer | query | No | |
| limitChildren | integer | query | No | |
| maxTreeDepth | integer | query | No | |
| urlId | string | query | No | |
| userId | string | query | No | |
| anonUserId | string | query | No | |
| contextUserId | string | query | No | |
| hashTag | string | query | No | |
| parentId | string | query | No | |
| direction | string | query | No |
Svar
Returnerer: GetComments200Response
Eksempel

Hent offentlige kommentarer 
req tenantId urlId
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| page | integer | query | Nej | |
| direction | string | query | Nej | |
| sso | string | query | Nej | |
| skip | integer | query | Nej | |
| skipChildren | integer | query | Nej | |
| limit | integer | query | Nej | |
| limitChildren | integer | query | Nej | |
| countChildren | boolean | query | Nej | |
| fetchPageForCommentId | string | query | Nej | |
| includeConfig | boolean | query | Nej | |
| countAll | boolean | query | Nej | |
| includei10n | boolean | query | Nej | |
| locale | string | query | Nej | |
| modules | string | query | Nej | |
| isCrawler | boolean | query | Nej | |
| includeNotificationCount | boolean | query | Nej | |
| asTree | boolean | query | Nej | |
| maxTreeDepth | integer | query | Nej | |
| useFullTranslationIds | boolean | query | Nej | |
| parentId | string | query | Nej | |
| searchText | string | query | Nej | |
| hashTags | array | query | Nej | |
| userId | string | query | Nej | |
| customConfigStr | string | query | Nej | |
| afterCommentId | string | query | Nej | |
| beforeCommentId | string | query | Nej |
Svar
Returnerer: GetCommentsPublic200Response
Eksempel

Lås kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: LockComment200Response
Eksempel

Fastgør kommentar 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: PinComment200Response
Eksempel

Gem kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| sendEmails | boolean | query | Nej | |
| populateNotifications | boolean | query | Nej |
Svar
Returnerer: SaveComment200Response
Eksempel

Gem kommentarer (bulk) 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| sendEmails | boolean | query | Nej | |
| populateNotifications | boolean | query | Nej |
Svar
Returnerer: Array<SaveComment200Response>
Eksempel

Sæt kommentartekst 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| editKey | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: SetCommentText200Response
Eksempel

Ophæv blokering af bruger fra kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| userId | string | query | No | |
| anonUserId | string | query | No |
Svar
Returnerer: UnBlockCommentPublic200Response
Eksempel

Fjern rapportering af kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: FlagComment200Response
Eksempel

Fjern låsning af kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| broadcastId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: LockComment200Response
Eksempel

Fjern fastgørelse af kommentar 
Parametre
| Name | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | sti | Ja | |
| commentId | string | sti | Ja | |
| broadcastId | string | forespørgsel | Ja | |
| sso | string | forespørgsel | Nej |
Svar
Returnerer: PinComment200Response
Eksempel

Opdater kommentar 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| contextUserId | string | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| isLive | boolean | query | Nej |
Respons
Returnerer: FlagCommentPublic200Response
Eksempel

Stem på kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| commentId | string | path | Ja | |
| urlId | string | query | Ja | |
| broadcastId | string | query | Ja | |
| sessionId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: VoteComment200Response
Eksempel

Tilføj domænekonfiguration 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: AddDomainConfig200Response
Eksempel

Slet domænekonfiguration 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Svar
Returnerer: DeleteDomainConfig200Response
Eksempel

Hent domænekonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domain | string | path | Ja |
Svar
Returnerer: GetDomainConfig200Response
Eksempel

Hent domænekonfigurationer 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetDomainConfigs200Response
Eksempel

Patch domænekonfiguration 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Svar
Returnerer: GetDomainConfig200Response
Eksempel

Erstat domænekonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| domainToUpdate | string | path | Ja |
Svar
Returnerer: GetDomainConfig200Response
Eksempel

Opret e-mail-skabelon 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateEmailTemplate200Response
Eksempel

Slet e-mail-skabelon 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Slet gengivelsesfejl for e-mail-skabelon 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| errorId | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent e-mail-skabelon 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: GetEmailTemplate200Response
Eksempel

Hent definitioner for e-mail-skabeloner 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetEmailTemplateDefinitions200Response
Eksempel

Hent gengivelsesfejl for e-mail-skabeloner 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplateRenderErrors200Response
Eksempel

Hent e-mail-skabeloner 
Parametre
| Navn | Type | Placering | Krævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetEmailTemplates200Response
Eksempel

Gengiv e-mail-skabelon 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| locale | string | query | Nej |
Svar
Returnerer: RenderEmailTemplate200Response
Eksempel

Opdater e-mail-skabelon 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent hændelseslog 
req tenantId urlId userIdWS
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Ja |
Svar
Returnerer: GetEventLog200Response
Eksempel

Hent global hændelseslog 
req tenantId urlId userIdWS
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| userIdWS | string | query | Ja | |
| startTime | integer | query | Ja | |
| endTime | integer | query | Ja |
Respons
Returnerer: GetEventLog200Response
Eksempel

Opret feed-indlæg 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| broadcastId | string | query | Nej | |
| isLive | boolean | query | Nej | |
| doSpamCheck | boolean | query | Nej | |
| skipDupCheck | boolean | query | Nej |
Svar
Returnerer: CreateFeedPost200Response
Eksempel

Opret offentligt feed-indlæg 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateFeedPostPublic200Response
Eksempel

Slet offentligt feed-indlæg 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: DeleteFeedPostPublic200Response
Eksempel

Hent feed-indlæg 
req tenantId afterId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nej | |
| limit | integer | query | Nej | |
| tags | array | query | Nej |
Svar
Returnerer: GetFeedPosts200Response
Eksempel

Hent offentlige feed-indlæg 
req tenantId afterId
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| afterId | string | query | Nej | |
| limit | integer | query | Nej | |
| tags | array | query | Nej | |
| sso | string | query | Nej | |
| isCrawler | boolean | query | Nej | |
| includeUserInfo | boolean | query | Nej |
Svar
Returnerer: GetFeedPostsPublic200Response
Eksempel

Hent statistik for feed-indlæg 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetFeedPostsStats200Response
Eksempel

Hent offentlige brugerreaktioner 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postIds | array | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserReactsPublic200Response
Eksempel

Reager på offentligt feed-indlæg 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| isUndo | boolean | query | Nej | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ReactFeedPostPublic200Response
Eksempel

Opdater feed-indlæg 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Opdater offentligt feed-indlæg 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| postId | string | path | Ja | |
| broadcastId | string | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: CreateFeedPostPublic200Response
Eksempel

Rapportér offentlig kommentar 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | path | Ja | |
| isFlagged | boolean | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Tilføj hashtag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Nej |
Svar
Returnerer: AddHashTag200Response
Eksempel

Tilføj hashtags (bulk) 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Nej |
Svar
Returnerer: AddHashTagsBulk200Response
Eksempel

Slet hashtag 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tag | string | path | Yes | |
| tenantId | string | query | No |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent hashtags 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| page | number | query | Nej |
Svar
Returnerer: GetHashTags200Response
Eksempel

Patch hashtag 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tag | string | path | Ja | |
| tenantId | string | query | Nej |
Svar
Returnerer: PatchHashTag200Response
Eksempel

Opret moderator 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateModerator200Response
Eksempel

Slet moderator 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sendEmail | string | query | Nej |
Respons
Returnerer: FlagCommentPublic200Response
Eksempel

Hent moderator 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetModerator200Response
Eksempel

Hent moderatorer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetModerators200Response
Eksempel

Send invitation 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| fromName | string | query | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Opdater moderator 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Slet notifikationstælling 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: FlagCommentPublic200Response
Eksempel

Hent cachet notifikationstælling 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetCachedNotificationCount200Response
Eksempel

Hent notifikationstælling 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| urlId | string | query | Nej | |
| fromCommentId | string | query | Nej | |
| viewed | boolean | query | Nej | |
| type | string | query | Nej |
Svar
Returnerer: GetNotificationCount200Response
Eksempel

Hent notifikationer 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| userId | string | query | No | |
| urlId | string | query | No | |
| fromCommentId | string | query | No | |
| viewed | boolean | query | No | |
| type | string | query | No | |
| skip | number | query | No |
Respons
Returnerer: GetNotifications200Response
Eksempel

Opdater notifikation 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Tilføj side 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: AddPageAPIResponse
Eksempel

Slet side 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: DeletePageAPIResponse
Eksempel

Hent side efter url-id 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetPageByURLIdAPIResponse
Eksempel

Hent sider 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: GetPagesAPIResponse
Eksempel

Patch side 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: PatchPageAPIResponse
Eksempel

Slet ventende webhook-hændelse 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent antal ventende webhook-hændelser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nej | |
| externalId | string | query | Nej | |
| eventType | string | query | Nej | |
| type | string | query | Nej | |
| domain | string | query | Nej | |
| attemptCountGT | number | query | Nej |
Svar
Returnerer: GetPendingWebhookEventCount200Response
Eksempel

Hent ventende webhook-hændelser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Nej | |
| externalId | string | query | Nej | |
| eventType | string | query | Nej | |
| type | string | query | Nej | |
| domain | string | query | Nej | |
| attemptCountGT | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetPendingWebhookEvents200Response
Eksempel

Opret spørgsmålskonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: CreateQuestionConfig200Response
Eksempel

Slet spørgsmålskonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent spørgsmålskonfiguration 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetQuestionConfig200Response
Eksempel

Hent spørgsmålskonfigurationer 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetQuestionConfigs200Response
Eksempel

Opdater spørgsmålskonfiguration 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Opret spørgsmålresultat 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateQuestionResult200Response
Eksempel

Slet spørgsmålresultat 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent spørgsmålresultat 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetQuestionResult200Response
Eksempel

Hent spørgsmålresultater 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Nej | |
| userId | string | query | Nej | |
| startDate | string | query | Nej | |
| questionId | string | query | Nej | |
| questionIds | string | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetQuestionResults200Response
Eksempel

Opdater spørgsmålresultat 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Aggreger spørgsmålresultater 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nej | |
| questionIds | array | query | Nej | |
| urlId | string | query | Nej | |
| timeBucket | string | query | Nej | |
| startDate | string | query | Nej | |
| forceRecalculate | boolean | query | Nej |
Svar
Returnerer: AggregateQuestionResults200Response
Eksempel

Aggreger spørgsmålresultater (bulk) 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| forceRecalculate | boolean | query | No |
Respons
Returnerer: BulkAggregateQuestionResults200Response
Eksempel

Kombinér kommentarer med spørgsmålresultater 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| questionId | string | query | Nej | |
| questionIds | array | query | Nej | |
| urlId | string | query | Nej | |
| startDate | string | query | Nej | |
| forceRecalculate | boolean | query | Nej | |
| minValue | number | query | Nej | |
| maxValue | number | query | Nej | |
| limit | number | query | Nej |
Svar
Returnerer: CombineCommentsWithQuestionResults200Response
Eksempel

Tilføj SSO-bruger 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: AddSSOUserAPIResponse
Eksempel

Slet SSO-bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | boolean | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: DeleteSSOUserAPIResponse
Eksempel

Hent SSO-bruger efter e-mail 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| string | path | Ja |
Svar
Returnerer: GetSSOUserByEmailAPIResponse
Eksempel

Hent SSO-bruger efter id 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetSSOUserByIdAPIResponse
Eksempel

Hent SSO-brugere 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| skip | integer | query | No |
Respons
Returnerer: GetSSOUsers200Response
Eksempel

Patch SSO-bruger 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PatchSSOUserAPIResponse
Eksempel

Erstat SSO-bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | boolean | query | Nej |
Svar
Returnerer: PutSSOUserAPIResponse
Eksempel

Opret abonnement 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateSubscriptionAPIResponse
Eksempel

Slet abonnement 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Respons
Returnerer: DeleteSubscriptionAPIResponse
Eksempel

Hent abonnementer 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetSubscriptionsAPIResponse
Eksempel

Opdater abonnement 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Response
Returnerer: UpdateSubscriptionAPIResponse
Eksempel

Hent lejers daglige forbrug 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| yearNumber | number | query | No | |
| monthNumber | number | query | No | |
| dayNumber | number | query | No | |
| skip | number | query | No |
Svar
Returnerer: GetTenantDailyUsages200Response
Eksempel

Opret lejerpakke 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Svar
Returnerer: CreateTenantPackage200Response
Eksempel

Slet lejerpakke 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent lejerpakke 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Respons
Returnerer: GetTenantPackage200Response
Eksempel

Hent lejerpakker 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantPackages200Response
Eksempel

Erstat lejerpakke 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Opdater lejerpakke 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: FlagCommentPublic200Response
Eksempel

Opret lejerbruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: CreateTenantUser200Response
Eksempel

Slet lejerbruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| deleteComments | string | query | Nej | |
| commentDeleteMode | string | query | Nej |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent lejerbruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetTenantUser200Response
Eksempel

Hent lejerbrugere 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| skip | number | query | Nej |
Svar
Returnerer: GetTenantUsers200Response
Eksempel

Erstat lejerbruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| updateComments | string | query | Nej |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Send login-link 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| redirectURL | string | query | Nej |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Opdater lejerbruger 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes | |
| updateComments | string | query | No |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Opret lejer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | forespørgsel | Ja |
Response
Returnerer: CreateTenant200Response
Eksempel

Slet lejer 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| sure | string | query | Nej |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Hent lejer 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetTenant200Response
Eksempel

Hent lejere 
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| meta | string | query | Nej | |
| skip | number | query | Nej |
Response
Returnerer: GetTenants200Response
Eksempel

Opdater lejer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: FlagCommentPublic200Response
Eksempel

Ændr billettilstand 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: ChangeTicketState200Response
Eksempel

Opret billet 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Ja |
Svar
Returnerer: CreateTicket200Response
Eksempel

Hent billet 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| userId | string | query | Nej |
Svar
Returnerer: GetTicket200Response
Eksempel

Hent billetter 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| state | number | query | Nej | |
| skip | number | query | Nej | |
| limit | number | query | Nej |
Svar
Returnerer: GetTickets200Response
Eksempel

Upload billede 
Upload og ændre størrelse på et billede
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| sizePreset | string | query | Nej | Størrelsesforindstilling: "Default" (1000x1000px) eller "CrossPlatform" (opretter størrelser til populære enheder) |
| urlId | string | query | Nej | Side-id som uploaden sker fra, til konfiguration |
Svar
Returnerer: UploadImageResponse
Eksempel

Hent brugerbadge-fremgang efter id 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetUserBadgeProgressById200Response
Eksempel

Hent brugerbadge-fremgang efter bruger-id 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | path | Ja |
Svar
Returnerer: GetUserBadgeProgressById200Response
Eksempel

Hent liste over brugerbadge-fremgang 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| limit | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetUserBadgeProgressList200Response
Eksempel

Opret brugerbadge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja |
Respons
Returnerer: CreateUserBadge200Response
Eksempel

Slet brugerbadge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Yes | |
| id | string | path | Yes |
Svar
Returnerer: UpdateUserBadge200Response
Eksempel

Hent brugerbadge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Respons
Returnerer: GetUserBadge200Response
Eksempel

Hent brugerbadges 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| userId | string | query | Nej | |
| badgeId | string | query | Nej | |
| type | number | query | Nej | |
| displayedOnComments | boolean | query | Nej | |
| limit | number | query | Nej | |
| skip | number | query | Nej |
Svar
Returnerer: GetUserBadges200Response
Eksempel

Opdater brugerbadge 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Response
Returnerer: UpdateUserBadge200Response
Eksempel

Hent brugers notifikationstælling 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserNotificationCount200Response
Eksempel

Hent brugers notifikationer 
Parametre
| Navn | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| pageSize | integer | query | Nej | |
| afterId | string | query | Nej | |
| includeContext | boolean | query | Nej | |
| afterCreatedAt | integer | query | Nej | |
| unreadOnly | boolean | query | Nej | |
| dmOnly | boolean | query | Nej | |
| noDm | boolean | query | Nej | |
| includeTranslations | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: GetUserNotifications200Response
Eksempel

Nulstil brugers notifikationstælling 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| sso | string | query | Nej |
Respons
Returnerer: ResetUserNotifications200Response
Eksempel

Nulstil brugers notifikationer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| afterId | string | query | Nej | |
| afterCreatedAt | integer | query | Nej | |
| unreadOnly | boolean | query | Nej | |
| dmOnly | boolean | query | Nej | |
| noDm | boolean | query | Nej | |
| sso | string | query | Nej |
Svar
Returnerer: ResetUserNotifications200Response
Eksempel

Opdater brugers abonnementsstatus for kommentarnotifikationer 
Aktivér eller deaktiver notifikationer for en specifik kommentar.
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| optedInOrOut | string | path | Ja | |
| commentId | string | query | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UpdateUserNotificationStatus200Response
Eksempel

Opdater brugers abonnementsstatus for sidenotifikationer 
Aktivér eller deaktiver notifikationer for en side. Når brugere er tilmeldt en side, oprettes der notifikationer for nye rodkommentarer, og også
Parameters
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| url | string | query | Ja | |
| pageTitle | string | query | Ja | |
| subscribedOrUnsubscribed | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UpdateUserNotificationStatus200Response
Eksempel

Opdater brugers notifikationsstatus 
Parametre
| Name | Type | Location | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| notificationId | string | path | Ja | |
| newStatus | string | path | Ja | |
| sso | string | query | Nej |
Svar
Returnerer: UpdateUserNotificationStatus200Response
Eksempel

Hent brugers tilstedeværelsesstatusser 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlIdWS | string | query | Ja | |
| userIds | string | query | Ja |
Respons
Returnerer: GetUserPresenceStatuses200Response
Eksempel

Søg efter brugere 
Parameters
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | path | Ja | |
| urlId | string | query | Ja | |
| usernameStartsWith | string | query | Nej | |
| mentionGroupIds | array | query | Nej | |
| sso | string | query | Nej | |
| searchSection | string | query | Nej |
Response
Returnerer: SearchUsers200Response
Eksempel

Hent bruger 
Parametre
| Name | Type | Location | Required | Description |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja |
Svar
Returnerer: GetUser200Response
Eksempel

Opret stemme 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| commentId | string | query | Ja | |
| direction | string | query | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Respons
Returnerer: VoteComment200Response
Eksempel

Slet stemme 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| id | string | path | Ja | |
| editKey | string | query | Nej |
Svar
Returnerer: DeleteCommentVote200Response
Eksempel

Hent stemmer 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja |
Svar
Returnerer: GetVotes200Response
Eksempel

Hent stemmer for bruger 
Parametre
| Navn | Type | Placering | Påkrævet | Beskrivelse |
|---|---|---|---|---|
| tenantId | string | query | Ja | |
| urlId | string | query | Ja | |
| userId | string | query | Nej | |
| anonUserId | string | query | Nej |
Svar
Returnerer: GetVotesForUser200Response
Eksempel

Brug for hjælp?
Hvis du støder på problemer eller har spørgsmål om Ruby SDK'et, så:
Bidrag
Bidrag er velkomne! Besøg venligst GitHub-repositoriet for retningslinjer for bidrag.