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 11 Next »

Autentisering

Basic HTTP-autentisering används. username kan vara email, kortnummer eller kundnummer. Fyll på med mer här sen.

Felhantering

Svar

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

Format

Alla datum/tidpunkter är angivna i GMT+1 (Stockholm).

Datatyp

Format

Exempel

Kommentar

Datum

yyyy-MM-DD

2012-12-24

 

Tidpunkt

yyyy-MM-dd hh:mm

2012-12-24 15:00

 

Tidsstämpel

nnnnnnnnnnnnn

1298023236

Unix Epoch

Boolean

true/false

true

 

Generellt

Anrop

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

Namn

Funktion

apikey

Integrationsnyckel

locale

Språk

Svar

Svarstaggar som representerar riktiga objekt har alltid attributet id som innehåller objektets unika id.

Återkommande taggar

Product

Tag

Attribut

Exempel

Format

Förklaring

description

 

<description>Produktbeskrivning</description>

 

Beskrivning

name

 

<name>Spinn B45</name>

 

Produktens namn

bookablefrominternet

 

<bookablefrominternet>true</bookablefrominternet>

Boolean

Bokbar via internet

productlabels

 

<productlabels>

 

Etikettlista

productlabel

id

<productlabel id='3'>Spinning</productlabel>

 

Produktetikett

cssclass

 

<cssclass>blue</cssclass>

 

 

group

id

<group id='45'>Gruppträning</group>

 

Produktgrupp

<product id='3'>
   <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

Mening

Kommentar

booking

Bokning

Passbokning, värdekort, abonnemang, tjänster, arrangemang

person

Användare/bokare

 

resource

Resurs

Lokal, instruktör, maskiner mm

activity

Gruppaktivitet/Pass

 

Boka

Anrop

POST till /bookings

Parametrar

namn

obligatorisk

exempelvärde

förklaring

Värdemängd

apikey

ja

338934897438

Integrationsspecifik nyckel

 

type

nej

groupactivity

Filtrera på typ av bokning.

groupactivity, service, valuecard, subscription, product, waitinglist, (package)

Specifika för type=groupactivity

namn

obligatorisk

exempelvärde

förklaring

Värdemängd

activityid

ja

activityid=34

Gruppaktivitetens id

 

Exempel:

http://api.brpsystems.se/v2/bookings.xml?apikey=338934897438&type=groupactivity&activityid=34

Svar

Se efterföljande avsnitt.

<booking id='24353'>
   <businessunit id=11>Centrum</businessunit>
   <start timestamp='123243434'>2012-12-24 15:00</start>
   <end timestamp='123243600'>2012-12-24 16:00</end>
   <product id='3'>#se återkommande taggar#</product>
   <resources>
      <resource id='1' type='Personal'>Laila</resource>
      <resource id='2' type='Lokal'>Spinningsal 1</resource>
   </resources>
   <externalmessage>Externt meddelande</externalmessage>
</booking>

Bokningar tillhörande autentiserad användare

Hämta bokningar tillhörande den inloggade användaren. Detta anrop kräver autentisering.

Anrop

HTTP GET till /bookings

Parametrar

namn

obligatorisk

exempelvärde

förklaring

Värdemängd

apikey

ja

338934897438

Integrationsspecifik nyckel

 

type

nej

groupactivity

Filtrera på typ av bokning.

groupactivity, service, valuecard, subscription, product, waitinglist, (package)

Exempel:

http://api.brpsystems.se/v2/bookings.xml?apikey=338934897438&type=groupactivity

Svar

Tag

Attribut

Exempel

Format

Förklaring

bookings

start, end

<bookings start='2012-01-01' end='2012-01-02'>

Start och end visar start och slut på listan. Bookings-tagen omsluter bokningar.

 

booking

id

<booking id='24353'>

 

Representerar en bokning

type

 

<type>groupactivity</type>

 

Typ av bokning

businessunit

id

<businessunit id=11>Centrum</businessunit>

Bokningens anläggning

start

timestamp

<start timestamp='123243434'>2012-12-24 15:00</start>

Tidpunkt, timestamp=Tidsstämpel

Bokningens starttid

end

timestamp

<end timestamp='123243600'>2012-12-24 16:00</end>

Tidpunkt, timestamp=Tidsstämpel

Bokningens sluttid

product

id

<product id='3'>#se återkommande taggar#</product>

 

Bokningens produkt. För detaljer, se Återkommande taggar.

resources

 

<resources>

 

Resurslista

resource

id, type

<resource id='1' type='personal'>Laila</resource>

 

Resurs

externalmessage

 

<externalmessage>Externt meddelande</externalmessage>

 

Externt meddelande på bokningen

<bookings start='2012-01-01' end='2012-01-02'>
   <booking id='24353'>
      <businessunit id=11>Centrum</businessunit>
      <start timestamp='123243434'>2012-12-24 15:00</start>
      <end timestamp='123243600'>2012-12-24 16:00</end>
      <product id='3'>#se återkommande taggar#</product>
      <resources>
         <resource id='1' type='Personal'>Laila</resource>
         <resource id='2' type='Lokal'>Spinningsal 1</resource>
      </resource>
      <externalmessage>Externt meddelande</externalmessage>
   </booking>
   ...
</bookings>

Avboka

Anrop

HTTP DELETE till /bookings/{id}

Parametrar

namn

obligatorisk

exempelvärde

förklaring

Värdemängd

apikey

ja

338934897438

Integrationsspecifik nyckel

 

Svar

HTTP 204
Tomt innehåll.

bookableearliest

 

<bookableearliest>2012-12-01 10:00</bookableearliest>

Tidpunkt

När man tidigast får boka. Saknar värde om bokningsregel saknas.

bookablelatest

 

<bookablelatest>2012-12-06 15:00</bookablelatest>

Tidpunkt

När man senast får boka. Saknar värde om bokningsregel saknas.

  • No labels