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 31 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</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

nnnnnnn

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.

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.

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

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:{APIURL}/bookings.xml
apikey:338934897438
type:ordinary&activityid=34

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>

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

apikey

ja

338934897438

Integrationsspecifik nyckel

Filter

namn

exempelvärde

förklaring

Värdemängd/Datatyp

Default

type

type=groupactivity

Filtrera på typ av bokning.

groupactivity eller waitinglist

groupactivity

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:

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

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

Heltal

<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>

Tidpunkt

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>

Avboka

Anrop

HTTP DELETE till /bookings/{id}

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:{APIURL}/bookings/25345?apikey=338934897438&type=ordinary

Svar

HTTP 204
Tomt innehåll.

  • No labels