Child pages
  • HTTP-API
Skip to end of metadata
Go to start of metadata

Allmänt

Gränssnittet använder sig av HTTP-protokollet. Anrop genomförs genom att skicka HTTP GET. Konstanten APIURL som används enligt nedan är kundspecifik och erhålls från BRP. Värdet är något i stil med "http://exempel.brp.se/brp/mesh"
Det finns två kategorier av anrop, bas och plus. Bas-anropen är fria att använda förutsatt att man tilldelats en apikey. Plus-anropen är en tjänst som tillhandahålls mot en månadsavgift.

För att testa anrop så kan APIURL=http://212.91.140.132:8080/appdemo/mesh användas.
Den går mot testdata och där körs senaste version av BRP.

Internetportalen för motsvarande system nås på http://212.91.140.132:8080/appdemo/.

Här av er till support@brpsystems.se med frågor kring API eller om ni önskar en apikey.

Lista gruppaktiviteter (bas)

Notera att gruppaktiviteter sorteras i tidföljd, så om flera anläggningsid:n anges kommer gruppaktiviteterna inte att grupperas per anläggning.

I rest-api

Anrop

Svar

Skapa beställning (plus) (från version 25.189)

Skapar person och bokning med angivna parametrar, svarar med fellista eller URL direkt till betalning om ok. Vid fel skapas aldrig något, varken person eller beställning. Om epost eller personnummer används av någon befintlig kund kommer dennes uppgifter att uppdateras och kunden kommer att användas till beställningen.

I rest-api

Anrop

Svar

Lista bokade gruppaktiviteter (plus)

Hämta bokade gruppaktiviteter för en användare

I rest-api

Anrop

Svar

Verifiera användare (bas)

Verifierar att en användare finns och har det angivna lösenordet.

I rest-api

Anrop

user, username eller email används tillsammans med password.

Svar

Vid lyckad verifiering:

<image> är en relativ URL till användarens bild. I exemplet ovan gör man alltså ett anrop till APIURL/showImage.action?customerNumber=12345 för att hämta bilden. Om användaren inte har någon bild returneras felkod 404 vid försök att hämta bilden.

Svar

Vid misslyckad verifiering:

Lista Arrangemang (bas)

Alla arrangemang där slutdag ännu inte uppnåts listas

I rest-api respektive rest-api

Anrop:

Alla tre parametrarna är valfria, d.v.s. de kan, men behöver inte anges.

Svar:

Om parametern customernumber är angiven:

Om parametern customernumber ej är angiven:

Boka arrangemang (bas)

BRP bokar in kunden på arrangemanget men kontrollerar först att det inte redan är gjort.

I rest-api

Anrop:

Svar:

Lista betalda deltagare (bas)

Anrop:

Svar:

Lista aktiviteter för deltagare (bas)

Enbart aktiviteter mellan max(startdag, betaldag) och slutdag listas.

Anrop:

Svar

Lista resultat av ett arrangemang (bas)

Resultatlista för deltagandet i ett arrangemang. Resultatlistan kan avse antingen deltagande i gruppaktiviteter som är taggade med viss produktetikett eller så visa resultatlistan antalet besök som deltagaren gjort i någon anläggning. Endast 1 besök per person och dag räknas vid besöksräkning.

Anrop 1: (vid arrangemang avseende gruppaktiviteter)

Anrop 2: (vid arrangemang avseende besök)

Svar:

Lista lediga tider för tjänstebokning (bas)

Returnerar en semikolonseparerad lista med de tider som är bokningsbara för en produkt från och med nu och valbart antal timmar framåt.

I rest-api

Hämta datum för medlemskaps giltighetstid (bas)

Returnerar datum för en specifik persons medlemskaps utgång. Om personen inte existerar eller saknar medlemskap blir 'result' error och man får en felbeskrivning i 'message'.

I rest-api

Anrop

Svar:

Lista Anläggningar (bas)

Hämtar vilka olika anläggningar som finns

I rest-api

Anrop

Svar

Möjligheten att exkludera taggen appInfo finns pga att svaret kan bli stort om svaret innehåller många anläggningar. Appinfo kan hämtas ut med separat anrop. 
Taggen showavailableslots styrs av inställningen "Visa lediga platser på gruppaktiviteter".

Observera att inställningen numberofdaysahead endast ger systemvärdet och inte det anläggningsspecifika.

Lista produktgrupper (bas)

Hämtar de som produktgrupper som används för gruppering för web och mobilapplikationsbokning. Det gäller de produktgrupper som ligger under den produktgrupp som är inställd under systeminställningen "Produktgrupp för gruppering av gruppaktivitet".

I rest-api

Anrop

Svar

Lista produkter (bas)

Hämtar produkter av specificerad typ.

I rest-api

Anrop

Svar

Boka gruppaktivitet (plus)

Bokar in en kund på en gruppaktivitet.

I rest-api

Anrop

Svar

Boka reservplats (plus)

Bokar in en kund på reserplatslistan till en gruppaktiviteten.

I rest-api

Anrop

Svar

Avboka gruppaktivitetsbokning (plus)

Avbokar en kund från en gruppaktivitetsbokning.

I rest-api

Anrop

Svar

Avboka reservplats (plus)

Avboka en kund från reservplatslistan till en gruppaktivitet.

I rest-api

Anrop

Svar

Hämta infosida för anläggning

I rest-api

Anrop

Svar

Ändringar

v25.172

  • showGroupActivitiesXML.action ny parameter onlyInternet=true|false, default true hämtar då endast de pass vars produkt har "Bokbar via Internet" förkryssat
  • listActiveEvents.action ger i svaret även <productdescription>Beskrivning från produkten</productdescription>

v25.186

  • showGroupActivitiesXML businessUnit kan nu ta en semikolonseparerad lista med anläggninsIDn
  • Skickat med <businessunitid> i svaret till showGroupActivitiesXML.

v25.189

  • Lagt till bookableFromInternet på showGroupActivitiesXML och listActiveEvents som motsvarar "Bokbar via Internet"
  • Lagt till bookableEarliest och bookableLatest på showGroupActivitiesXML och listActiveEvent som utgår från produktens bokningsregler.
  • Lagt till createUserAndOrderXML.action

v25.202

  • showGroupActivitiesXML har fått <productid /> och <groupid />

v25.205

  • Lagt till loadProductsXML. Metod för att hämta ut produktnamn för angiven produkttyp.

v25.209

  • Lagt till subscription som filter på productType i loadProductsXML.

v25.248

  • Lagt till showavailableslots på loadBusinessUnitsXML
  • No labels