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