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>]	string	Optional	Filtering
include	string	Optional	Inclusion
sort	string	Optional	Sorting

Includes:

Value	Description
countries	Country Object
shared_capacity_groups	Shared Capacity Group Object
qty_based_pricings	Quantity Based Price Object

Filters:

Filter Name	Type	Allow Blank	Allow Array	Filters by:
id	string	No	Yes	Capacity Pool id field.

Sorting:

Value	Sorts by:
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.

Sparse Fieldsets:

Value	Returns:
name	The name attribute.
renew_date	The renew_date attribute.
total_channels_count	The total_channels_count attribute.
assigned_channels_count	The assigned_channels_count attribute.
minimum_limit	The minimum_limit attribute.
minimum_qty_per_order	The minimum_qty_per_order attribute.
setup_price	The setup_price attribute.
monthly_price	The monthly_price attribute.
metered_rate	The metered_rate attribute.

Examples

Simple RequestInclude CountriesInclude Shared Capacity Groups

http

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

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"

response

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"
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized