Dokumentet beskriver felter og API-kall for dynamiske møterom som er en funksjon til eksisterende teknisk plattform. Dette er en kortfattet beskrivelse av datafelter og funksjonalitet, men ikke alle tekniske detaljer er nødvendigvis inkludert.

Målgruppe

Dokumentets målgruppe er personell med nødvendig grunnleggende kompetanse, som skal drifte eller endre oppsettet/detaljer i løsningen. Det forutsettes nødvendig kompetanse og erfaring med integrasjoner og API-kall.

Definisjoner og Begrep

Grensesnittet returnerer standard application/json. Ved behov for XML kan Accept header settes til application/xml.

Miljøer

Test

Tjeneste	DNS navn	IP adresse	Portåpninger	Tilgjengelig
Videoportal	videoportal.test.video.nhn.no	91.186.67.111	HTTPS/443	Internett
Videoportal	videoportal.test.video.nhn.no	83.118.129.181	HTTPS/443	Helsenett

QA miljø:

Tjeneste	DNS navn	IP adresse	Portåpninger	Tilgjengelig
Videoportal	videoportal.qa.video.nhn.no	91.186.67.96	HTTPS/443	Internett
Videoportal	videoportal.qa.video.nhn.no	83.118.129.182	HTTPS/443	Helsenett

Produksjonsmiljø:

Tjeneste	DNS navn	IP adresse	Portåpninger	Tilgjengelig
Videoportal	videoportal.nhn.no	83.118.185.132	HTTPS/443	Internett
Videoportal	videoportal.nhn.no	91.186.80.37	HTTPS/443	Helsenett

Oauth 2.0 Token

For å kunne kommunisere med API må det hentes ut et token som skal benyttes. Dette har en gyldighet på 14 dager, så dette må ikke gjøres hver gang.

HTTP POST *https://portal2.video.nhn.no/Token*
POST /Token HTTP/1.1
Host: portal2.video.nhn.no
Cache-Control: no-cache
grant_type=password&username=API-userName&password=API-password

Response:

{
"access_token": "< TOKEN >",
"token_type": "bearer",
"expires_in": 1209599,
"userName": "epost@atea.no",
".issued": "Tue, 10 Jul 2021 13:07:03 GMT",
".expires": "Tue, 24 Jul 2021 13:07:03 GMT"
}

Api bruker opprettes pr kunde av NHN etter avtale om at dynamisk booking skal tas i bruk.

Datafelter

startTime

DateTime Required
Påkrevd felt for angivelse av Starttid for dette møte.
Format: 'yyyy''MM''dd'T'HH':'mm':'ss (SortableDateTimePattern)
"startTime": "2021-09-08T10:00:00"

endTime

DateTime Required
Påkrevd felt for angivelse av Slutttid for dette møte.
Når verdien Recurrence ikke er satt, skal start og sluttdato være lik.
Format: 'yyyy'~~'MM'~~'dd'T'HH':'mm':'ss (SortableDateTimePattern)
"endTime ": "2021-09-08T17:00:00",

Subject

String Required
Påkrevd felt for angivelse av Emne for dette møtet
"Subject": "test møte 123",

Template

Int Optional
Valgfritt felt for angivelse av Mal for VMR
Det er anbefalt at dette feltet angis.
"Template": 14,

Recurrence

Enum Optional

String	Int	Beskrivelse
None *Standard	0	Ingen gjentagelse.
Daily	1	Skjer hver dag mellom startTime.Hour og endTime.Hour til og med endTime.Date.
Weekly	2	Skjer ukentlig hver startTime. DayOfWeek mellom startTime.Hour og endTime.Hour til og med endTime.Date
Monthly	3	Skjer startTime.Day i hver måned mellom startTime.Hour og endTime.Hour til og med endTime.Date
Weekdays	4	Skjer alle ukedager til og med endTime

timeZone

string Optional
Valgfritt felt for angivelse av tidssone. Standard er «W. Europe Standard Time»
"timeZone": "W. Europe Standard Time", *
"timeZone": "Europe/Oslo",

Note

String/MultilineText Optional
Valgfritt felt for visning av tekst i epost eller landingsside.
"note": "møtenotat",

Authentication

Emum Optional
Angir krav om autentisering for gjester som skal tilknyttes møte. Verten må alltid logge på via HelseID for å starte møte.

String	Int	Beskrivelse
None *Standard	0	Ingen autentisering av gjester er nødvendig. Bruker kobles direkte til landingsside for møte.
SSO	1	Autentisering av gjester via HelseID er nødvendig. Bruker kobles direkte til IDP for autentisering
SSO_SMS	2	Autentisering av gjester via HelseID eller SMS er nødvendig. Bruker får valg om å velge autentisering metode
Optional	3	Autentisering av gjester er valgfritt. Bruker får valg om å velge autentisering metode eller fortsette uten Autentisering

"authentication": "SSO_SMS"

InviteUser

String Optional

Valgfritt felt for å sende invitasjon på epost eller mobil basert på template.

"inviteUser": bruker@domene.net,90554800,+4790554800

"inviteUser": "bruker@domene.net"

Host

String Optional
Valgfritt felt for å sende invitasjon på epost på basert på template. Epost til eier av møterommet. Dette rommet vil vises under Mine Møter i portalen.
"host": "bruker@domene.net"

API kall

Vis alle møter for gjeldende kunde

HTTP GET /api/client/v1/booking/
GET /api/client/v1/booking/ HTTP/1.1
Host: portal2.video.nhn.no:443
Authorization: Bearer < TOKEN >
Cache-Control: no-cache
X-Paging-Headers

total_count	int	Totalt antall oppslag
limit	int	begrenser antall oppslag standard 100
next	string	Neste side
previous	string	Forrige side
showEnded	bool	Viser avluttende møter. Standard false

Eksempel
{
"offset": 5,
"next": "/api/admin/v1/booking/?&limit=5&offset=10",
"previous": "/api/admin/v1/booking/?&limit=5&offset=0",
"total_count": 12,
"limit": 5
}
Response Body:

{
        "id": 44,
        "bookingSecret": "9Cb9vFdy3Dv",
        "bookingURL": "https://portal2.video.nhn.no/join/9Cb9vFdy3Dv",
        "hostURL": "https://ttrd-vk-pex-e01.test.video.nhn.no/conference?98197650&PIN=8465",
        "guestURL": "https://ttrd-vk-pex-e01.test.video.nhn.no/conference?98197650&PIN=3058&role=guest",
        "subject": "sdfsdfsdf",
        "startTime": "2021-06-02T08:00:00",
        "endTime": "2021-06-02T18:00:00",
        "timeZone": "W. Europe Standard Time",
        "recurrence": "None",
        "authentication": "None",
        "note": null,
        "status": "Ended",
        "conference": {
            "id": 86,
            "name": "sdfsdfsdf (Customer1) - 98197650",
            "pin": "8465",
            "guestPin": "3058",
            "vmrProfile": "Demo (5 participants)",
            "creationTime": "2021-06-01T08:55:41.47",
            "aliases": null,
            "source": 4,
            "primaryOwnerEmailAddress": "rune@heggelund.net"
        }
    },
    {
        "id": 46,
        "bookingSecret": "RjRv9qm8yr7",
        "bookingURL": "https://portal2.video.nhn.no/join/RjRv9qm8yr7",
        "hostURL": "https://ttrd-vk-pex-e01.test.video.nhn.no/conference?98412355&PIN=6002",
        "guestURL": "https://ttrd-vk-pex-e01.test.video.nhn.no/conference?98412355&PIN=6994&role=guest",
        "subject": "testtest",
        "startTime": "2021-06-03T14:00:00",
        "endTime": "2021-06-03T15:00:00",
        "timeZone": "W. Europe Standard Time",
        "recurrence": "None",
        "authentication": "None",
        "note": null,
        "status": "Ended",
        "conference": {
            "id": 89,
            "name": "testtest (Customer1) - 98412355",
            "pin": "6002",
            "guestPin": "6994",
            "vmrProfile": "Demo (5 participants)",
            "creationTime": "2021-06-03T12:01:39.927",
            "aliases": null,
            "source": 4,
            "primaryOwnerEmailAddress": "rune@heggelund.net"
        }
    }
]

Vis enkelt møte for gjeldende kunde

HTTP GET /api/client/v1/booking/{id:int} eller /api/client/v1/booking/{bookingSecret:string}
GET /api/client/v1/booking/44 HTTP/1.1
Host: portal2.video.nhn.no:443
Authorization: Bearer < TOKEN >
Cache-Control: no-cache
Response Body:

Opprett et møte for gjeldende kunde

HTTP POST /api/client/v1/booking/
POST /api/client/v1/booking/44 HTTP/1.1
Host: portal2.video.nhn.no:443
Authorization: Bearer < TOKEN >
Cache-Control: no-cache
Request Body:

{
"startTime": "2021-06-30T08:00:00",
"endTime": "2021-06-30T16:00:00",
"template": 14,
"subject": "test møte 1234",
"recurrence": "None",
"timeZone": "W. Europe Standard Time",
"note":"test\ntest",
"authentication": "Optional","InviteUser": "epost@domene.no",
"host": "bruker@domene.net"

}

Response Body:

{
    "id": 53,
    "bookingSecret": "v57489S6U6E",
    "bookingURL": "https://portal2.video.nhn.no/join/v57489S6U6E",
    "hostURL": "https://ttrd-vk-pex-e01.test.video.nhn.no/conference?98877606&pin=3588",
    "guestURL": "https://ttrd-vk-pex-e01.test.video.nhn.no/conference?98877606&pin=9336&role=guest",
    "subject": "test møte 1234",
    "startTime": "2021-06-30T08:00:00",
    "endTime": "2021-06-30T16:00:00",
    "timeZone": "W. Europe Standard Time",
    "recurrence": "None",
    "authentication": "Optional",
    "note": "test\ntest",
    "status": "Scheduled",
    "conference": {
        "id": 98,
        "name": "test møte 1234 (Customer1) - 98877606",
        "pin": "3588",
        "guestPin": "9336",
        "vmrProfile": "Sensitivt rom (HD)",
        "creationTime": "2021-06-09T12:58:51.6320076Z",
        "aliases": null,
        "source": 4,
        "primaryOwnerEmailAddress": "moteleder@video.nhn.no"
    }
}

Endre et møte for gjeldende kunde

Det er ikke mulig å endre navnet til et allerede opprettet møte.

HTTP PUT /api/client/v1/booking/{id:int} eller /api/client/v1/booking/{bookingSecret:string}
PUT /api/client/v1/booking/44 HTTP/1.1
Host: portal2.video.nhn.no:443
Authorization: Bearer < TOKEN >
Cache-Control: no-cache
Request Body:

{
"startTime": "2021-10-13T14:00:00",
"endTime": "2021-10-13T14:45:00",
"recurrence": "None",
"timeZone": "W. Europe Standard Time",
"note":"Test av endring"
}

Response Body:

{
    "id": 405,
    "bookingSecret": "64MP34zQ22t",
    "bookingURL": "https://delta2.video.nhn.no/join/64MP34zQ22t",
    "hostURL": "https://join.test.video.nhn.no/conference?98823598&pin=12157355140381173042",
    "guestURL": "https://join.test.video.nhn.no/conference?98823598&pin=50439727811650102646&role=guest",
    "subject": "Videokonsultasjon",
    "startTime": "2021-10-13T14:00:00",
    "endTime": "2021-10-13T14:45:00",
    "timeZone": "W. Europe Standard Time",
    "recurrence": "None",
    "auth": 2,
    "authentication": "SSO_SMS",
    "note": "Test av endring",
    "status": "Ended",
    "conference": {
        "id": 469,
        "name": "Videokonsultasjon (Helse Midt-Norge) - 98823598",
        "pin": "12157355140381173042",
        "guestPin": "50439727811650102646",
        "vmrProfile": "Sensitivt rom (HD)",
        "creationTime": "2021-10-13T10:46:09.43",
        "aliases": null,
        "source": 4,
        "primaryOwnerEmailAddress": "bcmlv8bsuamlzjtlxtjz@api.nhn.no"
    }
}

Slette et møte for gjeldende kunde

HTTP DELETE /api/client/v1/booking/{id:int} eller /api/client/v1/booking/{bookingSecret:string}
DELETE /api/client/v1/booking/44 HTTP/1.1
Host: portal2.video.nhn.no:443
Authorization: Bearer < TOKEN >
Cache-Control: no-cache

Response Header:

200 OK