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 |
|
No |
Includes:
Value |
Description |
---|---|
available_did |
|
available_did.did_group |
|
available_did.did_group.stock_keeping_units |
Examples
GET /v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -i -X GET https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "09c3c91b-f7bf-4db3-b94a-63824b8b1bfa",
"type": "did_reservations",
"attributes": {
"expire_at": "2022-06-27T10:52:16.564Z",
"created_at": "2022-06-27T10:42:16.577Z",
"description": "DIDWW"
},
"relationships": {
"available_did": {
"links": {
"self": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/relationships/available_did",
"related": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/available_did"
}
}
}
},
"meta": {
"available_count": 9,
"api_version": "2022-05-10"
}
}
GET /v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d?include=available_did HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]
curl -i -X GET 'https://nohost/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d?include=available_did'
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json
{
"data": {
"id": "09c3c91b-f7bf-4db3-b94a-63824b8b1bfa",
"type": "did_reservations",
"attributes": {
"expire_at": "2022-06-27T10:52:16.564Z",
"created_at": "2022-06-27T10:42:16.577Z",
"description": "DIDWW"
},
"relationships": {
"available_did": {
"links": {
"self": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/relationships/available_did",
"related": "https://api.didww.com/v3/did_reservations/09c3c91b-f7bf-4db3-b94a-63824b8b1bfa/available_did"
},
"data": {
"type": "available_dids",
"id": "44ba95af-4b61-49a8-ae41-6235cc8cb573"
}
}
}
},
"included": [
{
"id": "44ba95af-4b61-49a8-ae41-6235cc8cb573",
"type": "available_dids",
"attributes": {
"number": "12124727602"
},
"relationships": {
"did_group": {
"links": {
"self": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/relationships/did_group",
"related": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/did_group"
}
},
"nanpa_prefix": {
"links": {
"self": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/relationships/nanpa_prefix",
"related": "https://api.didww.com/v3/available_dids/44ba95af-4b61-49a8-ae41-6235cc8cb573/nanpa_prefix"
}
}
}
}
],
"meta": {
"available_count": 9,
"api_version": "2022-05-10"
}
}
Other Responses
Code |
Success |
Description |
---|---|---|
404 |
No |
|
401 |
No |