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

List persongroups

Lists groups to which persons can belong.

Request

HTTP GET to /persongroups

Filter

Name

Required

Example

Description

Data Type

id

no

id=1

Only show the group with the given id

ID

Example:

APIURL/persongroups.xml?apikey=338934897438

Response

Name

Example

Description

Data Type

id

<id>1</id>

Unique ID

ID

name

<name>VIP</name>

Name of group

String

businessunitid<businessunitid>1</businessunitid>ID of business unitID
<persongroups>
  <persongroup>
    <id>3</id>
    <name>Elev</name>
    <businessunitid>1</businessunitid>
  </persongroup>
  <persongroup>
    <id>2</id>
    <name>Katalog</name>
    <businessunitid>1</businessunitid>
  </persongroup>
  <persongroup>
    <id>1</id>
    <name>VIP</name>
    <businessunitid>1</businessunitid>
  </persongroup>
</persongroups>
{
    "persongroups":  [
                         {
                             "id":  3,
                             "name":  "Elev",
                             "businessunitid":  1
                         },
                         {
                             "id":  2,
                             "name":  "Katalog",
                             "businessunitid":  1
                         },
                         {
                             "id":  1,
                             "name":  "VIP",
                             "businessunitid":  1
                         }
                     ]
}
  • No labels