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

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 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"
        }
      }
    }
  },
  "meta": {
    "api_version": "2017-09-18"
  }
}

http

GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?include=dids 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 '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

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"
        },
        "data": [{
          "type": "dids",
          "id": "44957076-778a-4802-b60c-d22db0cda284"
        }]
      }
    },
    "included": [{
      "id": "44957076-778a-4802-b60c-d22db0cda284",
      "type": "dids",
      "attributes": {
        "blocked": false,
        "capacity_limit": 1,
        "description": "string",
        "terminated": false,
        "awaiting_registration": false,
        "number": "437xxxxxxxxx",
        "expires_at": "2017-06-25T08:21:41.795Z",
        "channels_included_count": 2,
        "created_at": "2017-06-25T08:21:41.795Z",
        "pending_removal": false,
        "dedicated_channels_count": 0
      },
      "relationships": {
        "did_group": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/did_group",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/did_group"
          }
        },
        "order": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/order",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/order"
          }
        },
        "trunk": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/trunk",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/trunk"
          }
        },
        "trunk_group": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/trunk_group",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/trunk_group"
          }
        },
        "capacity_pool": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/capacity_pool",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/capacity_pool"
          }
        },
        "shared_capacity_group": {
          "links": {
            "self": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/relationships/shared_capacity_group",
            "related": "https://api.didww.com/v3/dids/44957076-778a-4802-b60c-d22db0cda284/shared_capacity_group"
          }
        }
      }
    }]
  },
  "meta": {
    "api_version": "2017-09-18"
  }
}

http

GET /v3/shared_capacity_groups/71afa2e2-8d46-4ea3-988d-aa112ed98b5e?include=capacity_pool 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 '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

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"
        },
        "data": {
          "type": "capacity_pools",
          "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f"
        }
      },
      "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"
        }
      }
    },
    "included": [{
      "id": "b8db1d7c-f415-4530-a340-c774bcc1c55f",
      "type": "capacity_pools",
      "attributes": {
        "name": "Extended",
        "renew_date": "2018-07-21",
        "total_channels_count": 10,
        "unassigned_channels_count": 4,
        "assigned_channels_count": 6,
        "minimum_limit": 5,
        "minimum_qty_per_order": 1,
        "nrc": "0.0",
        "mrc": "25.0",
        "metered_rate": "0.02"
      },
      "relationships": {
        "countries": {
          "links": {
            "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/countries",
            "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/countries"
          }
        },
        "shared_capacity_groups": {
          "links": {
            "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/shared_capacity_groups",
            "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/shared_capacity_groups"
          }
        },
        "qty_based_pricings": {
          "links": {
            "self": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/relationships/qty_based_pricings",
            "related": "https://api.didww.com/v3/capacity_pools/b8db1d7c-f415-4530-a340-c774bcc1c55f/qty_based_pricings"
          }
        }
      }
    }]
  },
  "meta": {
    "api_version": "2017-09-18"
  }
}

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized