Page tree
Skip to end of metadata
Go to start of metadata

List product groups

List product groups

Request

HTTP GET to /productgroups

Parameters

Name

Value

Description

Datatype

Default

forgrouping

forgrouping=true

Retrieves the product groups that are in the parent group specified in the system setting "Product group for group activites".

Boolean

false

businessunitid

businessunitid=4

Uses value from setting "Productgroup for group activities" from specified business unit/facility. Required when setting forgrouping=true

ID

 

languagelanguage=enIf supplied only returns the translations in the specific language for translatable fields (2 letter, ISO 639-1 language code)  

Example:

APIURL/productgroups.xml?apikey=338934897438

Response

Tag

Format

Example

Description

productgroups

 

<productgroups>

Productgroups tag encloses product groups.

id

ID

<id>14</id>

Unique ID

name

String

<name>Activity</name>

The product name

nametranslations <nametranslations>
<nametranslation>
<language>sv</language>
<translation>Conference</translation>
</nametranslation>
</nametranslations>
List of available translations with their respectinve language codes
parent <parent><id>2</id><name>Name</name></parent>Parent group of the productgroup
<productgroups>
  <productgroup>
    <id>14</id>
    <name>Activity</name>
	<parent>
		<id>2</id>
		<name>Name</name>
	</parent>
    <nametranslations>
	 <nametranslation>
		<language>sv</language>
		<translation>Conference</translation>
	 </nametranslation>
    </nametranslations>
  </productgroup> 
   ...
</productgroups>
  • No labels