metadata

Create a service page set

Creates a new page set for the service. name is required and must not contain spaces. title is required and must be an object keyed by locale code with string values (e.g. {"en": "My Set"}).

post/areas/{area_id}/services/{svc_id}/page-sets

Request

  • Base URL: https://api.recollect.net/api
  • URL: https://api.recollect.net/api/areas/{area_id}/services/{svc_id}/page-sets
  • Auth: none declared

Path parameters

area_idstring required

Area ID or Area name can be used.

svc_idstring required

Service ID. When used with an Area, a Service name (like "waste") can be used.

Request body

titleobject required
sort_orderinteger

Display order. Auto-assigned if omitted.

user_visibleinteger required

Whether the page set is visible to end users (0 or 1).

activeinteger

Whether the page set is active (0 or 1). Defaults to 1.

namestring required

Unique name within the service. Must not contain spaces.

Response

200 OK - the request was successful

Changes

No recorded changes to this operation across all 1 revision of this API.