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

Felkoder

Rest-objekt

 

Skapa

Ändra

Lista

Tabort

Kräver inlogging

Gruppaktivitets bokningar

X

 

X

X

X

Gruppaktiviteter

 

 

X

 

 

Produktgrupper

 

 

X

 

 

Produkter

 

 

X

 

 

Arrangemang

 

 

X

 

 

Arrangemangs bokningar

X

 

 

 

X

Personer

 

 

X

 

X

Meddelanden

 

X

 

 

 

Anläggningar

 

X

 

  • No labels