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	string	Yes	Unique ID number of the DID Reservation.
include	string	Optional	Inclusion

Includes:

Value	Description
available_did	Available DID Object
available_did.did_group	DID Group Object
available_did.did_group.stock_keeping_units	Stock Keeping Unit Object

Examples

Simple RequestRequest with available_did include

http

GET /v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -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

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "dd13cdb2-48ab-4374-94b3-56e162a659cd",
    "type": "did_reservations",
    "attributes": {
      "expire_at": "2018-03-15 12:34:56",
      "created_at": "2018-03-15 12:14:56",
      "description": "DIDWW"
    },
    "relationships": {
      "available_did": {
        "links": {
          "self": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/relationships/available_did",
          "related": "https://api.didww.com/v3/did_reservations/dd13cdb2-48ab-4374-94b3-56e162a659cd/available_did"
        }
      }
    }
  },
    "meta": {
        "available_count": 9,
        "api_version": "2017-09-18"
    }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized