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

Tid

HH:mm

14:54

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

Produkttyp

groupActivity/ subscription/ package/ article/ service/ event/ stockProduct/ valueCard/ entry

groupActivity

Textstängar som motsvarar produktgrupper

Kön

male/female

female

Textsträng motsvarande ett kön

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

lang

Språk, ex: sv eller en

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.

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.

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

 

event

Arrangemang

 

Återkommande taggar

Rest-objekt

Gruppaktivitets bokningar
Gruppaktiviteter
Produktgrupper
Produkter
Arrangemang
Arrangemangsbokningar
Personer

Lista produktgrupper

Listar produktgrupper

Anrop

HTTP GET till /productgroups

Parametrar

namn

exempelvärde

förklaring

Värdemängd/Datatyp

Default

forgrouping

forgrouping=true

Hämtar de som produktgrupper som som ligger under den produktgrupp som är inställd under systeminställningen "Produktgrupp för gruppering av gruppaktivitet".

Boolean

false

businessunit

businessunit=4

Tar "Produktgrupp för gruppering av gruppaktivitet" från angiven anläggning. Endast använd om forgrouping=true

ID

 

Exempel:

APIURL/productgroups.xml?apikey=338934897438

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>

Lista produkter

Listar produkt

Anrop

HTTP GET till /products

Filter

namn

exempelvärde

förklaring

Värdemängd/Datatyp

Default

businessunit

businessunit=4

Endast produkter på denna anläggning

ID

Alla

producttype

producttype=groupActivity

Endast produkter av denna produkttyp

Produkttyp

 

bookablefrominternet

bookablefrominternet=true

Endast produkter för internät

Boolean

true

Exempel:

APIURL/products.xml?apikey=338934897438&producttype=groupActivity

Svar

Tag

Format

Exempel

Förklaring

products

 

<products>

Products-tagen

product

 

<product>#se återkommande taggar#</product>

Produkt

<products>
 <product>#se återkommande taggar#</product>
   ...
</product>

Lista arrangemang

Hämtar alla arrangemang där slutdag ännu inte uppnåts listas

Anrop

HTTP GET till /events

Parametrar

namn

obligatorisk

exempelvärde

förklaring

Värdemängd

includebooking

nej

includebooking=true

Vurivida man ska kräva inloggning och ta med bokningsregler i svaret

Boolean

Filter

namn

exempelvärde

förklaring

Värdemängd/Datatyp

Default

businessunit

businessunit=4

Endast arrangemang på denna anläggning

ID

Alla

productlabel

productlabel=56

Endast arrangemang med denna produktetikett

ID

Alla

bookablefrominternet

bookablefrominternet=true

Endast arrangemang som är bokbara på internät

Boolean

true

Exempel:

APIURL/events.xml?apikey=338934897438&businessUnit=334

Svar

Tag

Format

Exempel

Förklaring

events

 

<events>

Events-tagen

event

 

<event>

Representerar ett arrangemang

id

ID

<id>12</id>

Arrangemangets id

name

Sträng

<name>Spinntour</name>

Arrangemangets namn

description

Sträng

<description>Tour de France på spinning cykel</description>

Arrangemangets beskrivning

productdescription

Sträng

<productdescription>Spinning</productdescription>

Arrangemangproduktens beskrivning

numberofoccasions

Heltal

<numberofoccasions>12</numberofoccasions>

Antal gånger

time

Tid

<time>13:45</time>

När arrangemang startar, tomt om ingen tid är angiven

startdate

Datum

<startdate>2009-09-01</startdate>

Start datum

enddate

Datum

<enddate>2009-09-01</enddate>

Slut datum

bookableslots

Heltal

<bookableslots>12</bookableslots>

Bokningsbara platser

filledslots

Heltal

<filledslots>12</filledslots>

Bokade platser

registered

Boolean

<registered>false</registered>

Inloggad person redan inbokade på detta arrangemang

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

<events>
  <event>
    <id>12</id>
    <name>Spinntour</name>
    <description>Beskrivning Internet från arrangemanget</description>
    <productdescription>Beskrivning från produkten</productdescription>  /
    <numberofoccasions>60</numberofoccasions>
    <time>13:45</time>
    <startdate>2009-09-01</startdate>
    <enddate>2009-12-31</enddate>
    <bookableslots>12</bookableslots>
    <filledslots>12</filledslots>    
    <registered>false</registered>
    <bookableEarliest>2010-01-23 14:00</bookableEarliest>
    <bookableLatest>2010-02-01 09:15</bookableLatest>
  </event>
 ...
</events>

Boka deltagande på arrangemang

Boka in inloggad kund på ett arrangemang om det går, kräver Basic HTTP-autentisering

Anrop

Parametrar

namn

obligatorisk

exempelvärde

förklaring

Värdemängd

Default

eventid

ja

eventid=34

Arrangemangets id

 

 

type

ja

type=ordinary

Typ av bokning.

ordinary

ordinary

Exempel:

POST:APIURL/eventbookings?apikey:338934897438&eventid=34&type=ordinary

Svar

<eventbooking>
  <id>2443</id>
  <participant>
    <id>8754</id>
    <firstname>Anna</firstname>
    <lastname>Larsson</lastname>
  </participant>
  <businessunit>
    <id>11</id>
    <name>Centrum</name>
  </businessunit>
  <start>2012-12-24 15:00</start>
  <end>2012-12-24 16:00</end>
  <eventmessage>Andra trappan</eventmessage>
  <product>#se återkommande taggar#</product>
</eventbooking>

Felkoder

REST-Objekt

Kod

Exempel

Tagg

Kommentar

Hämta personuppgifter

Hämtar personuppgifter motsvarande de som anges vid registrering. Ett id till personen måste anges (1 i exempelanropet). Detta måste stämma överrens med id på den person som man autentiserar sig som.

Anrop

HTTP GET till /persons/id

Exempel:

APIURL/persons/1.xml?apikey=338934897438

Svar

<person>
  <firstname>Tessan</firstname>
  <lastname>Testsson</lastname>
  <mailaddress>
    <streetaddress>Testgatan 14</streetaddress>
    <postalcode>12345</postalcode>
    <city>Teststa</city>
  </mailaddress>
  <email>tessan@test.se</email>
  <gender>female</gender>
  <personnumber>YYDDMM-NNNC</personnumber>
  <homephone>012 123 12</homephone>
  <mobilephone>070 123 12</mobilephone>
  <workphone>08 123 12</workphone>
</person>
  • No labels