-
Dokumentasjon
Informasjon om hvilke opplysninger som ligger i portalen.
Eksport / integrasjon
Det er laget mulighet for å eksportere data fra foreningsportalen. Dette kan være aktuelt når en ønsker å vise data fra portalen andre steder. Her finner du informasjon om denne muligheten.Innhold
- Generelt
- Eksport forening (json)
- Eksport kalender (json)
- Eksport kalender (ics/iCal)
- Eksport kalender (rss)
Generelt
JSON-format
Vi har valgt å benytte JSON-format på standard eksport da det er mange systemer som støtter dette formatet. Vi gjør følgende endringer på tekster:
- Alle html-tagger fjernes
- Ulike former for linjeskift ( br / /p / CR/LF ) erstattes med \n
- Tabulator erstattes med \t
- " erstattes med \"
- \ erstattes med \\
En kan legge inn parameter "Format=pre" for å vise teksten slik den er, ellers må en bruke "Vis sidekilde" for å se dataene riktig. Når en tar med "Format=pre" vises også litt informasjon om parametre i toppen. Det er ikke json i header på responsen.
Lenke
Kontakt WIS på post@wis.no for å få åpnet lenke til eksportene fra din foreningsportal. Det er pr. i dag to eksporter:
- Forening json (liste / detaljer)
- Kalender json (liste / detaljer)
- Kalender ics (liste)
- Kalender rss (liste)
Begrensninger
Det er ingen begrensninger når en henter ut data fra foreningsportalen på denne måten.
Pris
Tilgang til å hente ut data er inkludert i lisensen for portalen.
Eksport: Forening (json)
Denne lager en liste over alle foreninger på portalen som tilfredsstiller parameter som gis inn.
Parameter
- Format: Dersom denne settes til "pre" (Format=pre), vil resultat vises formatert
- Search: Fritektssøk i de fleste felt som styrer liste (brukes ikke dersom det er angitt Id)
- Id: Foreningens id. Dersom den er angitt vises detaljer om foreningen. Hvis ikke vises liste over foreninger
Felt i liste
- Id: Foreningens Id
- Name: Foreningens navn
- AreaId: Område Id
- AreaName: Område navn
- CategoryId: Kategori Id
- CategoryName: Kategori navn
- LogoUrl: Lenke til logo-bilde
- Email: E-postadresse
- Phone: Telefon
- Url: Adresse til nettside
Felt i detaljer
- Id: Foreningens Id
- Name: Foreningens navn
- AreaId: Område Id
- AreaName: Område navn
- CategoryId: Kategori Id
- CategoryName: Kategori navn
- ImageUrl: Lenke til illustrasjonsbilde
- LogoUrl: Lenke til logo-bilde
- Ingress: Kort info om foreningen
- Description: Lengre beskrivelse av foreningen
- Phone: Telefon
- Email: E-postadresse
- Url: Adresse til nettside
- Facebook: Lenke til Facebook-side
- Contact: Kontaktperson
- VisitAddress: Besøksadresse
- PostAddress: Postadresse
- PostNumber: Postnummer
- PostName: Poststed
- OrgNumber: Organisasjonsnummer
- EstDate: Etableringsdato (dd.mm.yyyy)
- Members: Antall medlemmer
- Vipps: VIPPS-nummer
- Keywords: Stikkord
- ExtranetLastModified: Siste endret på portalen
Eksport: Kalender (json)
Denne eksporten lager en liste over kalenderoppføringer eller en bestemt.
Parameter
- Format: Dersom denne settes til "pre" (Format=pre), vil resultat vises formatert
- ContentType=html tar med html-format på tekster, ellers brukes ren tekst (plain text)
- Id: Hvis det sendes inn Id får en all info om den oppføringen, ellers listes kalenderoppføringer opp
- DateFrom: Startdato (dd.mm.yyyy)
- DateTo: Sluttdato (dd.mm.yyyy)
- DaysFrom: Startdato i forhold til dagens dato (-1 betyr fra og med i går)
- DaysTo: Sluttdato i forhold til dagens dato (2 betyr til og med i overmorgen)
- OrganizerId: Id for organisasjon
- Search: Søker i de fleste felt
- Top: Antall treff. Hvis det ikke er angitt brukes 250
Felt
- Id: Id til kalenderoppføringen
- NewDate: 1 hvis det er første oppføring på ny dato, ellers 0
- Date: Oppføringens dato (dd.mm.yyyy)
- DateEnd: Oppføringens sluttdato (dd.mm.yyyy)
- Time: Klokkeslett (tt:mm). Dersom det er også er angitt tid slutt, vises det som start - slutt
- TimeStart: Klokkeslett start (tt:mm)
- TimeEnd: Klokkeslett slutt (tt:mm)
- Title: Tittel
- Description: Beskrivelse
- Details: Detaljert beskrivelse
- Location: Sted
- ImageUrl: Lenke til tilknyttet bilde
- OrganizerId: Id til foreningen som er tilknyttet oppføringen
- OrganizerName: Navn på foreningen som er tilknyttet oppføringen
- OrganizerLogo: Lenke til foreningens logo
Eksport: Kalender (ics/ical)
Denne eksporten lager en liste over kalenderoppføringer eller en bestemt.
Parameter
- Format: Dersom denne settes til "pre" (Format=pre), vil resultat vises formatert
- Id: Hvis det sendes inn Id får en all info om den oppføringen, ellers listes kalenderoppføringer opp
- DateFrom: Startdato (dd.mm.yyyy)
- DateTo: Sluttdato (dd.mm.yyyy)
- DaysFrom: Startdato i forhold til dagens dato (-1 betyr fra og med i går)
- DaysTo: Sluttdato i forhold til dagens dato (2 betyr til og med i overmorgen)
- OrganizerId: Id for organisasjon
- Search: Søker i de fleste felt
- Top: Antall treff. Hvis det ikke er angitt brukes 250
Felt
- UID: Id til kalenderoppføringen
- DTSTAMP
- LOCATION
- DTSTART: Klokkeslett start (tt:mm)
- DTEND: Klokkeslett slutt (tt:mm)
- SUMMARY: Tittel
- DESCRIPTION: Beskrivelse
Eksport: Kalender (RSS)
Denne eksporten lager en liste over kalenderoppføringer på RSS-format 2.0.
Parameter
- DateFrom: Startdato (dd.mm.yyyy)
- DateTo: Sluttdato (dd.mm.yyyy)
- DaysFrom: Startdato i forhold til dagens dato (-1 betyr fra og med i går)
- DaysTo: Sluttdato i forhold til dagens dato (2 betyr til og med i overmorgen)
- OrganizerId: Id for organisasjon
- Search: Søker i de fleste felt
- Top: Antall treff. Hvis det ikke er angitt brukes 250
Felt
- channel
- title
- link
- description
- language
- item
- title
- guid
- link
- description
- dc:creator: WisWeb
- dc:date: Arr.dato
- dc:dateend: Dato slutt hvis foreskjellig fra dc:date
- dc:start: Tid start
- dc:end: Tid slutt
- dc:place: Sted
- dc:arr: Arrangør
- enclosure: Url til oppføringens bilde