SDK Adressbok API dokumentation

Adressbok

I SDK adressbok finns det olika kodverk för att underlätta för organisationer att hitta rätt funktionsadress hos andra organisationer. En funktionsadress kan tilldelas en eller flera koder i ett kodverk för att möjliggöra exakta sökningar. Detta möjliggör för den som söker fram en funktionsadress att filtrera utifrån koder (sökkoder och sökord) i kodverket istället för att fritextsöka. SDK adressbok innehåller tre olika typer av kodverk:

Geografisk hemvist (används för att beskriva en organisations eller funktions geografiska hemvist utifrån län- och kommuntillhörighet).

Strukturkodverk (används för att koppla funktionsadress till en specifik kod/funktion, exempelvis korttidsboende).

Sökkodverk (används för att möjliggöra exakt sökning genom specifika sökord).

Adressbokens Sök-API är ett tekniskt gränssnitt som möjliggör för externa system (t.ex. Meddelandetjänst och Meddelandeklienter) läsåtkomst till information i SDK Adressbok.

Sök-API erbjuder funktionalitet så som lista funktionsadresser och deltagarorganisationer, fritextsökning, exakt filtrerad sökning utifrån koder (sökord, sökkoder) utifrån kodverk.

Kodverk

Kodverk som kan användas i Adressboken finns registrerade i kodverksregister, en tjänst som publicerar SDK:s standardiserade koder (sökord och sökkoder) via ett öppet API.

Kodverks Sök-API är ett tekniskt gränssnitt som möjliggör för externa system (t.ex. meddelandetjänst och meddelandeklienter) läsåtkomst till kodverkens koder som används i adressboken.

Sök-API erbjuder funktionalitet så som lista kodverk samt lista kodverkets koder och beskrivande text.

På följande tre länkar hittar du API dokumentation för de olika miljöerna:

Miljöspecifikation för miljön OPEN-TEST för leverantörer av meddelandesystem

Miljöspecifikation för SDK QA-miljö

Miljöspecifikation för SDK produktionsmiljö