iaasen/matrikkel

Client to access MatrikkelAPI from Kartverket

1.0.0 2024-10-30 13:46 UTC

Requires

• php: >=8.1
• ext-ctype: *
• ext-iconv: *
• ext-zip: *
• iaasen/stdlib: dev-master
• nyholm/psr7: ^1.8
• phpro/soap-client: ^2.4
• symfony/console: ^6|^7
• symfony/dotenv: 6.3.*
• symfony/flex: ^2
• symfony/framework-bundle: 6.3.*
• symfony/http-client: ^6.3
• symfony/runtime: 6.3.*
• symfony/yaml: 6.3.*

Suggests

• laminas/laminas-soap: Matrikkel in api-mode requires soap

Conflicts

• symfony/symfony: *

GPL-3.0-or-later

README

MatrikkelAPI option (The SOAP-API)

https://prodtest.matrikkel.no/matrikkelapi/wsapi/v1/dokumentasjon/index.html

Local DB option

A second solution using a local database import has been added. The URL for downloading the addreses is stored in AddressImportService::ADDRESS_URL

A database table names matrikkel_addresses must be created in the default database:

CREATE TABLE `matrikkel_addresses` (
  `adresseId` bigint(11) UNSIGNED NOT NULL,
  `fylkesnummer` tinyint(2) UNSIGNED NOT NULL,
  `kommunenummer` smallint(11) UNSIGNED NOT NULL,
  `kommunenavn` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_danish_ci NOT NULL,
  `adressetype` varchar(255) NOT NULL,
  `adressekode` mediumint(6) UNSIGNED NOT NULL,
  `adressenavn` varchar(255) NOT NULL,
  `nummer` smallint(6) NOT NULL,
  `bokstav` varchar(2) NOT NULL,
  `gardsnummer` smallint(6) UNSIGNED NOT NULL,
  `bruksnummer` smallint(6) UNSIGNED NOT NULL,
  `festenummer` smallint(6) UNSIGNED DEFAULT NULL,
  `undernummer` smallint(6) UNSIGNED DEFAULT NULL,
  `adresseTekst` varchar(255) NOT NULL,
  `epsg` smallint(6) UNSIGNED NOT NULL,
  `nord` float NOT NULL,
  `øst` float NOT NULL,
  `postnummer` smallint(6) UNSIGNED NOT NULL,
  `poststed` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_danish_ci NOT NULL,
  `grunnkretsnavn` varchar(255) NOT NULL,
  `soknenavn` varchar(255) NOT NULL,
  `tettstednavn` varchar(255) NOT NULL,
  `search_context` varchar(512) DEFAULT '',
  `timestamp_created` datetime NOT NULL DEFAULT current_timestamp()
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_general_ci;

ALTER TABLE `matrikkel_addresses`
  ADD PRIMARY KEY (`adresseId`),
  ADD KEY `fylkesnummer` (`fylkesnummer`),
  ADD KEY `adressenavn` (`adressenavn`),
  ADD KEY `postnummer` (`postnummer`),
  ADD KEY `search_context` (`search_context`);
COMMIT;

Run console command matrikkel:adresse-import to import the addresses (about 2,5 million) This command should be run at regular intervals