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

Document exhibitor_tags field in API docs (#4172)

Browse Source 
* Document exhibitor_tags field in API

* Update doc/plugins/exhibitors.rst

---------

Co-authored-by: Raphael Michel <michel@rami.io>
This commit is contained in:
Mira
2024-05-24 10:00:44 +02:00
committed by GitHub
parent ef620ceb37
commit 78b65d0757
1 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/plugins/exhibitors.rst
View File

@@ -45,6 +45,8 @@ allow_voucher_access boolean Enables access
lead_scanning_scope_by_device string Enables lead scanning to be handled as one lead per attendee lead_scanning_scope_by_device string Enables lead scanning to be handled as one lead per attendee
per scanning device, instead of only per exhibitor. per scanning device, instead of only per exhibitor.
comment string Internal comment, not shown to exhibitor comment string Internal comment, not shown to exhibitor
exhibitor_tags list of strings Internal tags to categorize exhibitors, not shown to exhibitor.
The tags need to be created through the web interface currently.
===================================== ========================== ======================================================= ===================================== ========================== =======================================================
You can also access the scanned leads through the API which contains the following public fields: You can also access the scanned leads through the API which contains the following public fields:
@@ -119,7 +121,8 @@ Endpoints
"allow_lead_scanning": true, "allow_lead_scanning": true,
"allow_lead_access": true, "allow_lead_access": true,
"allow_voucher_access": true, "allow_voucher_access": true,
"comment": "" "comment": "",
"exhibitor_tags": []
} }
] ]
} }
@@ -173,7 +176,8 @@ Endpoints
"allow_lead_scanning": true, "allow_lead_scanning": true,
"allow_lead_access": true, "allow_lead_access": true,
"allow_voucher_access": true, "allow_voucher_access": true,
"comment": "" "comment": "",
"exhibitor_tags": []
} }
:param organizer: The ``slug`` field of the organizer to fetch :param organizer: The ``slug`` field of the organizer to fetch
@@ -374,7 +378,10 @@ Endpoints
"allow_lead_scanning": true, "allow_lead_scanning": true,
"allow_lead_access": true, "allow_lead_access": true,
"allow_voucher_access": true, "allow_voucher_access": true,
"comment": "" "comment": "",
"exhibitor_tags": [
"Gold Sponsor"
]
} }
**Example response**: **Example response**:
@@ -407,7 +414,10 @@ Endpoints
"allow_lead_scanning": true, "allow_lead_scanning": true,
"allow_lead_access": true, "allow_lead_access": true,
"allow_voucher_access": true, "allow_voucher_access": true,
"comment": "" "comment": "",
"exhibitor_tags": [
"Gold Sponsor"
]
} }
:param organizer: The ``slug`` field of the organizer to create new exhibitor for :param organizer: The ``slug`` field of the organizer to create new exhibitor for
@@ -468,7 +478,10 @@ Endpoints
"allow_lead_scanning": true, "allow_lead_scanning": true,
"allow_lead_access": true, "allow_lead_access": true,
"allow_voucher_access": true, "allow_voucher_access": true,
"comment": "" "comment": "",
"exhibitor_tags": [
"Gold Sponsor"
]
} }
:param organizer: The ``slug`` field of the organizer to modify :param organizer: The ``slug`` field of the organizer to modify