Возвращает список подписок указанного реселлера и/или профиля.
| Метод | URI |
|---|---|
| GET | /subscriptions?reseller_id={reseller_id}&profile_id={profile_id}&offset={offset}&limit={limit}&childs={childs} |
| Имя | Тип | Обязательный | Описание | Значение по-умолчанию |
|---|---|---|---|---|
| reseller_id | GUID | ✔ | ID реселлера | |
| profile_id | GUID | ID профиля | ||
| offset | int | пропуск указанного кол-ва записей от начала | 0 | |
| limit | int | вернуть не более указанного кол-ва записей | 100 | |
| childs | bit | 1 - в поле Childs содержатся полные контракты дочерних подписок. 0 - в поле Childs содержатся только Id дочерних подписок. | 0 |
Нет.
GET /subscriptions?reseller_id=c06b9b37-f449-4b6c-8e94-5da79b1ff4d5&profile_id=38558f28-a8a1-4c9b-9744-7baab493e307&offset=100&limit=20&childs=1
Стандартный код HTTP: 200 OK.
Тело ответа: массив объектов Subscription. Контракты сервиса
В случае, если запрашиваемая подписка имеет связанные дочерние подписки (аддоны), поле Childs должно содержать массив Id дочерних подписок в формате:
"Childs": [{"Id":"aaa"}, {"Id":"bbb"}]
Для подписки без аддонов поле Childs необязательно. При указании необязательного параметра childs=1 в поле Childs возвращаются полные контракты дочерних подписок.
Для указания типа ошибки в ответе сервера, используются стандартные HTTP-коды 4xx-5xx.
Тело ответа: возвращается общий для сервиса набор данных, содержащий сообщение об ошибке и дополнительную информацию. Дополнительная информация в разделе Ошибки сервиса.
[{
"ProfileId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602b",
"OfferId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602c",
...
"Childs": [{
"ProfileId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602b",
"OfferId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602c"
...
}]
}, {
"ProfileId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602b",
"OfferId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602c",
...
"Childs": [{
"ProfileId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602b",
"OfferId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602c"
...
}]
}]
| Поле | Тип | Описание |
|---|---|---|
| Id | GUID | Генерация уникальных идентификаторов для объектов |
| Quantity | number | |
| State | string | Возможные значения: Starting, Started, Stopping, Stopped, Suspending, Suspended, Deleting, Deleted |
| OfferId | GUID | ID продаваемой услуги (тарифный план). Примеры услуг: Office 365 Business, SharePoint Online (Plan 2) |
| ParentId | GUID | ID родительской подписки (указывается только для дочерних подписок - аддонов) |
| ProfileId | GUID | ID подписчика |
| Childs | JSON array | Массив дочерних подписок (аддонов). Контракты родительской и дочерних подписок абсолютно идентичны по структуре. Вложенность свыше 1 уровня не поддерживается (т.е. у дочерних подписок детей быть не может). |
| DynamicProperties | JSON array | Динамические свойства контрактов |
| CreateDate | datetime | дата-время создания |
| StartDate | datetime | дата-время начала работы (биллингового периода?) |
| ActiveTill | datetime | дата-время окончания работы |