Page Comparison

...

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

Code Block

APIURL/showGroupActivitiesXML.action?
date={datum att visa}
&toDate={till och med datum. om det saknas visas enbart en dag} 
&product={valfritt filter på produktid} 
&businessUnit={valfritt, filter på anläggningsidn, semikolonseparerad} 
&productLabel={valfri produktetikett} 
&productGroup={deprecated används productGroupId, valfri, filtrera på produktgruppnamn}
&productGroupId={valfri, filtrera på produktgrupps id}
&user={valfritt, krävs för att få bookingid och waitinglist*}
&password={lösenord}
&onlyInternet=true //Default true, hämtar då endast de pass vars produkt har "BokbarBokningsbar via Internet" förkryssat

Svar

Code Block

<passlista> 
    <datum>2010-02-01</datum> 
    <tilldatum>2010-02-02</tilldatum>  
    <pass> 
        <id>12345</id>                #Gruppaktivitetens id, används vid inbokning
        <businessunit>Centrum</businessunit>
        <businessunitid>11</businessunitid>
        <startTime>1298023236</startTime> #Millisekunder från 1970-01-01
        <endTime>1298033236</endTime> #Millisekunder från 1970-01-01
        <datum>2010-02-01</datum> 
        <tid>09:45 - 10:30</tid> 
        <aktivitet>Spinn B45</aktivitet>  
        <productid>11</productid>         #Från v25.202. 
        <beskrivning>Detta är beskrivningen av gruppaktivitetsprodukten.</beskrivning>
        <resurs>Lena Olsson</resurs> #personal, instruktör
        <resurskundnummer>12345</resurskundnummer> #instruktorens kundnummer
        <lokal>Spinnsal</lokal>
        <bookableFromInternet>true | false</bookableFromInternet> # Motsvarar "BokbarBokningsbar via Internet"
        <bookableEarliest>2010-01-23 14:00</bookableEarliest> # När man tidigast får boka. Tom tag om bokningsregel saknas
        <bookableLatest>2010-02-01 09:15</bookableLatest>  # När man senast får boka. Tom tag om bokningsregel saknas
        <lediga>10</lediga>  
        <bokningsbara>10</bokningsbara>  
        <totalt>42</totalt>  
        <productlabels>  
            <productlabel>Spinning</productlabel>  
            <productlabel>Svår</productlabel>
        </productlabels> 
        <css-class>blue</css-class> 
        <notering>Detta är ett externt meddelande på gruppaktivitetsbokningen.</notering> 
        <installt>false</installt> 
        <group>produktgrupp</group>
        <groupid>11</groupid>           #Från v25.202. 
        <bookingid>54323</bookingid>    #Gruppaktivitetsboknings id, visas bara om parametern user är satt och om kunden har en bokning på passet
        <waitinglist>                   #Finns bara om köhantering används
            <waitinglistsize>3</waitinglistsize>
            <waitinglistposition># köplats (börjar på 1)</waitinglistposition>
            <waitinglistid>köplatsbokningens id</waitinglistid>
        </waitinglist>
    </pass> 
    <pass> 
        ...
    </pass> 
</passlista>

...

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

Code Block

APIURL/createUserAndOrderXML.action?
apikey={tilldelad säkerhetsnyckel}
businessUnit={anläggning som order och person ska skapas på}
&productNumber={produktnummer, måste vara ett abonnemang eller värdekort samt vara bokbartbokningsbart via internet}
{Nedanstående fält behöver endast vara med om de är obligatoriska i BRP. Kontakta supporten för att få veta vilka fält som behövs på aktuell anläggning}
&firstName=
&lastName=
&workPhone=
&homePhone=
&mobilePhone=
&emailAddress=
&streetAddress=
&postalCity=
&zipCode=
&personNumber=
&gender=
&password=

...

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

I rest-api

Anrop

Code Block
APIURL/showBookedGroupActivitiesXML.action? user={passdeltagarens epostadress/kortnummer} &password={lösenord} &apikey={tilldelad säkerhetsnyckel}

...

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

I rest-api

Anrop

Code Block
APIURL/verifyUser.action? user=(email eller kortnummer) &username={kortnummer i BRP} &email={epostadress} &password={lösenord}

...

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

I rest-api respektive rest-api

Anrop:

Code Block

APIURL/listActiveEvents.action?
productlabel={produktetikettnamn i BRP}
&businessunit={ID för anläggningen}
&customernumber={kundnummer i BRP}
&onlyInternet=true //Från version 25.172, Default true, hämtar då endast de arrangemang vars produkt har "BokbarBokningsbar via Internet" förkryssat

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

...

Code Block

<events>
    <event>
        <registered>true/false</registered>
        <id>123</id>
        <name>Spinntour</name>
        <description>Beskrivning Internet från arrangemanget</description>
        <productdescription>Beskrivning från produkten</productdescription>  // Från version 25.172
        <numberofoccasions>60</numberofoccasions>
        <time>06:00</time> (här blir det 00:00 om ingen tid är angiven på eventet)
        <startday>2009-09-01</startday>
        <endday>2009-12-31</endday>
        <bookableFromInternet>true | false</bookableFromInternet> # Motsvarar "BokbarBokningsbar via Internet"
        <bookableEarliest>2010-01-23 14:00</bookableEarliest> # När man tidigast får boka. Tom tag om bokningsregel saknas
        <bookableLatest>2010-02-01 09:15</bookableLatest>  # När man senast får boka. Tom tag om bokningsregel saknas

    </event>
    <event>
        ...
    </event>
</events>

...

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

I rest-api

Anrop:

Code Block
APIURL/addParticipantToEvent? eventid={arrangemangsid i BRP} &customernumber={Kundnummer i BRP}

...

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

Code Block
APIURL/showAvailableTimes.action? productNo={produktnr i BRP} &businessUnit={Anläggnings id} &hours={Antal timmar framåt sökningen ska göras}

...

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

Code Block
APIURL/getMemberUntil.action? cardnumber={kunds kortnummer} &apikey={tilldelad säkerhetsnyckel}

...

Hämtar vilka olika anläggningar som finns

I rest-api

Anrop

Code Block

APIURL/loadBusinessUnitsXML.action?
filter=groupactivity (valfritt, hämtar bara de anläggningar som har gruppaktivitetsbokningar)
&excludeAppInfo=true|1 (valfritt, om true eller 1 exkluderas taggen appInfo i svaret)
&apikey={tilldelad säkerhetsnyckel}

...

Code Block

<businessunitlist> 
    <businessunit>
        <id>1</id>
        <name>Centrum</name>
        <appinfo>Detta fält kan ställas in iinifrån BP per anläggning och tanken är 
        att lägga info om anläggning här i html-format för att visa i appar. Typ öppettider, 
        och telefonnr.</appinfo>
        <settings>
          <showavailableslots>true</showavailableslots>
		  <numberofdaysahead>7</numberofdaysahead>
        </settings>
    </businessunit>
    <businessunit>
        ...
    </businessunit>
</businessunitlist>

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

Code Block
APIURL/loadProductGroupsXML.action? businessUnit={valfritt filter på anläggningsid} &apikey={tilldelad säkerhetsnyckel}

...

Hämtar produkter av specificerad typ.

I rest-api

Anrop

Code Block

APIURL/loadProductsXML.action?
businessUnit={valfritt filter på anläggningsid}
&apikey={tilldelad säkerhetsnyckel}
&productType=[groupActivity | subscription | package | article | service | event | stockProduct | valueCard | entry]

...

Bokar in en kund på en gruppaktivitet.

I rest-api

Anrop

Code Block
APIURL/bookGroupActivityXML.action? groupActivityId={passid i BRP} &user={kundens epostadress/kortnummer} &password={kundens lösenord} &locale={sv/en/no} &apikey={tilldelad säkerhetsnyckel}

...

Bokar in en kund på reserplatslistan till en gruppaktiviteten.

I rest-api

Anrop

Code Block
APIURL/bookWaitingListXML.action? groupActivityId={passid i BRP} &user={passdeltagarens epostadress/kortnummer} &password={kundens lösenord} &locale={sv/en/no} &apikey={tilldelad säkerhetsnyckel}

...

Avbokar en kund från en gruppaktivitetsbokning.

I rest-api

Anrop

Code Block
APIURL/debookGroupActivityXML.action? bookingId={bokningsid i BRP} &user={passdeltagarens epostadress/kortnummer} &password={kundens lösenord} &locale={sv/en/no} &apikey={tilldelad säkerhetsnyckel}

...

Avboka en kund från reservplatslistan till en gruppaktivitet.

I rest-api

Anrop

Code Block
APIURL/debookWaitingListXML.action? bookingId={postid i BRP} &user={passdeltagarens epostadress/kortnummer} &password={kundens lösenord} &locale={sv/en/no} &apikey={tilldelad säkerhetsnyckel}

...

Hämta infosida för anläggning

I rest-api

Anrop

Code Block
APIURL/loadAppInfoXML.action? businessUnitId={anläggningsid}

...

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

...

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

...

Versions Compared

Old Version 1

New Version Current

Key

Lista gruppaktiviteter (bas)

Anrop

Svar

Anrop

Anrop

Anrop

Anrop:

Anrop:

Anrop

Anrop

Lista produktgrupper (bas)

Anrop

Anrop

Anrop

Anrop

Anrop

Anrop

Hämta infosida för anläggning

Anrop