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>]

string

Optional

Filtering

include

string

Optional

Inclusion

sort

string

Optional

Sorting

Includes:

Value

Description

dids

A list of Shared Capacity Group objects

capacity_pool

Capacity Pool Object

Filters:

Filter Name

Type

Allow Blank

Allow Array

Filters by:

name

string

Yes

Yes

Shared Capacity Group name field.

capacity_pool.id

string

Yes

Yes

The capacity_pool.id field.

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}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized