Gränssnittsdefinition

Åtkomstpunkt

Verifiering: https://api-ver.lantmateriet.se/distribution/produkter/samfallighetsforening/v2.2

Produktion: https://api.lantmateriet.se/distribution/produkter/samfallighetsforening/v2.2

Schema

XML: http://namespace.lantmateriet.se/distribution/produkter/samfallighetsforening/v2.2/samfallighetsforening-2.2.0.xsd

JSON: http://namespace.lantmateriet.se/distribution/produkter/samfallighetsforening/v2.2/samfallighetsforening-2.2.0.json

Format

Data kan hämtas i XML- och JSON-format. Vilket format som önskas anges i HTTP-headern Accept med värdena application/xml eller application/json. I frågor som skickas in med POST ska motsvarande värden anges i headern Content-Type.

Felmeddelande

Om ett fel uppstår skickas ett svar med en HTTP-felkod och ett Fault-meddelande.

Sammanfattning

Samfällighetsförening

Hämta hela - eller delmängder av - samfällighetsföreningar.

Operation	Beskrivning
`GET /{id}`	Hämta en samfallighetsförening med id.
`POST /`	Hämta en eller flera samfällighetsföreningar med id.
`GET /organisation/{organisationsnummer}`	Hämta en samfällighetsförening med organisationsnummer.
`POST /organisation`	Hämta en eller flera samfällighetsföreningar med organisationsnummer.

Referens

Hämta referenser till samfällighetsföreningar, med id och etikett

Operation	Beskrivning
GET /referens/beror/{id}	Hitta samfällighetsföreningar med berörkrets.
`GET /referens/filter`	Hitta samfällighetsföreningar med filter.

Operationer

GET /{id}

Beskrivning

Hämta en samfällighetsförening med id. Delar av föreningen kan hämtas genom includeData-parametern.

Exempel

/3a572b3f-07c4-5a7d-e053-9443ed8f45cb?includeData=total

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
id	Samfällighetsföreningens id.	path	string (uuid)	ja
includeData	Vilka delmängder som skall hämtas. Flera delmängder kan anges som en kommaseparerad lista. Styrelseinformation inkluderas inte för uttag som görs i marknadsföringssyfte. Som default hämtas ingenting. Möjliga värden: `basinformation` - namn på och adress till samfällighetsföreningen, telefonnummer, styrelseinformation, samt information om föreningens stadgar och förändring av stadgar. `styrelsemedlem` - information om styrelsemedlemmar som är utsedda av stämman eller förordnade av länsstyrelsen. `berorkrets` - delmängden innehåller de objekt som förvaltas av föreningen. `arkivakt` - akter och åtgärdsinformation. `total` - alla delmängder.	query	string[] (x ∈ { "basinformation", "styrelsemedlem", "berorkrets", "arkivakt", "total" })	nej
includePersonid	Anger om personidn ska finnas med i svaret. Kräver utökad behörighet. Kan ej sättas till `true` om `marknadsforing` är `true`. Default: `false`.	query	boolean	nej
includeAlternativaKontaktvagar	Endast för internt bruk inom Lantmäteriet. Anger om föreningens telefonnummer och epost ska finnas med i svaret. Kan ej sättas till `true` vid uttag. Default: `false`.	query	boolean	nej
marknadsforing	Endast för internt bruk. Anger om informationshämtningen görs i marknadsföringssyfte. Kan ej sättas till `true` om includePersonid är `true`. Default: `false`.	query	boolean	nej

Svar

Ett SamfallighetsforeningResponse i form av en GeoJSON eller GML FeatureCollection med föreningar, beroende på vilket format som efterfrågades.

POST /

Beskrivning

Hämta en eller flera samfällighetsföreningar med id. 250 id:n kan skickas in i samma fråga. Delar av föreningarna kan hämtas genom includeData-parametern.

Exempel

/?includeData=basinformation

Body, Content-Type: application/xml

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/samfallighetsforening/v2.2">
  <id>12345678-1234-1234-1234-123456789012</id>
  <id>10000008-cafe-cafe-cafe-100000000002</id>
</IdRequest>

Body, Content-Type: application/json

["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]

Requestparametrar

Body: IdRequest - ett objekt innehållande en lista med idn.

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
includeData	Vilka delmängder som skall hämtas. Flera delmängder kan anges som en kommaseparerad lista. Styrelseinformation inkluderas inte för uttag som görs i marknadsföringssyfte. Som default hämtas ingenting. Möjliga värden: `basinformation` - namn på och adress till samfällighetsföreningen, telefonnummer, styrelseinformation, samt information om föreningens stadgar och förändring av stadgar. `styrelsemedlem` - information om styrelsemedlemmar som är utsedda av stämman eller förordnade av länsstyrelsen. `berorkrets` - delmängden innehåller de objekt som förvaltas av föreningen. `arkivakt` - akter och åtgärdsinformation. `total` - alla delmängder.	query	string[] (x ∈ { "basinformation", "styrelsemedlem", "berorkrets", "arkivakt", "total" })	nej
includePersonid	Anger om personidn ska finnas med i svaret. Kräver utökad behörighet. Kan ej sättas till `true` om `marknadsforing` är `true`. Default: `false`.	query	boolean	nej
includeAlternativaKontaktvagar	Endast för internt bruk inom Lantmäteriet. Anger om föreningens telefonnummer och epost ska finnas med i svaret. Kan ej sättas till `true` vid uttag. Default: `false`.	query	boolean	nej
marknadsforing	Endast för internt bruk. Anger om informationshämtningen görs i marknadsföringssyfte. Kan ej sättas till `true` om includePersonid är `true`. Default: `false`.	query	boolean	nej

Svar

Ett SamfallighetsforeningResponse i form av en GeoJSON eller GML FeatureCollection med föreningar, beroende på vilket format som efterfrågades.

GET /organisation/{organisationsnummer}

Beskrivning

Hämta en samfällighetsförening med organisationsnummer. Delar av föreningen kan hämtas genom includeData-parametern.

Exempel

/organisation/717901-5404?includeData=basinformation,styrelse,berorkrets

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
organisationsnummer	Samfällighetsföreningens organisationsnummer.	path	string	ja
includeData	Vilka delmängder som skall hämtas. Flera delmängder kan anges som en kommaseparerad lista. Styrelseinformation inkluderas inte för uttag som görs i marknadsföringssyfte. Som default hämtas ingenting. Möjliga värden: `basinformation` - namn på och adress till samfällighetsföreningen, telefonnummer, styrelseinformation, samt information om föreningens stadgar och förändring av stadgar. `styrelsemedlem` - information om styrelsemedlemmar som är utsedda av stämman eller förordnade av länsstyrelsen. `berorkrets` - delmängden innehåller de objekt som förvaltas av föreningen. `arkivakt` - akter och åtgärdsinformation. `total` - alla delmängder.	query	string[] (x ∈ { "basinformation", "styrelsemedlem", "berorkrets", "arkivakt", "total" })	nej
includePersonid	Anger om personidn ska finnas med i svaret. Kräver utökad behörighet. Kan ej sättas till `true` om `marknadsforing` är `true`. Default: `false`.	query	boolean	nej
includeAlternativaKontaktvagar	Endast för internt bruk inom Lantmäteriet. Anger om föreningens telefonnummer och epost ska finnas med i svaret. Kan ej sättas till `true` vid uttag. Default: `false`.	query	boolean	nej
marknadsforing	Endast för internt bruk. Anger om informationshämtningen görs i marknadsföringssyfte. Kan ej sättas till `true` om includePersonid är `true`. Default: `false`.	query	boolean	nej

Svar

Ett SamfallighetsforeningResponse i form av en GeoJSON eller GML FeatureCollection med föreningar, beroende på vilket format som efterfrågades.

POST /organisation

Beskrivning

Hämta en eller flera samfällighetsföreningar med organisationsnummer. 250 organisationsnummer kan skickas in i samma fråga. Delar av föreningarna kan hämtas genom includeData-parametern.

Exempel

/organisation?includeData=basinformation,berorkrets

Body, Content-Type: application/xml

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/samfallighetsforening/v2.2">
  <id>717901-5404</id>
  <id>365968-2437</id>
</IdRequest>

Body, Content-Type: application/json

["717901-5404", "365968-2437"]

Requestparametrar

Body: IdRequest - ett objekt innehållande en lista med idn.

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
includeData	Vilka delmängder som skall hämtas. Flera delmängder kan anges som en kommaseparerad lista. Styrelseinformation inkluderas inte för uttag som görs i marknadsföringssyfte. Som default hämtas ingenting. Möjliga värden: `basinformation` - namn på och adress till samfällighetsföreningen, telefonnummer, styrelseinformation, samt information om föreningens stadgar och förändring av stadgar. `styrelsemedlem` - information om styrelsemedlemmar som är utsedda av stämman eller förordnade av länsstyrelsen. `berorkrets` - delmängden innehåller de objekt som förvaltas av föreningen. `arkivakt` - akter och åtgärdsinformation. `total` - alla delmängder.	query	string[] (x ∈ { "basinformation", "styrelsemedlem", "berorkrets", "arkivakt", "total" })	nej
includePersonid	Anger om personidn ska finnas med i svaret. Kräver utökad behörighet. Kan ej sättas till `true` om `marknadsforing` är `true`. Default: `false`.	query	boolean	nej
includeAlternativaKontaktvagar	Endast för internt bruk inom Lantmäteriet. Anger om föreningens telefonnummer och epost ska finnas med i svaret. Kan ej sättas till `true` vid uttag. Default: `false`.	query	boolean	nej
marknadsforing	Endast för internt bruk. Anger om informationshämtningen görs i marknadsföringssyfte. Kan ej sättas till `true` om includePersonid är `true`. Default: `false`.	query	boolean	nej

Svar

Ett SamfallighetsforeningResponse i form av en GeoJSON eller GML FeatureCollection med föreningar, beroende på vilket format som efterfrågades.

GET /referens/beror/{id}

Beskrivning

Hitta samfällighetsföreningar med ett samfällighets- eller gemensamhetsanläggningsid.

Exempel

/referens/beror/db7c8959-70e9-5422-e040-ed8f5b434c7b

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
id	Samfällighetens eller gemensamhetsanläggningens id i form av ett UUID	path	string (uuid)	ja

Svar

Ett SamfallighetsforeningsreferensResponse i form av en JSON-array eller XML-lista med samfällighetsföreningreferenser, beroende på vilket format som efterfrågades.

GET /referens/filter

Beskrivning

Hitta samfällighetsföreningar med filtersök. Flera filterparametrar kan kombineras för att begränsa urvalet. Minst en parameter måste sättas.

Exempel

/referens/filter?lanskod=21&sate=gävle&sateMatch=startsWith&kommunkodForvaltningsobjekt=2180&namn=Trödje&namnMatch=contains&foreningstyp=Vägförening&andamal=Vägar&maxHits=20

Requestparametrar

Namn	Beskrivning	Typ	Datatyp	Obligatorisk
lanskod	Samfällighetsföreningens lanskod.	query	string	nej
sate	Samfällighetsföreningens säte.	query	string	nej
sateMatch	Hur det angivna kommunnamnet ska matchas mot sätet. Default: `equals.`	query	string (x ∈ { "equals", "startsWith", "contains", "endsWith" })	nej
kommunkodForvaltningsobjekt	Kommun som föreningen förvaltar registerenheter i.	query	string	nej
namn	Föreningsnamn.	query	string	nej
namnMatch	Hur det angivna föreningsnamnet ska matchas mot samfällighetsföreningens namn. Default: `equals.`	query	string (x ∈ { "equals", "startsWith", "contains", "endsWith" })	nej
foreningstyp	Vilken typ av förening att hitta.	query	string (x ∈ { "LGA-samfällighet", "Vägsamfällighet", "Vägförening", "Samfällighetsförening" })	nej
andamal	Ändamål för förvaltningsobjekt som önskas hittas.	query	string (x ∈ { "Anläggning enligt vattenlagen", "Avloppsanläggning", "Bad och/eller båtanläggning", "Elledning och/eller belysning", "Garage och/eller parkering", "Grönområden", "Kvartersanläggning", "Radio- TV och/eller tele", "Skiftessamfälligheter", "Vattenförsörjning", "Vägar", "Värmeanläggning", "Övrigt" })	nej
maxHits	Kan användas för att begränsa antal resultat. Ange ett värde mindre eller lika med 0 för obegränsat antal. Default `100`.	query	integer	nej

Svar

Ett SamfallighetsforeningsreferensResponse i form av en JSON-array eller XML-lista med samfällighetsföreningreferenser, beroende på vilket format som efterfrågades.

Datatyper

Frågor

IdRequest

Hämta en samfällighetsförening med angiven identifierare. Obegränsat antal för idn kan anges.

Properties

Namn	Beskrivning	Typ	Multiplicitet
id	Samfällighetsföreningens identitet.	string	1..*

Exempel

XML

<IdRequest
    xmlns="http://namespace.lantmateriet.se/distribution/produkter/samfallighetsforening/v2.2">
  <id>12345678-1234-1234-1234-123456789012</id>
  <id>10000008-cafe-cafe-cafe-100000000002</id>
</IdRequest>

JSON

["12345678-1234-1234-1234-123456789012", "10000008-cafe-cafe-cafe-100000000002"]

Felmeddelande

Fault

Properties

Namn	Beskrivning	Typ	Multiplicitet
code	HTTP-felkod.	integer	1
reason	Textöversättning av felkod	string	1
errors	Mer detaljerad felbeskrivning	string	0..*

Exempel

XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lmfault:Fault
   xmlns:lmfault="http://namespace.lantmateriet.se/distribution/produkter/fault">
   <lmfault:code>400</lmfault:code>
   <lmfault:reason>Bad Request</lmfault:reason>
   <lmfault:errors>Invalid UUID: test-cafe-123</lmfault:errors>
</lmfault:Fault>

JSON

{
   "code": 400,
   "reason": "Bad Request",
   "errors": [
      "Invalid UUID: test-cafe-123"
   ]
}

Gränssnittsdefinition

Åtkomstpunkt

Schema

Format

Felmeddelande

Sammanfattning

Samfällighetsförening

Referens

Operationer

GET /{id}

Beskrivning

Exempel

Requestparametrar

Svar

POST /

Beskrivning

Exempel

Requestparametrar

Svar

GET /organisation/{organisationsnummer}

Beskrivning

Exempel

Requestparametrar

Svar

POST /organisation

Beskrivning

Exempel

Requestparametrar

Svar

GET /referens/beror/{id}

Beskrivning

Exempel

Requestparametrar

Svar

GET /referens/filter

Beskrivning

Exempel

Requestparametrar

Svar

Datatyper

Frågor

IdRequest

Properties

Exempel

Felmeddelande

Fault

Properties

Exempel

Versionshistorik, Samfällighetsförening Direkt