1 Metodens formål
2 Detaljert dokumentasjon av metoden
- 2.1 Autentisering og autorisering
- 2.2 HTTP-verb
- 2.3 Request GET
- 2.4 Response GET
- 2.5 Request POST
- 2.6 Response POST
- 2.7 Request DELETE
- 2.8 Response DELETE
- 2.9 Miljøer
- 2.10 Vilkår for bruk
3 Feilmeldinger
4 Valideringer
5 Versjonering og endringer

API-navn	VideolenkerApi?
Funksjonelt område	Videolenker
API-versjon og dato publisert	Versjon 0.7 Apr 13, 2026
Status	Under utvikling
API-dokumentasjon sist endret	Apr 13, 2026
Teknologi	REST

Metodens formål

Metoden REST Videolenker anvendes for å administrere video-URLer

Løsningen er under utvikling og er enda ikke tilgjengelig for utprøving

Detaljert dokumentasjon av metoden

Autentisering og autorisering

HelseId sin autoriseringstjeneste for maskin-til-maskin skal benyttes:

Velg Helsenorge Ekstern API i HelseId sin selvbetjeningsløsning
1. Velg deretter scope “ikke-definert”
2. Når tilgangen er godkjent av Helsenorge, kan aksesstoken hentes ut fra HelseId

Se ytterligere detaljer her: 3. Ekstern applikasjon kaller Helsenorge API i systemkontekst

AksessToken som mottas fra HelseId skal deretter være med i Authorization header i alle HTTP-requestene. Se: 2. Ekstern innbyggerløsning kaller Helsenorge API i innbyggerkontekst

HTTP-verb

Det skal benyttes GET, POST og DELETE og alltid https. AksessToken skal være med i Authorization header. Se her: 2. Ekstern innbyggerløsning kaller Helsenorge API i innbyggerkontekst

Request GET

Plassering	Navn	Type	Beskrivelse

Plassering	Navn	Type	Beskrivelse
Header	Authorization: bearer {access-token}	-	Aksess token som klienten fikk fra Helsenorge sikkerhetstjeneste etter å ha autentisert/autorisert seg mot denne.
Header	Content-Type	application/json	Parametere i body er JSON
Query	HerIdKommunikasjonspart	int (valgfritt felt)	Hvis feltet ikke tas med eller settes til 0 så spørres det på HerIdVirksomhet. Hvis feltet er satt større enn 0 så spørres det på kombinasjonen HerIdKommunikasjonspart og HerIdVirksomhet .
	HerIdVirksomhet	int
	FraOgMedDato	DateTime (valgfritt felt)
	TilOgMedDato	DateTime (valgfritt felt)
	KunAktivBaseUrl	bool

Response GET

Plassering	Navn		Type	Beskrivelse

Plassering	Navn		Type
Body	Videolenker		List<VideoLenke>
		Id	Guid
		Url	string
		HerIdKommunikasjonspart	int
		HerIdVirksomhet	int
		OrganisasjonsnummerVirksomhet	string
		FraOgMedDato	DateTime
		TilOgMedDato	DateTime? (nullable)
		OpprettetDato	DateTime
		SistEndretDato	DateTime
		Beskrivelse	string
		BaseUrlId	Guid
		BaseUrlErAktiv	bool
		VideolosningErAktiv	bool
		LeverandorErAktiv	bool

Request POST

Plassering	Navn		Type	Beskrivelse

Plassering	Navn		Type	Beskrivelse
Header	Authorization: bearer {access-token}		-	Aksess token som klienten fikk fra Helsenorge sikkerhetstjeneste etter å ha autentisert/autorisert seg mot denne.
Header	Content-Type		application/json	Parametere i body er JSON
Body	HerIdVirksomhet		int
	Videolenker		List<VideolenkeToSave>
		Id	Guid (valgfritt felt)
		Url	bool
		FraOgMedDato	DateTime
		TilOgMedDato	DateTime
		Beskrivelse	string
		HerIdKommunikasjonspart	int

Response POST

Plassering	Navn	Type	Beskrivelse

Plassering	Navn	Type	Beskrivelse
Body	SavedVideolenkerGuids	List<Guid>
Body	UpdatedVideolenkerGuids	List<Guid>

Request DELETE

Plassering	Navn	Type	Beskrivelse

Plassering	Navn	Type	Beskrivelse
Header	Authorization: bearer {access-token}	-	Aksess token som klienten fikk fra Helsenorge sikkerhetstjeneste etter å ha autentisert/autorisert seg mot denne.
Header	Content-Type	application/json	Parametere i body er JSON
Query	VideolenkeGuid	Guid

Response DELETE

Plassering	Navn	Type	Beskrivelse

Plassering	Navn	Type	Beskrivelse
Body	Deleted	bool

Miljøer

URL for å nå endepunktet (forskjellig pr miljø): https://<miljø>/ikkedefinertenda/api/v1

Oversikt over tilgjengelige miljøer finnes her: Testmiljøer og endepunkter

Vilkår for bruk

Generelle vilkår for bruk av APIer finnes her: Vilkår og betingelser for bruk av APIer og kommunikasjonsprosesserarchived

Feilmeldinger

Følgende responskoder kan forventes fra Helsenorge:

Kode	Beskrivelse

Kode	Beskrivelse
200	Alt OK
400	Validering av request feiler
401	Autorisasjon er feil eller mangler
403	Tilganger mangler
500	Midlertidig feil, prøv igjen senere

Ved HTTP-statuskoder som tilsier at det har oppstått en feil returneres også en respons med feilkode og feilmelding.

Eksempler:

{  "Code": "SEC-110000",  "Message": "Token is expired or invalid"}
{  "Code": "HT-000600", "Message": "Videolenke ikke tilkoblet organisasjon 80001234"}
{  "Code": "HT-000602", "Message": "Ingen leverandørløsninger av type video funnet"}
{  "Code": "HT-000603", "Message": "BaseUrl 6b110d06-8611-4667-8465-0ade5a8d61bb not found"}
{  "Code": "HT-000604", "Message": "Request OrganisasjonsnummerAnvender er tom"}
{  "Code": "HT-000604", "Message": "Request Url er tom"}
{  "Code": "HT-000604", "Message": "Ingen videoleverandør funnet"}
{  "Code": "HT-000604", "Message": "Du kan ikke oppdatere URL og/eller OrganisasjonsnummerAnvender for BaseUrl med id 9791885a-bdfd-4df3-802c-c0e87faf7e08, fordi den er i bruk av 19 videolenker"
{  "Code": "HT-000605", "Message": "Du har ikke tilgang til å oppdatere BaseUrl med id 2508b4fc-41dc-46ef-89f8-63f5dea689d7"

REST Videolenker