Получение списка подписок всех нижестоящих реселлеров
Метод Get list of subscriptions of downstream resellers используется для получения списка подписок, существующих у всех реселлеров, являющихся нижестоящими по отношению к текущему реселлеру, или по отношению к его выбранному нижестоящему реселлеру.
Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).
По указанному в запросе API-токену определяются:
- Роль и уровень доступа менеджера, от которых зависит доступность метода.
- Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.
GET {base_url}/api/v3/resellers/{reseller_id}/child_reseller_subscriptionsАргументы
Название | Тип параметра | Тип данных | Обязательный/ | Описание |
|---|---|---|---|---|
| X-Api-Token | header | string | Обязательный | API-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
| Content-Type | header | string | Обязательный | Тип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json |
| Accept | header | string | Обязательный | Поддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json |
| base_url | path | string | Обязательный | URL ActivePlatform |
| reseller_id | path | integer | Обязательный | ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере) |
| page[size] | query | integer | Опциональный | Параметр постраничной навигации. Количество элементов на странице ответа (50 по умолчанию) |
| page[number] | query | integer | Опциональный | Параметр постраничной навигации. Номер страницы ответа |
| meta | query | bool | Опциональный | Запрос дополнительных атрибутов подписки |
Модель ответа
Модель ответа аналогична методу Получение списка подписок без включения в ответ параметра included с дополнительной информации о связанных объектах.
Пример запроса
GET /api/v3/resellers/1/child_reseller_subscriptions?meta=true&page[number]=396&page[size]=2
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+jsonПример ответа
{
"data": [
{
"id": "3007095",
"type": "subscriptions",
"attributes": {
"created_at": "2020-08-05T05:44:55.355+03:00",
"updated_at": "2020-08-05T06:26:53.948+03:00",
"plan_id": 1200,
"account_id": 523,
"name": "1200 G Suite Business test.activeplatform.com",
"trial": false,
"status": "active",
"start_date": "2020-08-05",
"expiration_date": "2020-09-05",
"plan_period_id": 2014,
"promo_code": null,
"payment_model": "prepay",
"payment_model_parameters": {},
"renewal_settings": {
"autorenew": false,
"disable_autorenew": false,
"autorenew_point": 0,
"manual_renew_point": 0
},
"fixed_price": false,
"ability": {
"stop": true,
"activate": false,
"destroy": true,
"adjust": true,
"immediate_switch_plan_order": false,
"delayed_switch_plan_order": false,
"renew": false,
"change_auto_renew_option": true,
"prolong": false,
"change_resources_renewal_order": true,
"decrease_resources_change_order": false,
"decrease_resources_prolong_order": false
},
"custom_price": false
},
"relationships": {
"account": {
"data": {
"id": "523",
"type": "accounts"
}
},
"subscription_resources": {
"data": [
{
"id": "34847",
"type": "subscription_resources"
}
]
},
"subscription_period": {
"data": {
"id": "6200",
"type": "subscription_periods"
}
},
"plan": {
"data": {
"id": "1200",
"type": "plans"
}
}
},
"meta": {
"applications": [
{
"user_manual": "<h3>G Suite activation steps</h3><br><ul><li>1. Go to the account admin console <a class=\"link\" href=\"https://admin.google.com\" target=\"blank\">https://admin.google.com</a> using the credentials below.<li><li>2. Accept the G Suite Agreement.<li><li>3. Create a new, strong password for your G Suite Account.<li><li>4. Accept the Term of Service.<li><li>5. Verify your domain to activate G Suite using the \"Start Setup\" button.</li></ul>",
"customer_id": "new1",
"admin_login": "admin",
"domain_name": "test.activeplatform.com",
"first_password": "pass123",
"plugin_name": "Vendor service"
}
]
}
},
{
"id": "3007096",
"type": "subscriptions",
"attributes": {
"created_at": "2020-08-11T08:15:18.760+03:00",
"updated_at": "2020-08-11T08:15:58.394+03:00",
"plan_id": 804,
"account_id": 685,
"name": "CSP monthly",
"trial": false,
"status": "active",
"start_date": "2020-08-11",
"expiration_date": "2022-08-11",
"plan_period_id": 1614,
"promo_code": null,
"payment_model": "prepay",
"payment_model_parameters": {},
"renewal_settings": {
"autorenew": false,
"disable_autorenew": false,
"autorenew_point": 0,
"manual_renew_point": -1
},
"fixed_price": false,
"ability": {
"stop": true,
"activate": false,
"destroy": true,
"adjust": true,
"immediate_switch_plan_order": false,
"delayed_switch_plan_order": false,
"renew": true,
"change_auto_renew_option": true,
"prolong": true,
"change_resources_renewal_order": true,
"decrease_resources_change_order": true,
"decrease_resources_prolong_order": true
},
"custom_price": false
},
"relationships": {
"account": {
"data": {
"id": "685",
"type": "accounts"
}
},
"subscription_resources": {
"data": [
{
"id": "34848",
"type": "subscription_resources"
}
]
},
"subscription_period": {
"data": {
"id": "6201",
"type": "subscription_periods"
}
},
"plan": {
"data": {
"id": "804",
"type": "plans"
}
}
},
"meta": {
"applications": []
}
}
],
"links": {
"self": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=396&page%5Bsize%5D=2",
"first": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=1&page%5Bsize%5D=2",
"prev": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=395&page%5Bsize%5D=2",
"next": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=397&page%5Bsize%5D=2",
"last": "http://test.activeplatform.com/api/v3/resellers/1/child_reseller_subscriptions?meta=true&page%5Bnumber%5D=573&page%5Bsize%5D=2"
}
}