Get Capacity Pools
Description
Returns a list of Capacity Pools.
Request
HTTP Method: GET
URI Path: /v3/capacity_pools
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
---|---|---|---|
filter[<filter_name>] |
|
No |
|
include |
|
No |
|
sort |
|
No |
Includes:
Value |
Description |
---|---|
countries |
|
shared_capacity_groups |
|
qty_based_pricings |
Filters:
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
---|---|---|---|---|
id |
|
No |
Yes |
Capacity Pool |
Sorting:
Value |
Sorts by |
---|---|
name |
The |
renew_date |
The |
total_channels_count |
The |
assigned_channels_count |
The |
minimum_limit |
The |
minimum_qty_per_order |
The |
setup_price |
The |
monthly_price |
The |
metered_rate |
The |
Fielding:
Value |
Returns |
---|---|
name |
The |
renew_date |
The |
total_channels_count |
The |
assigned_channels_count |
The |
minimum_limit |
The |
minimum_qty_per_order |
The |
setup_price |
The |
monthly_price |
The |
metered_rate |
The |
Examples
GET /v3/capacity_pools HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -i -X GET https://api.didww.com/v3/capacity_pools -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"id": "ca1315c5-1915-4fc7-9441-de78e1f38ef9",
"type": "capacity_pools",
"attributes": {
"name": "Extended",
"renew_date": "2018-07-21",
"total_channels_count": 136,
"assigned_channels_count": 136,
"minimum_limit": 0,
"minimum_qty_per_order": 1,
"setup_price": "25.0",
"monthly_price": "25.0",
"metered_rate": "0.02"
},
"relationships": {
"countries": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/countries",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/countries"
}
},
"shared_capacity_groups": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/shared_capacity_groups",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/shared_capacity_groups"
}
},
"qty_based_pricings": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/qty_based_pricings",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/qty_based_pricings"
}
}
}
},
{
"id": "daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d",
"type": "capacity_pools",
"attributes": {
"name": "Standard",
"renew_date": "2018-07-21",
"total_channels_count": 2,
"assigned_channels_count": 2,
"minimum_limit": 0,
"minimum_qty_per_order": 1,
"setup_price": "15.0",
"monthly_price": "15.0",
"metered_rate": "0.01"
},
"relationships": {
"countries": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/countries",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/countries"
}
},
"shared_capacity_groups": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/shared_capacity_groups",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/shared_capacity_groups"
}
},
"qty_based_pricings": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/qty_based_pricings",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/qty_based_pricings"
}
}
}
}
],
"meta": {
"total_records": 2
},
"links": {
"first": "https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"last": "https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1&page%5Bsize%5D=50"
}
}
GET /v3/capacity_pools?include=countries HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -i -X GET 'https://api.didww.com/v3/capacity_pools?include=countries' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"id": "ca1315c5-1915-4fc7-9441-de78e1f38ef9",
"type": "capacity_pools",
"attributes": {
"name": "Extended",
"renew_date": "2018-07-21",
"total_channels_count": 136,
"assigned_channels_count": 136,
"minimum_limit": 0,
"minimum_qty_per_order": 1,
"setup_price": "25.0",
"monthly_price": "25.0",
"metered_rate": "0.02"
},
"relationships": {
"countries": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/countries",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/countries"
},
"data": [
{
"type": "countries",
"id": "7eda11bb-0e66-4146-98e7-57a5281f56c8"
}
]
},
"shared_capacity_groups": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/shared_capacity_groups",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/shared_capacity_groups"
}
},
"qty_based_pricings": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/qty_based_pricings",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/qty_based_pricings"
}
}
}
},
{
"id": "daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d",
"type": "capacity_pools",
"attributes": {
"name": "Standard",
"renew_date": "2018-07-21",
"total_channels_count": 2,
"assigned_channels_count": 2,
"minimum_limit": 0,
"minimum_qty_per_order": 1,
"setup_price": "15.0",
"monthly_price": "15.0",
"metered_rate": "0.01"
},
"relationships": {
"countries": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/countries",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/countries"
},
"data": [
{
"type": "countries",
"id": "1f6fc2bd-f081-4202-9b1a-d9cb88d942b9"
}
]
},
"shared_capacity_groups": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/shared_capacity_groups",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/shared_capacity_groups"
}
},
"qty_based_pricings": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/qty_based_pricings",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/qty_based_pricings"
}
}
}
}
],
"included": [
{
"id": "7eda11bb-0e66-4146-98e7-57a5281f56c8",
"type": "countries",
"attributes": {
"name": "United Kingdom",
"prefix": "44",
"iso": "GB"
}
},
{
"id": "1f6fc2bd-f081-4202-9b1a-d9cb88d942b9",
"type": "countries",
"attributes": {
"name": "United States",
"prefix": "1",
"iso": "US"
}
}
],
"meta": {
"total_records": 2
},
"links": {
"first": "https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"last": "https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1&page%5Bsize%5D=50"
}
}
GET /v3/capacity_pools?include=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]
curl -i -X GET 'https://api.didww.com/v3/capacity_pools?include=shared_capacity_groups' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": [
{
"id": "ca1315c5-1915-4fc7-9441-de78e1f38ef9",
"type": "capacity_pools",
"attributes": {
"name": "Extended",
"renew_date": "2018-07-21",
"total_channels_count": 136,
"assigned_channels_count": 136,
"minimum_limit": 0,
"minimum_qty_per_order": 1,
"setup_price": "25.0",
"monthly_price": "25.0",
"metered_rate": "0.02"
},
"relationships": {
"countries": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/countries",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/countries"
}
},
"shared_capacity_groups": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/shared_capacity_groups",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/shared_capacity_groups"
},
"data": [
{
"type": "shared_capacity_groups",
"id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc"
}
]
},
"qty_based_pricings": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/relationships/qty_based_pricings",
"related": "https://api.didww.com/v3/capacity_pools/ca1315c5-1915-4fc7-9441-de78e1f38ef9/qty_based_pricings"
}
}
}
},
{
"id": "daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d",
"type": "capacity_pools",
"attributes": {
"name": "Standard",
"renew_date": "2018-07-21",
"total_channels_count": 2,
"assigned_channels_count": 2,
"minimum_limit": 0,
"minimum_qty_per_order": 1,
"setup_price": "15.0",
"monthly_price": "15.0",
"metered_rate": "0.01"
},
"relationships": {
"countries": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/countries",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/countries"
}
},
"shared_capacity_groups": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/shared_capacity_groups",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/shared_capacity_groups"
}
},
"qty_based_pricings": {
"links": {
"self": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/relationships/qty_based_pricings",
"related": "https://api.didww.com/v3/capacity_pools/daae37a3-c4fc-40a7-b5e6-6ec9d08ed74d/qty_based_pricings"
}
}
}
}
],
"included": [
{
"id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
"type": "shared_capacity_groups",
"attributes": {
"name": "Sample group",
"shared_channels_count": 0,
"created_at": "2018-06-19T11:41:21.644Z",
"metered_channels_count": 30
},
"relationships": {
"capacity_pool": {
"links": {
"self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
"related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
}
},
"dids": {
"links": {
"self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
"related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
}
}
}
}
],
"meta": {
"total_records": 2
},
"links": {
"first": "https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1&page%5Bsize%5D=50",
"last": "https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1&page%5Bsize%5D=50"
}
}
Other Responses
Code |
Success |
Description |
---|---|---|
404 |
No |
|
401 |
No |