Formats

Relationships

Format resources have the following relationships for their records.

  • Card Pools
  • Snapshots
  • Restrictions

Get A Single Format

Endpoint

GET /api/v3/public/formats/:id

Parameters

Name Description Type
id required Id string

Request

Route

GET /api/v3/public/formats/startup

Headers

Content-Type: application/json
Host: api-preview.netrunnerdb.com

cURL

curl -g "https://api-preview.netrunnerdb.com/api/v3/public/formats/startup" -X GET

Response

Simulated Response

Status

200

Headers

content-type: application/vnd.api+json; charset=utf-8

Body

{
  "data": {
    "id": "startup",
    "type": "formats",
    "attributes": {
      "name": "Startup",
      "active_snapshot_id": "startup_02",
      "snapshot_ids": [
        "startup_01",
        "startup_02"
      ],
      "restriction_ids": [],
      "active_card_pool_id": "startup_02",
      "active_restriction_id": null,
      "updated_at": "2022-12-08T12:00:00+00:00"
    },
    "relationships": {
      "card_pools": {
        "links": {
          "related": "http://localhost:3000/api/v3/public/card_pools?filter[format_id]=startup"
        }
      },
      "snapshots": {
        "links": {
          "related": "http://localhost:3000/api/v3/public/snapshots?filter[format_id]=startup"
        }
      },
      "restrictions": {
        "links": {
          "related": "http://localhost:3000/api/v3/public/restrictions?filter[format_id]=startup"
        }
      }
    },
    "links": {
      "self": "http://localhost:3000/api/v3/public/formats/startup"
    }
  },
  "meta": {}
}