products

Lista produkter

Listar produkt

Anrop

HTTP GET till /products

Filter

namn	exempelvärde	förklaring	Värdemängd/Datatyp	Default
businessunitids	businessunitids=4,54	Endast produkter på dessa anläggningar	ID-lista	Alla
producttype	producttype=groupActivity	Endast produkter av denna produkttyp	Produkttyp
bookablefrominternet	bookablefrominternet=true	Endast produkter markerade som "Bokbar via Internet". Detta betyder även att produkten finns för försäljning på webben (abonnemang, vara, värdekort, tjänst, arrangemang)	Boolean
productlabel	productlabel=cafe	Filtrerar på produktetikett, om etiketten inte hittas blir resultatet tomt.	Sträng
groupid	groupid=2	Filtrerar ut produkter som tillhör angiven produktgrupp	ID
stockid	stockid=2	Om angivet inkluderas lagerbalansen för angivet lagerställe på produkter av typen lagervara.	ID

Exempel:

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

Svar

Tag	Exempel	Format	Förklaring
description	<description>Produktbeskrivning</description>	Sträng	Beskrivning
name	<name>Spinn B45</name>	Sträng	Produktens namn
number	<number>23</number>	Nummer	Produktnummer
lastupdate	<lastupdate>2013-11-19 12:42</lastupdate>	Tidpunkt	När produkten sparades senast
businessunits	(se businessunitsblock)		Lista på de anläggningar som har produkten kopplad
bookablefrominternet	<bookablefrominternet>true</bookablefrominternet>	Boolean	Bokbar via Internet
productlabels	<productlabels>		Etikettlista
productlabel	<productlabel><id>3</id><name>Spinning</name></productlabel>		Produktetikett
standardprice	<standardprice>		Ej anläggningsspecifikt standardpris. Om standardpris saknas kommer priserna nedan vara 0
priceincvat	<priceincvat>20000</priceincvat>	Nummer	Pris inklusive moms uttryckt i ören
priceexvat	<priceexvat>16000</priceexvat>	Nummer	Pris exklusive moms uttryckt i ören
cssclass	<cssclass>blue</cssclass>
group	<group><id>3</id><name>Gruppträning</name></group>		Produktgrupp
producttype	<producttype>service</producttype>		Produkttyp
stock	<stock><id>2</id><name>L1</name><balance>3</balance></stock>		Lagerbalans
onlyUseAsPackagePart	<onlyUseAsPackagePart>false</onlyUseAsPackagePart>	Boolean	Produkten är endast bokbar som del av paket

Produkttyper

Namn	Förklaring
groupActivity	Gruppaktivitetsprodukt
subscription	Abonnemangsprodukt (som abonnemang baseras på)
package	Paketprodukt
article	Vara
service	Tjänst
event	Arrangemang
stockProduct	Lagervara
valueCard	Värdekort
entry	Entré

Fält som tillkommer i svaret om produkten är en tjänst

Tag	Exempel	Format	Förklaring
timeresolution	<timeresolution>00:15</timeresolution>		Upplösning av tidsförslag
timeresolutionfromschedulestart	<timeresolutionfromschedulestart>false</timeresolutionfromschedulestart>	Boolean	Om tidsförslagen ska räknas från början på schemat eller från slutet av tidigare bokning
resourcerequirements	<resourcerequirements>		Lista med resurskrav när produkten är en tjänst
resourcerequirement	<resourcerequirement><id>44</id><type>Lokal</type><resourcerequirement>		Resurskrav

Fält som tillkommer i svaret om produkten är ett värdekort

Tag	Exempel	Format	Förklaring
isvaluecardproducttype	<isvaluecardproducttype>true</isvaluecardproducttype>	Boolean	Om värdekort baserad på denna produkt blir klippkort

Fält som tillkommer i svaret om produkten är ett abonnemang

Tag	Exempel	Format	Förklaring
requiresautogiro	<requiresautogiro>true</requiresautogiro>	Boolean	Om abonnemanget kräver autogiro
requiresrecurringcardpayment	<requiresrecurringcardpayment>false</requiresrecurringcardpayment>	Boolean	Om abonnemanget kräver återkommande kortbetalning
requiresmembership	<requiresmembership>true</requiresmembership>	Boolean	Kräver medlemskap
givesmembership	<givesmembership>true</givesmembership>	Boolean	Ger medlemskap
signupfeeproduct	<signupfeeproduct><id>4</id><name>Inskrivningsavgift 2014</name></signupfeeproduct>		Produkt för inskrivningsavgift
campaign	<campaign><campaignstart>....</campaign>		Omsluter kampanjinfo (om produkten inte är en kampanjprodukt är taggen tom)
campaignstart	<campaignstart>2014-10-01</campaignstart>	Datum	Datum för kampanjstart
campaignend	<campaignend>2014-12-31</campaignend>	Datum	Datum för kampanjslut
campaignprice	<campaignprice>19900</campaignprice>	Nummer	Pris under kampanjlängden
campaignpriceend	<campaignpriceend>2015-01-31</campaignpriceend>	Datum	Datum då abonnemanget övergår från kampanjpris till ordinarie pris
campaignpricemonths	<campaignpricemonths>3</campaignpricemonths>	Nummer	Antal månader från start till att abonnemanget övergår till ordinarie pris
campaignnewproduct	<campaignnewproduct><id>45</id><name>Månadskort ordinarie</name></campaignnewproduct>		Produkt som abonnemanget övergår till efter bindningstidens slut

Fält som tillkommer i svaret om produkten har ett anläggningspris

Tag	Exempel	Format	Förklaring
prices	<prices />		Lista anläggningsp riser
price	<price>		Anläggnings pris
businessunitid	<businessunitid>134</businessunitid>	Id	Id på anläggningen
priceincvat	<priceincvat>25000</priceincvat>	Nummer	Pris inklusive moms uttryckt i ören
priceexvat	<priceexvat>20000</priceexvat>	Nummer	Pris exklusive moms uttryckt i ören

Fält som tillkommer i svaret om produkten är av typen lagervara och parametern "stockid" är angiven

Tag	Exempel	Format	Förklaring
stock	<stock>		Lagerbalans
id	<id>2</id>	Id	Lagerställets id
name	<name>Lager 1</name>	Sträng	Lagerställets namn
balance	<balance>42</balance>	Nummer	Antal enheter i det aktuella lagerstället
businessunitid	<businessunitid>134</businessunitid>	Id	Id på anläggningen

Fält som tillkommer i svaret om produkten är av typen paket

Tag	Exempel	Format	Förklaring
packageparts	<packageparts>		Lista av paketdelar
packagepart	<packagepart>		Paketdel
productid	<id>2</id>	Id	Produktens id
productname	<name>Lager 1</name>	Sträng	Produktens namn
perpackage	<perpackage>true</perpackage>	Boolean	En per antal eller en för hela bokningen*
day	<day>1</day>	Nummer	Vilken dag paketdelen infaller på (1 = startdagen)
relativetime	<relativetime>01:00</relativetime>	Tid	Relativ startid utifrån paketets start**
fixedtime	<fixedtime>14:00</fixedtime>	Tid	Fast tid för paketdelen**

* Om true så ska det vara lika många av paketdelen som av paketet annars endast 1 för hela paketet.

** Endast en av dessa är satta.

<product>
  <id>3</id>
  <description>Produktbeskrivning</description>
  <name>Spinn B45</name>
  <number>23</number>
  <lastupdate>2013-11-19 12:42</lastupdate>
  <businessunits>
    <businessunit>
      <id>1</id>
      <name>Anläggningens namn</name>
      <companyname>Bolagsnamn</companyname>
      <companyid>1</companyid>
    </businessunit>
  </businessunits>
  <bookablefrominternet>true</bookablefrominternet>
  <productlabels>
    <productlabel>
      <id>3</id>
      <name>Spinning</name>
    </productlabel>
    <productlabel>
      <id>8</id>
      <name>Medel</name>
    </productlabel>
  </productlabels>
  <standardprice>
    <priceincvat>12500</priceincvat>
    <priceexvat>10000</priceexvat>
  </standardprice>
  <prices>
    <price>
      <businessunitid>134</businessunitid>
      <priceincvat>25000</priceincvat>
      <priceexvat>20000</priceexvat>
    </price>
  </prices>
  <cssclass>blue</cssclass>
  <group>
    <id>45</id>
    <name>Gruppträning</name>
  </group>
  <producttype>service</producttype>
  <timeresolution>00:15</timeresolution>
  <timeresolutionfromschedulestart>false</timeresolutionfromschedulestart>
  <resourcerequirements>
    <resourcerequirement>
      <id>44</id>
      <type>Lokal</type>
    </resourcerequirement>
    <resourcerequirement>
      <id>45</id>
      <name>Personal</type>
    </resourcerequirement>
  </resourcerequirements>
</product>