Modeller
Alle API-responser bruger camelCase JSON. Timestamps er ISO 8601 med offset (fx 2026-06-28T10:00:00Z eller 2026-06-28T12:00:00+02:00). UUID'er returneres som strenge.
Mange responser inkluderer HAL _links med self og evt. scheduling-info href.
Model-oversigt
Felt-konventioner
| Type |
Format |
Eksempel |
| string |
UTF-8 tekst |
"Patientkonsultation" |
| uuid |
UUID-streng |
"46b46a1e-a4d3-4387-87ee-a67dcaa222cb" |
| datetime |
ISO 8601 med offset |
"2026-06-28T10:00:00Z" |
| boolean |
true / false |
"guestPinRequired": false |
| enum |
Streng (se Reference) |
"provisionStatus": "AWAITS_PROVISION" |
Meeting
Møde returneret af GET/POST/PUT/PATCH.
Felter (udvalgte)
| Felt |
Type |
Beskrivelse |
uuid |
uuid |
Primær nøgle |
subject |
string |
Emne (max 100) |
startTime |
datetime |
Mødestart |
endTime |
datetime |
Mødeslut |
description |
string |
Beskrivelse (max 500) |
projectCode |
string |
Projektreference (max 100) |
externalId |
string |
Eksternt ID fra kaldende system (max 200) |
shortId |
string |
12-tegns short ID |
shortLink |
string |
Kort mødelink (fx https://m.vconf.dk/...) |
createdBy |
meetingUser |
Oprettet af |
updatedBy |
meetingUser |
Sidst opdateret af |
organizedBy |
meetingUser |
Arrangør |
guestMicrophone |
enum |
on, off, muted |
guestPinRequired |
boolean |
PIN kræves ved deltagelse |
labels |
string[] |
Labels til søgning |
additionalInformation |
array |
Nøgle/værdi-par |
_links |
object |
HAL-links (self, scheduling-info) |
JSON-eksempel
{
"uuid": "46b46a1e-a4d3-4387-87ee-a67dcaa222cb",
"subject": "Patientkonsultation",
"startTime": "2026-06-28T10:00:00Z",
"endTime": "2026-06-28T10:30:00Z",
"shortId": "abcdefghijkl",
"shortLink": "https://m.vconf.dk/abcdefghijkl",
"createdBy": { "organisationId": "test-org", "email": "laege@eksempel.dk" },
"organizedBy": { "organisationId": "test-org", "email": "laege@eksempel.dk" },
"guestPinRequired": false,
"_links": {
"self": { "href": "https://videoapi.vconf-stage.dk/v2/meetings/46b46a1e-a4d3-4387-87ee-a67dcaa222cb" },
"scheduling-info": { "href": "https://videoapi.vconf-stage.dk/v2/scheduling-info/46b46a1e-a4d3-4387-87ee-a67dcaa222cb" }
}
}
create-meeting
Request-body til POST /v2/meetings.
Påkrævede felter
| Felt |
Type |
Beskrivelse |
subject |
string |
Emne |
startTime |
datetime |
Start |
endTime |
datetime |
Slut |
Valgfrie felter (udvalgte)
| Felt |
Type |
Beskrivelse |
description |
string |
Beskrivelse |
projectCode |
string |
Projektreference |
organizedByEmail |
string |
Arrangør (planner kan oprette på vegne af andre) |
schedulingTemplateId |
integer |
Specifik template |
externalId |
string |
Dit systems ID |
meetingType |
enum |
NORMAL (default) eller POOL |
schedulingInfoReservationId |
uuid |
Pool-reservation (ikke med guestPin/hostPin) |
guestMicrophone |
enum |
Default on |
guestPinRequired |
boolean |
Default false |
guestPin / hostPin |
integer |
PIN-koder (1000–999999999) |
uriWithoutDomain |
string |
Kun hvis organisation understøtter det |
labels |
string[] |
Søgelabels |
additionalInformation |
array |
Nøgle/værdi-par |
vmrType, hostView, guestView, vmrQuality |
enum |
VMR-indstillinger |
update-meeting
Request-body til PUT /v2/meetings/{uuid}. Påkrævede: subject, startTime, endTime. Valgfrie: description, projectCode, organizedByEmail, labels, additionalInformation.
patch-meeting
Request-body til PATCH /v2/meetings/{uuid}. Alle felter valgfrie — kun medsendte felter opdateres; null sletter felt.
Understøtter bl.a. subject, startTime, endTime, description, guestMicrophone, guestPinRequired, guestPin, hostPin, labels, additionalInformation, callType.
scheduling-info
Teknisk information knyttet til et møde — URI, PIN, provisioneringsstatus m.m. Returneres som read-only respons ved GET /v2/scheduling-info.
Felter (udvalgte)
| Felt |
Type |
Beskrivelse |
uuid |
uuid |
Samme som mødets uuid |
uriWithDomain |
string |
Møde-URI med domæne |
uriWithoutDomain |
string |
URI uden domæne |
hostPin / guestPin |
integer |
PIN-koder |
provisionStatus |
enum |
Se provisionStatus |
portalLink |
string |
Link til borgerportal |
shortLink |
string |
Kort deltagelseslink |
vmrAvailableBefore |
integer |
Minutter før start VMR er tilgængelig |
maxParticipants |
integer |
Max deltagere |
endMeetingOnEndTime |
boolean |
Afslut møde ved endTime |
reservationId |
uuid |
Pool-reservations-ID |
meetingDetails |
meeting |
Indlejret møde (ved visse svar) |
_links |
object |
HAL self-link |
scheduling-template
Mødeskabelon med URI-interval, PIN-indstillinger, VMR-defaults m.m.
Felter (udvalgte)
| Felt |
Type |
Beskrivelse |
id |
integer |
Template-ID |
organisationId |
string |
Organisation |
uriPrefix / uriDomain |
string |
URI-komponenter |
hostPinRequired / guestPinRequired |
boolean |
PIN-krav |
hostPinRangeLow/High |
integer |
PIN-interval |
vMRAvailableBefore |
integer |
Minutter før start |
maxParticipants |
integer |
Max deltagere |
endMeetingOnEndTime |
boolean |
Auto-afslut |
ivrTheme |
string |
IVR-tema |
isPoolTemplate |
boolean |
Pool-template |
directMedia |
enum |
never, best_effort |
isDefaultTemplate |
boolean |
Default for organisation |
pool-info
| Felt |
Type |
Beskrivelse |
organisationId |
string |
Organisation |
availablePoolMeetings |
integer |
Ledige pool-møder |
desiredPoolSize |
integer |
Ønsket pool-størrelse |
schedulingTemplate |
scheduling-template |
Default template (kan være null) |
meetingUser
| Felt |
Type |
Beskrivelse |
organisationId |
string |
Organisation |
email |
string |
Email |
detailedError
Returneres ved fejl (400, 401, 403, 404, 406, 500).
| Felt |
Type |
Beskrivelse |
errorCode |
integer |
Numerisk fejlkode |
errorText |
string |
Beskrivelse |
{
"errorCode": 100,
"errorText": "Meeting not found"
}
Se også
Ændringshistorik
| Dato |
Ændring |
| 2026-06-27 |
Første model-reference for MedCom Video API v2 |