Groups

This endpoint can be used to retrieve a list of available category-groups for this client

Reference

POST /groups/

Retrieve a list of the available groups and optionally filter the result using additional parameters.

General Search parameters

field	type	description/constraints	Req	W	U
useCache	boolean	Use API caching module	No	No	No
groupId	array	List of groupId's to include in the searchresult. When omitted: all group ids linked with this client will be in the result.	No	No	No
userId	int	Only show groups used by this user.	No	No	No
status	string	Use in combination with userId	No	No	No
		Filter groups by advertisement-status
		Available options
		- concept
		- active (default)
		- archive
availability	boolean	Use in combination with userId	No	No	No
		Show per portal if an active advertisement is available using the specific group
locale	array	List of locales to include in the search-result	No	No	No
page	int	Show page x from resultset (default: 1)	No	No	No
itemsPerPage	int	Number of items per page Minimum: 1 item Maximum 100 items (default: 25)	No	No	No
total	boolean	show one complete list instead of a limited number of items per page. Default: false	No	No	No

Fields

field	type	constraints	W	U
groupId	int	The groupId	No	No
groupDescriptions	array	List of groupDescription-objects	No	No

Example

Request

POST /rest/v1/groups/ HTTP/2

{
 "useCache": false,
 "groupId": [],
 "locale": [
   "nl_NL"
 ],
 "page": 1,
 "itemsPerPage": 100
}

Response

{
 "fromCache": false,
 "totalItems": 37,
 "totalInSet": 37,
 "page": 1,
 "itemsPerPage": 100,
 "speed": 0.00026988983154297,
 "data": [
   {
     "groupId": 1,
     "descriptions": [
       {
         "locale": "nl_NL",
         "description": "Antiek en Kunst"
       }
     ]
   },
   {
     "groupId": 2,
     "descriptions": [
       {
         "locale": "nl_NL",
         "description": "Audio, Tv en Foto"
       }
     ]
   },
 ]
}

Example Availability

Request

POST /rest/v1/groups/ HTTP/2

{
  "useCache": false,
  "userId": 12311,
  "availability": true,
  "groupId": [],
  "locale": [
    "nl_NL"
  ],
  "page": 1,
  "itemsPerPage": 100
}

Response

{
  "fromCache": false,
  "totalItems": 37,
  "totalInSet": 37,
  "page": 1,
  "itemsPerPage": 100,
  "speed": 0.00026988983154297,
  "data": [
    {
      "groupId": 1,
      "descriptions": [
        {
          "locale": "nl_NL",
          "description": "Antiek en Kunst"
        }
      ],
      "availability": {
        "marktplaats": true,
        "tweedehands": false,
        "website": true
      }
    },
    {
      "groupId": 2,
      "descriptions": [
        {
          "locale": "nl_NL",
          "description": "Audio, Tv en Foto"
        }
      ],
      "availability": {
        "marktplaats": true,
        "tweedehands": false,
        "website": true
      }
    },
  ]
}