Vinkin lisäys

Form POST osoitteeseen /lisaa-vinkki/, palauttaa defaulttina JSON:ia, jossa kyseisellä kielellä vastaus.

Formin kentät:

  • suggestion_name: Kirjoittajan nimi

  • suggestion_title: Vinkin otsikko

  • suggestion_content: vinkin sisältö, pakollinen

  • post_guid : aktiviteetin guid

  • partio_id : mikäli käyttäjällä partio-id, niin täytä tämä

  • lang, kielikoodi (fi, sv, en ja niin edelleen), default fi

  • suggestion_file_user: Vinkin liite, file upload tyyppiä. Sallitut tiedostotyypit määritetään asetuksissa.

API-kuvaus, JSON, hakusivu

GET https://pof-backend.partio.fi/json-hakusivu
GET https://pof-backend.partio.fi/json-hakusivu&program={program}&tags={tags}

Palauttaa jsonin, jossa osa-alueittain ne asiat, mitä hakusivulla pitäisi näyttää. Palauttaa machine namen tuosta kyseistä itemistä, eli ei käännöstä. Käännökset haettava käännössivusta.

Mahdollisuus filtteröidä,

/json-hakusivu/?tags=ryhmakoko,paikka palauttaa tagit ryhmäkoko ja paikka

Parametri Selite
tags Pilkulla eroteltu lista tageista, mitä halutaan palauttaa. Oletuksena palautetaan kaikki tagit
program Ohjelman GUID, minkä alla olevat tagit palautetaan. Mikäli tyhjä, palautetaan oletuksena Partio-ohjelman hakutiedot

API-kuvaus, tagien käännösten filtteröinti

Sivu /tag-translations-json/ näyttää tagien käännökset. Kyseinen sivu defaulttina tarjoaa kaikki käännökset kaikista kielistä.

Määrää voi filtteröidä yksinkertaisilla get-parametreilla, joiden sisältö on pilkuilla eroteltua

Kieli:
?langs=en,fi

Esimerkki: /tag-translations-json/?langs=en,fi

Näyttää suomen ja englannin

Kielilistassa tällä hetkellä valittavissa fi, sv ja en

Tagit
?tags=paikka,ryhmakoko

Esimerkki: /tag-translations-json/?tags=paikka,ryhmakoko

Näyttää suoritepaikat ja ryhmäkoot

Näyttää siis valitut taxonomiat. Kaikki taxonomiat saatavilla, kun listaa ilman parametreja. Tällä hetkellä olevat

  • paikka
  • ryhmakoko
  • pakollisuus
  • suoritus_kesto
  • suoritus_valmistelu_kesto
  • tarvikkeet
  • taitoalueet
  • yleiset
  • api_type

API-kuvaus, sisäinen linkitys

Sivujen sisäisessä linkityksessä käytetään WP:n shortcode -tyyppistä tapaa, eli hakasuluilla ympäröityä tekstiä. Esimerkkinä:

[pofapilink guid=”431f20ff38fce334c1ff988075b69b03″ kuva=”http://pof-backend.partio.fi/wp-content/uploads/2015/08/leiri.gif” lang=”fi”]

Kyseinen linkittäisi apin läpi tulevaan sivuun, jonka guid on 431f20ff38fce334c1ff988075b69b03 ja linkin sisältönä olisi tarkoitus käyttää kuva-parametrissä olevaa kuvaa.

[pofapilink guid=”431f20ff38fce334c1ff988075b69b03″ teksti=”Leiri”]

Kyseinen linkittäisi apin läpi tulevaan sivuun 431f20ff38fce334c1ff988075b69b03 ja linkin sisältönä olisi tarkoitus käyttää teksti-parametrissä olevaa kuvaa.

parametrit
– guid => linkitettävän sivun guid
– teksti => a tagin sisään tuleva teksti
– kuva => urli kuvasta, joka olisi tarkoitus näyttää
– lang => kieli. Defaulttina suomi

Esimerkkinä testiaktiviteetin json api sivu

API kuvaus, JSON, tagit

GET https://pof-backend.partio.fi/tag-translations-json
GET https://pof-backend.partio.fi/tag-translations-json?tags={tags}&langs={langs}&program={program}

Palauttaa listan tageista, käännöksineen. Saatavilla olevat tagit ovat:

  • paikka
  • ryhmakoko
  • pakollisuus
  • suoritus_kesto
  • suoritus_valmistelu_kesto
  • tarvikkeet
  • taitoalueet
  • yleiset
  • api_type
  • teemat

Parametrit

Parametri Selite
tags Pilkulla eroteltu lista tageista, mitä halutaan palauttaa. Oletuksena palautetaan kaikki tagit.
langs Pilkulla eroteltu lista kielistä, minkä alla olevat tagit palautetaan. Jos tyhjä palautetaan kaikki kielet.
program Ohjelman GUID, minkä alla olevat tagit palautetaan. Oletuksena tyhjä, milloin palautetaan kaikki ohjelmille yhteiset tagit.

API kuvaus, JSON, taskgroup

Key Type Mahdolliset arvot Esimerkkisisältö Selite
additional_tasks_count int 7 Kyseisen suoritepaketin hyväksyttyyn suorittamiseeen vaadittavien valinnaisten suoritteiden määrä
mandatory_tasks array<string> ”97624960085f6d6887b1ebed0ddf8514,2117855a307a10be8d0d430672b64ef3” Kyseisen suoritepaketin hyväksyttyyn suorittamiseeen vaadittavien pakollisten suoritteiden hashit

 

API kuvaus, JSON, yleiset

Seuraavat kentät ovat kaikissa json-apin detailseissa. Osa löytyy myös puusta.

Key Type Mahdolliset arvot Esimerkkisisältö Selite
type string ”program”, ”agegroup”, ”taskgroup”, ”task” ”task” Sivun tyyppi
title string ”Keitän teetä luonnonantimista” Otsikko
ingress string  ”Sudenpentu oppii, että luonnosta voi löytää erilaisia syötäväksi kelpaavia kasveja.” Lyhyt kuvausteksti
content string  ”Tutustukaa luonnosta löytyviin syötäväksi kelpaaviin kasveihin.” Sisältö
lastModified datetime  ”2015-07-01 00:05:48” Kyseisen lehden viimeisimmän muokkauksen ajankohta
lastModifiedBy obj Kyseisen lehden viimeisimmän muokkaajan tiedot
lastModifiedBy->id int  maxInt  1 Backendissä olevan käyttäjän id
lastModifiedBy->name string  Osku Badckendissä olevan käyttäjän nimi
treeDetails -> lastModified datetime  ”2015-07-01 00:05:48” Koko puun viimeisimmän muokkauksen ajankohta
treeDetails -> lastModifiedBy obj Koko puun viimeisimmän muokkaajan tiedot
treeDetails -> lastModifiedBy->id int  maxInt  1 Backendissä olevan käyttäjän id, joka on tehnyt viimeisen muokkauksen puussa.
treeDetails -> lastModifiedBy->name string  Osku Badckendissä olevan käyttäjän nimi, joka on tehnyt viimeisen muokkauksen puussa.
treeDetails -> hash string c64f71aacb0906a9d7fc6ae0de515efd Hash, joka vaihtuu jokaisen muokkauksen jälkeen.

 

API kuvaus, JSON, program

Key Type Mahdolliset arvot Esimerkkisisältö Selite
title string ”Keitän teetä luonnonantimista” Otsikko
ingress string  ”Sudenpentu oppii, että luonnosta voi löytää erilaisia syötäväksi kelpaavia kasveja.” Lyhyt kuvausteksti
content string  ”Tutustukaa luonnosta löytyviin syötäväksi kelpaaviin kasveihin.” Sisältö
lastModified datetime  ”2015-07-01 00:05:48” Otsikko
lastModifiedBy obj Otsikko
lastModifiedBy->id int  maxInt  1 Backendissä olevan käyttäjän id
lastModifiedBy->name string  Osku Badckendissä olevan käyttäjän nimi
mandatory boolean  true, false  true Onko suoritus pakollinen. Näkyy suorituksen sivulla (pakollinen, vapaaehtoinen), sekä on hakuehto
groupsize array of strings  ”one”, ”two”,”few”,
”group”, ”big”
Ryhmäkokoone : Yksin
two : Kaksin
few : Muutama
group : Laumassa tai vartiossa
big : Isommassa porukassa