Get Capacity Pool

Description

Returns a single Capacity Pool.

Request

HTTP Method: GET

URI Path: /v3/capacity_pools/

URI Query Parameters:

Name	Type	Is Required?	Description
id	string	Yes	Unique ID number allocated to this Capacity Pool.
include	string	No	Inclusion.

Includes:

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

Examples

Simple RequestInclude CountriesInclude Shared Capacity Groups

http

GET /v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f 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/b8db1d7c-f415-4530-a340-c774bcc1c55f -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": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
    "type": "capacity_pools",
    "attributes": {
      "name": "Extended",
      "renew_date": "2018-07-21",
      "total_channels_count": 10,
      "assigned_channels_count": 6,
      "minimum_limit": 5,
      "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/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
          "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
        }
      },
      "shared_capacity_groups": {
        "links": {
          "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
          "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
        }
      },
      "qty_based_pricings": {
        "links": {
          "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
          "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
        }
      }
    }
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized