Vai al contenuto principale
GET
/
instances
/
{instanceId}
/
coupon-schedules
/
{scheduleId}
Recupera una pianificazione di coupon
curl --request GET \
  --url https://api.altostrat.io/instances/{instanceId}/coupon-schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
  "name": "Pass Ospiti Giornalieri",
  "instance_id": "9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
  "count": 20,
  "recurrence_type": "daily",
  "day_of_week": 1,
  "day_of_month": 15,
  "valid_for_in_minutes": 480,
  "timezone": "Australia/Sydney",
  "notification_group_id": "ng_a1b2c3d4e5f6",
  "last_run_at": "2025-10-29T08:00:00Z",
  "next_run_at": "2025-10-30T08:00:00Z",
  "tokens_used_since_last_run": 5,
  "tokens_generated_since_last_run": 20,
  "tokens_available_since_last_run": 15,
  "created_at": "2025-10-20T14:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Autenticazione tramite chiave API. Fornisci il tuo token nell'header 'Authorization'. Esempio: Authorization: Bearer <TUO_TOKEN>

Path Parameters

​
instanceId
string<uuid>
required

L'identificatore univoco per l'istanza captive portal.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

​
scheduleId
string<uuid>
required

L'identificatore univoco per la pianificazione dei coupon.

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

Response

La pianificazione dei coupon richiesta.

​
id
string<uuid>

L'identificatore univoco per la pianificazione dei coupon.

Example:

"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"

​
name
string

Un nome leggibile per la pianificazione.

Example:

"Pass Ospiti Giornalieri"

​
instance_id
string<uuid>

L'ID dell'istanza a cui appartiene questa pianificazione.

Example:

"9a7f1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c"

​
count
integer

Il numero di coupon da generare ogni volta che la pianificazione viene eseguita.

Example:

20

​
recurrence_type
enum<string>

La frequenza con cui la pianificazione deve essere eseguita.

Opzioni disponibili:
daily,
weekly,
monthly
Example:

"daily"

​
day_of_week
integer | null

Richiesto per la ricorrenza 'settimanale'. Il giorno della settimana in cui eseguire (0=Domenica, 6=Sabato).

Example:

1

​
day_of_month
integer | null

Richiesto per la ricorrenza 'mensile'. Il giorno del mese in cui eseguire (1-31).

Example:

15

​
valid_for_in_minutes
integer

Il numero di minuti per cui ogni coupon generato sarà valido dopo la sua creazione.

Example:

480

​
timezone
string

Il fuso orario in cui la pianificazione deve essere valutata (es. 'America/New_York').

Example:

"Australia/Sydney"

​
notification_group_id
string

L'ID di un gruppo di notifica per ricevere i coupon generati.

Example:

"ng_a1b2c3d4e5f6"

​
last_run_at
string<date-time> | null

Il timestamp dell'ultima esecuzione riuscita di questa pianificazione.

Example:

"2025-10-29T08:00:00Z"

​
next_run_at
string<date-time> | null

Il timestamp calcolato della prossima esecuzione pianificata.

Example:

"2025-10-30T08:00:00Z"

​
tokens_used_since_last_run
integer

Il numero di coupon dell'ultima esecuzione che sono stati riscattati.

Example:

5

​
tokens_generated_since_last_run
integer

Il numero totale di coupon generati nell'ultima esecuzione.

Example:

20

​
tokens_available_since_last_run
integer

Il numero di coupon validi e non riscattati rimasti dall'ultima esecuzione.

Example:

15

​
created_at
string<date-time>

Il timestamp di creazione della pianificazione.

Example:

"2025-10-20T14:30:00Z"