Discount Codes in Open Event Server
The Open Event System allows usage of discount codes with tickets and events. This blogpost describes what types of discount codes are present and what endpoints can be used to fetch and update details.
In Open Event API Server, each event can have two types of discount codes. One is ‘event’ discount code, while the other is ‘ticket’ discount code. As the name suggests, the event discount code is an event level discount code and the ticket discount code is ticket level.
Now each event can have only one ‘event’ discount code and is accessible only to the server admin. The Open Event server admin can create, view and update the ‘event’ discount code for an event. The event discount code followsDiscountCodeEvent Schema. This schema is inherited from the parent class DiscountCodeSchemaPublic. To save the unique discount code associated with an event, the event model’s discount_code_id field is used.
The ‘ticket’ discount is accessible by the event organizer and co-organizer. Each event can have any number of ‘ticket’ discount codes. This follows the DiscountCodeTicket schema, which is also inherited from the same base class ofDiscountCodeSchemaPublic. The use of the schema is decided based on the value of the field ‘used_for’ which can have the value either ‘events’ or ‘tickets’. Both the schemas have different relationships with events and marketer respectively.
We have the following endpoints for Discount Code events and tickets:
The first endpoint is based on the DiscountCodeDetail class. It returns the detail of one discount code which in this case is the event discount code associated with the event.
The second endpoint is based on the DiscountCodeList class which returns a list of discount codes associated with an event. Note that this list also includes the ‘event’ discount code, apart from all the ticket discount codes.
class DiscountCodeFactory(factory.alchemy.SQLAlchemyModelFactory): class Meta: model = DiscountCode sqlalchemy_session = db.session event_id = None user = factory.RelatedFactory(UserFactory) user_id = 1
Since each discount code belongs to an event(either directly or through the ticket), the factory for this has event as related factory, but to check for /events/<int:event_id>/discount-code endpoint we first need the event and then pass the discount code id to be 1 for dredd to check this. Hence, event is not included as a related factory, but added as a different object every time a discount code object is to be used.
@hooks.before("Discount Codes > Get Discount Code Detail of an Event > Get Discount Code Detail of an Event") def event_discount_code_get_detail(transaction): """ GET /events/1/discount-code :param transaction: :return: """ with stash['app'].app_context(): discount_code = DiscountCodeFactory() db.session.add(discount_code) db.session.commit() event = EventFactoryBasic(discount_code_id=1) db.session.add(event) db.session.commit()
The other tests and extended documentation can be found here.
- How to set up discount codes for one or multiple event – Antwonne D, [blog]
- Related Factories in FactoryBoy – Official Docs, FactoryBoy
- Discount Code related endpoints documentation – enigmaeth[commit]