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 |
|
Yes |
Unique ID number allocated to this Capacity Pool. |
include |
|
Optional |
Includes:
Value |
Description |
|---|---|
countries |
|
shared_capacity_groups |
|
qty_based_pricings |
Examples#
http
1GET /v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -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
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
7 "type": "capacity_pools",
8 "attributes": {
9 "name": "Extended",
10 "renew_date": "2018-07-21",
11 "total_channels_count": 10,
12 "assigned_channels_count": 6,
13 "minimum_limit": 5,
14 "minimum_qty_per_order": 1,
15 "setup_price": "25.0",
16 "monthly_price": "25.0",
17 "metered_rate": "0.02"
18 },
19 "relationships": {
20 "countries": {
21 "links": {
22 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
23 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
24 }
25 },
26 "shared_capacity_groups": {
27 "links": {
28 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
29 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
30 }
31 },
32 "qty_based_pricings": {
33 "links": {
34 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
35 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
36 }
37 }
38 }
39 }
40}
http
1GET /v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f?include=countries HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -i -X GET 'https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f?include=countries' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
7 "type": "capacity_pools",
8 "attributes": {
9 "name": "Extended",
10 "renew_date": "2018-07-21",
11 "total_channels_count": 10,
12 "assigned_channels_count": 6,
13 "minimum_limit": 5,
14 "minimum_qty_per_order": 1,
15 "setup_price": "25.0",
16 "monthly_price": "25.0",
17 "metered_rate": "0.02"
18 },
19 "relationships": {
20 "countries": {
21 "links": {
22 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
23 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
24 },
25 "data": [
26 {
27 "type": "countries",
28 "id": "7eda11bb-0e66-4146-98e7-57a5281f56c8"
29 },
30 {
31 "type": "countries",
32 "id": "1f6fc2bd-f081-4202-9b1a-d9cb88d942b9"
33 }
34 ]
35 },
36 "shared_capacity_groups": {
37 "links": {
38 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
39 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
40 }
41 },
42 "qty_based_pricings": {
43 "links": {
44 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
45 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
46 }
47 }
48 }
49 },
50 "included": [
51 {
52 "id": "7eda11bb-0e66-4146-98e7-57a5281f56c8",
53 "type": "countries",
54 "attributes": {
55 "name": "United Kingdom",
56 "prefix": "44",
57 "iso": "GB"
58 }
59 },
60 {
61 "id": "1f6fc2bd-f081-4202-9b1a-d9cb88d942b9",
62 "type": "countries",
63 "attributes": {
64 "name": "United States",
65 "prefix": "1",
66 "iso": "US"
67 }
68 }
69 ]
70}
http
1GET /v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f?include=shared_capacity_groups HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -i -X GET 'https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f?include=shared_capacity_groups' -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4{
5 "data": {
6 "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
7 "type": "capacity_pools",
8 "attributes": {
9 "name": "Extended",
10 "renew_date": "2018-07-21",
11 "total_channels_count": 10,
12 "assigned_channels_count": 6,
13 "minimum_limit": 5,
14 "minimum_qty_per_order": 1,
15 "setup_price": "25.0",
16 "monthly_price": "25.0",
17 "metered_rate": "0.02"
18 },
19 "relationships": {
20 "countries": {
21 "links": {
22 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
23 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
24 }
25 },
26 "shared_capacity_groups": {
27 "links": {
28 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
29 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
30 },
31 "data": [
32 {
33 "type": "shared_capacity_groups",
34 "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc"
35 }
36 ]
37 },
38 "qty_based_pricings": {
39 "links": {
40 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
41 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
42 }
43 }
44 }
45 },
46 "included": [
47 {
48 "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
49 "type": "shared_capacity_groups",
50 "attributes": {
51 "name": "Sample group",
52 "shared_channels_count": 0,
53 "created_at": "2018-06-19T11:41:21.644Z",
54 "metered_channels_count": 30
55 },
56 "relationships": {
57 "capacity_pool": {
58 "links": {
59 "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
60 "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
61 }
62 },
63 "dids": {
64 "links": {
65 "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
66 "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
67 }
68 }
69 }
70 }
71 ]
72}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |