CGM_Public/pretix_original
3
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-09-14 16:24:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor JSON spelling mistakes

Browse Source
This commit is contained in:
Martin Gross
2019-03-27 15:41:56 +01:00
parent e82bc732a3
commit 7ef289da45
11 changed files with 41 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/api/resources/categories.rst
+1 -1
View File
@@ -20,7 +20,7 @@ internal_name string An optional nam
description multi-lingual string A public description (might include markdown, can description multi-lingual string A public description (might include markdown, can
be ``null``) be ``null``)
position integer An integer, used for sorting the categories position integer An integer, used for sorting the categories
is_addon boolean If ``True``, items within this category are not on sale is_addon boolean If ``true``, items within this category are not on sale
on their own but the category provides a source for on their own but the category provides a source for
defining add-ons for other products. defining add-ons for other products.
===================================== ========================== ======================================================= ===================================== ========================== =======================================================
doc/api/resources/checkinlists.rst
+3 -3
View File
@@ -156,14 +156,14 @@ Endpoints
"checkin_count": 17, "checkin_count": 17,
"position_count": 42, "position_count": 42,
"event": { "event": {
"name": "Demo Converence", "name": "Demo Conference"
}, },
"items": [ "items": [
{ {
"name": "T-Shirt", "name": "T-Shirt",
"id": 1, "id": 1,
"checkin_count": 1, "checkin_count": 1,
"admission": False, "admission": false,
"position_count": 1, "position_count": 1,
"variations": [ "variations": [
{ {
@@ -184,7 +184,7 @@ Endpoints
"name": "Ticket", "name": "Ticket",
"id": 2, "id": 2,
"checkin_count": 15, "checkin_count": 15,
"admission": True, "admission": true,
"position_count": 22, "position_count": 22,
"variations": [] "variations": []
} }
doc/api/resources/events.rst
+1 -1
View File
@@ -25,7 +25,7 @@ is_public boolean If ``true``, th
presale_start datetime The date at which the ticket shop opens (or ``null``) presale_start datetime The date at which the ticket shop opens (or ``null``)
presale_end datetime The date at which the ticket shop closes (or ``null``) presale_end datetime The date at which the ticket shop closes (or ``null``)
location multi-lingual string The event location (or ``null``) location multi-lingual string The event location (or ``null``)
has_subevents boolean ``True`` if the event series feature is active for this has_subevents boolean ``true`` if the event series feature is active for this
event. Cannot change after event is created. event. Cannot change after event is created.
meta_data dict Values set for organizer-specific meta data parameters. meta_data dict Values set for organizer-specific meta data parameters.
plugins list A list of package names of the enabled plugins for this plugins list A list of package names of the enabled plugins for this
doc/api/resources/invoices.rst
+1 -1
View File
@@ -13,7 +13,7 @@ Field Type Description
===================================== ========================== ======================================================= ===================================== ========================== =======================================================
number string Invoice number (with prefix) number string Invoice number (with prefix)
order string Order code of the order this invoice belongs to order string Order code of the order this invoice belongs to
is_cancellation boolean ``True``, if this invoice is the cancellation of a is_cancellation boolean ``true``, if this invoice is the cancellation of a
different invoice. different invoice.
invoice_from string Sender address invoice_from string Sender address
invoice_to string Receiver address invoice_to string Receiver address
doc/api/resources/item_variations.rst
+1 -1
View File
@@ -18,7 +18,7 @@ default_price money (string) The price set d
price money (string) The price used for this variation. This is either the price money (string) The price used for this variation. This is either the
same as ``default_price`` if that value is set or equal same as ``default_price`` if that value is set or equal
to the item's ``default_price`` (read-only). to the item's ``default_price`` (read-only).
active boolean If ``False``, this variation will not be sold or shown. active boolean If ``false``, this variation will not be sold or shown.
description multi-lingual string A public description of the variation. May contain description multi-lingual string A public description of the variation. May contain
Markdown syntax or can be ``null``. Markdown syntax or can be ``null``.
position integer An integer, used for sorting position integer An integer, used for sorting
doc/api/resources/items.rst
+13 -13
View File
@@ -21,18 +21,18 @@ default_price money (string) The item price
overwritten by variations or other options. overwritten by variations or other options.
category integer The ID of the category this item belongs to category integer The ID of the category this item belongs to
(or ``null``). (or ``null``).
active boolean If ``False``, the item is hidden from all public lists active boolean If ``false``, the item is hidden from all public lists
and will not be sold. and will not be sold.
description multi-lingual string A public description of the item. May contain Markdown description multi-lingual string A public description of the item. May contain Markdown
syntax or can be ``null``. syntax or can be ``null``.
free_price boolean If ``True``, customers can change the price at which free_price boolean If ``true``, customers can change the price at which
they buy the product (however, the price can't be set they buy the product (however, the price can't be set
lower than the price defined by ``default_price`` or lower than the price defined by ``default_price`` or
otherwise). otherwise).
tax_rate decimal (string) The VAT rate to be applied for this item. tax_rate decimal (string) The VAT rate to be applied for this item.
tax_rule integer The internal ID of the applied tax rule (or ``null``). tax_rule integer The internal ID of the applied tax rule (or ``null``).
admission boolean ``True`` for items that grant admission to the event admission boolean ``true`` for items that grant admission to the event
(such as primary tickets) and ``False`` for others (such as primary tickets) and ``false`` for others
(such as add-ons or merchandise). (such as add-ons or merchandise).
position integer An integer, used for sorting position integer An integer, used for sorting
picture string A product picture to be displayed in the shop picture string A product picture to be displayed in the shop
@@ -43,12 +43,12 @@ available_from datetime The first date
(or ``null``). (or ``null``).
available_until datetime The last date time at which this item can be bought available_until datetime The last date time at which this item can be bought
(or ``null``). (or ``null``).
require_voucher boolean If ``True``, this item can only be bought using a require_voucher boolean If ``true``, this item can only be bought using a
voucher that is specifically assigned to this item. voucher that is specifically assigned to this item.
hide_without_voucher boolean If ``True``, this item is only shown during the voucher hide_without_voucher boolean If ``true``, this item is only shown during the voucher
redemption process, but not in the normal shop redemption process, but not in the normal shop
frontend. frontend.
allow_cancel boolean If ``False``, customers cannot cancel orders containing allow_cancel boolean If ``false``, customers cannot cancel orders containing
this item. this item.
min_per_order integer This product can only be bought if it is included at min_per_order integer This product can only be bought if it is included at
least this many times in the order (or ``null`` for no least this many times in the order (or ``null`` for no
@@ -56,17 +56,17 @@ min_per_order integer This product ca
max_per_order integer This product can only be bought if it is included at max_per_order integer This product can only be bought if it is included at
most this many times in the order (or ``null`` for no most this many times in the order (or ``null`` for no
limitation). limitation).
checkin_attention boolean If ``True``, the check-in app should show a warning checkin_attention boolean If ``true``, the check-in app should show a warning
that this ticket requires special attention if such that this ticket requires special attention if such
a product is being scanned. a product is being scanned.
original_price money (string) An original price, shown for comparison, not used original_price money (string) An original price, shown for comparison, not used
for price calculations (or ``null``). for price calculations (or ``null``).
require_approval boolean If ``True``, orders with this product will need to be require_approval boolean If ``true``, orders with this product will need to be
approved by the event organizer before they can be approved by the event organizer before they can be
paid. paid.
require_bundling boolean If ``True``, this item is only available as part of bundles. require_bundling boolean If ``true``, this item is only available as part of bundles.
generate_tickets boolean If ``False``, tickets are never generated for this generate_tickets boolean If ``false``, tickets are never generated for this
product, regardless of other settings. If ``True``, product, regardless of other settings. If ``true``,
tickets are generated even if this is a tickets are generated even if this is a
non-admission or add-on product, regardless of event non-admission or add-on product, regardless of event
settings. If this is ``null``, regular ticketing settings. If this is ``null``, regular ticketing
@@ -81,7 +81,7 @@ variations list of objects A list with one
├ price money (string) The price used for this variation. This is either the ├ price money (string) The price used for this variation. This is either the
same as ``default_price`` if that value is set or equal same as ``default_price`` if that value is set or equal
to the item's ``default_price``. to the item's ``default_price``.
├ active boolean If ``False``, this variation will not be sold or shown. ├ active boolean If ``false``, this variation will not be sold or shown.
├ description multi-lingual string A public description of the variation. May contain ├ description multi-lingual string A public description of the variation. May contain
Markdown syntax or can be ``null``. Markdown syntax or can be ``null``.
└ position integer An integer, used for sorting └ position integer An integer, used for sorting
doc/api/resources/orders.rst
+12 -12
View File
@@ -26,7 +26,7 @@ status string Order status, o
* ``p`` – paid * ``p`` – paid
* ``e`` – expired * ``e`` – expired
* ``c`` – canceled * ``c`` – canceled
testmode boolean If ``True``, this order was created when the event was in testmode boolean If ``true``, this order was created when the event was in
test mode. Only orders in test mode can be deleted. test mode. Only orders in test mode can be deleted.
secret string The secret contained in the link sent to the customer secret string The secret contained in the link sent to the customer
email string The customer email address email string The customer email address
@@ -39,13 +39,13 @@ payment_date date **DEPRECATED AN
payment_provider string **DEPRECATED AND INACCURATE** Payment provider used for this order payment_provider string **DEPRECATED AND INACCURATE** Payment provider used for this order
total money (string) Total value of this order total money (string) Total value of this order
comment string Internal comment on this order comment string Internal comment on this order
checkin_attention boolean If ``True``, the check-in app should show a warning checkin_attention boolean If ``true``, the check-in app should show a warning
that this ticket requires special attention if a ticket that this ticket requires special attention if a ticket
of this order is scanned. of this order is scanned.
invoice_address object Invoice address information (can be ``null``) invoice_address object Invoice address information (can be ``null``)
├ last_modified datetime Last modification date of the address ├ last_modified datetime Last modification date of the address
├ company string Customer company name ├ company string Customer company name
├ is_business boolean Business or individual customers (always ``False`` ├ is_business boolean Business or individual customers (always ``false``
for orders created before pretix 1.7, do not rely on for orders created before pretix 1.7, do not rely on
it). it).
├ name string Customer name ├ name string Customer name
@@ -56,7 +56,7 @@ invoice_address object Invoice address
├ country string Customer country ├ country string Customer country
├ internal_reference string Customer's internal reference to be printed on the invoice ├ internal_reference string Customer's internal reference to be printed on the invoice
├ vat_id string Customer VAT ID ├ vat_id string Customer VAT ID
└ vat_id_validated string ``True``, if the VAT ID has been validated against the └ vat_id_validated string ``true``, if the VAT ID has been validated against the
EU VAT service and validation was successful. This only EU VAT service and validation was successful. This only
happens in rare cases. happens in rare cases.
positions list of objects List of non-canceled order positions (see below) positions list of objects List of non-canceled order positions (see below)
@@ -78,9 +78,9 @@ downloads list of objects List of ticket
download options. download options.
├ output string Ticket output provider (e.g. ``pdf``, ``passbook``) ├ output string Ticket output provider (e.g. ``pdf``, ``passbook``)
└ url string Download URL └ url string Download URL
require_approval boolean If ``True`` and the order is pending, this order require_approval boolean If ``true`` and the order is pending, this order
needs approval by an organizer before it can needs approval by an organizer before it can
continue. If ``True`` and the order is canceled, continue. If ``true`` and the order is canceled,
this order has been denied by the event organizer. this order has been denied by the event organizer.
payments list of objects List of payment processes (see below) payments list of objects List of payment processes (see below)
refunds list of objects List of refund processes (see below) refunds list of objects List of refund processes (see below)
@@ -295,7 +295,7 @@ List of all orders
"require_approval": false, "require_approval": false,
"invoice_address": { "invoice_address": {
"last_modified": "2017-12-01T10:00:00Z", "last_modified": "2017-12-01T10:00:00Z",
"is_business": True, "is_business": true,
"company": "Sample company", "company": "Sample company",
"name": "John Doe", "name": "John Doe",
"name_parts": {"full_name": "John Doe"}, "name_parts": {"full_name": "John Doe"},
@@ -305,7 +305,7 @@ List of all orders
"country": "Testikistan", "country": "Testikistan",
"internal_reference": "", "internal_reference": "",
"vat_id": "EU123456789", "vat_id": "EU123456789",
"vat_id_validated": False "vat_id_validated": false
}, },
"positions": [ "positions": [
{ {
@@ -437,7 +437,7 @@ Fetching individual orders
"invoice_address": { "invoice_address": {
"last_modified": "2017-12-01T10:00:00Z", "last_modified": "2017-12-01T10:00:00Z",
"company": "Sample company", "company": "Sample company",
"is_business": True, "is_business": true,
"name": "John Doe", "name": "John Doe",
"name_parts": {"full_name": "John Doe"}, "name_parts": {"full_name": "John Doe"},
"street": "Test street 12", "street": "Test street 12",
@@ -446,7 +446,7 @@ Fetching individual orders
"country": "Testikistan", "country": "Testikistan",
"internal_reference": "", "internal_reference": "",
"vat_id": "EU123456789", "vat_id": "EU123456789",
"vat_id_validated": False "vat_id_validated": false
}, },
"positions": [ "positions": [
{ {
@@ -593,7 +593,7 @@ Updating order fields
"email": "other@example.org", "email": "other@example.org",
"locale": "de", "locale": "de",
"comment": "Foo", "comment": "Foo",
"checkin_attention": True "checkin_attention": true
} }
**Example response**: **Example response**:
@@ -817,7 +817,7 @@ Creating orders
], ],
"payment_provider": "banktransfer", "payment_provider": "banktransfer",
"invoice_address": { "invoice_address": {
"is_business": False, "is_business": false,
"company": "Sample company", "company": "Sample company",
"name_parts": {"full_name": "John Doe"}, "name_parts": {"full_name": "John Doe"},
"street": "Sesam Street 12", "street": "Sesam Street 12",
doc/api/resources/questions.rst
+3 -3
View File
@@ -30,12 +30,12 @@ type string The expected ty
* ``D`` – date * ``D`` – date
* ``H`` – time * ``H`` – time
* ``W`` – date and time * ``W`` – date and time
required boolean If ``True``, the question needs to be filled out. required boolean If ``true``, the question needs to be filled out.
position integer An integer, used for sorting position integer An integer, used for sorting
items list of integers List of item IDs this question is assigned to. items list of integers List of item IDs this question is assigned to.
identifier string An arbitrary string that can be used for matching with identifier string An arbitrary string that can be used for matching with
other sources. other sources.
ask_during_checkin boolean If ``True``, this question will not be asked while ask_during_checkin boolean If ``true``, this question will not be asked while
buying the ticket, but will show up when redeeming buying the ticket, but will show up when redeeming
the ticket instead. the ticket instead.
options list of objects In case of question type ``C`` or ``M``, this lists the options list of objects In case of question type ``C`` or ``M``, this lists the
@@ -53,7 +53,7 @@ dependency_question integer Internal ID of
``ask_during_checkin``. ``ask_during_checkin``.
dependency_value string The value ``dependency_question`` needs to be set to. dependency_value string The value ``dependency_question`` needs to be set to.
If ``dependency_question`` is set to a boolean If ``dependency_question`` is set to a boolean
question, this should be ``"True"`` or ``"False"``. question, this should be ``"true"`` or ``"false"``.
Otherwise, it should be the ``identifier`` of a Otherwise, it should be the ``identifier`` of a
question option. question option.
===================================== ========================== ======================================================= ===================================== ========================== =======================================================
doc/api/resources/vouchers.rst
+2 -2
View File
@@ -18,8 +18,8 @@ max_usages integer The maximum num
redeemed integer The number of times this voucher already has been redeemed integer The number of times this voucher already has been
redeemed. redeemed.
valid_until datetime The voucher expiration date (or ``null``). valid_until datetime The voucher expiration date (or ``null``).
block_quota boolean If ``True``, quota is blocked for this voucher. block_quota boolean If ``true``, quota is blocked for this voucher.
allow_ignore_quota boolean If ``True``, this voucher can be redeemed even if a allow_ignore_quota boolean If ``true``, this voucher can be redeemed even if a
product is sold out and even if quota is not blocked product is sold out and even if quota is not blocked
for this voucher. for this voucher.
price_mode string Determines how this voucher affects product prices. price_mode string Determines how this voucher affects product prices.
doc/api/resources/webhooks.rst
+3 -3
View File
@@ -17,11 +17,11 @@ The webhook resource contains the following public fields:
Field Type Description Field Type Description
===================================== ========================== ======================================================= ===================================== ========================== =======================================================
id integer Internal ID of the webhook id integer Internal ID of the webhook
enabled boolean If ``False``, this webhook will not receive any notifications enabled boolean If ``false``, this webhook will not receive any notifications
target_url string The URL to call target_url string The URL to call
all_events boolean If ``True``, this webhook will receive notifications all_events boolean If ``true``, this webhook will receive notifications
on all events of this organizer on all events of this organizer
limit_events list of strings If ``all_events`` is ``False``, this is a list of limit_events list of strings If ``all_events`` is ``false``, this is a list of
event slugs this webhook is active for event slugs this webhook is active for
action_types list of strings A list of action type filters that limit the action_types list of strings A list of action type filters that limit the
notifications sent to this webhook. See below for notifications sent to this webhook. See below for
doc/plugins/pretixdroid.rst
+1 -1
View File
@@ -316,7 +316,7 @@ uses to communicate with the pretix server.
"total": 42, "total": 42,
"version": 3, "version": 3,
"event": { "event": {
"name": "Demo Converence", "name": "Demo Conference",
"slug": "democon", "slug": "democon",
"date_from": "2016-12-27T17:00:00Z", "date_from": "2016-12-27T17:00:00Z",
"date_to": "2016-12-30T18:00:00Z", "date_to": "2016-12-30T18:00:00Z",