Get DID Reservations#
Description
Returns a list of DID Reservations.
Request#
HTTP Method: GET
URI Path: /v3/did_reservations
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
filter[<filter_name>] |
|
Optional |
|
include |
|
Optional |
|
sort |
|
Optional |
Includes:
Value |
Description |
|---|---|
available_did |
|
available_did.did_group |
|
available_did.did_group.stock_keeping_units |
Filters:
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
id |
|
No |
Yes |
DID Reservation |
Examples#
http
1GET /v3/did_reservations HTTP/1.1
2 Host: api.didww.com
3 Content-Type: application/vnd.api+json
4 Accept: application/vnd.api+json
5 Api-Key: [API token]
6
7
8 HTTP/1.1 200 OK
9 Content-Type: application/vnd.api+json
10
11 {
12 "data": [{
13 "id": "d35148e7-8858-446e-ae53-2f5ae17501ef",
14 "type": "did_reservations",
15 "attributes": {
16 "expire_at": "2018-03-15 12:34:56",
17 "created_at": "2018-03-15 12:14:56",
18 "description": "DIDWW"
19 },
20 "relationships": {
21 "available_did": {
22 "links": {
23 "self": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/available_did",
24 "related": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/available_did"
25 }
26 }
27 }
28 },
29 {
30 "id": "9e31a4a5-38ef-4e1e-8a83-f6ae10d61d51",
31 "type": "did_reservations",
32 "attributes": {
33 "expire_at": "2018-03-15 12:34:56",
34 "created_at": "2018-03-15 12:14:56",
35 "description": "DIDWW"
36 },
37 "relationships": {
38 "available_did": {
39 "links": {
40 "self": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/available_did",
41 "related": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/available_did"
42 }
43 }
44 }
45 }
46 ],
47 "meta": {
48 "total_records": 2,
49 "available_count": 9,
50 "api_version": "2017-09-18"
51 },
52 "links": {
53 "first": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50",
54 "last": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50"
55 }
56}
curl
1curl -i -X GET https://nohost/v3/did_reservations --data-raw 'HTTP/1.1 200 OK
2
3 Content-Type: application/vnd.api+json
4
5
6
7 {
8
9 "data": [{
10
11 "id": "d35148e7-8858-446e-ae53-2f5ae17501ef",
12
13 "type": "did_reservations",
14
15 "attributes": {
16
17 "expire_at": "2018-03-15 12:34:56",
18
19 "created_at": "2018-03-15 12:14:56",
20
21 "description": "DIDWW"
22
23 },
24
25 "relationships": {
26
27 "available_did": {
28
29 "links": {
30
31 "self": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/available_did",
32
33 "related": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/available_did"
34
35 }
36
37 }
38
39 }
40
41 },
42
43 {
44
45 "id": "9e31a4a5-38ef-4e1e-8a83-f6ae10d61d51",
46
47 "type": "did_reservations",
48
49 "attributes": {
50
51 "expire_at": "2018-03-15 12:34:56",
52
53 "created_at": "2018-03-15 12:14:56",
54
55 "description": "DIDWW"
56
57 },
58
59 "relationships": {
60
61 "available_did": {
62
63 "links": {
64
65 "self": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/available_did",
66
67 "related": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/available_did"
68
69 }
70
71 }
72
73 }
74
75 }
76
77 ],
78
79 "meta": {
80
81 "total_records": 2,
82
83 "available_count": 9,
84
85 "api_version": "2017-09-18"
86
87 },
88
89 "links": {
90
91 "first": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50",
92
93 "last": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50"
94
95 }
96
97}'
http
1GET /v3/did_reservations?include=available_did HTTP/1.1
2 Host: api.didww.com
3 Content-Type: application/vnd.api+json
4 Accept: application/vnd.api+json
5 Api-Key: [API token]
6
7
8 HTTP/1.1 200 OK
9 Content-Type: application/vnd.api+json
10
11 {
12 "data": [
13 {
14 "id": "d0163fe0-001f-4a03-87ea-84224822708e",
15 "type": "did_reservations",
16 "attributes": {
17 "expire_at": "2018-03-15 12:34:56",
18 "created_at": "2018-03-15 12:14:56",
19 "description": "DIDWW"
20 },
21 "relationships": {
22 "available_did": {
23 "links": {
24 "self": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did",
25 "related": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"
26 },
27 "data": {
28 "type": "available_dids",
29 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683"
30 }
31 }
32 }
33 },
34 {
35 "id": "952b0724-45bc-4f87-b31b-ff04579357ef",
36 "type": "did_reservations",
37 "attributes": {
38 "expire_at": "2018-03-15 12:34:56",
39 "created_at": "2018-03-15 12:14:56",
40 "description": "DIDWW"
41 },
42 "relationships": {
43 "available_did": {
44 "links": {
45 "self": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did",
46 "related": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"
47 },
48 "data": {
49 "type": "available_dids",
50 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683"
51 }
52 }
53 }
54 }
55 ],
56 "included": [
57 {
58 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683",
59 "type": "available_dids",
60 "attributes": {
61 "number": "77124562356"
62 }
63 }
64 ],
65 "meta": {
66 "total_records": 2,
67 "available_count": 8,
68 "api_version": "2017-09-18"
69 },
70 "links": {
71 "first": "https://api.didww.com/v3/did_reservations?include=available_did&page%5Bnumber%5D=1&page%5Bsize%5D=50",
72 "last": "https://api.didww.com/v3/did_reservations?include=available_did&page%5Bnumber%5D=1&page%5Bsize%5D=50"
73 }
74}
curl
1curl -i -X GET 'https://nohost/v3/did_reservations?include=available_did' --data-raw 'HTTP/1.1 200 OK
2
3 Content-Type: application/vnd.api+json
4
5
6
7 {
8
9 "data": [
10
11 {
12
13 "id": "d0163fe0-001f-4a03-87ea-84224822708e",
14
15 "type": "did_reservations",
16
17 "attributes": {
18
19 "expire_at": "2018-03-15 12:34:56",
20
21 "created_at": "2018-03-15 12:14:56",
22
23 "description": "DIDWW"
24
25 },
26
27 "relationships": {
28
29 "available_did": {
30
31 "links": {
32
33 "self": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did",
34
35 "related": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"
36
37 },
38
39 "data": {
40
41 "type": "available_dids",
42
43 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683"
44
45 }
46
47 }
48
49 }
50
51 },
52
53 {
54
55 "id": "952b0724-45bc-4f87-b31b-ff04579357ef",
56
57 "type": "did_reservations",
58
59 "attributes": {
60
61 "expire_at": "2018-03-15 12:34:56",
62
63 "created_at": "2018-03-15 12:14:56",
64
65 "description": "DIDWW"
66
67 },
68
69 "relationships": {
70
71 "available_did": {
72
73 "links": {
74
75 "self": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did",
76
77 "related": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"
78
79 },
80
81 "data": {
82
83 "type": "available_dids",
84
85 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683"
86
87 }
88
89 }
90
91 }
92
93 }
94
95 ],
96
97 "included": [
98
99 {
100
101 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683",
102
103 "type": "available_dids",
104
105 "attributes": {
106
107 "number": "77124562356"
108
109 }
110
111 }
112
113 ],
114
115 "meta": {
116
117 "total_records": 2,
118
119 "available_count": 8,
120
121 "api_version": "2017-09-18"
122
123 },
124
125 "links": {
126
127 "first": "https://api.didww.com/v3/did_reservations?include=available_did&page%5Bnumber%5D=1&page%5Bsize%5D=50",
128
129 "last": "https://api.didww.com/v3/did_reservations?include=available_did&page%5Bnumber%5D=1&page%5Bsize%5D=50"
130
131 }
132
133}'
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |