Get Shared Capacity Groups#
Description
Returns a collection of Shared Capacity Groups.
Request#
HTTP Method: GET
URI Path: /v3/shared_capacity_groups
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
filter[<filter_name>] |
|
Optional |
|
include |
|
Optional |
|
sort |
|
Optional |
Includes:
Value |
Description |
|---|---|
dids |
|
capacity_pool |
Filters:
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
name |
|
Yes |
Yes |
Shared Capacity Group |
capacity_pool.id |
|
Yes |
Yes |
The |
Examples#
http
1GET /v3/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/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": "8a581244-de83-4c46-ac0a-32659279169e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Mixed group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-20T08:48:47.811Z",
12 "metered_channels_count": 5
13 },
14 "relationships": {
15 "capacity_pool": {
16 "links": {
17 "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/capacity_pool",
18 "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/capacity_pool"
19 }
20 },
21 "dids": {
22 "links": {
23 "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/dids",
24 "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/dids"
25 }
26 }
27 }
28 },
29 {
30 "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
31 "type": "shared_capacity_groups",
32 "attributes": {
33 "name": "Metered group",
34 "shared_channels_count": 0,
35 "created_at": "2018-06-19T11:41:21.644Z",
36 "metered_channels_count": 30
37 },
38 "relationships": {
39 "capacity_pool": {
40 "links": {
41 "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
42 "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
43 }
44 },
45 "dids": {
46 "links": {
47 "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
48 "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
49 }
50 }
51 }
52 }
53 ],
54 "meta": {
55 "total_records": 2,
56 "api_version": "2017-09-18"
57 },
58 "links": {
59 "first": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
60 "last": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
61 }
62}
http
1GET /v3/shared_capacity_groups?include=dids 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/shared_capacity_groups?include=dids' -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": "8a581244-de83-4c46-ac0a-32659279169e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Mixed group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-20T08:48:47.811Z",
12 "metered_channels_count": 5
13 },
14 "relationships": {
15 "capacity_pool": {
16 "links": {
17 "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/capacity_pool",
18 "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/capacity_pool"
19 }
20 },
21 "dids": {
22 "links": {
23 "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/dids",
24 "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/dids"
25 },
26 "data": [{
27 "type": "dids",
28 "id": "44957076-778a-4802-b60c-d22db0cda284"
29 }]
30 }
31 }
32 },
33 {
34 "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
35 "type": "shared_capacity_groups",
36 "attributes": {
37 "name": "Metered group",
38 "shared_channels_count": 0,
39 "created_at": "2018-06-19T11:41:21.644Z",
40 "metered_channels_count": 30
41 },
42 "relationships": {
43 "capacity_pool": {
44 "links": {
45 "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
46 "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
47 }
48 },
49 "dids": {
50 "links": {
51 "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
52 "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
53 }
54 }
55 }
56 }
57 ],
58 "included": [{
59 "id": "44957076-778a-4802-b60c-d22db0cda284",
60 "type": "dids",
61 "attributes": {
62 "blocked": false,
63 "capacity_limit": 1,
64 "description": "string",
65 "terminated": false,
66 "awaiting_registration": false,
67 "number": "437xxxxxxxxx",
68 "expires_at": "2017-06-25T08:21:41.795Z",
69 "channels_included_count": 2,
70 "created_at": "2017-06-25T08:21:41.795Z",
71 "pending_removal": false,
72 "dedicated_channels_count": 0
73 },
74 "relationships": {
75 "did_group": {
76 "links": {
77 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
78 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
79 }
80 },
81 "order": {
82 "links": {
83 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
84 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
85 }
86 },
87 "trunk": {
88 "links": {
89 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/trunk",
90 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/trunk"
91 }
92 },
93 "trunk_group": {
94 "links": {
95 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/trunk_group",
96 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/trunk_group"
97 }
98 },
99 "capacity_pool": {
100 "links": {
101 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
102 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
103 }
104 },
105 "shared_capacity_group": {
106 "links": {
107 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
108 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
109 }
110 }
111 }
112 }],
113 "meta": {
114 "total_records": 2,
115 "api_version": "2017-09-18"
116 },
117 "links": {
118 "first": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
119 "last": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
120 }
121}
http
1GET /v3/shared_capacity_groups?include=capacity_pool 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/shared_capacity_groups?include=capacity_pool' -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": "8a581244-de83-4c46-ac0a-32659279169e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Mixed group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-20T08:48:47.811Z",
12 "metered_channels_count": 5
13 },
14 "relationships": {
15 "capacity_pool": {
16 "links": {
17 "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/capacity_pool",
18 "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/capacity_pool"
19 },
20 "data": {
21 "type": "capacity_pools",
22 "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f"
23 }
24 },
25 "dids": {
26 "links": {
27 "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/dids",
28 "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/dids"
29 }
30 }
31 }
32 },
33 {
34 "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
35 "type": "shared_capacity_groups",
36 "attributes": {
37 "name": "Metered group",
38 "shared_channels_count": 0,
39 "created_at": "2018-06-19T11:41:21.644Z",
40 "metered_channels_count": 30
41 },
42 "relationships": {
43 "capacity_pool": {
44 "links": {
45 "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
46 "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
47 }
48 },
49 "dids": {
50 "links": {
51 "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
52 "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
53 }
54 }
55 }
56 }
57 ],
58 "included": [{
59 "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
60 "type": "capacity_pools",
61 "attributes": {
62 "name": "Extended",
63 "renew_date": "2018-07-21",
64 "total_channels_count": 10,
65 "unassigned_channels_count": 4,
66 "assigned_channels_count": 6,
67 "minimum_limit": 5,
68 "minimum_qty_per_order": 1,
69 "nrc": "0.0",
70 "mrc": "25.0",
71 "metered_rate": "0.02"
72 },
73 "relationships": {
74 "countries": {
75 "links": {
76 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
77 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
78 }
79 },
80 "shared_capacity_groups": {
81 "links": {
82 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
83 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
84 }
85 },
86 "qty_based_pricings": {
87 "links": {
88 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
89 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
90 }
91 }
92 }
93 }],
94 "meta": {
95 "total_records": 2,
96 "api_version": "2017-09-18"
97 },
98 "links": {
99 "first": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
100 "last": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
101 }
102}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |