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	string	Yes	Unique ID number allocated to this Shared Capacity Group.

Includes:

Value	Description
dids	A list of Shared Capacity Group objects
capacity_pool	Capacity Pool Object

Examples

Simple RequestInclude DIDsInclude Capacity Pool

http

GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e 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/71afa2e2-8d46-4ea3-988d-aa112ed98b5e -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": "71afa2e2-8d46-4ea3-988d-aa112ed98b5e",
    "type": "shared_capacity_groups",
    "attributes": {
      "name": "Sample group",
      "shared_channels_count": 3,
      "created_at": "2018-06-19T11:41:21.644Z",
      "metered_channels_count": 5
    },
    "relationships": {
      "capacity_pool": {
        "links": {
          "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/capacity_pool",
          "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/capacity_pool"
        }
      },
      "dids": {
        "links": {
          "self": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/relationships/dids",
          "related": "https://api.didww.com/v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e/dids"
        }
      }
    }
  }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized