******
Events
******
Events is a collection resource, consisting of all events that are currently active. If no sale_start and sale_end
dates are passed default values are used (sale_start__lte and sale_end__gte will be set to the time the request is made).

Accepted methods
================
* **GET**: Retrieve the list of all events.

Accepted query parameters
=========================
======================= ==========================
Field name              Description
======================= ==========================
merchant_name           Name of company
title                   Title of event
subtitle                Subtitle of event
sale_start              Sale start date
sale_end                Sale end date
event_start             Event start date
event_end               Event end date
location.name           Name of location
location.postal_code    Postal code of location
location.city           City of location
location.country        Country of location
artist                  Artist of event
======================= ==========================

Data
====
==========  ========  ======================================
Field name  Type      Description
==========  ========  ======================================
item_count  Integer   The total number of events
==========  ========  ======================================

Link relations
==============
* Search
* First
* Prev
* Next
* Last
* :doc:`event`

Embedded resources
==================
* :doc:`Event (list) <event>`.

Example representation
======================
.. code-block:: bash

	[GET] https://shopping-api.paylogic.com/events/

.. code-block:: javascript

	{
        "_links": {
            "self": { "href": "https://shopping-api.paylogic.com/events?page=2" },
            "curies": [
                { "name": "shop", "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html", "templated": true, "type": "text/html" },
            ],
            "profile": { "href": "https://shopping-api-docs.paylogic.com/documentation/events.html", "type": "text/html" },
            "search": { "href": "https://shopping-api.paylogic.com/events{?merchant_name,title,subtitle,sale_start,sale_end,event_start,event_end,location.name,location.postal_code,location.city,location.country,artist}", "templated": true },
            "first": { "href": "https://shopping-api.paylogic.com/events" },
            "prev": { "href": "https://shopping-api.paylogic.com/events?page=1" },
            "next": { "href": "https://shopping-api.paylogic.com/events?page=3" },
            "last": { "href": "https://shopping-api.paylogic.com/events?page=5" }
        },
        "item_count": 83,
        "_embedded": {
            "shop:event": [
                // ...
            ]
        }
    }