Get Shared Capacity Group#
Description
Returns a single Channels Group.
Request#
HTTP Method: GET
URI Path: /v3/shared_capacity_groups/
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID number allocated to this Shared Capacity Group. |
Includes:
Value |
Description |
|---|---|
dids |
|
capacity_pool |
Examples#
http
1GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e 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/71afa2e2-8d46-4ea3-988d-aa112ed98b5e -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": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Sample group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-19T11:41:21.644Z",
12 "metered_channels_count": 5
13 },
14 "relationships": {
15 "capacity_pool": {
16 "links": {
17 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
18 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
19 }
20 },
21 "dids": {
22 "links": {
23 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
24 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
25 }
26 }
27 }
28 },
29 "meta": {
30 "api_version": "2017-09-18"
31 }
32}
http
1GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?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/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?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": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Sample group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-19T11:41:21.644Z",
12 "metered_channels_count": 5
13 },
14 "relationships": {
15 "capacity_pool": {
16 "links": {
17 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
18 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
19 }
20 },
21 "dids": {
22 "links": {
23 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
24 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
25 },
26 "data": [{
27 "type": "dids",
28 "id": "44957076-778a-4802-b60c-d22db0cda284"
29 }]
30 }
31 },
32 "included": [{
33 "id": "44957076-778a-4802-b60c-d22db0cda284",
34 "type": "dids",
35 "attributes": {
36 "blocked": false,
37 "capacity_limit": 1,
38 "description": "string",
39 "terminated": false,
40 "awaiting_registration": false,
41 "number": "437xxxxxxxxx",
42 "expires_at": "2017-06-25T08:21:41.795Z",
43 "channels_included_count": 2,
44 "created_at": "2017-06-25T08:21:41.795Z",
45 "pending_removal": false,
46 "dedicated_channels_count": 0
47 },
48 "relationships": {
49 "did_group": {
50 "links": {
51 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
52 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
53 }
54 },
55 "order": {
56 "links": {
57 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
58 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
59 }
60 },
61 "trunk": {
62 "links": {
63 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/trunk",
64 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/trunk"
65 }
66 },
67 "trunk_group": {
68 "links": {
69 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/trunk_group",
70 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/trunk_group"
71 }
72 },
73 "capacity_pool": {
74 "links": {
75 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
76 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
77 }
78 },
79 "shared_capacity_group": {
80 "links": {
81 "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
82 "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
83 }
84 }
85 }
86 }]
87 },
88 "meta": {
89 "api_version": "2017-09-18"
90 }
91}
http
1GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?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/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?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": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
7 "type": "shared_capacity_groups",
8 "attributes": {
9 "name": "Sample group",
10 "shared_channels_count": 3,
11 "created_at": "2018-06-19T11:41:21.644Z",
12 "metered_channels_count": 5
13 },
14 "relationships": {
15 "capacity_pool": {
16 "links": {
17 "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
18 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/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/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
28 "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
29 }
30 }
31 },
32 "included": [{
33 "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
34 "type": "capacity_pools",
35 "attributes": {
36 "name": "Extended",
37 "renew_date": "2018-07-21",
38 "total_channels_count": 10,
39 "unassigned_channels_count": 4,
40 "assigned_channels_count": 6,
41 "minimum_limit": 5,
42 "minimum_qty_per_order": 1,
43 "nrc": "0.0",
44 "mrc": "25.0",
45 "metered_rate": "0.02"
46 },
47 "relationships": {
48 "countries": {
49 "links": {
50 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
51 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
52 }
53 },
54 "shared_capacity_groups": {
55 "links": {
56 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
57 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
58 }
59 },
60 "qty_based_pricings": {
61 "links": {
62 "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
63 "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
64 }
65 }
66 }
67 }]
68 },
69 "meta": {
70 "api_version": "2017-09-18"
71 }
72}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |