API Spec

/index -> Instruktioner för användingen av API:et

/get_all_museums -> Funktion som returnerar alla museer.

/get_museums -> Hämtar museer baserat på sökkriterier i url

/get_provinces -> Hämtar lista på alla landskap

/get_categories -> Hämtar lista med alla tillgängliga kategorier

/get_museum_image -> Hämtar bilden som tillhör museet som b64-string

/get_ewks -> Hämtar alla EWK-verk

/ewk_search -> Hämtar EWK-verk baserat på sökkriterier i url

/get_ewk_image       -> Hämtar bilden för ewk som b64-string

/get_museum_guide_image -> Hämtar museets museiguide bild som b64-string

 

 

Spec och exempel

get_museum

Url kan se ut enligt följande: /api/get_museum/1298 . Där siffrorna motsvarar id för ett museum i databasen. Om inget museum hittas så returneras en tom array.

get_all_museums 

Hämtar alla museer som finns tillgängliga och som inte är nedlagda. Kan returnera mycket data. För att paginera datan så kan man skicka in antal per sida och sidonummer i url enligt följande: /api/get_all_museums/[antal per sida]/[sidonummer] . Url /api/get_all_museums/10/1 kommer returnera de första 10 resultaten i listan, /api/get_all_museums/10/2 kommer returnera de kommande 10 efter. Högre antal sidor än det finns kommer returnera tom array, likaså färre.

get_museums 

Url kan se ut enligt följande: /api/get_museums?category=3&province=3&postal_place=ort-post&free-search=fritextsökning där category söks efter id som kan hittas med get_categories. Province är landskap och kan också letas upp med ett id som kan hittas med get_provinces. postal_place avser postort och kan sökas med hjälp av ett sökord. free-search tillåter sökning efter sökord bland museernas textfält. Sökningen kan köras med vilket kriterium som helst eller samtliga om man vill begränsa resultaten. Endpointen har också följande query-variabler tillängliga som booleans för att begränsa sökresultaten ytterligare:

• children_activities (bool) -> Utesluter resultat som har eller saknar möjlighet till fika
• fika (bool) -> Utesluter resultat som har eller saknar möjlighet till fika
• overnight (bool) -> Utesluter resultat som har eller saknar möjlighet till övernattning
• member (bool) -> Utesluter resultat som är/är inte medlemmar i ArbetSam
• museum_guide (bool) -> Utesluter resultat som är / är inte med i Museiguiden
• museum_of_year (bool) -> Utesluter resultat som har varit / inte varit årets arbetslivsmuseum vid något tillfälle.

 

ewk_search

Url kan se ut enligt följande: /api/ewk_search?subject=Konst&title=Utvecklaren&depicted=ber . Subject avser ämnesord som ewk-verk har kopplade till sig och är en sträng. Title avser EWK-verkets titel och är också en sträng. Depicted avser den avbildade personen i verket och är också en sträng. Sökningen kan köras med vilket kriterium som helst eller samtliga om man vill begränsa resultaten.

get_museum_image 

Url kan se ut enligt följande: /api/get_museum_image/2 där siffran avser id för museum. Bilden returneras som en B64-sträng.

get_museum_image_with_info 

Url kan se ut enligt följande: /api/get_museum_image_with_info/2 där siffran avser id för museum. Enpointen hämtar ett object som innehåller museets bild samt fotografens namn och bildens titel. Bilden returneras som en B64-sträng.

get_ewk_image 

Url kan se ut enligt följande: /api/get_ewk_image/2 där siffran avser id för ewk-verk. Bilden returneras som en B64-sträng.

get_museum_guide_image

Url kan se ut enligt följande: /api/get_museum_guide_image/2 där siffran avser id för museum. Bilden returneras som en B64-sträng.