Du har en kontorstol. Hvilke tjenester kan den få? Det svarer ett endepunkt på:

  GET https://api.sirktek.com/orgadmin/v1/solutions?category=OfficeChair

Endepunktet er åpent. Det krever ingen innlogging.

Søket går oppover

Standardoppførselen er categoryMatch=ancestors. Da matcher søket kategorien selv og alle kategoriene over den i taksonomien:

  Kontorstol → Stol → Sittemøbler → Møbler

En tjeneste registrert på Stol treffer altså søket etter Kontorstol. Det er poenget: leverandøren registrerer tjenesten én gang, på riktig nivå. Du finner den uansett hvor spesifikt objektet ditt er kategorisert.

De andre modusene:

categoryMatchRetningBruk
ancestorsOppover (standard)«Jeg har en kontorstol. Hva kan gjøres med den?»
descendantsNedover«Hvilke tjenester finnes i stol-grenen?»
exactBare kategorien selvPresis filtrering

category godtar klassenavnet (OfficeChair) eller hele URI-en (http://taxonomy.sirktek.no/furniture#OfficeChair). Se Identifikatorer.

Flere filtre

ParameterHva den gjør
typeFiltrer på tjenestetype: RECOVER_VALUE, RETAIN_VALUE, ADD_VALUE, PRODUCTION
excludeTypeUtelat en type. excludeType=PRODUCTION gir bare tjenester.
organizationIdsBare tjenester fra gitte leverandører
minLatitude osv.Geografisk avgrensning med minLatitude, maxLatitude, minLongitude, maxLongitude
pageNumber, pageSizePaginering. pageSize er maks 100.

Send Accept-Language: nb for norske kategorinavn i svaret.

Svaret

Svaret er en JSON-liste. Totalen står i headerne Content-Range og X-Total-Count.

  [
  {
    "id": 214,
    "name": "Omtrekk av stol",
    "description": "Full omtapetsering med nytt tekstil.",
    "type": "RETAIN_VALUE",
    "module": "B3",
    "organizationId": "b7f2…",
    "organizationName": "Møbeltapetsereren AS",
    "categoryId": -907692052,
    "categoryName": "Stol",
    "providerLocation": { "type": "Point", "coordinates": [10.75, 59.91] },
    "co2eData": {
      "impactCategory": "GWP-total",
      "total": 12.4,
      "savings": 88.1,
      "unit": "kg CO2e",
      "status": "COMPLETED"
    },
    "functionalUnit": { "amount": 1.0, "unit": "PCS", "expectedServiceLife": 10 }
  }
]

Legg merke til categoryId og categoryName. Tjenesten over er registrert på Stol, ikke på Kontorstol. Den kom med fordi søket gikk oppover.

co2eData viser tjenestens klimaregnskap: utslippet tjenesten koster, og hva den sparer mot å kjøpe nytt.

Verdt å vite

  • Ukjent kategori gir tom liste, ikke feil. Sjekk stavingen av klassenavnet hvis du får null treff.
  • Søket oppover følger bare det felles taksonomitreet. En organisasjons egne kategorier er ikke med i oppoverssøket ennå.
  • Hver tjeneste peker på én kategori, gjennom sin funksjonelle enhet.

Hele taksonomien

Trenger du selve treet, henter du det fra et annet åpent endepunkt:

  GET https://api.sirktek.com/orgadmin/v1/categories

Svaret er hele hierarkiet som nøstet JSON. Hver node har id, uri, name og displayName på ditt språk.

Leverandører 

  GET https://api.sirktek.com/orgadmin/v1/providers?name=tapetser

Lister organisasjoner med minst én offentlig tjeneste. Søkestrengen må ha minst to tegn.

Videre