POST api/v1/subscriptionplans
Create a Subscription Plan
Request Information
URI Parameters
None.
Body Parameters
SubscriptionPlanModel| Name | Description | Type | Additional information |
|---|---|---|---|
| DistributionListName | string |
None. |
|
| SubscriptionPlanId | globally unique identifier |
Required |
|
| FacilityId | integer |
Required |
|
| ClusterIds | string |
String length: inclusive between 0 and 100 |
|
| SubscriptionName | string |
Required String length: inclusive between 0 and 50 |
|
| OptionTypeValueId | integer |
Required |
|
| DistributionListId | globally unique identifier |
Required |
|
| ScheduledTimeUtc | time interval |
Required |
|
| EndDateTimeUtc | date |
None. |
|
| IsActive | boolean |
Required |
|
| CreatedBy | string |
Required String length: inclusive between 0 and 50 |
|
| CreatedOnUtc | date |
Required |
|
| ModifiedBy | string |
String length: inclusive between 0 and 50 |
|
| ModifiedOnUtc | date |
None. |
|
| SubscriptionSchedules | Collection of SubscriptionScheduleModel |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
ApiResponseModelOfSubscriptionPlanModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ApiResponseDataModelOfSubscriptionPlanModel |
None. |
|
| Errors | Collection of string |
None. |
|
| Warnings | Collection of string |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.