Create Shared Capacity Groups
Description
Creates a Shared Capacity Group.
Request
HTTP Method: POST
URI Path: /v3/shared_capacity_groups
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
---|---|---|---|
include |
|
No |
Request Body Object Attributes:
Name |
Type |
Nullable |
Is Required? |
Description |
---|---|---|---|---|
name |
|
False |
Yes |
Unique name of Shared Capacity Group. |
shared_channels_count |
|
False |
No |
Unassigned channels quantity to assign to the Shared Capacity Group from the Capacity Pool. |
metered_channels_count |
|
False |
No |
Metered channels quantity to assign to the Shared Capacity Group. |
Request Body Object Relationships:
Title |
Type |
Description |
---|---|---|
dids |
Linkage for included dids. |
|
capacity_pool |
Linkage for included capacity_pool. |
Examples
POST /v3/shared_capacity_groups HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
{
"data": {
"type": "shared_capacity_groups",
"attributes": {
"name": "Sample Capacity Group",
"metered_channels_count": 5,
"shared_channels_count": 3
},
"relationships": {
"capacity_pool": {
"data": {
"type": "capacity_pools",
"id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa"
}
}
}
}
}
curl -i -X POST https://api.didww.com/v3/shared_capacity_groups -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"metered_channels_count": 5, "name": "Sample Capacity Group", "shared_channels_count": 3}, "relationships": {"capacity_pool": {"data": {"id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa", "type": "capacity_pools"}}}, "type": "shared_capacity_groups"}}'
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"data": {
"id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
"type": "shared_capacity_groups",
"attributes": {
"name": "Sample Capacity Group",
"shared_channels_count": 3,
"created_at": "2018-07-06T16:11:32.981Z",
"metered_channels_count": 5
},
"relationships": {
"capacity_pool": {
"links": {
"self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
"related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
}
},
"dids": {
"links": {
"self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
"related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
}
}
}
}
}
POST /v3/shared_capacity_groups?include=dids HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
{
"data": {
"type": "shared_capacity_groups",
"attributes": {
"name": "Sample Capacity Group",
"metered_channels_count": 5,
"shared_channels_count": 3
},
"relationships": {
"capacity_pool": {
"data": {
"type": "capacity_pools",
"id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa"
}
},
"dids": {
"data": [
{
"type": "dids",
"id": "091b6984-07f7-4eca-a42c-f1856248d646"
},
{
"type": "dids",
"id": "88b0e9a1-5d8e-4737-8f31-43f0b2aa2861"
}
]
}
}
}
}
curl -i -X POST 'https://api.didww.com/v3/shared_capacity_groups?include=dids' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json" --data-raw '{"data": {"attributes": {"metered_channels_count": 5, "name": "Sample Capacity Group", "shared_channels_count": 3}, "relationships": {"capacity_pool": {"data": {"id": "1e9e4362-bc5c-47f3-a2bb-c17afa66f3fa", "type": "capacity_pools"}}, "dids": {"data": [{"type": "dids", "id": "091b6984-07f7-4eca-a42c-f1856248d646"}, {"type": "dids", "id": "88b0e9a1-5d8e-4737-8f31-43f0b2aa2861"}]}}, "type": "shared_capacity_groups"}}'
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json
{
"data": {
"id": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
"type": "shared_capacity_groups",
"attributes": {
"name": "Sample Capacity Group",
"shared_channels_count": 3,
"created_at": "2018-07-06T16:11:32.981Z",
"metered_channels_count": 5
},
"relationships": {
"capacity_pool": {
"links": {
"self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
"related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
}
},
"dids": {
"links": {
"self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
"related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
}
}
}
}
}
Other Responses
Code |
Success |
Description |
---|---|---|
422 |
No |
|
401 |
No |