Check-in API: require_attention and ignore_status

doc/api/resources/checkinlists.rst

@@ -41,6 +41,11 @@ include_pending                       boolean                    If ``true``, th
 
    The ``include_pending`` field has been added.
 
+.. versionchanged:: 2.7
+
+   The ``positions`` subresource now contains the new attributes ``require_attention`` and ``order__status`` and
+   accepts the new ``ignore_status`` filter.
+
 Endpoints
 ---------
 
@@ -339,8 +344,12 @@ Order position endpoints
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/positions/
 
    Returns a list of all order positions within a given event. The result is the same as
-   the :ref:`order-position-resource`, with one important difference: the ``checkins`` value will only include
-   check-ins for the selected list.
+   the :ref:`order-position-resource`, with the following differences:
+
+   * The ``checkins`` value will only include check-ins for the selected list.
+
+   * An additional boolean property ``require_attention`` will inform you whether either the order or the item
+     have the ``checkin_attention`` flag set.
 
    **Example request**:
 
@@ -407,6 +416,8 @@ Order position endpoints
       }
 
    :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string ignore_status: If set to ``true``, results will be returned regardles of the state of
+                                 the order they belong to and you will need to do your own filtering by order status.
    :query string ordering: Manually set the ordering of results. Valid fields to be used are ``order__code``,
                            ``order__datetime``, ``positionid``, ``attendee_name``, ``last_checked_in`` and ``order__email``. Default:
                            ``attendee_name,positionid``