Возвращает подписку по ее уникальному идентификатору.
Метод | URI |
---|---|
GET | /subscriptions/{id} |
Имя | Тип | Обязательный | Описание | Значение по-умолчанию |
---|---|---|---|---|
id | string | ✔ | Subscription.Id - уникальный ID подписки |
None.
GET /subscriptions/ece0c779-9bfb-4711-83c9-1b743c1ee669
Стандартный код HTTP: 200 OK.
Тело ответа: объект Subscription
. Контракты сервиса
В случае, если запрашиваемая подписка имеет связанные дочерние подписки (аддоны), поле Childs
должно содержать массив Id
дочерних подписок в формате:
"Childs": [{"Id":"aaa"}, {"Id":"bbb"}]
Для подписки без аддонов поле Childs
необязательно.
Для указания типа ошибки в ответе сервера, используются стандартные HTTP-коды 4xx-5xx.
Тело ответа: возвращается общий для сервиса набор данных, содержащий сообщение об ошибке и дополнительную информацию. Дополнительная информация в разделе Ошибки сервиса.
{ "Id": "0a0ae92f-f5f1-4349-9d51-fdb7d971602b", "ProfileId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602b", "OfferId": "3a0ae92f-f5f1-4349-9d51-fdb7d971602c", ... "Childs": [{ "Id": "9asde92f-f5f1-4349-9d51-fdb7d971602b", "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 | дата-время окончания работы |