Get DID Reservation#
Description
Returns a single DID Reservation.
Request#
HTTP Method: GET
URI Path: /v3/did_reservations/
URI Query Parameters:
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID number of the DID Reservation. |
include |
|
Optional |
Includes:
Value |
Description |
|---|---|
available_did |
|
available_did.did_group |
|
available_did.did_group.stock_keeping_units |
Examples#
http
1GET /v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd 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_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd -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": "dd13cdb2-48ab-4374-94b3-56e162a659cd",
7 "type": "did_reservations",
8 "links": {
9 "self": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd"
10 },
11 "attributes": {
12 "expire_at": "2018-03-15 12:34:56",
13 "created_at": "2018-03-15 12:14:56",
14 "description": "DIDWW"
15 },
16 "relationships": {
17 "available_did": {
18 "links": {
19 "self": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/available_did",
20 "related": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/available_did"
21 }
22 }
23 }
24 }
25 }
http
1GET /v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d?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]
curl
1curl -i -X GET 'https://nohost/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d?include=available_did'
response
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4 {
5 "data": {
6 "id": "80167e78-62a1-4720-bf00-229fa7e1935d",
7 "type": "did_reservations",
8 "links": {
9 "self": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d"
10 },
11 "attributes": {
12 "expire_at": "2018-03-15 12:34:56",
13 "created_at": "2018-03-15 12:14:56",
14 "description": "DIDWW"
15 },
16 "relationships": {
17 "available_did": {
18 "links": {
19 "self": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did",
20 "related": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"
21 },
22 "data": {
23 "type": "available_dids",
24 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683"
25 }
26 }
27 }
28 },
29 "included": [
30 {
31 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683",
32 "type": "available_dids",
33 "attributes": {
34 "number": "77124562356"
35 }
36 }
37 ]
38 }
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |