Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 52 Next »

Autentisering

Basic HTTP-autentisering används. username kan vara email, kortnummer eller kundnummer.

Felhantering

Svar

<errors>
   <error>
      <code>1001</code>
      <message>Felaktig parameter, fisrtname</message>
      <debug>field=fisrtname</debug>
   </error>
</errors>

Format

Datatyp

Format

Exempel

Kommentar

Datum

yyyy-MM-DD

2012-12-24

GMT+1 (Stockholm) ink. justering för sommar/vintertid

Tidpunkt

yyyy-MM-dd HH:mm

2012-12-24 15:00

GMT+1 (Stockholm) ink. justering för sommar/vintertid

Tidsstämpel

nnnnnnnnnnnnn

1298023236

Unix Epoch, UTC (Ska detta format alls finnas???)

Boolean

true/false

true

 

ID-lista

n,n,n....

1,2,45

Lista med objekt-idn

Sträng

 

Spinningsal

Textsträng UTF8 av godtycklig längd. Tecken escapeas enligt xml respektive json-standard

Heltal

nnnnnnnnn

124234

Heltal anges alltid utan tusentalsavskiljare eller tiopotenser

Decimaltal

nnnn.nnn

34.45

Inga begränsningar i antal decimaler. Ingen tusenavskiljare eller tiopotens. Saknas decimala siffror skickas ingen decimalavskiljare.

ID

nnnn

43

Heltal som är ett object-id

Generellt

Anrop

Alla parameternamn anges med små bokstäver.

Följande parametrar kan skickas med i alla anrop. Om inget annat anges är de valfria.

Namn

Funktion

apikey

Integrationsnyckel

locale

Språk

Alla parametrar förutom de ovan är att betrakta som filtrerande parametrar vid list-anrop.

Om en parameter skickas med så ska den vara av korrekt format, annars får man ett felsvar.

Unknown macro: {APIURL}

är exempelvis:

https://api.brpsystems.se/brpgog/api/ver2/

Svar

Svarstaggar som representerar riktiga objekt har alltid taggen id som innehåller objektets unika id. Unikt id är alltid ett heltal.
Alla taggar och attributnamn anges i med små bokstäver.

Återkommande taggar

Product

Tag

Exempel

Format

Förklaring

description

<description>Produktbeskrivning</description>

Sträng

Beskrivning

name

<name>Spinn B45</name>

Sträng

Produktens namn

bookablefrominternet

<bookablefrominternet>true</bookablefrominternet>

Boolean

Bokbar via internet

productlabels

<productlabels>

 

Etikettlista

productlabel

<productlabel><id>3</id><name>Spinning</name></productlabel>

 

Produktetikett

cssclass

<cssclass>blue</cssclass>

 

 

group

<group><id>3</id><name>Gruppträning</name></group>

 

Produktgrupp

<product>
   <id>3</id>
   <description>Produktbeskrivning</description>
   <name>Spinn B45</name>
   <bookablefrominternet>true</bookablefrominternet>
   <productlabels>
      <productlabel id='3'>Spinning</productlabel>
      <productlabel id='8'>Medel</productlabel>
   </productlabels>
   <cssclass>blue</cssclass>
   <group id='45'>Gruppträning</group>
</product>

Vokabulär

Ord

Betydelse

Kommentar

booking

Passbokning

Passbokning och bokning på väntelista

purchase

Köp

Köp av tjänster,arrangemang, varor, abonnemang, värdekort och paket

person

Användare/bokare

 

resource

Resurs

Lokal, instruktör, maskiner mm

activity

Gruppaktivitet/Pass

 

Boka

Passbokning, kräver Basic HTTP-autentisering

Anrop

Parametrar

namn

obligatorisk

exempelvärde

förklaring

Värdemängd

apikey

ja

338934897438

Integrationsspecifik nyckel

 

type

ja

type=ordinary

Filtrera på typ av bokning.

ordinary, waitinglist

activityid

ja

activityid=34

Gruppaktivitetens id

 

Exempel:


POST:

/bookings.xml
apikey:338934897438
type:ordinary&activityid=34


h3. Svar

<booking>
<id>24353</id>
<businessunit>
<id>11</id>
<name>Centrum</name>
</businessunit>
<start>2012-12-24 15:00</start>
<end>2012-12-24 16:00</end>
<product>#se återkommande taggar#</product>
</booking>



h2. Bokningar tillhörande autentiserad användare
Hämta bokningar tillhörande den inloggade användaren. Detta anrop kräver Basic HTTP-autentisering
h3. Anrop
HTTP GET till /bookings
h4. Parametrar
||namn||obligatorisk||exempelvärde||förklaring||
|apikey|ja|338934897438|Integrationsspecifik nyckel|

h4. Filter
||namn||exempelvärde||förklaring||Värdemängd/Datatyp||Default||
|type|type=groupactivity|Filtrera på typ av bokning.|ordinary eller waitinglist | ordinary |
|fromdate|fromdate=2012-02-02|Returnera endast bokningar som startar efter angivet datum|Datum| idag |
|todate|todate=2012-02-02|Returnera endast bokningar som startar innan angivet datum|Datum| Om 14 dagar |

Exempel:
Unknown macro: {APIURL}

bookings.xml?apikey=338934897438&type=groupactivity


h3. Svar
||Tag||Format||Exempel||Förklaring||
|bookings| | <bookings> | Bookings-tagen omsluter bokningar. | 
|start|Datum|<start>2012-12-24</start>|Anger vilken dag tidigaste bokningen i listan startar|
|end|Datum|<end>2012-12-24</end>|Anger vilken dag senaste bokningen i listan startar|
| booking | | | Representerar en bokning |
|id| ID | <id>12</id> |Unikt id|
| type | | Typ av bokning |
| businessunit | | <businessunit><id>11</id><name>Centrum</name></businessunit> | Bokningens anläggning |
| start |Tidpunkt| <start>2012-12-24 15:00</start> | Bokningens starttid|
| end | Tidpunkt | <end>2012-12-24 16:00</end> | Bokningens sluttid|
| product | | <product>#se återkommande taggar#</product> | Bokningens produkt. För detaljer, se Återkommande taggar.|

<bookings>
<start>2012-12-24</start>
<end>2012-12-24</end>
<booking>
<id>24353</id>
<businessunit>
<id>11</id>
<name>Centrum</name>
</businessunit>
<start>2012-12-24 15:00</start>
<end>2012-12-24 16:00</end>
<product>#se återkommande taggar#</product>
</booking>
...
</bookings>


h2. Avboka
h3. Anrop, kräver Basic HTTP-autentisering
HTTP DELETE till /bookings/\{id\}
h4. Parametrar
||namn||obligatorisk||exempelvärde||förklaring||Värdemängd||
|apikey|ja|apikey=338934897438|Integrationsspecifik nyckel| |
|type|ja|type=ordinary|Typ av bokning som skall avbokas|ordinary, waitinglist|

Exempel:

DELETE:

/bookings/25345.xml?apikey=338934897438&type=ordinary


h3. Svar
HTTP 204
Tomt innehåll.

h2. Lista gruppaktiviteter
Hämta gruppaktiviteter
h3. Anrop
HTTP GET till /activities

h4. Filter
||namn||exempelvärde||förklaring||Värdemängd/Datatyp||Default||
|fromdate|fromdate=2012-02-02|Returnera endast aktiviteter som startar efter angivet datum|Datum| idag |
|todate|todate=2012-02-02|Returnera endast aktiviteter som startar innan angivet datum|Datum| Om 14 dagar |
|product|product=12,23|Endast aktiviter av denna product|ID-lista| |
|businessUnit|businessUnit=4,334|Endast aktiviterer på dessa anläggningarna| ID-lista | Inloggad användares anläggning|
|productLabel|productLabel=56,3|Endast aktiviter med denna produktetikett| ID-lista | |
|productGroup|productGroup=23| Endast aktiviter i denna produktgrupp | ID | | 
|bookableFromInternet|bookableFromInternet=true| Endast aktiviter som är bokbara på internät | Boolean | true |

Exempel:
Unknown macro: {APIURL}

activities.xml?apikey=338934897438&businessUnit=4,334&product=12,23


h3. Svar
||Tag||Format||Exempel||Förklaring||
|activities| | <activities> | Activity-tagen omsluter aktiviteter. | 
|start|Datum|<start>2012-12-24</start>|Anger vilken dag tidigaste aktiviteten i listan startar|
| end|Datum|<end>2012-12-24</end>|Anger vilken dag senaste aktiviteten i listan startar|
| actvivty | | | Representerar en aktivitet|
| id | ID| <id>12</id> |Unikt id|
| businessunit | | <businessunit><id>11</id><name>Centrum</name></businessunit> | Bokningens anläggning |
| start | Tidpunkt| <start>2012-12-24 15:00</start> | Bokningens starttid|
| end | Tidpunkt | <end>2012-12-24 16:00</end> | Bokningens sluttid|
| product | | <product>#se återkommande taggar#</product> | Bokningens produkt. För detaljer, se Återkommande taggar.|
| resources | | | Lista med resurser |
| resurs | Sträng | <resurs>Lena Olsson</resurs> |Personal, instruktör eller lokal till aktiviten|
| bookableearliest | Tidpunkt | <bookableEarliest>2010-01-23 14:00</bookableEarliest>| När man tidigast får boka. |
| bookablelatest | Tidpunkt |>bookableLatest>2010-02-01 09:15</bookableLatest> | När man senast får boka|
|freeslots|Heltal |<freeslots>10</freeslots>|Lediga platser|
|bookableslots|Heltal |<bookableslots>10</bookableslots> |Bokningsbara platser|
|totalslots|Heltal |<totalslots>42</totalslots>|Totalt platser|
|canceled| Boolean |  <canceled>false</canceled> |Aktiviteten är instäld|
|waitinglistsize|Heltal|<waitinglistsize>3</waitinglistsize>| Storleken på kölistan |



<activities>
<actvivty>
...
<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>
</actvivty>
...
</activities>


h2. Lista produktgrupper
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".

h3. Anrop
HTTP GET till /productgroups

h4. Parametrar
||namn||exempelvärde||förklaring||Värdemängd/Datatyp||Default||
|businessunit|businessunit=4| Tar "Produktgrupp för gruppering av gruppaktivitet" från angiven anläggning | ID | Alla|

Exempel:

productgroups.xml?apikey=338934897438&businessunit=4


h3. Svar
||Tag||Format||Exempel||Förklaring||
|productgroups| | <productgroups> | Productgroup-tagen omsluter produktgrupper. | 
| id | ID | <id>14</id> | Unikt id |
| name |Sträng | <name>Aktiviteter</name> | Namn på produktgruppen |



<productgroups>
<productgroup>
<id>14</id>
<name>Aktiviteter</name>
</productgroup>
...
</productgroups>


  • No labels