SMAPI v2: Documentation

smapi (V2)

Smålands APIet (SMAPI) är ett REST-baserat webb-API som erbjuder snabb och öppen åtkomst till intressanta platser i Småland och på Öland. SMAPI erbjuder information om tusentals affärsverksamheter runt om Småland och Öland. Med SMAPI kan du som utvecklare fokusera på att bygga effektiva, användbara och lättillgängliga applikationer och tjänster, utan att spendera tid på datainsamling. Denna dokumentation syftar att beskriva den andra generationen av SMAPI (SMAPI V2) och hur denna version används.

API-nyckel

För att få tillgång till SMAPIs databas med information, måste en giltig API-nyckel erhållas. API-nycklar distrubueras via SMAPIs administratörer och görs tillgängliga för tredjepartsutvecklare. API-anrop som görs utan, eller med ogiltig API-nyckel, blockeras av SMAPI och retunerar således ingen information till den som initierat API-anropet. Då en API-nyckel är en unik identifierare skall den hållas hemlig. Spridning eller felaktig användning av en API-nyckel resulterar i att nyckeln inaktiveras och därmed inte längre kan användas för begäran av information.

Här följer ett exempel på API-anrop med angiven API-nyckel som argument. Notera att värdet XXX måste ersättas med aktiv API-nyckel för att anropet skall fungera:

https://smapi.lnu.se/api/?api_key=XXX

Exekveringslägen

API-anrop till SMAPI kan exekveras i två lägen; debug mode och Production Mode. Standardinställningen är production mode och innebär att responsobjektet returneras i komprimerat format. Detta resulterar i ett "maskinvänligt" format som går snabbt att överföra och tolka. För att underlätta testning kan SMAPI-anrop exekveras under debug mode. Detta görs genom att i samband med aktuellt API-anrop bifoga argumentet debug. Detta argument skall sättas till true och resulterar i att responsobjektet presenteras i okomprimerat, samt formaterat format. Färdigställda applikationer och tjänster som brukar SMAPI, skall inte använda debug mode i sin produktionskod.

Här följer ett exempel på API-anrop som exekveras i debug mode:

https://smapi.lnu.se/api/?debug=true

Kontrollanter

SMAPI är utformat efter ett koncept där kontrollanter används för att kommunicera med APIet. En kontrollant utgör en specifik del eller gruppering av SMAPIs funktionalitet. För att genomföra ett API-anrop, måste en giltig kontrollant bifogas som argument i samband med anropet. Detta görs via GET-argumentet controller. Avsaknad av controller-argumentet resulterar i felkod 101. För mer information, se avsnittet om felkoder.

activity: Innefattar funktionalitet för att hantera affärsverksamheter med inriktning aktiviteter.
accommodation: Innefattar funktionalitet för att hantera affärsverksamheter med inriktning boende och övernattning.
attraction: Innefattar funktionalitet för att hantera affärsverksamheter med inriktning sevärdheter.
establishment: Innefattar funktionalitet för att hantera affärsverksamheter. Denna kontrollant innefattar samtliga affärsverksamheter, oavsett inriktning.
food: Innefattar funktionalitet för att hantera affärsverksamheter med inriktning mat och dryck.
shop: Innefattar funktionalitet för att hantera affärsverksamheter med inriktning handel.

Här följer ett exempel på anrop som specificerar kontrollanten food:

https://smapi.lnu.se/api/?controller=food

Metoder

En metod är en åtgärd som kopplats till en kontrollant och kan utföras på begäran. Metoder specificeras via GET-argumentet method. Avsaknad av method-argumentet resulterar i felkod 102. För mer information, se avsnittet om felkoder.

Här följer ett exempel på anrop som specificerar metoden getall i kontrollanten food:

https://smapi.lnu.se/api/?controller=food&method=getall

Responseobjekt

SMAPI använder JavaScript Object Notation (JSON) som sitt primära dataöverföringsformat. API-anrop till SMAPI resulterar därför i en utskrift av ett responsobjekt som formaterats enligt JSON-formatet. Responsobjektet innehåller två sektioner; header och payload. Detta avsnitt är menat att ge en kort beskrivning av respektive sektion i SMAPIs responsobjekt. Det skall noteras att detta responsobjekt är standardiserat och därmed använder samma struktur för samtliga API-anrop.

header: Sektion innehållande metadata för aktuellt API-anrop. Metadatan består av statuskod samt eventuellt felobjekt. API-anrop som resulterar i en positiv statuskod retunerar felobjektet som null. Negativa felkoder resulterar i ett felobjekt vars innehåll syftar till att beskriva det aktuella felet. Mer information om fel som kan uppstå i samband med API-anrop finns dokumenterade under avsnittet om statuskoder.
payload: Denna sektion av SMAPIs responsobjekt representerar en liststruktur (Array) innehållande eventuell responsdata. Responsdata presenteras som enskilda objekt innehållande information som redogörs under samtliga API-metoders responsdatasektion.

Här följer ett exempel på responsobjekt:

    {
        "header": {
            "status": "OK",
            "error": null
        },
        "payload": []
    }

Statuskoder

Detta avsnitt redogör för SMAPIs statuskoder för responsobjekt. Ett responsobjekt representerar ett svar, eller bekräftelse på genomfört API-anrop. Samtliga API-anrop till SMAPI skall resultera i ett responsobjekt innehållande något av följande statuskoder.

OK: Aktuellt API-anrop genomfördes korrekt. Eventuella resultat går att finna i responsobjektets payload. Notera att eventuella resultat presenteras i listformat. Notera att ett korrekt genomfört API-anrop inte garanterar någon responsdata. Ett responsobjekt kan innehålla en tom payload, även om API-anropet genomförts korrekt.
FAILED: Aktuellt API-anrop misslyckades. Misslyckade API-anrop returnerar aldrig någon responsdata och därmed förblir payload tom. Statuskoden indikerar i regel felaktig användning av APIet. Fel korrigeras därmed av tredjepartsutvecklaren och inte av SMAPIs administratörer.

Felkoder

Detta avsnitt redogör för SMAPIs felkoder. En felkod syftar till att beskriva ett eller flera fel som uppstått under exekvering av aktuellt API-anrop. Statuskoder redogörs i felobjekt, som implementerats som en del av SMAPIs header-sektion. Felaktiga, eller misslyckade anrop får av säkerhetsskäl inte returnera någon svarsdata.

000 - Database Error: SMAPIs databaskommunikation är bruten eller på annat sätt inaktiv. Felet klassas som allvarligt, men internt. API-användare kan inte påverka detta fel utan ombedes att försöka igen. Om felet kvarstår, kontakta SMAPIs administratörer.
100 - Invalid API Key: Det aktuella API-anropet angav ingen API-nyckel, alternativt var den nyckel som angavs ogiltig. Kontrollera att den nyckel som används är identisk med den som förmedlats av SMAPIs administratörer.
101 - Invalid Controller: Det aktuella API-anropet angav ingen kontrollant. Kontrollera att kontrollant-argumentet (controller) finns med i API-anropets resursförfrågan.
102 - Missing Method: Det aktuella API-anropet angav ingen metod. Kontrollera att metod-argumentet (method) finns med i API-anropets resursförfrågan.
103 - Invalid Method: Den efterfrågade metoden finns inte tillgänglig i aktuell kontrollant. Kontrollera metodens stavning och att korrekt kontrollant adresseras.
201 - Missing Argument: En eller flera obligatoriska argument saknas vid aktuellt API-anrop. Kontrollera dokumentationen för aktuell metod för mer information om vilka argument som anses vara obligatoriska.

Här följer ett exempel på responsobjekt med felkod 101:

    {
        "header": {
            "status": "FAILED",
            "error": {
                "id": 101,
                "title": "invalid controller",
                "description": "An invalid or nonexistent controller was requested"
            }
        },
        "payload": []
    }

JavaScript API

SMAPI är ett REST-baserat API och således sker all kommunikation mellan klient och server via HTTP-anrop. I syfte att underlätta kommunikation mellan klient och server, erbjuds SMAPI JavaScript API; som är ett programmeringsbart gränssnitt för att kommunicera med SMAPI direkt via JavaScript. Detta API inkluderar samtlig SMAPI-funktionalitet direkt via dedikerade egenskaper och metoder. SMAPI JavaScript API är av öppen källkod och kan laddas ned via projektets GitHub-sida.

smapi.accommodation

Kontrollant för att hantera generell information som relaterar till en eller flera affärsverksamheter som bedriver hotell, camping, bed & breakfasts, eller liknande verksamhet. Det skall noteras att kontrollanten inte innehåller något unikt innehåll utifrån establishment-kontrollanten. Kontrollanten innehåller följande metoder:

getAll: Hämtar samtliga affärsverksamheter i SMAPIs databas som typats som hotell, camping, bed & breakfasts, eller liknande verksamhet.
getFromLatLng: Hämtar affärsverksamheter (som typats inom accommodation) utifrån geografisk position (latitude och longitude).

smapi.accommodation.getall

Hämtar samtliga affärsverksamheter i SMAPIs databas som typats som hotell, camping, bed & breakfasts, eller liknande verksamhet. Argument kan användas för att filtrera informationshämtning.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Argument som betecknats som obligatoriska måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel ignoreras av systemet och levererar därför ingen information.
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som CSV-data, där vardera namn separeras med kommatecken. Exempel: ?names=okq8,mcdonalds
descriptions: Begränsar informationshämtning utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,camping
breakfast: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder frukostmöjlighet (Y) eller inte (N).
free_parking: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder gratis parkering åt sina gäster (Y) eller inte (N).
restaurant: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder möjlighet till mat (Y) eller inte (N).
conference: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder konferensmöjligheter (Y) eller inte (N).
laundry_service: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder tvättjänst (Y) eller inte (N).
wifi: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder åtkomst till trådlös internetuppkoppling (Y) eller inte (N). Notera att denna datapunkt inte beskriver huruvida det är en gratis- eller betaltjänst.
spa: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder spamöjlighet (Y) eller inte (N).
gym: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder åtkomst till gym (Y) eller inte (N).
bar: Begränsar informationshämtning till huruvida affärsverksamheten har tillgång till bar (Y) eller inte (N).
pet_friendly: Begränsar informationshämtning till huruvida affärsverksamheten tillåter husdjur (Y) eller inte (N).
max_rating: Begränsar informationshämtning till affärsverksamheter vars betyg begränsats till angivet maximumvärde.
min_rating: Begränsar informationshämtning till affärsverksamheter vars betyg begränsats till angivet minimivärde.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tillsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdata-objekt.

id: Affärsrörelsens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
breakfast: Huruvida affärsverksamheten erbjuder frukostmöjlighet (Y) eller inte (N).
free_parking: Huruvida affärsverksamheten erbjuder gratis parkering åt sina gäster (Y) eller inte (N).
restaurant: Huruvida affärsverksamheten erbjuder möjlighet till mat (Y) eller inte (N).
conference: Huruvida affärsverksamheten erbjuder konferensmöjligheter (Y) eller inte (N).
laundry_service: Huruvida affärsverksamheten erbjuder tvättjänst (Y) eller inte (N).
wifi: Huruvida affärsverksamheten erbjuder åtkomst till trådlös internetuppkoppling (Y) eller inte (N). Notera att denna datapunkt inte beskriver huruvida det är en gratis- eller betaltjänst.
spa: Huruvida affärsverksamheten erbjuder spamöjlighet (Y) eller inte (N).
gym: Huruvida affärsverksamheten erbjuder åtkomst till gym (Y) eller inte (N).
bar: Huruvida affärsverksamheten har tillgång till bar (Y) eller inte (N).
pet_friendly: Huruvida affärsverksamheten tillåter husdjur (Y) eller inte (N).
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.

smapi.accommodation.getfromlatlng

Hämtar en lista med affärsverksamheter utifrån en geografisk position. Metoden begränsar informationshämtningen till en radie kring den geografiska position som angivits i samband med API-anropet. Radien har ett standardvärde på 15 kilometer men kan modifieras efter behov via radius-argumentet. Affärsverksamheter som är belägna utanför sökradien, inkluderas inte i responsobjektet.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska, måste förkomma i samband med ett API-anrop. Avsaknad av obligatoriska argument, resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan gilltig API-nyckel, ignoreras av systemet och levererar därmed ingen information.
lat (Obligatorisk): Sökkoordinat angiven i latitude.
lng (Obligatorisk): Sökkoordinat angiven i longitud.
radius: Radie som begränsar geosökningar. API-anropet resulterar i affärsverksamheter inom den angivna radien. Distans anges i kilometer. Standardvärdet är 15 (km).
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som CSV-data, där vardera namn separeras med kommatecken. Exempel: ?names=okq8,mcdonalds
descriptions: Begränsar informationshämtning utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,camping
breakfast: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder frukostmöjlighet (Y) eller inte (N).
free_parking: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder gratis parkering åt sina gäster (Y) eller inte (N).
restaurant: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder möjlighet till mat (Y) eller inte (N).
conference: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder konferensmöjligheter (Y) eller inte (N).
laundry_service: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder tvättjänst (Y) eller inte (N).
wifi: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder åtkomst till trådlös internetuppkoppling (Y) eller inte (N). Notera att denna datapunkt inte beskriver huruvida det är en gratis- eller betaltjänst.
spa: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder spamöjlighet (Y) eller inte (N).
gym: Begränsar informationshämtning till huruvida affärsverksamheten erbjuder åtkomst till gym (Y) eller inte (N).
bar: Begränsar informationshämtning till huruvida affärsverksamheten har tillgång till bar (Y) eller inte (N).
pet_friendly: Begränsar informationshämtning till huruvida affärsverksamheten tillåter husdjur (Y) eller inte (N).
max_rating: Begränsar informationshämtning till affärsverksamheter vars betyg begränsats till angivet maximumvärde.
min_rating: Begränsar informationshämtning till affärsverksamheter vars betyg begränsats till angivet minimivärde.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

id: Affärsrörelsens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
breakfast: Huruvida affärsverksamheten erbjuder frukostmöjlighet (Y) eller inte (N).
free_parking: Huruvida affärsverksamheten erbjuder gratis parkering åt sina gäster (Y) eller inte (N).
restaurant: Huruvida affärsverksamheten erbjuder möjlighet till mat (Y) eller inte (N).
conference: Huruvida affärsverksamheten erbjuder konferensmöjligheter (Y) eller inte (N).
laundry_service: Huruvida affärsverksamheten erbjuder tvättjänst (Y) eller inte (N).
wifi: Huruvida affärsverksamheten erbjuder åtkomst till trådlös internetuppkoppling (Y) eller inte (N). Notera att denna datapunkt inte beskriver huruvida det är en gratis- eller betaltjänst.
spa: Huruvida affärsverksamheten erbjuder spamöjlighet (Y) eller inte (N).
gym: Huruvida affärsverksamheten erbjuder åtkomst till gym (Y) eller inte (N).
bar: Huruvida affärsverksamheten har tillgång till bar (Y) eller inte (N).
pet_friendly: Huruvida affärsverksamheten tillåter husdjur (Y) eller inte (N).
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.
distance_in_km: Avståendet mellan affärsverksameten och den geografiska position som angavs i samband med API-anropet. Avståendet anges i kilomter (km).

smapi.activity

Kontrollant för att hantera affärsverksamheter som bedriver någon form av aktivitet (eller aktiviteter) för deras kunder, alternativt erbjuder tillgång till en plats där aktiviteten (eller aktiviteterna) kan utföras. Exempel på affärsverksamheter som uppfyller detta kriterium är: nöjesparker, bowlinghallar, gokartbanor, golfbanor, tennisbanor, etc.

getAll: Hämtar samtliga affärsverksamheter som bedriver någon form av aktivitet (eller aktiviteter) för deras kunder, alternativt erbjuder tillgång till en plats där aktiviteten (eller aktiviteterna) kan utföras.
getFromLatLng: Hämtar affärsverksamheter (som typats inom activity) utifrån geografisk position (latitude och longitude).

smapi.activity.getall

Hämtar samtliga affärsverksamheter som bedriver någon form av aktivitet (eller aktiviteter) för deras kunder, alternativt erbjuder tillgång till en plats där aktiviteten (eller aktiviteterna) kan utföras. Argument kan användas för att filtrera informationshämtning.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Argument som betecknats som obligatoriska, måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel, ignoreras av systemet och levererar därmed ingen information.
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som CSV-data, där vadera namn separeras med kommatecken. Exempel: ?names=okq8,mcdonalds
descriptions: Begränsar informationshämtning utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,camping
physical_efforts: Begränsar informationshämtning till en eller flera nivåer av fysisk ansträngningsnivå. De nivåer som finns tillgängliga är; LOW, MEDIUM och HIGH. Aktiviteter med ansträngningsnivå LOW i huvudsak "sittande" aktiviteter där utövaren inte löper någon risk för fysisk utmattning. Aktiviteter med ansträngningsnivå MEDIUM är aktiviteter där utövaren förväntas röra på sig, men utan någon direkt ansträngning och låg risk för fysisk utmattning. Aktiviteter med ansträngningsnivå HIGH är aktiviteter där utövaren utsätts för fysiska påfrestningar och därmed en hög risk för fysisk utmattning.
disability_support: Begränsar informationshämtning till huruvida aktuell aktivitet är handikappanpassad (Y) eller inte (N).
child_support: Begränsar informationshämtning till huruvida aktuell aktivitet är barnanpassad (Y) eller inte (N).
event_booking: Begränsar informationshämtning till huruvida aktuell aktivitet kan bokas för evenemang (Y) eller inte (N). Exempel på evenemang är kick-off, konferens, barnkalas eller annan tillställning.
involves_water: Begränsar informationshämtning till huruvida aktuell aktivitet innefattar vatten (Y) eller inte (N).
involves_animals: Begränsar informationshämtning till huruvida aktuell aktivitet innefattar levande djur (Y) eller inte (N).
estimated_durations: Begränsar informationshämtning till en eller flera upskattade aktivitetstider. Systemet innefattar tidsuppskattningarna; MINUTES, HOURS & DAYS.
min_age: Begränsar informationshämtning till aktiviteter med en rekommenderad lägsta ålder.
max_age: Begränsar informationshämtning till aktiviteter med en rekommenderad högsta ålder.
min_reviews: Begränsar informationshämtning till affärsverksamheter som har X, eller fler recensioner, där X är angivet värde.
max_reviews: Begränsar informationshämtning till affärsverksamheter som har X, eller färre recensioner, där X är angivet värde.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdata-objekt.

id: Affärsverksamhetens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
physical_effort: Beskriver aktuell aktivitets ansträngningsnivå. Möjliga utfall är LOW, MEDIUM & HIGH.
disability_support: Beskriver huruvida aktuell aktivitet är handikappanpassad (Y) eller inte (N).
child_support: Beskriver huruvida aktuell aktivitet är barnanpassad (Y) eller inte (N).
event_booking: Beskriver huruvida aktuell aktivitet kan bokas för evenemang (Y) eller inte (N).
involves_water: Beskriver huruvida aktuell aktivitet innefattar vatten (Y) eller inte (N).
involves_animals: Beskriver huruvida aktuell aktivitet innefattar levande djur (Y) eller inte (N).
estimated_duration: Beskriver upskattad tid för genomförande av aktivitet. Möjliga utfall är MINUTES, HOURS & DAYS.
min_age: Beskriver rekommenderad lägsta ålder för aktuell aktivitet.
max_age: Beskriver rekommenderad högsta ålder för aktuell aktivitet.
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.

smapi.activity.getfromlatlng

Hämtar en lista med affärsverksamheter utifrån en geografisk position. Metoden begränsar informationshämtningen till en radie kring den geografiska position som angivits i samband med API-anropet. Radien har ett standardvärde på 15 kilometer men kan modifieras efter behov via radius-argumentet. Affärsverksamheter som är belägna utanför sökradien, inkluderas inte i responsobjektet.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska, måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument resulterar i felkod 201. Argument som namnges i plural, har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel, ignoreras av systemet och levererar därmed ingen information.
lat (Obligatorisk): Sökkoordinat angiven i latitude.
lng (Obligatorisk): Sökkoordinat angiven i longitud.
radius: Radie som begränsar geosökningar. API-anropet resulterar i affärsverksamheter inom den angivna radien. Distans anges i kilometer. Standardvärdet är 15 (km).
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som CSV-data, där vardera namn separeras med kommatecken. Exempel: ?names=okq8,mcdonalds
descriptions: Begränsar informationshämtning utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,camping
physical_efforts: Begränsar informationshämtning till en eller flera nivåer av fysisk ansträngningsnivå. De nivåer som finns tillgängliga är; LOW, MEDIUM och HIGH. Aktiviteter med ansträngningsnivå LOW i huvudsak "sittande" aktiviteter där utövaren inte löper någon risk för fysisk utmattning. Aktiviteter med ansträngningsnivå MEDIUM är aktiviteter där utövaren förväntas röra på sig, men utan någon direkt ansträngning och låg risk för fysisk utmattning. Aktiviteter med ansträngningsnivå HIGH är aktiviteter där utövaren utsätts för fysiska påfrestningar och därmed en hög risk för fysisk utmattning.
disability_support: Begränsar informationshämtning till huruvida aktuell aktivitet är handikappanpassad (Y) eller inte (N).
child_support: Begränsar informationshämtning till huruvida aktuell aktivitet är barnanpassad (Y) eller inte (N).
event_booking: Begränsar informationshämtning till huruvida aktuell aktivitet kan bokas för evenemang (Y) eller inte (N). Exempel på evenemang är kick-off, konferens, barnkalas eller annan tillställning.
involves_water: Begränsar informationshämtning till huruvida aktuell aktivitet innefattar vatten (Y) eller inte (N).
involves_animals: Begränsar informationshämtning till huruvida aktuell aktivitet innefattar levande djur (Y) eller inte (N).
estimated_durations: Begränsar informationshämtning till en eller flera upskattade aktivitetstider. Systemet innefattar tidsuppskattningarna; MINUTES, HOURS & DAYS.
min_age: Begränsar informationshämtning till aktiviteter med en rekommenderad lägsta ålder.
max_age: Begränsar informationshämtning till aktiviteter med en rekommenderad högsta ålder.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

id: Affärsverksamhetens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
physical_effort: Beskriver aktuell aktivitets ansträngningsnivå. Möjliga utfall är LOW, MEDIUM & HIGH.
disability_support: Beskriver huruvida aktuell aktivitet är handikappanpassad (Y) eller inte (N).
child_support: Beskriver huruvida aktuell aktivitet är barnanpassad (Y) eller inte (N).
event_booking: Beskriver huruvida aktuell aktivitet kan bokas för evenemang (Y) eller inte (N).
involves_water: Beskriver huruvida aktuell aktivitet innefattar vatten (Y) eller inte (N).
involves_animals: Beskriver huruvida aktuell aktivitet innefattar levande djur (Y) eller inte (N).
estimated_duration: Beskriver upskattad tid för genomförande av aktivitet. Möjliga utfall är MINUTES, HOURS & DAYS.
min_age: Beskriver rekommenderad lägsta ålder för aktuell aktivitet.
max_age: Beskriver rekommenderad högsta ålder för aktuell aktivitet.
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.
distance_in_km: Avståendet mellan affärsverksameten och den geografiska position som angavs i samband med API-anropet. Avståendet anges i kilomter (km).

smapi.attraction

Kontrollant för att hantera generell information som relaterar till en eller flera affärsverksamheter. Kontrollanten innehåller följande metoder:

getAll: Hämtar samtliga affärsverksamheter som klassificerats som sevärdhet.
getFromLatLng: Hämtar affärsverksamheter utifrån geografisk position (latitud och longitude).

smapi.attraction.getall

Hämtar samtliga affärsverksamheter som typats inom attraction-kategorin. API-anrop kan därför inte inkludera affärsverksamheter inom andra kategorier.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Argument som betecknats som obligatoriska måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel ignoreras av systemet och levererar därmed ingen information.
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som CSV-data, där vardera namn separeras med kommatecken. Exempel: ?names=okq8,mcdonalds
descriptions: Begränsar informationshämtning utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,camping
category: Begränsar informationshämtning till sevärdheter inom en eller flera av följande kategorier; ART, HISTORY, NATURE & SCIENCE, SOCIAL. ART; sevärdheten innefattar, eller betraktas som konst, -utställning eller -installation. HISTORY; sevärdheten är av historisk karaktär. NATURE & SCIENCE; sevärdheten betraktas som ett naturfenomen utan mänsklig inblandning. SOCIAL; sevärdheten är av "social" karaktär, exempelvis artefakt från populärkultur.
static_content: Begränsar informationshämtning till affärsverksamheter vars utbud är statiskt (Y) eller inte (N).
interactive: Begränsar informationshämtning till affärsverksamheter vars utbud, eller delar av utbudet är interaktivt (Y) eller inte (N).
significances: Begränsar informationshämtning till sevärdheter vars innehåll är av följande signifikas; OBSCURE, LOCAL, NATIONAL & INTERNATIONAL. OBSCURE; sevärdheten är av ovanlig karaktär och okänd. LOCAL; sevärdheten är lokalt känd eller har betydelse för omnejd. NATIONAL; sevärdheten är nationellt (er)känd. INTERNATIONAL; sevärdheten är internationellt (er)känd.
max_rating: Beskriver maxbetyg för affärsverksamheter. Information med högre än angivet maxbetyg, kommer inte att hämtas i samband med aktuellt API-anrop.
min_rating: Beskriver minimumbetyg för affärsverksamheter. Information med lägre än angivet minimumbetyg, kommer inte att hämtas i samband med aktuellt API-anrop.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdata-objekt.

id: Affärsrörelsens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
category: Nyckelord som beskriver sevärdhetens kategori. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
static_content: Hurvida sevärdheten är statisk (Y) eller uppdateras över tid (N).
interactive: Hurvida sevärdheten är interaktiv (Y) eller inte (N).
significance: Nyckelord som beskriver sevärdhetens signifikans. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.

smapi.attraction.getfromlatlng

Hämtar en lista med affärsverksamheter utifrån en geografisk position. Metoden begränsar informationshämtningen till en radie kring den geografiska position som angivits i samband med API-anropet. Radien har ett standardvärde på 15 kilometer men kan modifieras efter behov via radius-argumentet. Affärsverksamheter som är belägna utanför sökradien, inkluderas inte i responsobjektet.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument, resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan gilltig API-nyckel ignoreras av systemet och levererar därmed ingen information.
lat (Obligatorisk): Sökkoordinat angiven i latitud.
lng (Obligatorisk): Sökkoordinat angiven i longitud.
radius: Radie som begränsar geosökningar. API-anropet resulterar i affärsverksamheter inom den angivna radien. Distans anges i kilometer. Standardvärdet är 15 (km).
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som CSV-data, där vardera namn separeras med kommatecken. Exempel: ?names=okq8,mcdonalds
descriptions: Begränsar informationshämtning utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,camping
category: Begränsar informationshämtning till sevärdheter inom en eller flera av följande kategorier; ART, HISTORY, NATURE & SCIENCE, SOCIAL. ART; sevärdheten innefattar, eller betraktas som konst, -utställning eller -installation. HISTORY; sevärdheten är av historisk karaktär. NATURE & SCIENCE; sevärdheten betraktas som ett naturfenomen utan mänsklig inblandning. SOCIAL; sevärdheten är av "social" karaktär, exempelvis artefakt från populärkultur.
static_content: Begränsar informationshämtning till affärsverksamheter vars utbud är statiskt (Y) eller inte (N).
interactive: Begränsar informationshämtning till affärsverksamheter vars utbud, eller delar av utbudet är interaktivt (Y) eller inte (N).
significances: Begränsar informationshämtning till sevärdheter vars innehåll är av följande signifikas; OBSCURE, LOCAL, NATIONAL & INTERNATIONAL. OBSCURE; sevärdheten är av ovanlig karaktär och okänd. LOCAL; sevärdheten är lokalt känd eller har betydelse för omnejd. NATIONAL; sevärdheten är nationellt (er)känd. INTERNATIONAL; sevärdheten är internatiellt (er)känd.
max_rating: Beskriver maxbetyg för affärsverksamheter. Information med högre än angivet maxbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
min_rating: Beskriver minimumbetyg för affärsverksamheter. Information med lägre än angivet minimumbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

id: Affärsrörelsens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
category: Nyckelord som beskriver sevärdhetens kategori. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
static_content: Hurvida sevärdheten är statisk (Y) eller uppdateras över tid (N).
interactive: Hurvida sevärdheten är interaktiv (Y) eller inte (N).
significance: Nyckelord som beskriver sevärdhetens signifikans. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.
distance_in_km: Avståendet mellan affärsverksameten och den geografiska position som angavs i samband med API-anropet. Avståendet anges i kilomter (km).

smapi.establishment

Kontrollat för att hantera generell information som relaterar till en eller flera affärsverksamheter. Kontrollanten innehåller följande metoder:

getAll: Hämtar samtliga affärsverksamheter i SMAPIs databas.
getFromLatLng: Hämtar affärsverksamheter utifrån geografisk position (latitud och longitud).
getReviews: Hämtar kundrescentioner för en specifik affärsverksamheter utifrån affärsverksamhetens unika ID-nummer.

smapi.establishment.getall

Hämtar en lista med samtliga affärsverksamheter som finns registerade i SMAPI:s databas. Det skall noteras att denna informationshämtning görs oberoende av affärverksamhetens typning. Argument används för att filtrera informationshämtningar och på så sätt fokusera det urval som returneras som svar på API-anropet.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Argument som betecknats som obligatoriska måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel ignoreras av systemet och levererar därför ingen information.
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera affärsverksamheters namn. Namn förmedlas som CSV-data, där vardera namn separeras med kommatecken. Exempel: ?names=okq8,mcdonalds
descriptions: Begränsar informationshämtning utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,camping
types: Begränsar informationshämtning utifrån en eller flera standardiserade kategorier av affärsverksamheter. SMAPI kategoriserar all data som en av följande typer: activity, accommodation, attraction, food eller shop. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?types=food,shop
addresses: Begränsar informationshämtning utifrån en eller flera gatuadresser. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra.
cities: Begränsar informationshämtning utifrån en eller flera städer. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra.
phone_numbers: Begränsar informationshämtning utifrån ett eller flera telefonnummer. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra.
websites: Begränsar informationshämtning utifrån en eller flera webbadresser. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra.
price_ranges: Begränsar informationshämtning till ett eller flera prisintervall.
outdoors: Begränsar informationshämtning till affärsverksamheter som bedrivs utomhus. Argument förmedlas som konstanterna Y och N. Att genomföra ett anrop där argumentet Y förmedlas resulterar i en lista över affärsverksamheter som primärt bedrivs utomhus. Om argumentet N används, blir resultatet omvänt och enbart affärsverksamheter som bedrivs primärt inomhus returneras. Exempel: ?outdoors=Y
child_discount: Begränsar informationshämtning till affärsverksamheter som erbjuder någon form av barnrabatt. Informationen redovisas via konstanterna Y (för sant) och N (för falskt). Exempel: ?child_discount=Y
student_discount: Begränsar informationshämtning till affärsverksamheter som erbjuder någon form av studentrabatt. Informationen redovisas via konstanterna Y (för sant) och N (för falskt). Exempel: ?student_discount=N
senior_discount: Begränsar informationshämtning till affärsverksamheter som erbjuder någon form av pensionärsrabatt. Informationen redovisas via konstanterna Y (för sant) och N (för falskt). Exempel: ?senior_discount=Y
municipalities: Begränsar informationshämtning till affärsverksamheter inom en eller flera kommuner. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?municipalities=växjö kommun, kalmar kommun
counties: Begränsar informationshämtning till affärsverksamheter inom ett eller flera län. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?counties=kalmar län, jönköpings län
provinces: Begränsar informationshämtning till affärsverksamheter inom ett eller flera landskap. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?provinces=öland
max_rating: Beskriver maxbetyg för affärsverksamheter. Information med högre än angivet maxbetyg, kommer inte att hämtas i samband med aktuellt API-anrop.
min_rating: Beskriver minimumbetyg för affärsverksamheter. Information med lägre än angivet minimumbetyg, kommer inte att hämtas i samband med aktuellt API-anrop.
min_reviews: Begränsar informationshämtning till affärsverksamheter som har X, eller fler recensioner, där X är angivet värde.
max_reviews: Begränsar informationshämtning till affärsverksamheter som har X, eller färre recensioner, där X är angivet värde.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdata-objekt.

id: Affärsverksamhetens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
type: Beskriver den innehållstyp som affärsverksamheten är kopplad till.
address: Den postadress som affärsverksamheten använder.
zip_code: Postnummer till den plats där affärsverksamheten är lokaliserad.
city: Den stad där affärsverksamheten är lokaliserad.
phone_number: Affärsverksamhetens telefonnummer (om sådant finns tillgängligt).
website: Redogör aktuell affärsverksamhets aktuella webbadress. Det finns ingen garanti att affärsverksamheten har en egen webbplats eller att den länkar till en egen domän. Den adress som anges är den webbplats som affärsverksamheten själva förespråkar.
abstract: Beskrivningstext till aktuell affärsverksamhet där antalet tecken begränsats till 256. Denna datapunkt förväntas därmed ge en kort introduktion till affärsverksamheten.
text: Informationstext från aktuell affärsverksamhet. Längden på beskrivningstexten är begränsad till 16 777 215 tecken.
price_range: Beskriver uppskattad prisnivå hos affärsverksamheten. Denna information kan användas för att avgöra om affärsverksamhetens produkter eller tjänster uppfattas som "dyra" eller "billiga". Det skall noteras att denna information är en uppskattning och inte syftar till att ge ett exakt eller numeriskt värde.
outdoors: Beskriver huruvida affärsverksamheten i huvudsak bedriver sin verksamhet utomhus. Värdet Y indikerar att detta är sant och värdet N indikerar att detta inte är sant, dvs att verksamheten bedrivs i huvudsak inomhus.
child_discount: Huruvida aktuell affärsverksamhet erbjuder barnrabatt (Y) eller inte (N).
student_discount: Huruvida aktuell affärsverksamhet erbjuder studentrabatt (Y) eller inte (N).
senior_discount: Huruvida aktuell affärsverksamhet erbjuder pensionärsrabatt (Y) eller inte (N).
municipality: Den kommun där affärsverksamheten är lokaliserad.
county: Det län där affärsverksamheten är lokaliserad.
province: Det landskap där affärsverksamheten är lokaliserad.
modified_at: Tidsstämpel som anger den tidpunkt då affärsverksamhetens data senast var uppdaterad. Tidsstämpeln är främst menad för internt bruk men kan exempelvis användas för att avgöra om informationen är föråldrad.
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.

smapi.establishment.getfromlatlng

Hämtar en lista med affärsverksamheter utifrån en geografisk position. Metoden begränsar informationshämtningen till en radie kring den geografiska position som angivits i samband med API-anropet. Radien har ett standardvärde på 15 kilometer men kan modifieras efter behov via radius-argumentet. Affärsverksamheter som är belägna utanför sökradien, inkluderas inte i responsobjektet.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska, måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument, resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel ignoreras av systemet och levererar därmed ingen information.
lat (Obligatorisk): Sökkoordinat angiven i latitud.
lng (Obligatorisk): Sökkoordinat angiven i longitud.
radius: Radie som begränsar geosökningar. API-anropet resulterar i affärsverksamheter inom den angivna radien. Distans anges i kilometer. Standardvärdet är 15 (km).
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter baserat på deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som CSV-data, där vardera namn separeras med kommatecken. Exempel: ?names=okq8,mcdonalds
descriptions: Begränsar informationshämtningen utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,camping
types: Begränsar informationshämtning utifrån en eller flera standardiserade kategorier av affärsverksamheter. SMAPI kategoriserar all data som en av följande typer: activity, accommodation, attraction, food och shop. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?types=food,shop
addresses: Begränsar informationshämtning utifrån en eller flera gatuadresser. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra.
cities: Begränsar informationshämtning utifrån en eller flera städer. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra.
phone_numbers: Begränsar informationshämtning utifrån ett eller flera telefonnummer. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra.
websites: Begränsar informationshämtning utifrån en eller flera webbadresser. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra.
price_ranges: Begränsar informationshämtning till ett eller flera prisintervall.
outdoors: Begränsar informationshämtning till affärsverksamheter som bedrivs utomhus. Argument förmedlas som konstanterna Y och N. Att genomföra ett anrop där argumentet Y förmedlas resulterar i en lista över affärsverksamheter som primärt bedrivs utomhus. Om argumentet N används, blir resultatet omvänt och enbart affärsverksamheter som bedrivs primärt inomhus returneras. Exempel: ?outdoors=Y
child_discount: Begränsar informationshämtning till affärsverksamheter som erbjuder någon form av barnrabatt. Informationen redovisas via konstanterna Y (för sant) och N (för falskt). Exempel: ?child_discount=Y
student_discount: Begränsar informationshämtning till affärsverksamheter som erbjuder någon form av studentrabatt. Informationen redovisas via konstanterna Y (för sant) och N (för falskt). Exempel: ?student_discount=N
senior_discount: Begränsar informationshämtning till affärsverksamheter som erbjuder någon form av pensionärsrabatt. Informationen redovisas via konstanterna Y (för sant) och N (för falskt). Exempel: ?senior_discount=Y
municipalities: Begränsar informationshämtning till affärsverksamheter inom en eller flera kommuner. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?municipalities=växjö kommun, kalmar kommun
counties: Begränsar informationshämtning till affärsverksamheter inom ett eller flera län. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?counties=kalmar län, jönköpings län
provinces: Begränsar informationshämtning till affärsverksamheter inom ett eller flera landskap. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?provinces=öland
max_rating: Beskriver maxbetyg för affärsverksamheter. Information med högre än angivet maxbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
min_rating: Beskriver minimumbetyg för affärsverksamheter. Information med lägre än angivet minimumbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

id: Affärsrörelsens unika ID-nummer.
lat: Affärsrörelsens koordinater i latitud.
lng: Affärsrörelsens koordinater i longitud.
name: Affärsrörelsens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
type: Beskriver den innehållstyp som affärsverksamheten är kopplad till.
address: Den postadress som affärsrörelsen använder.
zip_code: Postnummer till den plats där affärsverksamheten är lokaliserad.
city: Den stad där affärsverksamheten är lokaliserad.
phone_number: Affärsverksamhetens kontaktnummer (om sådant finns tillgängligt).
website: Redogör aktuell affärsverksamhets aktuella webbadress. Det finns ingen garanti att affärsverksamheten har en egen webbplats eller att den länkar till en egen domän. Den adress som anges är den webbplats som affärsverksamheten själva förespråkar.
abstract: Beskrivningstext till aktuell affärsverksamhet där antalet tecken begränsats till 256. Denna datapunkt förväntas därmed ge en kort introduktion till affärsverksamheten.
text: Informationstext från aktuell affärsverksamhet. Längden på beskrivningstexten är begränsad till 16 777 215 tecken.
price_range: Beskriver uppskattad prisnivå hos affärsrörelsen. Denna information kan användas för att avgöra om affärsrörelsens produkter eller tjänster uppfattas som "dyra" eller "billiga". Det skall noteras att denna information är en uppskattning och inte syftar till att ge ett exakt eller numeriskt värde.
outdoors: Beskriver huruvida affärsverksamheten i huvudsak bedriver sin verksamhet utomhus. Värdet Y indikerar att detta är sant och värdet N indikerar att detta inte är sant, dvs att verksamheten bedrivs i huvudsak inomhus.
child_discount: Huruvida aktuell affärsrörelse erbjuder barnrabatt (Y) eller inte (N).
student_discount: Huruvida aktuell affärsrörelse erbjuder studentrabatt (Y) eller inte (N).
senior_discount: Huruvida aktuell affärsrörelse erbjuder pensionärsrabatt (Y) eller inte (N).
municipality: Den kommun där affärsverksamheten är lokaliserad.
county: Det län där affärsverksamheten är lokaliserad.
province: Det landskap där affärsverksamheten är lokaliserad.
modified_at: Tidsstämpel som redogör den tidpunkt då affärsverksamhetens data senast var uppdaterad. Tidsstämpeln är främst menad för internt bruk men kan exempelvis användas för att avgöra om information är föråldrad.
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecentioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som herhållit noll kundrecensioner, redogör ett kundbetyg (rating) på 2.5.
distance_in_km: Avståendet mellan affärsverksameten och den geografiska position som angavs i samband med API-anropet. Avståndet anges i kilomter (km).

smapi.establishment.getdescriptions

Hämtar en lista över de beskrivningstexter som används av affärsverksamheter. Metoden är ett användbart verktyg för att få en överblick av SMAPIs utbud. Beskrivningstexter är även en fördelaktig datapunkt att utföra filtrering på.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

description: Beskrivningsnamn på affärsverksamhet.
num_establishments: Antalet affärsverksamheter i SMAPIs databas som använder beskrivningsnamnet.

smapi.establishment.getreviews

Hämtar eventuella recensioner av specifik affärsverksamhet. Recensioner används för att beräkna affärsverksamheters betyg.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument resulterar i felkod 201.

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel ignoreras av systemet och levererar därmed ingen information.
id (Obligatorisk): ID-nummer till den affärsverksamhet vars recensioner skall hämtas.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

rating: Det betyg som aktuell recensent tilldelat affärsverksamheten. Betygsskalan sträcker sig mellan ett till fem och tillåter decimaltal.
name: För- och efternamn på aktuell recensent.
email: Aktuell recensents angivna e-postadress.
comment: Kommentar eller motivering till aktuellt betyg.
timestamp: Datumstämpel för den tidpunkt då recensionen sparades i SMAPIs databas. Formatet för datumstämpeln är enligt följande: YYYY-MM-DD HH:MM:SS
unix_time: Datumstämpel för den tidpunkt då recensionen sparades i SMAPIs databas. Formatet för datumstämpeln är enligt Unix-/epoch-tid. Exempel: 1520606345
relative_time: Datumstämpel för den tidpunkt då recensionen sparades i SMAPIs databas. Formatet för datumstämpeln är enlig "mänsklig tidsuppfattning". Exempel: 6 days ago

smapi.establishment.getstats

Hämtar information om antal registerade affärsverksamheter. Responsobjektet innefattar information om antalet affärsverksamheter inom respektive kategori, samt en summering av samtliga affärsverksamheter. API-anropet är främst utformat för internt bruk men kan även användas för produktionssyfte.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Detta API-anrop resulterar i ett responsobjekt och inte i en liststruktur av flera.

num_accommodation: Antalet affärsverksamheter som bedriver någon form av boende. Exempel: hotell, camping & bed and breakfast.
num_activity: Antalet affärsverksamheter som erbjuder någon form av aktivitet. Exempel: bowling, nöjespark & go-kart.
num_attraction: Antalet affärsverksamheter som erbjuder någon form av sevärdighet. Exempel: museum, kulturhistoriska platser & utsiktsplatser.
num_establishment: Antalet affärsverksamheter som registerats i SMAPI:s databas, dvs summan av samtliga typer av affärsverksamheter.
num_food: Antalet affärsverksamheter som erbjuder någon form av matbespisning. Exempel: restaurang, café & gatukök.
num_shop: Antalet affärsverksamheter som erbjuder någon form av handel. Exempel: gårdsbutik, klädbutik & bensinstation.

smapi.food

Kontrollant innehållande metoder för att hämta affärsverksamheter vars bransch är inom mat och dryck. Till skillnad från establishment-kontrollanten, resulterar API-anrop inom denna kontrollant i mer branschspecifik information. Kontrollanten innehåller följande metoder:

getAll: Hämtar samtliga affärsverksamheter som klassificerats som restaurang, café, bistro eller bageri.
getFromLatLng: Hämtar affärsverksamheter utifrån geografisk position (latitud och longitud).

smapi.food.getall

Hämtar samtliga affärsverksamheter som typats inom food-kategorin. API-anrop kan därför inte inkludera affärsverksamheter inom andra kategorier.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska, måste förekomma i samband med ett API-anrop. Avsaknad av obligatoriska argument, resulterar i felkod 201. Argument som namnges i plural, har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel, ignoreras av systemet och levererar därmed ingen information.
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som SCV-data, där vadera namn separeras med kommatecken. Exempel: ?names=mcdonalds, burger king
descriptions: Begränsar informationshämtningen utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,B&B
types: Begränsar informationshämtning utifrån en eller flera typer. Informationen är kategoriserad inom följande typer: CASUAL, ETHNIC, FAST och FINE_DINING.
sub_types: Begränsar informationshämtning utifrån en eller flera undertyper. Informationen är kategoriserad inom följande undertyper: A_LA_CARTE, ASIAN, BURGERS, HOT_DOGS, LATIN, LOCAL, MEDITERRANEAN, PIZZA, OTHER & PASTRIES.
settings: Begränsar informationshämtning utifrån en eller flera miljöer. Informationen är kategoriserad inom följande miljöer: BISTRO, CAFE, LUNCH, PIZZERIA, PUB, RESTAURANT, TAKE_OUT & BAKERY.
indoor_seating: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder inomhusservering. Argument förmedlas som konstanterna Y (true) och N (false).
outdoor_seating: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder utomhusservering. Argument förmedlas som konstanterna Y (true) och N (false).
drive_through: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder drive through-beställning. Argument förmedlas som konstanterna Y (true) och N (false).
alcohol_licence: Begränsar informationshämtning till huruvida aktuell affärsverksamhet har alkoholrättigheter (Y) eller inte (N).
vegetarian_option: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder vegetariska alternativ (Y) eller inte (N).
ecological_option: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder ekologiska alternativ (Y) eller inte (N).
buffet_option: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder middagsbuffé (Y) eller inte (N).
child_menu: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder en barnmeny (Y) eller inte (N).
takeout: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder avhämtning (take out / take away) av mat (Y) eller inte (N).
wine_cellar: Begränsar informationshämtning till huruvida aktuell affärsverksamhet har tillgång till egen vinkällare (Y) eller inte (N).
require_booking: Begränsar informationshämtning till huruvida aktuell affärsverksamhet förutsätter bokning för dinering (Y) eller inte (N).
min_rating: Begränsar informationshämtning till affärsverksamheter vars betyg begränsats till angivet minimivärde.
max_rating: Begränsar informationshämtning till affärsverksamheter vars betyg begränsats till angivet maximumvärde.
min_michelin_rating: Begränsar informationshämtning till affärsverksamheter vars Michelin-betyg begränsats till angivet minimivärde.
max_michelin_rating: Begränsar informationshämtning till affärsverksamheter vars Michelin-betyg begränsats till angivet maximumvärde.
min_avg_dinner_pricing: Begränsar informationshämtning till affärsverksamheter med ett angivet lägsta genomsnittspris för en middagsrätt.
max_avg_dinner_pricing: Begränsar informationshämtning till affärsverksamheter med ett angivet högsta genomsnittspris för en middagsrätt.
min_avg_lunch_pricing: Begränsar informationshämtning till affärsverksamheter med ett angivet lägsta genomsnittspris för en lunchrätt.
max_avg_lunch_pricing: Begränsar informationshämtning till affärsverksamheter med ett angivet högsta genomsnittspris för en lunchrätt.
search_tags: Begränsar informationshämtning till affärsverksamheter vars söktaggar innefattas av angiven söksträng.
max_rating: Beskriver maxbetyg för affärsverksamheter. Information med högre än angivet maxbetyg, kommer inte att hämtas i samband med aktuellt API-anrop.
min_rating: Beskriver minimumbetyg för affärsverksamheter. Information med lägre än angivet minimumbetyg, kommer inte att hämtas i samband med aktuellt API-anrop.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tillsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

id: Affärsverksamhetens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
type: Nyckelord som beskriver affärsverksamhetens primära typ. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
sub_type: Nyckelord som beskriver affärsverksamhetens sekundära typ. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
search_tags: Textsträng innehållande sökord vars syfte är att beskriva affärverksamhetens utbud. Sökord separeras med kommatecken.
setting: Nyckelord som beskriver affärsverksamhetens miljö. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
avg_dinner_pricing: Summa som beskriver snittpris för en middag.
avg_lunch_pricing: Summa som beskriver snittpris för en lunch.
indoor_seating: Huruvida affärsverksamheten erbjuder innomhusservering (Y) eller inte (N).
outdoor_seating: Huruvida affärsverksamheten erbjuder utomhusservering (Y) eller inte (N).
drive_through: Huruvida aktuell affärsverksamhet erbjuder drive through-beställning. Argument förmedlas som konstanterna Y (true) och N (false).
alcohol_licence: Huruvida aktuell affärsverksamhet har alkoholrättigheter (Y) eller inte (N).
vegetarian_option: Huruvida aktuell affärsverksamhet erbjuder vegetariska alternativ (Y) eller inte (N).
ecological_option: Huruvida aktuell affärsverksamhet erbjuder ekologiska alternativ (Y) eller inte (N).
buffet_option: Huruvida aktuell affärsverksamhet erbjuder middagsbuffé (Y) eller inte (N).
child_menu: Huruvida aktuell affärsverksamhet erbjuder en barnmeny (Y) eller inte (N).
takeout: Huruvida aktuell affärsverksamhet erbjuder avhämtning (take out / take away) av mat (Y) eller inte (N).
wine_cellar: Huruvida aktuell affärsverksamhet har tillgång till egen vinkällare (Y) eller inte (N).
require_booking: Huruvida aktuell affärsverksamhet förutsätter bokning för dinnering (Y) eller inte (N).
michelin_rating: Affärsverksamhetens michelin-betyg (0-3).
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.

smapi.food.getfromlatlng

Hämtar en lista med affärsverksamheter utifrån en geografisk position. Metoden begränsar informationshämtningen till en radie kring den geografiska position som angivits i samband med API-anropet. Radien har ett standardvärde på 15 kilometer men kan modifieras efter behov via radius-argumentet. Affärsverksamheter som är belägna utanför sökradien inkluderas inte i responsobjektet.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska, måste förkomma i samband med ett API-anrop. Avsaknad av obligatoriska argument, resulterar i felkod 201. Argument som namnges i plural, har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel, ignoreras av systemet och levererar därmed ingen information.
lat (Obligatorisk): Sökkoordinat angiven i latitude.
lng (Obligatorisk): Sökkoordinat angiven i longitud.
radius: Radie som begränsar geosökningar. API-anropet resulterar i affärsverksamheter inom den angivna radien. Distans anges i kilometer. Standardvärdet är 15 (km).
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter, baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera affärsverksamheters namn. Namn förmedlas som SCV-data, där vardera namn separeras med kommatecken. Exempel: ?names=mcdonalds, burger king
descriptions: Begränsar informationshämtningen utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,B&B
types: Begränsar informationshämtning utifrån en eller flera typer. Informationen är kategoriserad inom följande typer: CASUAL, ETHNIC, FAST och FINE_DINING.
sub_types: Begränsar informationshämtning utifrån en eller flera undertyper. Informationen är kategoriserad inom följande undertyper: A_LA_CARTE, ASIAN, BURGERS, HOT_DOGS, LATIN, LOCAL, MEDITERRANEAN, PIZZA, OTHER & PASTRIES.
settings: Begränsar informationshämtning utifrån en eller flera miljöer. Informationen är kategoriserad inom följande miljöer: BISTRO, CAFE, LUNCH, PIZZERIA, PUB, RESTAURANT, TAKE_OUT & BAKERY.
indoor_seating: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder inomhusservering. Argument förmedlas som konstanterna Y (true) och N (false).
outdoor_seating: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder utomhusservering. Argument förmedlas som konstanterna Y (true) och N (false).
drive_through: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder drive through-beställning. Argument förmedlas som konstanterna Y (true) och N (false).
alcohol_licence: Begränsar informationshämtning till huruvida aktuell affärsverksamhet har alkoholrättigheter (Y) eller inte (N).
vegetarian_option: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder vegetariska alternativ (Y) eller inte (N).
ecological_option: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder ekologiska alternativ (Y) eller inte (N).
buffet_option: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder middagsbuffé (Y) eller inte (N).
child_menu: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder en barnmeny (Y) eller inte (N).
takeout: Begränsar informationshämtning till huruvida aktuell affärsverksamhet erbjuder avhämtning (take out / take away) av mat (Y) eller inte (N).
wine_cellar: Begränsar informationshämtning till huruvida aktuell affärsverksamhet har tillgång till egen vinkällare (Y) eller inte (N).
require_booking: Begränsar informationshämtning till huruvida aktuell affärsverksamhet förutsätter bokning för dinnering (Y) eller inte (N).
min_rating: Begränsar informationshämtning till affärsverksamheter vars betyg begränsats till angivet minimivärde.
max_rating: Begränsar informationshämtning till affärsverksamheter vars betyg begränsats till angivet maximumvärde.
min_michelin_rating: Begränsar informationshämtning till affärsverksamheter vars Michelin-betyg begränsats till angivet minimivärde.
max_michelin_rating: Begränsar informationshämtning till affärsverksamheter vars Michelin-betyg begränsats till angivet maximumvärde.
min_avg_dinner_pricing: Begränsar informationshämtning till affärsverksamheter med ett angivet lägsta genomsnittspris för en middagsrätt.
max_avg_dinner_pricing: Begränsar informationshämtning till affärsverksamheter med ett angivet högsta genomsnittspris för en middagsrätt.
min_avg_lunch_pricing: Begränsar informationshämtning till affärsverksamheter med ett angivet lägsta genomsnittspris för en lunchrätt.
max_avg_lunch_pricing: Begränsar informationshämtning till affärsverksamheter med ett angivet högsta genomsnittspris för en lunchrätt.
search_tags: Begränsar informationshämtning till affärsverksamheter vars söktaggar innefattas av angiven söksträng.
max_rating: Beskriver maxbetyg för affärsverksamheter. Information med högre än angivet maxbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
min_rating: Beskriver minimumbetyg för affärsverksamheter. Information med lägre än angivet minimumbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

id: Affärsverksamhetens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
type: Nyckelord som beskriver affärsverksamhetens primära typ. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
sub_type: Nyckelord som beskriver affärsverksamhetens sekundära typ. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
search_tags: Textsträng innehållande sökord vars syfte är att beskriva affärverksamhetens utbud. Sökord separeras med kommatecken.
setting: Nyckelord som beskriver affärsverksamhetens miljö. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
avg_dinner_pricing: Summa som beskriver snittpris för en middag.
avg_lunch_pricing: Summa som beskriver snittpris för en lunch.
indoor_seating: Huruvida affärsverksamheten erbjuder innomhusservering (Y) eller inte (N).
outdoor_seating: Huruvida affärsverksamheten erbjuder utomhusservering (Y) eller inte (N).
drive_through: Huruvida aktuell affärsverksamhet erbjuder drive through-beställning. Argument förmedlas som konstanterna Y (true) och N (false).
alcohol_licence: Huruvida aktuell affärsverksamhet har alkoholrättigheter (Y) eller inte (N).
vegetarian_option: Huruvida aktuell affärsverksamhet erbjuder vegetariska alternativ (Y) eller inte (N).
ecological_option: Huruvida aktuell affärsverksamhet erbjuder ekologiska alternativ (Y) eller inte (N).
buffet_option: Huruvida aktuell affärsverksamhet erbjuder middagsbuffé (Y) eller inte (N).
child_menu: Huruvida aktuell affärsverksamhet erbjuder en barnmeny (Y) eller inte (N).
takeout: Huruvida aktuell affärsverksamhet erbjuder avhämtning (take out / take away) av mat (Y) eller inte (N).
wine_cellar: Huruvida aktuell affärsverksamhet har tillgång till egen vinkällare (Y) eller inte (N).
require_booking: Huruvida aktuell affärsverksamhet förutsätter bokning för dinering (Y) eller inte (N).
michelin_rating: Affärsverksamhetens michelin-betyg (0-3).
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.
distance_in_km: Avståendet mellan affärsverksameten och den geografiska position som angavs i samband med API-anropet. Avståendet anges i kilomter (km).

smapi.shop

Kontrollant för att hantera generell information som relaterar till en eller flera affärsverksamheter. Kontrollanten innehåller följande metoder:

getAll: Hämtar samtliga affärsverksamheter som klassificerats som butik eller annan plats där försäljning av produkter förekommer.
getFromLatLng: Hämtar affärsverksamheter (som typats inom shop) utifrån geografisk position (latitude och longitude).

smapi.shop.getall

Hämtar samtliga affärsverksamheter som typats inom shop-kategorin. API-anrop kan därför inte inkludera affärsverksamheter inom andra kategorier.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska, måste förkomma i samband med ett API-anrop. Avsaknad av obligatoriska argument, resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel ignoreras av systemet och levererar därmed ingen information.
names: Begränsar informationshämtning utifrån en eller flera afärsverksamheters namn. Namn förmedlas som SCV-data, där vardera namn separeras med kommatecken. Exempel: ?names=mcdonalds, burger king
descriptions: Begränsar informationshämtningen utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,B&B
categories: Begränsar informationshämtning till en eller flera kategorier. Systemet innefattar kategorierna; AUTOMOBILE, BEAUTY, DECORATION, DEPARTMENT_STORE, ELECTRONICS, FOOD, FASHION, HARDWARE, HEALTH, HOBBY, LIQUOR, MALL, SPORT & TOYS. AUTOMOBILE: affärsverksamheter vars affärsidé är kopplad till personbil, eller andra motordrivna fordon. BEAUTY: affärsverksamheter som inriktat sig mot skönhetsprodukter så som kosmetika och perfym. DECORATION: affärsverksamheter som säljer heminredning och annan dekoration. DEPARTMENT_STORE: Affärsverksamhet som bedriver försäljning av flera blandade hushållsprodukter. ELECTRONICS: affärsverksamheter vars försäljning är inriktad mot hemelektronik och vitvaror. FOOD: affärsverksamheter som bedriver försäljning av livsmedel. FASHION: affärsverksamheter som bedriver försäljning av kläder, skor och väskor. HARDWARE: affärsverksamheter som bedriver järnhandel, dvs butiker som säljer verktyg och annan byggmateriel. HEALTH: affärsverksamheter vars affärsidé kretsar kring hälsa. HOBBY: affärsverksamheter som bedriver försäljning av hobbymateriel eller -material. LIQUOR: affärsverksamheter vars affärsidé är inriktad mot alkoholhaltiga drycker så som vin, sprit och öl. MALL: en samlingspunkt av flera affärsverksamheter som bedrivs under samma tak. SPORT: affärsverksamheter som inriktats mot försäljning av produkter som används i samband med sport- och idrottsaktiviteter. TOYS: affärsverksamheter som bedriver försäljning av leksaker eller andra produkter som inriktas mot barn som primär målgrupp.
franchise: Begränsar informationshämtning till affärsverksamheter som är franchisetagare (Y) eller inte (N).
max_rating: Beskriver maxbetyg för affärsverksamheter. Information med högre än angivet maxbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
min_rating: Beskriver minimumbetyg för affärsverksamheter. Information med lägre än angivet minimumbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

id: Affärsrörelsens unika ID-nummer.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
category: Nyckelord som beskriver affärsverksamhetens primära försäljningsområde. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
franchise: Huruvida affärsverksamheten är franchisetagare (Y) eller inte (N).
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.

smapi.shop.getfromlatlng

Hämtar en lista med affärsverksamheter utifrån en geografisk position. Metoden begränsar informationshämtningen till en radie kring den geografiska position som angivits i samband med API-anropet. Radien har ett standardvärde på 15 kilometer men kan modifieras efter behov via radius-argumentet. Affärsverksamheter som är belägna utanför sökradien, inkluderas inte i responsobjektet.

Argument

Detta avsnitt listar metodens samtliga GET-argument. Arguments som betecknats som obligatoriska, måste förkomma i samband med ett API-anrop. Avsaknad av obligatoriska argument, resulterar i felkod 201. Argument som namnges i plural har möjlighet att hantera flera parametrar i form av CSV-data (Comma-separated values). Exempel: ?ids=4,8,15,16,23,42

api_key (Obligatorisk): Din unika API-nyckel. API-anrop som genomförs utan giltig API-nyckel ignoreras av systemet och levererar därmed ingen information.
lat (Obligatorisk): Sökkoordinat angiven i latitud.
lng (Obligatorisk): Sökkoordinat angiven i longitud.
radius: Radie som begränsar geosökningar. API-anropet resulterar i affärsverksamheter inom den angivna radien. Distans anges i kilometer. Standardvärdet är 15 (km).
ids: Begränsar informationshämtning till en eller flera specifika affärsverksamheter, baserat utifrån deras unika IDn. ID-nummer förmedlas som CSV-data och separeras därför med kommatecken. Exempel: ?ids=4,8,15,16,23,42
names: Begränsar informationshämtning utifrån en eller flera affärsverksamheters namn. Namn förmedlas som SCV-data där vardera namn separeras med kommatecken. Exempel: ?names=mcdonalds, burger king
descriptions: Begränsar informationshämtningen utifrån en eller flera textsträngar som ger en beskrivning av affärsverksamheten. Argument förmedlas som CSV-data och använder därför kommatecken för att separera argument från varandra. Exempel: ?description=hotell,B&B
categories: Begränsar informationshämtning till en eller flera kategorier. Systemet innefattar kategorierna; AUTOMOBILE, BEAUTY, DECORATION, DEPARTMENT_STORE, ELECTRONICS, FOOD, FASHION, HARDWARE, HEALTH, HOBBY, LIQUOR, MALL, SPORT & TOYS. AUTOMOBILE: affärsverksamheter vars affärsidé är kopplad till personbil, eller andra motordrivna fordon. BEAUTY: affärsverksamheter som inriktat sig mot skönhetsprodukter så som kosmetika och perfym. DECORATION: affärsverksamheter som säljer heminredning och annan dekoration. DEPARTMENT_STORE: Affärsverksamheter som bedriver försäljning av flera blandade hushållsprodukter. ELECTRONICS: affärsverksamheter vars försäljning är inriktade mot hemelektronik och vitvaror. FOOD: affärsverksamheter som bedriver försäljning av livsmedel. FASHION: affärsverksamheter som bedriver försäljning av kläder, skor och väskor. HARDWARE: affärsverksamheter som bedriver järnhandel, dvs butiker som säljer verktyg och annan byggmateriel. HEALTH: affärsverksamhet vars affärsidé kretsar kring hälsa. HOBBY: affärsverksamheter som bedriver försäljning av hobbymateriel eller -material. LIQUOR: affärsverksamheter vars affärsidé är inriktad mot alkoholhaltiga drycker så som vin, sprit och öl. MALL: en samlingspunkt av flera affärsverksamhet som bedrivs under samma tak. SPORT: affärsverksamheter som inriktats mot försäljning av produkter som används i samband med sport- och idrotsaktiviteter. TOYS: affärsverksamheter som bedriver försäljning av leksaker eller adnra produkter som inriktas mot barn som primär målgrupp.
franchise: Begränsar informationshämtning till affärsverksamheter som är franchisetagare (Y) eller inte (N).
max_rating: Beskriver maxbetyg för affärsverksamheter. Information med högre än angivet maxbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
min_rating: Beskriver minimumbetyg för affärsverksamheter. Information med lägre än angivet minimumbetyg kommer inte att hämtas i samband med aktuellt API-anrop.
group_by (Avancerat): Möjlighet att gruppera information enligt specifik datapunkt.
order_by (Avancerat): Möjlighet att sortera information enligt specifik datapunkt. Som standard sorteras all svarsdata enligt affärverksamheters unika ID-nummer. Exempel: ?order_by=rating
sort_in (Avancerat): Huruvida resultaten skall sorteras i stigande (ASC) eller fallande (DESC) ordningsföljd. Argumentet kan användas tilsammans med order_by för att exempelvis sortera enligt bästa eller sämsta datapunkt. Exempel:?sort_in=DESC&order_by=rating
per_page (Avancerat): Begränsar antalet svarsobjekt till ett förbestämt maxantal.
current_page (Avancerat): Delar upp svarsobjekt i flera sektioner baserat på per_page. Användbar för att skapa pagination. Notera att sidor påbörjar sin indexering på ett och inte noll.

Responsdata

Detta avsnitt redogör för innehållet av den responsdata som innefattas av responsobjektet för aktuellt API-anrop. Följande punkter skall därför betraktas som egenskaper hos enskilda responsdatan-objekt.

id: Affärsrörelsens unika ID-nummer.
name: Affärsverksamhetens namn.
description: Textsträng vars syfte är att beskriva affärsverksamheten med ett ord.
lat: Affärsverksamhetens koordinater i latitud.
lng: Affärsverksamhetens koordinater i longitud.
category: Nyckelord som beskriver affärsverksamhetens primära försäljningsområde. För mer information om möjliga utfall, se beskrivningstexten under metodanropets möjliga argument.
franchise: Huruvida affärsverksamheten är franchisetagare (Y) eller inte (N).
rating: Representerar affärsverksamhetens kundbetyg. Ett betyg representeras av ett numeriskt värde i decimalform. Skalan går från 1.0 till 5.0 och har ett standardvärde på 2.5. Kundbetyget baseras på kundrecensioner och utgörs av kundernas medelbetyg.
num_reviews: Beskriver hur många kundrecensioner som affärsverksamheten har fått. Affärsverksamheter som erhållit noll kundrecensioner erhåller ett kundbetyg (rating) på 2.5.
distance_in_km: Avståendet mellan affärsverksameten och den geografiska position som angavs i samband med API-anropet. Avståendet anges i kilomter (km).

Ich bin SMAPI, das große API

smapi (V2)

API-nyckel

Exekveringslägen

Kontrollanter

Metoder

Responseobjekt

Statuskoder

Felkoder

JavaScript API

smapi.accommodation

smapi.accommodation.getall

Argument

Responsdata

smapi.accommodation.getfromlatlng

Argument

Responsdata

smapi.activity

smapi.activity.getall

Argument

Responsdata

smapi.activity.getfromlatlng

Argument

Responsdata

smapi.attraction

smapi.attraction.getall

Argument

Responsdata

smapi.attraction.getfromlatlng

Argument

Responsdata

smapi.establishment

smapi.establishment.getall

Argument

Responsdata

smapi.establishment.getfromlatlng

Argument

Responsdata

smapi.establishment.getdescriptions

Responsdata

smapi.establishment.getreviews

Argument

Responsdata

smapi.establishment.getstats

Responsdata

smapi.food

smapi.food.getall

Argument

Responsdata

smapi.food.getfromlatlng

Argument

Responsdata

smapi.shop

smapi.shop.getall

Argument

Responsdata

smapi.shop.getfromlatlng

Argument

Responsdata