Семьи

Download schema

Своя база отдела: семьи, дети, их брони и оплаты

Дети вашей базы

GET

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/children

Все ваши дети, включая прошлые сезоны. Ребёнок, ушедший в другой отдел, здесь больше не появляется.

Дети вашей базы › query Parameters

season_id_visited

string

Были в сезоне: есть неотменённая обычная (не корпоративная) бронь на смену этого сезона

season_id_not_visited

string

Не были в сезоне: ваши дети без неотменённой обычной брони в этом сезоне — «кого не было в этом году»

birth_year_from

integer · int32

Год рождения от (включительно)

birth_year_to

integer · int32

Год рождения до (включительно)

cursor

string

Курсор из next_cursor прошлого ответа

limit

integer · int64 · min: 1 · max: 200

Сколько записей вернуть, 1–200, по умолчанию 50

Default: 50

Дети вашей базы › Responses

Готово

Порция списка. `next_cursor` пуст — дальше ничего нет.

Page_Child

Child[] · required

next_cursor

string | null

Передать в cursor, чтобы получить следующую порцию

Ребёнок

GET

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/children/{id}

Ребёнок › path Parameters

id

string · required

Номер ребёнка

Ребёнок › Responses

Готово

Child

family_id

string · required

Семья ребёнка

full_name

string · required

id

string · required

Metadata · maxProps: 20 · required

Ваши метки: до 20 пар «ключ — значение». Ключ — от 1 до 40 знаков, значение — строка (до 500 знаков), число, true/false или null. Мы их не разбираем: только храним и возвращаем

Example: {"deal_id":"D-1042","priority":2}

birth_date

string | null · date

Нет — дата рождения неизвестна

external_id

string | null

Номер ребёнка в вашей CRM

Правка ребёнка

PATCH

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/children/{id}

Только ваш номер и метки: ФИО и дата рождения ребёнка — данные путёвки и правятся в брони.

Правка ребёнка › path Parameters

id

string · required

Номер ребёнка

Правка ребёнка › Request Body

Свой номер и метки ребёнка. Отсутствующее поле — не менять.

ChildPatch

external_id

string | null

Номер ребёнка в вашей CRM. null — стереть номер, поле не передано — не менять

Metadata | null · maxProps: 20

Заменяет метки целиком

Example: {"deal_id":"D-1042","priority":2}

Правка ребёнка › Responses

Готово

Child

family_id

string · required

Семья ребёнка

full_name

string · required

id

string · required

Metadata · maxProps: 20 · required

Example: {"deal_id":"D-1042","priority":2}

birth_date

string | null · date

Нет — дата рождения неизвестна

external_id

string | null

Номер ребёнка в вашей CRM

Семьи вашей базы

GET

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/families

Поиск по телефону и ФИО. Без фильтров — вся ваша база по возрастанию номера, порциями.

Семьи вашей базы › query Parameters

phone

string

Телефон в любом написании (8 701…, +7 701…): ищется по основному и вторым номерам семьи

name

string

Часть ФИО родителя или вашего ребёнка, от 2 символов

updated_since

string · date-time

Только семьи, у которых родитель или ваш ребёнок изменились начиная с этого момента (RFC 3339)

cursor

string

Курсор из next_cursor прошлого ответа

limit

integer · int64 · min: 1 · max: 200

Сколько записей вернуть, 1–200, по умолчанию 50

Default: 50

Семьи вашей базы › Responses

Готово

Порция списка. `next_cursor` пуст — дальше ничего нет.

Page_Family

Family[] · required

next_cursor

string | null

Передать в cursor, чтобы получить следующую порцию

GET/families

curl https://partners.zvezdnyy-burabai.edu.kz/ext/v1/families \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "items": [
    {
      "bookings": [
        {
          "child_id": "child_id",
          "id": "id",
          "shift": {
            "date_start": "2024-08-25",
            "id": "id",
            "number": 0
          },
          "status": "active",
          "voucher_number": "05-012"
        }
      ],
      "children": [
        {
          "birth_date": "2024-08-25",
          "external_id": "external_id",
          "family_id": "family_id",
          "full_name": "full_name",
          "id": "1503",
          "metadata": {
            "deal_id": "D-1042",
            "priority": 2
          }
        }
      ],
      "city": {
        "id": "3",
        "name": "Астана"
      },
      "external_id": "external_id",
      "extra_phones": [
        "string"
      ],
      "full_name": "full_name",
      "id": "812",
      "marketing_opt_in": true,
      "merged_from": [
        "string"
      ],
      "metadata": {
        "deal_id": "D-1042",
        "priority": 2
      },
      "phone": "+77010000001",
      "shared": true,
      "version": "3"
    }
  ],
  "next_cursor": "next_cursor"
}

json

application/json

Семья по номеру в вашей CRM

GET

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/families/by-external-id/{external_id}

Семья по номеру в вашей CRM › path Parameters

external_id

string · required

Ваш номер семьи

Семья по номеру в вашей CRM › Responses

Готово

Семья: родитель, ваши дети и ваши брони. Если семью ведёт и другой отдел (`shared`), её общие данные вам не показываются: `full_name` — как вы записали родителя в своей брони, `extra_phones` пуст, `city` нет. Править ФИО, город, согласие и вторые номера такой семьи нельзя (`403 family_shared`); свои `external_id` и `metadata` — можно.

Family

BookingSummary[] · required

Ваши брони детей этой семьи, свежие первыми

Child[] · required

Только ваши дети. Брат или сестра, которых ведёт другой отдел, здесь не показываются

extra_phones

string[] · required

full_name

string · required

id

string · required

marketing_opt_in

boolean · required

Согласие на рассылки

merged_from

string[] · required

Номера карточек, слитых в эту (дубли семьи). Запрос по старому номеру отвечает этой карточкой

Metadata · maxProps: 20 · required

Example: {"deal_id":"D-1042","priority":2}

phone

string · required

Основной телефон, +7XXXXXXXXXX. Ключ узнавания семьи: через API не меняется, второй номер — в extra_phones

shared

boolean · required

Семью ведёт и другой отдел: общие данные семьи скрыты и не правятся

version

string · required

Версия записи для If-Match при правке

City | null

Город из справочника.

external_id

string | null

Номер семьи в вашей CRM

GET/families/by-external-id/{external_id}

curl https://partners.zvezdnyy-burabai.edu.kz/ext/v1/families/by-external-id/:external_id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "bookings": [
    {
      "child_id": "child_id",
      "id": "id",
      "shift": {
        "date_start": "2024-08-25",
        "id": "id",
        "number": 0
      },
      "status": "active",
      "voucher_number": "05-012"
    }
  ],
  "children": [
    {
      "birth_date": "2024-08-25",
      "external_id": "external_id",
      "family_id": "family_id",
      "full_name": "full_name",
      "id": "1503",
      "metadata": {
        "deal_id": "D-1042",
        "priority": 2
      }
    }
  ],
  "city": {
    "id": "3",
    "name": "Астана"
  },
  "external_id": "external_id",
  "extra_phones": [
    "string"
  ],
  "full_name": "full_name",
  "id": "812",
  "marketing_opt_in": true,
  "merged_from": [
    "string"
  ],
  "metadata": {
    "deal_id": "D-1042",
    "priority": 2
  },
  "phone": "+77010000001",
  "shared": true,
  "version": "3"
}

json

application/json

Семья

GET

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/families/{id}

Родитель, ваши дети и ваши брони. По номеру слитой карточки отвечает живой семьёй (её номер — в id, старый — в merged_from).

Семья › path Parameters

id

string · required

Номер семьи

Семья › Responses

Готово

Family

BookingSummary[] · required

Ваши брони детей этой семьи, свежие первыми

Child[] · required

Только ваши дети. Брат или сестра, которых ведёт другой отдел, здесь не показываются

extra_phones

string[] · required

full_name

string · required

id

string · required

marketing_opt_in

boolean · required

Согласие на рассылки

merged_from

string[] · required

Номера карточек, слитых в эту (дубли семьи). Запрос по старому номеру отвечает этой карточкой

Metadata · maxProps: 20 · required

Example: {"deal_id":"D-1042","priority":2}

phone

string · required

Основной телефон, +7XXXXXXXXXX. Ключ узнавания семьи: через API не меняется, второй номер — в extra_phones

shared

boolean · required

Семью ведёт и другой отдел: общие данные семьи скрыты и не правятся

version

string · required

Версия записи для If-Match при правке

City | null

Город из справочника.

external_id

string | null

Номер семьи в вашей CRM

GET/families/{id}

curl https://partners.zvezdnyy-burabai.edu.kz/ext/v1/families/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "bookings": [
    {
      "child_id": "child_id",
      "id": "id",
      "shift": {
        "date_start": "2024-08-25",
        "id": "id",
        "number": 0
      },
      "status": "active",
      "voucher_number": "05-012"
    }
  ],
  "children": [
    {
      "birth_date": "2024-08-25",
      "external_id": "external_id",
      "family_id": "family_id",
      "full_name": "full_name",
      "id": "1503",
      "metadata": {
        "deal_id": "D-1042",
        "priority": 2
      }
    }
  ],
  "city": {
    "id": "3",
    "name": "Астана"
  },
  "external_id": "external_id",
  "extra_phones": [
    "string"
  ],
  "full_name": "full_name",
  "id": "812",
  "marketing_opt_in": true,
  "merged_from": [
    "string"
  ],
  "metadata": {
    "deal_id": "D-1042",
    "priority": 2
  },
  "phone": "+77010000001",
  "shared": true,
  "version": "3"
}

json

application/json

Правка семьи

PATCH

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/families/{id}

Контакты — те же поля и правила, что у менеджера в CRM; основной телефон не меняется. С If-Match: <version> правка пройдёт, только если запись не меняли после вашего чтения, иначе — 412.

Правка семьи › path Parameters

id

string · required

Номер семьи

Правка семьи › Headers

If-Match

string

Версия записи (version)

Правка семьи › Request Body

Правка семьи. Отсутствующее поле — не менять.

FamilyPatch

city_id

string | null

Город родителя; null — стереть

external_id

string | null

Номер семьи в вашей CRM. null — стереть номер, поле не передано — не менять

extra_phones

array | null

Вторые номера семьи — заменяют список целиком. Номер, записанный за другой семьёй, не принимается (phone_taken). ФИО, город, согласие и вторые номера семьи, которую ведёт и другой отдел (shared), не правятся (family_shared)

full_name

string | null

marketing_opt_in

boolean | null

Metadata | null · maxProps: 20

Заменяет метки целиком

Example: {"deal_id":"D-1042","priority":2}

Правка семьи › Responses

Готово

Family

BookingSummary[] · required

Ваши брони детей этой семьи, свежие первыми

Child[] · required

Только ваши дети. Брат или сестра, которых ведёт другой отдел, здесь не показываются

extra_phones

string[] · required

full_name

string · required

id

string · required

marketing_opt_in

boolean · required

Согласие на рассылки

merged_from

string[] · required

Номера карточек, слитых в эту (дубли семьи). Запрос по старому номеру отвечает этой карточкой

Metadata · maxProps: 20 · required

Example: {"deal_id":"D-1042","priority":2}

phone

string · required

Основной телефон, +7XXXXXXXXXX. Ключ узнавания семьи: через API не меняется, второй номер — в extra_phones

shared

boolean · required

Семью ведёт и другой отдел: общие данные семьи скрыты и не правятся

version

string · required

Версия записи для If-Match при правке

City | null

Город из справочника.

external_id

string | null

Номер семьи в вашей CRM

PATCH/families/{id}

curl https://partners.zvezdnyy-burabai.edu.kz/ext/v1/families/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "city_id": "city_id",
  "external_id": "external_id",
  "extra_phones": [
    "string"
  ],
  "full_name": "full_name",
  "marketing_opt_in": true,
  "metadata": {
    "deal_id": "D-1042",
    "priority": 2
  }
}'

Example Request Body

{
  "city_id": "city_id",
  "external_id": "external_id",
  "extra_phones": [
    "string"
  ],
  "full_name": "full_name",
  "marketing_opt_in": true,
  "metadata": {
    "deal_id": "D-1042",
    "priority": 2
  }
}

json

Example Responses

{
  "bookings": [
    {
      "child_id": "child_id",
      "id": "id",
      "shift": {
        "date_start": "2024-08-25",
        "id": "id",
        "number": 0
      },
      "status": "active",
      "voucher_number": "05-012"
    }
  ],
  "children": [
    {
      "birth_date": "2024-08-25",
      "external_id": "external_id",
      "family_id": "family_id",
      "full_name": "full_name",
      "id": "1503",
      "metadata": {
        "deal_id": "D-1042",
        "priority": 2
      }
    }
  ],
  "city": {
    "id": "3",
    "name": "Астана"
  },
  "external_id": "external_id",
  "extra_phones": [
    "string"
  ],
  "full_name": "full_name",
  "id": "812",
  "marketing_opt_in": true,
  "merged_from": [
    "string"
  ],
  "metadata": {
    "deal_id": "D-1042",
    "priority": 2
  },
  "phone": "+77010000001",
  "shared": true,
  "version": "3"
}

json

application/json

Платежи семьи

GET

https://partners.zvezdnyy-burabai.edu.kz/ext/v1

/families/{id}/payments

Платежи по вашим броням детей этой семьи. Только чтение: платежи принимает лагерь (счёт Kaspi), ввода платежей в API нет.

Платежи семьи › path Parameters

id

string · required

Номер семьи

Платежи семьи › query Parameters

cursor

string

Курсор из next_cursor прошлого ответа

limit

integer · int64 · min: 1 · max: 200

Сколько записей вернуть, 1–200, по умолчанию 50

Default: 50

Платежи семьи › Responses

Готово

Порция списка. `next_cursor` пуст — дальше ничего нет.

Page_FamilyPayment

FamilyPayment[] · required

next_cursor

string | null

Передать в cursor, чтобы получить следующую порцию

Брони События