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>]	string	Optional	Filtering
include	string	Optional	Inclusion
sort	string	Optional	Sorting

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

Filters:

Filter Name	Type	Allow Blank	Allow Array	Filters by:
id	string	No	Yes	DID Reservation id field.

Sparse Fieldsets:

Value	Returns:
expire_at	The expire_at attribute.
created_at	The created_at attribute.
description	The description attribute.

Examples

Simple RequestRequest with available_did include

http

GET /v3/did_reservations 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 -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": "d35148e7-8858-446e-ae53-2f5ae17501ef",
          "type": "did_reservations",
          "links": {
            "self": "https://api.didww.com/v3/did_reservations/d35148e7-8858-446e-ae53-2f5ae17501ef"
          },
          "attributes": {
            "expire_at": "2018-03-15 12:34:56",
            "created_at": "2018-03-15 12:14:56",
            "description": "DIDWW"
          },
          "relationships": {
            "did_group": {
              "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"
              }
            }
          }
        },
        {
          "id": "9e31a4a5-38ef-4e1e-8a83-f6ae10d61d51",
          "type": "did_reservations",
          "links": {
            "self": "https://api.didww.com/v3/did_reservations/9e31a4a5-38ef-4e1e-8a83-f6ae10d61d51"
          },
          "attributes": {
            "expire_at": "2018-03-15 12:34:56",
            "created_at": "2018-03-15 12:14:56",
            "description": "DIDWW"
          },
          "relationships": {
            "did_group": {
              "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": {
        "total_records": 2
      }
    }

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized