Compare commits

...
Author SHA1 Message Date
Phin Wolkwitz 49bbffdc58 API: Add an endpoint for gates 2026-11-18 20:55:20 +01:00
4 changed files with 253 additions and 1 deletions

No files matched your search

+195
View File
@@ -0,0 +1,195 @@
Gate resource
-------------
The gate resource contains the following public fields:
.. rst-class:: rest-resource-table
===================================== ========================== =======================================================
Field Type Description
===================================== ========================== =======================================================
id integer Internal ID of the gate within this organizer
name string gate name
identifier string Internal identifier to make it easier to match the data with other sources
===================================== ========================== =======================================================
Device endpoints
----------------
.. http:get:: /api/v1/organizers/(organizer)/gates/
Returns a list of all gates within a given organizer.
**Example request**:
.. sourcecode:: http
GET /api/v1/organizers/bigevents/gates/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
**Example response**:
.. sourcecode:: http
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": 1,
"name": "Main door",
"identifier": "west_entry"
}
]
}
:param organizer: The ``slug`` field of the organizer to fetch
:statuscode 200: no error
:statuscode 401: Authentication failure
:statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
.. http:get:: /api/v1/organizers/(organizer)/gates/(id)/
Returns information on one gate, identified by its ID.
**Example request**:
.. sourcecode:: http
GET /api/v1/organizers/bigevents/gates/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
**Example response**:
.. sourcecode:: http
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"id": 1,
"name": "Main door",
"identifier": "west_entry"
}
:param organizer: The ``slug`` field of the organizer to fetch
:param id: The ``id`` of the gate to fetch
:statuscode 200: no error
:statuscode 401: Authentication failure
:statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
.. http:post:: /api/v1/organizers/(organizer)/gates/
Creates a new gate
You can supply the following fields of the resource:
* ``name``
* ``identifier`` (optional, if you do not supply one, it will be auto-generated)
**Example request**:
.. sourcecode:: http
POST /api/v1/organizers/bigevents/gates/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json
{
"name": "South gate",
"identifier": "south_entry",
}
**Example response**:
.. sourcecode:: http
HTTP/1.1 201 Created
Vary: Accept
Content-Type: application/json
{
"id": 2,
"name": "South gate",
"identifier": "south_entry"
}
:param organizer: The ``slug`` field of the organizer to create a gate for
:statuscode 201: no error
:statuscode 400: The gate could not be created due to invalid submitted data.
:statuscode 401: Authentication failure
:statuscode 403: The requested organizer/gate does not exist **or** you have no permission to create this resource.
.. http:patch:: /api/v1/organizers/(organizer)/gates/(id)/
Update a gate.
**Example request**:
.. sourcecode:: http
PATCH /api/v1/organizers/bigevents/gates/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
Content-Type: application/json
Content-Length: 94
{
"name": "Foo"
}
**Example response**:
.. sourcecode:: http
HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
{
"id": 2,
"name": "Foo",
"identifier": "south_entry"
}
:param organizer: The ``slug`` field of the organizer to modify
:param id: The ``id`` field of the gate to modify
:statuscode 200: no error
:statuscode 400: The gate could not be modified due to invalid submitted data
:statuscode 401: Authentication failure
:statuscode 403: The requested organizer/gate does not exist **or** you have no permission to change this resource.
.. http:delete:: /api/v1/organizers/(organizer)/gates/(id)/
Delete a gate.
**Example request**:
.. sourcecode:: http
DELETE /api/v1/organizers/bigevents/gates/1/ HTTP/1.1
Host: pretix.eu
Accept: application/json, text/javascript
**Example response**:
.. sourcecode:: http
HTTP/1.1 204 No Content
Vary: Accept
:param organizer: The ``slug`` field of the organizer to modify
:param id: The ``id`` field of the gate to delete
:statuscode 204: no error
:statuscode 401: Authentication failure
:statuscode 403: The requested organizer/gate does not exist **or** you have no permission to change it **or** this gate cannot be deleted since it is currently in use.
+10
View File
@@ -45,6 +45,7 @@ from pretix.base.models import (
Membership, MembershipType, OrderPosition, Organizer, ReusableMedium,
SalesChannel, SeatingPlan, Team, TeamAPIToken, TeamInvite, User,
)
from pretix.base.models.devices import Gate
from pretix.base.models.seating import SeatingPlanLayoutValidator
from pretix.base.permissions import (
get_all_event_permission_groups, get_all_organizer_permission_groups,
@@ -477,6 +478,15 @@ class DeviceSerializer(serializers.ModelSerializer):
del self.fields['initialization_token']
class GateSerializer(serializers.ModelSerializer):
name = serializers.CharField(max_length=190)
identifier = serializers.CharField(max_length=190, required=False)
class Meta:
model = Gate
fields = ('id', 'name', 'identifier')
class TeamInviteSerializer(serializers.ModelSerializer):
class Meta:
model = TeamInvite
+1
View File
@@ -62,6 +62,7 @@ orga_router.register(r'membershiptypes', organizer.MembershipTypeViewSet)
orga_router.register(r'reusablemedia', media.ReusableMediaViewSet)
orga_router.register(r'teams', organizer.TeamViewSet)
orga_router.register(r'devices', organizer.DeviceViewSet)
orga_router.register(r'gates', organizer.GateViewSet)
orga_router.register(r'orders', order.OrganizerOrderViewSet)
orga_router.register(r'invoices', order.InvoiceViewSet)
orga_router.register(r'scheduled_exports', exporters.ScheduledOrganizerExportViewSet)
+47 -1
View File
@@ -44,7 +44,7 @@ from pretix.api.models import OAuthAccessToken
from pretix.api.pagination import TotalOrderingFilter
from pretix.api.serializers.organizer import (
CustomerCreateSerializer, CustomerSerializer, DeviceSerializer,
EventMetaPropertiesSerializer, GiftCardSerializer,
EventMetaPropertiesSerializer, GateSerializer, GiftCardSerializer,
GiftCardTransactionSerializer, MembershipSerializer,
MembershipTypeSerializer, OrganizerSerializer, OrganizerSettingsSerializer,
SalesChannelSerializer, SeatingPlanSerializer, TeamAPITokenSerializer,
@@ -55,6 +55,7 @@ from pretix.base.models import (
LogEntry, Membership, MembershipType, Organizer, SalesChannel, SeatingPlan,
Team, TeamAPIToken, TeamInvite, User,
)
from pretix.base.models.devices import Gate
from pretix.base.plugins import (
PLUGIN_LEVEL_EVENT, PLUGIN_LEVEL_EVENT_ORGANIZER_HYBRID,
)
@@ -571,6 +572,51 @@ class DeviceViewSet(mixins.CreateModelMixin,
return inst
class GateViewSet(viewsets.ModelViewSet):
serializer_class = GateSerializer
queryset = Gate.objects.none()
write_permission = 'organizer.settings.general:write'
def get_queryset(self):
return self.request.organizer.gates.order_by('pk')
def get_serializer_context(self):
ctx = super().get_serializer_context()
ctx['organizer'] = self.request.organizer
return ctx
@transaction.atomic()
def perform_destroy(self, instance):
instance.log_action(
'pretix.gate.deleted',
user=self.request.user,
auth=self.request.auth,
data={'id': instance.pk}
)
instance.delete()
@transaction.atomic()
def perform_create(self, serializer):
inst = serializer.save(organizer=self.request.organizer)
inst.log_action(
'pretix.gate.created',
user=self.request.user,
auth=self.request.auth,
data=merge_dicts(self.request.data, {'id': inst.pk})
)
@transaction.atomic()
def perform_update(self, serializer):
inst = serializer.save()
inst.log_action(
'pretix.gate.changed',
user=self.request.user,
auth=self.request.auth,
data=self.request.data
)
return inst
class OrganizerSettingsView(views.APIView):
permission = None
write_permission = 'organizer.settings.general:write'