CGM_Public/pretix_original
2
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-05-05 15:14:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Add new field to exhibitors API (#3624)

Browse Source 
Co-authored-by: Richard Schreiber <schreiber@rami.io>
This commit is contained in:
Raphael Michel
2023-10-04 16:29:38 +02:00
committed by GitHub
parent c1c828d8a2
commit b8c448fbd7
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/plugins/exhibitors.rst
View File

@@ -230,7 +230,8 @@ Endpoints
.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/ .. http:get:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/
Returns a list of all vouchers connected to an exhibitor. The response contains the same data as described in Returns a list of all vouchers connected to an exhibitor. The response contains the same data as described in
:ref:`rest-vouchers`. :ref:`rest-vouchers` as well as for each voucher an additional field ``exhibitor_comment`` that is shown to the exhibitor. It can only
be modified using the ``attach`` API call below.
**Example request**: **Example request**:
@@ -285,7 +286,7 @@ Endpoints
.. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/attach/ .. http:post:: /api/v1/organizers/(organizer)/events/(event)/exhibitors/(id)/vouchers/attach/
Attaches an **existing** voucher to an exhibitor. You need to send either the ``id`` **or** the ``code`` field of Attaches an **existing** voucher to an exhibitor. You need to send either the ``id`` **or** the ``code`` field of
the voucher. the voucher. You can call this method multiple times to update the optional ``exhibitor_comment`` field.
**Example request**: **Example request**:
@@ -296,7 +297,8 @@ Endpoints
Accept: application/json, text/javascript Accept: application/json, text/javascript
{ {
"id": 15 "id": 15,
"exhibitor_comment": "Free ticket"
} }
**Example request**: **Example request**:
@@ -308,7 +310,8 @@ Endpoints
Accept: application/json, text/javascript Accept: application/json, text/javascript
{ {
"code": "43K6LKM37FBVR2YG" "code": "43K6LKM37FBVR2YG",
"exhibitor_comment": "Free ticket"
} }
**Example response**: **Example response**:
@@ -410,7 +413,7 @@ Endpoints
.. sourcecode:: http .. sourcecode:: http
PATCH /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/1/ HTTP/1.1 PATCH /api/v1/organizers/bigevents/events/sampleconf/exhibitors/1/ HTTP/1.1
Host: pretix.eu Host: pretix.eu
Accept: application/json, text/javascript Accept: application/json, text/javascript
Content-Type: application/json Content-Type: application/json