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	No	Filtering
include	string	No	Inclusion
sort	string	No	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.

Fielding:

Value	Returns:
name	The name attribute.
shared_channels_count	The shared_channels_count attribute.
metered_channels_count	The metered_channels_count attribute.
created_at	The created_at attribute.

Examples

Simple RequestInclude DIDsInclude Capacity Pool

http

GET /v3/shared_capacity_groups HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "8a581244-de83-4c46-ac0a-32659279169e",
      "type": "shared_capacity_groups",
      "attributes": {
        "name": "Mixed group",
        "shared_channels_count": 3,
        "created_at": "2018-06-20T08:48:47.811Z",
        "metered_channels_count": 5
      },
      "relationships": {
        "capacity_pool": {
          "links": {
            "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/capacity_pool",
            "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/capacity_pool"
          }
        },
        "dids": {
          "links": {
            "self": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/relationships/dids",
            "related": "https://api.didww.com/v3/shared_capacity_groups/8a581244-de83-4c46-ac0a-32659279169e/dids"
          }
        }
      }
    },
    {
      "id": "dd2e8844-6a79-4673-ba1c-c8a4913884cc",
      "type": "shared_capacity_groups",
      "attributes": {
        "name": "Metered group",
        "shared_channels_count": 0,
        "created_at": "2018-06-19T11:41:21.644Z",
        "metered_channels_count": 30
      },
      "relationships": {
        "capacity_pool": {
          "links": {
            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/capacity_pool",
            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/capacity_pool"
          }
        },
        "dids": {
          "links": {
            "self": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/relationships/dids",
            "related": "https://api.didww.com/v3/shared_capacity_groups/dd2e8844-6a79-4673-ba1c-c8a4913884cc/dids"
          }
        }
      }
    }
  ],
  "meta": {
    "total_records": 2
  },
  "links": {
    "first": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "https://api.didww.com/v3/shared_capacity_groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized