Get DID Group Types#

Returns a list of DID Group Types. A DID Group Type defines a broad category of DID services supported by DIDWW (for example, mobile, local and toll-free).

Request#

HTTP Method: GET

URI Path: /v3/did_group_types

Note

For all returned data attributes, see Did Group Type Object.

URI Query Parameters#

Name

Type

Is Required?

Description

filter[<filter_name>]

string

No

Filtering

fields[did_group_types]

string

No

Sparse fieldsets

sort

string

No

Sorting

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

Group Type id field.

name

string

Yes

Yes

Group Type name field.

Sorting#

Value

Sorts by:

name

DID Group Type name field.

Example#

http

1GET /v3/did_group_types 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/did_group_types -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    {
 7        "id": "5827aaef-b3e7-4282-ab9f-e9c17a3e9b93",
 8        "type": "did_group_types",
 9        "attributes": {
10            "name": "Local"
11           }
12     },
13     {
14         "id": "842b298a-9243-4989-a455-4bceac0c7e0e",
15         "type": "did_group_types",
16         "attributes": {
17             "name": "National"
18         }
19     },
20     {
21         "id": "96462614-64cf-4898-a434-4e03f8d7f6ab",
22         "type": "did_group_types",
23         "attributes": {
24             "name": "Toll-free"
25         }
26     },
27     {
28         "id": "bf31407e-d583-4a1b-b8ee-a5f0d77d865a",
29         "type": "did_group_types",
30         "attributes": {
31             "name": "Mobile"
32         }
33     },
34     {
35         "id": "5ad07e30-11f3-4ff9-ba87-fd06575c8f06",
36         "type": "did_group_types",
37         "attributes": {
38             "name": "Shared Cost"
39         }
40     },
41     {
42         "id": "e961316f-7f16-4d29-b619-2fd7c421c738",
43         "type": "did_group_types",
44         "attributes": {
45             "name": "Global"
46         }
47     }
48     ],
49     "meta": {
50         "total_records": 6
51         },
52         "links": {
53             "first": "https://api.didww.comv3/did_group_types?page%5Bnumber%5D=1&page%5Bsize%5D=50",
54             "last": "https://api.didww.com/v3/did_group_types?page%5Bnumber%5D=1&page%5Bsize%5D=50"
55         }
56}

Other Responses#

Code

Success

Description

401

No

Unauthorized