Gå til indholdet

Endpoints

Alle endpoints nedenfor er v2 og relative til base URL.

Base URLs

Miljø Base URL
Stage https://videoapi.vconf-stage.dk
Produktion https://videoapi.vconf.dk

Eksempel: POST https://videoapi.vconf-stage.dk/v2/meetings

Fælles headers

Header Påkrævet Beskrivelse
Authorization Ja Bearer <access_token> fra Keycloak
Content-Type Ved POST/PUT/PATCH application/json

Endpoint-oversigt

Info

Metode Route Formål Roller
GET /v2/info API-info og health-test Alle meeting-roller

Video Meetings

Metode Route Formål Roller
GET /v2/meetings Søg/list møder user, planner, admin
POST /v2/meetings Opret møde user, planner, admin
GET /v2/meetings/{uuid} Hent møde user, planner, admin
PUT /v2/meetings/{uuid} Opdater møde (fuld) user, planner, admin
PATCH /v2/meetings/{uuid} Opdater møde (delvis) user, planner, admin
DELETE /v2/meetings/{uuid} Slet møde user, planner, admin
GET /v2/meetings/findByUriWithDomain Find møde via URI med domæne user, planner, admin
GET /v2/meetings/findByUriWithoutDomain Find møde via URI uden domæne user, planner, admin

Video Scheduling Information (læseadgang)

Metode Route Formål Roller
GET /v2/scheduling-info List scheduling info (datointerval) user, planner, admin
GET /v2/scheduling-info/{uuid} Hent scheduling info user, planner, admin
GET /v2/scheduling-info-reserve Reservér scheduling info fra pool admin
GET /v2/scheduling-info-reserve/{uuid} Hent reserveret scheduling info admin

Scheduling Template Administration

Metode Route Formål Roller
GET /v2/scheduling-templates List templates for organisation Alle meeting-roller
POST /v2/scheduling-templates Opret template admin
GET /v2/scheduling-templates/{id} Hent template Alle meeting-roller
PUT /v2/scheduling-templates/{id} Opdater template admin
DELETE /v2/scheduling-templates/{id} Slet template admin

Pool

Metode Route Formål Roller
GET /v2/pool Pool-status pr. organisation Alle meeting-roller

GET /v2/info

Test at API'et svarer og at token er gyldigt.

Eksempel (curl)

curl -s -X GET "https://videoapi.vconf-stage.dk/v2/info" \
  -H "Authorization: Bearer DIT_ACCESS_TOKEN"

GET /v2/meetings

Søg møder via query-parametre. Kun ét søgekriterium bruges ad gangen — de evalueres i denne rækkefølge:

  1. short-id
  2. label
  3. subject
  4. organizedBy
  5. search (+ evt. from-start-time / to-start-time)
  6. from-start-time + to-start-time (begge skal angives)
  7. uriWithDomain
Parameter Type Beskrivelse
from-start-time datetime Start af datointerval (ISO 8601)
to-start-time datetime Slut af datointerval
short-id string (12 tegn) Short ID
subject string Emne
organizedBy string Arrangør-email
search string Fritekstsøgning
label string Label
uriWithDomain string URI med domæne

Eksempel (curl)

curl -s -X GET "https://videoapi.vconf-stage.dk/v2/meetings?from-start-time=2026-06-01T00:00:00Z&to-start-time=2026-06-30T23:59:59Z" \
  -H "Authorization: Bearer DIT_ACCESS_TOKEN"

POST /v2/meetings

Opretter et nyt møde. Minimum: subject, startTime, endTime.

Se create-meeting for alle felter.

Eksempel (curl)

curl -s -X POST "https://videoapi.vconf-stage.dk/v2/meetings" \
  -H "Authorization: Bearer DIT_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Patientkonsultation",
    "startTime": "2026-06-28T10:00:00Z",
    "endTime": "2026-06-28T10:30:00Z"
  }'

Fejl

HTTP Årsag
400 Manglende/ugyldigt input
401 Manglende rolle eller ugyldig token
403 Organisationsadgang nægtet
406 Ugyldig template eller organisationsindstilling

GET /v2/meetings/{uuid}

Hent et specifikt møde.

Eksempel (curl)

curl -s -X GET "https://videoapi.vconf-stage.dk/v2/meetings/46b46a1e-a4d3-4387-87ee-a67dcaa222cb" \
  -H "Authorization: Bearer DIT_ACCESS_TOKEN"

PUT /v2/meetings/{uuid}

Fuld opdatering. Kun tilladt når provisionStatus er AWAITS_PROVISION — eller PROVISIONED_OK hvor kun endTime opdateres.

Se update-meeting.


PATCH /v2/meetings/{uuid}

Delvis opdatering. Felter der mangler i JSON opdateres ikke. Felter sat til null slettes.

Se patch-meeting.


DELETE /v2/meetings/{uuid}

Sletter møde. Kun tilladt når provisionStatus er AWAITS_PROVISION. Returnerer 204 No Content.


GET /v2/scheduling-info

List scheduling information i datointerval.

Parameter Påkrævet Beskrivelse
from-start-time Ja Start (ISO 8601)
to-end-time Ja Slut (ISO 8601)
provision-status Nej Default: AWAITS_PROVISION

Eksempel (curl)

curl -s -X GET "https://videoapi.vconf-stage.dk/v2/scheduling-info?from-start-time=2026-06-01T00:00:00Z&to-end-time=2026-06-30T23:59:59Z&provision-status=AWAITS_PROVISION" \
  -H "Authorization: Bearer DIT_ACCESS_TOKEN"

GET /v2/scheduling-info-reserve

Reservér scheduling info fra organisations pool (kræver meeting-admin).

Valgfrie query-parametre: vmrType, hostView, guestView, vmrQuality, enableOverlayText, guestsCanPresent, forcePresenterIntoMain, forceEncryption, muteAllGuests.


GET /v2/scheduling-templates

Returnerer scheduling templates for brugerens organisation.


GET /v2/pool

Returnerer pool-information pr. organisation inkl. default template.


Se også

Ændringshistorik

Dato Ændring
2026-06-27 Første endpoint-reference for MedCom Video API v2