ru:vendor-api:contracts

Содержание

Контракты сервиса

Контракты сервиса

Subscription (Подписка)

Поле	Тип	Описание
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	дата-время окончания работы

Profile (Пользователь)

Поле	Тип	Описание
Id	string	Генерация уникальных идентификаторов для объектов
Login	string
Password	string
Email	string
State	string	Возможные значения: Active
Type	string	Возможные значения: Organization, User
Address	Address (Адрес)
DynamicProperties	JSON array	Динамические свойства контрактов
ActivationDate	datetime	дата-время создания
AuthCode	string	технический код пользователя (например, domain prefix в Microsoft CREST API)

Address (Адрес)

Поле	Тип	Описание
FirstName	string
MiddleName	string
LastName	string
City	string
PostalCode	string
Region	string
AddressLine	string
Culture	string	{xx-XX}
Language	string	{xx}

SubscriptionEvent (Событие подписки)

{
	"Id": "ece0c779-9bfb-4711-83c9-1b743c1ee669",
	"Time": "2016-02-16T17:00:39.8623196+03:00",
	"SubscriptionId": "ece0c779-9bfb-4711-83c9-1b743c1ee669",
	"Type": "Info",
	"Description": "changed world",
	"Previous": {...},
	"Current": {...}
}

Поле	Тип	Описание
Id	GUID
SubscriptionId	GUID
Time	datetime	Время изменения состояния
Previous	Subscription (Подписка)	Состояние подписки до изменения - полный контракт Subscription
Current	Subscription (Подписка)	Состояние подписки после изменения - полный контракт Subscription
Type	string	Допустимые значения: Info, Error
Description	string	Описание изменения

UsageRecord

{
	"IntervalBegin": "2002-12-30T23:59:59+00:00",
	"IntervalEnd": "2002-12-31T23:59:59+00:00",
	"Quantity": 123.45,
	"ResourceId": "31605363-f28b-468f-9bc5-ab7b3bdb355a"
}

Поле	Тип	Описание
IntervalBegin	datetime
IntervalEnd	datetime
Quantity	number	Количество потребленного ресурса
ResourceId	string	ID ресурса