SubscriptionGroups
SubscriptionGroups
GetGroupsList
returns groups of the subscription or subscription user
Request
GET /api/manage/v1/Subscriptions/{subscriptionId}/groups[?userId]Parameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | subscripiton id |
|
| userId | string | user Id (optional) |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Everything is all right (list of groups may be empty) |
|
| 400 | id is not hex24 |
|
| 402 | Subscription is blocked |
|
| 403 | You don't have permission to get groups from this subscription (or in your default (1st) subscription) |
|
| 404 | there is no subscription with provided id found, or user don't even have a subscription |
CountGroupsAsync
Returns a number of groups in subscription
Request
GET /api/manage/v1/Subscriptions/{subscriptionId}/countParameters
| Name | Type | Value | Notes |
|---|---|---|---|
| *subscriptionId | string | subscripiton id |
Responses
| Status Code | Description | Samples |
|---|---|---|
| 200 | Everything is all right |
|
| 400 | id is not hex24 |
|
| 402 | Subscription is blocked |
|
| 403 | You don't have permission to get groups from this subscription (or in your default (1st) subscription) |
|
| 404 | there is no subscription with provided id found, or user don't even have a subscription |
Definitions
GroupsVM
| Name | Type | Notes |
|---|---|---|
| groups |
|
|
| count | integer (int64) | |
| skip | integer (int32) | |
| take | integer (int32) | |
| $t | string |
GroupVM
| Name | Type | Notes |
|---|---|---|
| id | string | |
| name | string | |
| subscriptionId | string | |
| $t | string |
ProblemDetails
| Name | Type | Notes |
|---|---|---|
| type | string | |
| title | string | |
| status | integer (int32) | |
| detail | string | |
| instance | string |