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

integer, string, boolean

Optional

Filtering

includes

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

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

http

GET /v3/did_reservations?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

curl -i 'https://nohost/v3/did_reservations?include=available_did'

response

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

     {
       "data": [
         {
           "id": "d0163fe0-001f-4a03-87ea-84224822708e",
           "type": "did_reservations",
           "links": {
             "self": "https://api.didww.com/v3/did_reservations/d0163fe0-001f-4a03-87ea-84224822708e"
           },
           "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/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did",
                 "related": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"
               },
               "data": {
                 "type": "available_dids",
                 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683"
               }
             }
           }
         },
         {
           "id": "952b0724-45bc-4f87-b31b-ff04579357ef",
           "type": "did_reservations",
           "links": {
             "self": "https://api.didww.com/v3/did_reservations/952b0724-45bc-4f87-b31b-ff04579357ef"
           },
           "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/80167e78-62a1-4720-bf00-229fa7e1935d/relationships/available_did",
                 "related": "https://api.didww.com/v3/did_reservations/80167e78-62a1-4720-bf00-229fa7e1935d/available_did"
               },
               "data": {
                 "type": "available_dids",
                 "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683"
               }
             }
           }
         }
       ],
       "included": [
         {
           "id": "8bc37f63-acd7-4e43-a760-1a1caa6e4683",
           "type": "available_dids",
           "attributes": {
             "number": "77124562356"
           }
         }
       ],
       "meta": {
         "total_records": 2
       }
     }

Other Responses

Code

Success

Description

404

No

Not Found

401

No

Unauthorized