Get DID Group Types#

Description

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

URI Query Parameters:

Name

Type

Is Required?

Description

filter[<filter_name>]

string

Optional

Filtering

sort

string

Optional

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             "id": "5827aaef-b3e7-4282-ab9f-e9c17a3e9b93",
 7             "type": "did_group_types",
 8             "attributes": {
 9                 "name": "Local"
10             }
11         },
12         {
13             "id": "842b298a-9243-4989-a455-4bceac0c7e0e",
14             "type": "did_group_types",
15             "attributes": {
16                 "name": "National"
17             }
18         },
19         {
20             "id": "96462614-64cf-4898-a434-4e03f8d7f6ab",
21             "type": "did_group_types",
22             "attributes": {
23                 "name": "Toll-free"
24             }
25         },
26         {
27             "id": "bf31407e-d583-4a1b-b8ee-a5f0d77d865a",
28             "type": "did_group_types",
29             "attributes": {
30                 "name": "Mobile"
31             }
32         },
33         {
34             "id": "5ad07e30-11f3-4ff9-ba87-fd06575c8f06",
35             "type": "did_group_types",
36             "attributes": {
37                 "name": "Shared Cost"
38             }
39         },
40         {
41             "id": "e961316f-7f16-4d29-b619-2fd7c421c738",
42             "type": "did_group_types",
43             "attributes": {
44                 "name": "Global"
45             }
46         }
47     ],
48     "meta": {
49         "total_records": 6,
50         "api_version": "2017-09-18"
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

404

No

Not Found

401

No

Unauthorized