Identifikatorer
En kategori har tre identiteter. Alle tre peker på det samme.
| Identitet | Eksempel | Bruk |
|---|---|---|
| Klassenavn | OfficeChair | Kortformen i API-kall. Engelsk, stabil. |
| URI | http://taxonomy.sirktek.no/furniture#OfficeChair | Fullt navn. Entydig på tvers av taksonomier. |
| Numerisk ID | -907692052 (for Chair) | Nøkkelen i data. Alltid negativ for felleskategorier. |
Klassenavn
Klassenavnet er engelsk og skrives i PascalCase: Chair, OfficeChair, CabinetUnit.
Det norske navnet, for eksempel «Kontorstol», er visningstekst. Bruk aldri
visningsteksten som nøkkel.
I API-kall kan du bruke klassenavnet direkte:
GET /solutions?category=OfficeChair
URI
URI-en er klassenavnet med taksonomiens navnerom foran:
http://taxonomy.sirktek.no/furniture#OfficeChair
API-et godtar URI-en overalt der det godtar klassenavnet. Bruk URI-en når du trenger å være helt entydig på tvers av taksonomier.
Numerisk ID
Hver kategori har en numerisk ID. Den regnes ut deterministisk fra URI-en med en hash. Samme URI gir samme ID, i alle tjenester og til enhver tid.
To regler er verdt å huske:
- Felleskategorier har negativ ID. For eksempel
Chair=-907692052. - Organisasjonens egne kategorier har positiv ID. De kommer fra databasen.
ID-ene er trygge i JavaScript. De holder seg innenfor Number.MAX_SAFE_INTEGER.
Det er den numeriske ID-en som står i data: på objekter, på tjenester og på ordrelinjer. Klassenavn og URI er oppslagsnøkler inn til den.
Videre
- Tjenestesøk. Kategorien i praksis.