Get Capacity Pools
GET https://{{host}}/v3/capacity_pools
Returns a list of Capacity Pools.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
| Details in Inclusion of Related Resources Article. |
Allowed values:
countries - Country Object
shared_capacity_groups - Shared Capacity Group Object
qty_based_pricings - Quantity Based Price Object
*** |
| filter[id] | null | | string - Filters by Capacity Pool id field.
- Allow blank - No.
- Allow array - Yes. |
|
sort| null | | Used for sorting the fields returned by the request, with a comma,separating the included fields. Details in Sorting Article.
name - The name field.
renew_date - The renew_date field.
total_channels_count_ - The total_channels_count field.
assigned_channels_count - The assigned_channels_count field.
minimum_limit - The minimum_limit field.
minimum_qty_per_order - The minimum_qty_per_order field.
setup_price - The setup_price field.
monthly_price - The monthly_price field.
metered_rate - The metered_rate field.
*** |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"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,"api_version":"2021-04-19"},"links":{"first":"https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/capacity_pools?page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}