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.

Fielding:

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": "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"
                    }
                }
            }
        },
        {
            "id": "e85a5b1f-850d-498f-8418-ec74cccc9e9a",
            "type": "did_reservations",
            "attributes": {
                "expire_at": "2022-06-27T10:59:58.131Z",
                "created_at": "2022-06-27T10:49:58.151Z",
                "description": "DIDWW"
            },
            "relationships": {
                "available_did": {
                    "links": {
                        "self": "https://api.didww.com/v3/did_reservations/e85a5b1f-850d-498f-8418-ec74cccc9e9a/relationships/available_did",
                        "related": "https://api.didww.com/v3/did_reservations/e85a5b1f-850d-498f-8418-ec74cccc9e9a/available_did"
                    }
                }
            }
        },
        {
            "id": "4789767d-d59a-485b-9adb-da14b4859f51",
            "type": "did_reservations",
            "attributes": {
                "expire_at": "2022-06-27T11:00:03.332Z",
                "created_at": "2022-06-27T10:50:03.344Z",
                "description": "DIDWW"
            },
            "relationships": {
                "available_did": {
                    "links": {
                        "self": "https://api.didww.com/v3/did_reservations/4789767d-d59a-485b-9adb-da14b4859f51/relationships/available_did",
                        "related": "https://api.didww.com/v3/did_reservations/4789767d-d59a-485b-9adb-da14b4859f51/available_did"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_records": 3,
        "available_count": 7,
        "api_version": "2022-05-10"
    },
    "links": {
        "first": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "last": "https://api.didww.com/v3/did_reservations?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized