DspState

List DspStates

GET https://api.idol.io/api/v2/dsp-states

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": [
    {
      "id": "<ID>",
      "type": "dsp-states",
      "links": {
        "self": "https://api.idol.io/api/v2/dsp-states/<ID>"
      },
      "attributes": {
        "created-at": null,
        "updated-at": "2022-09-15T13:06:45.000+02:00",
        "available": true
      },
      "relationships": {
        "availabilities": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/availabilities",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/availabilities"
          }
        },
        "dsp": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/dsp",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/dsp"
          },
          "data": {
            "type": "dsps",
            "id": "<ID>"
          }
        },
        "product": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/product",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/product"
          },
          "data": {
            "type": "products",
            "id": "<ID>"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "dsp-states",
      "links": {
        "self": "https://api.idol.io/api/v2/dsp-states/<ID>"
      },
      "attributes": {
        "created-at": null,
        "updated-at": "2012-09-15T13:06:45.000+02:00",
        "available": true
      },
      "relationships": {
        "availabilities": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/availabilities",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/availabilities"
          }
        },
        "dsp": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/dsp",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/dsp"
          },
          "data": {
            "type": "dsps",
            "id": "<ID>"
          }
        },
        "product": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/product",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/product"
          },
          "data": {
            "type": "products",
            "id": "<ID>"
          }
        }
      }
    },
    {
      "id": "<ID>",
      "type": "dsp-states",
      "links": {
        "self": "https://api.idol.io/api/v2/dsp-states/<ID>"
      },
      "attributes": {
        "created-at": null,
        "updated-at": "2016-08-19T13:13:25.925+02:00",
        "available": true
      },
      "relationships": {
        "availabilities": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/availabilities",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/availabilities"
          }
        },
        "dsp": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/dsp",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/dsp"
          },
          "data": {
            "type": "dsps",
            "id": "<ID>"
          }
        },
        "product": {
          "links": {
            "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/product",
            "related": "https://api.idol.io/api/v2/dsp-states/<ID>/product"
          },
          "data": {
            "type": "products",
            "id": "<ID>"
          }
        }
      }
    }
  ],
  "meta": {
    "record-count": 6106684,
    "page-count": 2035562
  },
  "links": {
    "first": "https://api.idol.io/api/v2/dsp-states?page%5Bnumber%5D=1&page%5Bsize%5D=3",
    "next": "https://api.idol.io/api/v2/dsp-states?page%5Bnumber%5D=2&page%5Bsize%5D=3",
    "last": "https://api.idol.io/api/v2/dsp-states?page%5Bnumber%5D=2035562&page%5Bsize%5D=3"
  }
}

Filter resources

Product

api/v2/dsp-states?filter[product-id]=1

DspUploadIdentification

api/v2/dsp-states?filter[dsp-upload-identification-id]=1

Current

api/v2/dsp-states?filter[current]=true

Get DspStates

GET https://api.idol.io/api/v2/dsp-states/:id

Path Parameters

Name	Type	Description
id*	number	ID of the DspState

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

200

{
  "data": {
    "id": "<ID>",
    "type": "dsp-states",
    "links": {
      "self": "https://api.idol.io/api/v2/dsp-states/<ID>"
    },
    "attributes": {
      "created-at": null,
      "updated-at": "2022-09-15T13:06:45.000+02:00",
      "available": true
    },
    "relationships": {
      "availabilities": {
        "links": {
          "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/availabilities",
          "related": "https://api.idol.io/api/v2/dsp-states/<ID>/availabilities"
        }
      },
      "dsp": {
        "links": {
          "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/dsp",
          "related": "https://api.idol.io/api/v2/dsp-states/<ID>/dsp"
        },
        "data": {
          "type": "dsps",
          "id": "<ID>"
        }
      },
      "product": {
        "links": {
          "self": "https://api.idol.io/api/v2/dsp-states/<ID>/relationships/product",
          "related": "https://api.idol.io/api/v2/dsp-states/<ID>/product"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      }
    }
  }
}

Create DspState

POST https://api.idol.io/api/v2/dsp-states

Headers

Name	Type	Description
Authorization*	string	Bearer <token>
Content-Type*	string	application/vnd.api+json

Request Body

Name	Type	Description
product*	object	Product Object
dsp-upload-identification	object	DspUploadIdentification Object
availabilities	object	Availabilities Object
is-available*	boolean	true

200

{
  "data": {
    "id": "<ID>",
    "type": "dsp-states",
    "links": {
      "self": "http://api.idol.io/api/v2/dsp-states/<ID>"
    },
    "attributes": {
      "created-at": "2022-04-11T15:25:19.741+02:00",
      "updated-at": "2022-04-11T15:25:19.741+02:00",
      "available": true,
      "batch-id": "N/A",
      "is-available": true
    },
    "relationships": {
      "availabilities": {
        "links": {
          "self": "http://api.idol.io/api/v2/dsp-states/<ID>/relationships/availabilities",
          "related": "http://api.idol.io/api/v2/dsp-states/<ID>/availabilities"
        }
      },
      "dsp": {
        "links": {
          "self": "http://api.idol.io/api/v2/dsp-states/<ID>/relationships/dsp",
          "related": "http://api.idol.io/api/v2/dsp-states/<ID>/dsp"
        },
        "data": {
          "type": "dsps",
          "id": "<ID>"
        }
      },
      "dsp-upload-identification": {
        "links": {
          "self": "http://api.idol.io/api/v2/dsp-states/<ID>/relationships/dsp-upload-identification",
          "related": "http://api.idol.io/api/v2/dsp-states/<ID>/dsp-upload-identification"
        },
        "data": {
          "type": "dsp-upload-identifications",
          "id": "<ID>"
        }
      },
      "product": {
        "links": {
          "self": "http://api.idol.io/api/v2/dsp-states/<ID>/relationships/product",
          "related": "http://api.idol.io/api/v2/dsp-states/<ID>/product"
        },
        "data": {
          "type": "products",
          "id": "<ID>"
        }
      }
    }
  }
}