Intervention API

An intervention is a « Type of Service », examples: « Consultation », « Back Massage », a.s.o ... Every appointment must be linked to an intervention.

Retrieve all the interventions of the group

GET /api/v1/groups/:group_id/interventions

Retrieve the interventions which belong to a category (Interventionset)

GET /api/v1/groups/:group_id/interventions?interventionset_id=:interventionset_id

Retrieve the interventions available on a specific calendar

GET /api/v1/groups/:group_id/interventions?calendar_ids[]=:calendar_id

Create an intervention

POST /api/v1/groups/:group_id/interventions?apikey=xxxxxx
{
  "intervention": {
     "group_id": 4,
     "name": "Thai Massage",
     "length": 30
  }
}

Update an intervention

PUT /api/v1/groups/:group_id/interventions/:id?apikey=xxxxxx
{
  "intervention": {
     "publicname": "Traditionnal Thai Massage"
  }
}

Delete an intervention

DELETE /api/v1/groups/:group_id/interventions/:id

This operation does not remove the intervention completely! It will change the value of the deleted attribute to true. The intervention can be restored later on:

PUT /api/v1/groups/:group_id/interventions/:id?apikey=xxxxxx
{
   "intervention": {
      "deleted": false
   }
}

Standard fields

Field	Type	Description
group_id	integer	Group identifier
interventionset_id	integer	(optional) InterventionSet identifier (only when intervention sets are in use)
name	string(255)	Name of the intervention
abbr	string(255)	Abbreviation of the intervention (as displayed on the appointments on the Pro Interface)
length	integer	Duration of the intervention in minutes (default: 15)
colorref	string(7)	Color of the intervention as displayed on appointments on the Pro Interface. Hexadecimal format #RRGGBB (example: #FF6600) (default: #dddddd)
sort	integer	Integer to specify the order of the interventions when displayed in the pro interface and the appointment module.
price	integer	(optional) Price of the intervention in cents - ex: set to 3000 for a service with a price of $30
deleted	boolean	When true, the intervention is deleted and will not be shown neither on the Pro Interface nor on the appointment module (default: 0)

Fields for appointments on the client module:

Field	Type	Description
publicname	string(255)	Name of the intervention as displayed on the appointment module. Important If blank, the intervention will not be available on the appointment module.
description	text	Descriptive text about the intervention. Will be displayed in the appointment module.