DRF Docs

Document Web APIs made with Django REST Framework.

List all photos

Fields:

  • id: IntegerField
  • pk: IntegerField
  • sizes: DictField R
  • display_name: CharField
  • image: ImageField R
  • crop_from: ChoiceField
  • created_date: DateTimeField
  • slug: SlugField
  • title_pl: CharField R
  • title_en: CharField
  • description_pl: CharField
  • description_en: CharField
  • polymorphic_ctype: PrimaryKeyRelatedField

List all galleries, or create a new gallery.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • sorted_photos: SerializerMethodField
  • slug: SlugField
  • pub_date: DateTimeField
  • title_pl: CharField R
  • title_en: CharField
  • description_pl: CharField
  • description_en: CharField
  • photos: ManyRelatedField R
  • tags: ManyRelatedField

List all galleries, or create a new gallery.

Fields:

  • pk: IntegerField
  • title_pl: CharField R

Retrieve, update or delete an article instance.

No fields.

Retrieve, update or delete an article instance.

No fields.

Retrieve, update or delete an article instance.

No fields.

List galleries for widget GalleriesList, return only necessary fields. method: GET params: widgetHash: hash (widget_xxxxx) page: describes number of page page_size: number for elements on page

Fields:

  • title: ReadOnlyField
  • pub_date: DateTimeField
  • description: ReadOnlyField
  • photos: ListSerializer R

No fields.

No fields.

List tags by POST filtered with models names models field must be a list

No fields.

List all tags, create new tags, update tags

Fields:

  • id: IntegerField
  • pk: IntegerField
  • type_name: CharField
  • name: CharField R
  • type: PrimaryKeyRelatedField R

List all articles, or create a new article.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • slug: CharField
  • category: PrimaryKeyRelatedField
  • age_category: ManyRelatedField
  • widgets: ListSerializer R
  • tags: ListSerializer
  • url: URLField
  • pub_datetime: DateTimeField
  • modified_datetime: DateTimeField
  • is_published: BooleanField
  • vertical_bg_position: ChoiceField
  • horizontal_bg_position: ChoiceField
  • description_pl: CharField
  • description_en: CharField
  • title_pl: CharField R
  • title_en: CharField
  • polymorphic_ctype: PrimaryKeyRelatedField
  • photo: PrimaryKeyRelatedField
  • parent_page: PrimaryKeyRelatedField

Retrieve, update or delete an article instance.

No fields.

Get information about number of articles

No fields.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • slug: CharField
  • age_category: ManyRelatedField
  • widgets: ListSerializer R
  • tags: ListSerializer
  • url: URLField
  • pub_datetime: DateTimeField
  • modified_datetime: DateTimeField
  • is_published: BooleanField
  • vertical_bg_position: ChoiceField
  • horizontal_bg_position: ChoiceField
  • title_pl: CharField R
  • title_en: CharField
  • show_header: BooleanField
  • header_pl: CharField
  • header_en: CharField
  • polymorphic_ctype: PrimaryKeyRelatedField
  • photo: PrimaryKeyRelatedField
  • category: PrimaryKeyRelatedField
  • parent_page: PrimaryKeyRelatedField
  • menu: PrimaryKeyRelatedField

Retrieve, update or delete an subpage instance.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • slug: CharField
  • age_category: ManyRelatedField
  • widgets: ListSerializer R
  • tags: ListSerializer
  • url: URLField
  • pub_datetime: DateTimeField
  • modified_datetime: DateTimeField
  • is_published: BooleanField
  • vertical_bg_position: ChoiceField
  • horizontal_bg_position: ChoiceField
  • title_pl: CharField R
  • title_en: CharField
  • show_header: BooleanField
  • header_pl: CharField
  • header_en: CharField
  • polymorphic_ctype: PrimaryKeyRelatedField
  • photo: PrimaryKeyRelatedField
  • category: PrimaryKeyRelatedField
  • parent_page: PrimaryKeyRelatedField
  • menu: PrimaryKeyRelatedField

Get information about number of subpages

No fields.

Update order in categories

Fields:

  • id: IntegerField
  • pk: IntegerField
  • name_pl: CharField R
  • name_en: CharField
  • order: IntegerField
  • type: PrimaryKeyRelatedField R

List all Categories, or create a new Category.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • name_pl: CharField R
  • name_en: CharField
  • order: IntegerField
  • type: PrimaryKeyRelatedField R

Retrieve, update or delete a Category instance.

No fields.

List all age categories

Fields:

  • id: IntegerField
  • pk: IntegerField
  • name_pl: CharField R
  • name_en: CharField

List all Partners, or create a new Partner.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • url: URLField
  • name_pl: CharField R
  • name_en: CharField
  • description_pl: CharField
  • description_en: CharField
  • photo: PrimaryKeyRelatedField
  • tags: ManyRelatedField R

Retrieve, update or delete a Partner instance.

No fields.

List all People, or create a new Person.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • tags: ListSerializer
  • first_name: CharField R
  • last_name: CharField R
  • email: EmailField
  • mobile: CharField
  • about_pl: CharField
  • about_en: CharField
  • photo: PrimaryKeyRelatedField
  • second_photo: PrimaryKeyRelatedField
  • category: PrimaryKeyRelatedField

Retrieve, update or delete a Person instance.

No fields.

List all menus, or create a new menu.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • items: ListSerializer
  • name: CharField R
  • has_widget: BooleanField
  • is_main_menu: BooleanField
  • order_in_main_menu: IntegerField
  • parent_page: PrimaryKeyRelatedField

Retrieve, update or delete a Menu instance.

No fields.

No fields.

List all MenuItems, or create a new MenuItem.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • entry: SubpageSerializer R
  • link: URLField
  • widget: CharField
  • label_pl: CharField R
  • label_en: CharField
  • order: IntegerField
  • menu: PrimaryKeyRelatedField R

List all MenuItems, or create a new MenuItem.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • entry: SubpageSerializer R
  • link: URLField
  • widget: CharField
  • label_pl: CharField R
  • label_en: CharField
  • order: IntegerField
  • menu: PrimaryKeyRelatedField R

List ParentPages, for moderator return only available

No fields.

List all Quotes, or create a new Quote.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • title_pl: CharField R
  • title_en: CharField

Retrieve, update or delete a quote instance.

No fields.

List all homepage videos, or create a new one.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • hash: CharField R

Retrieve, update or delete a homepage video instance.

No fields.

List all log entries

Fields:

  • id: IntegerField
  • pk: IntegerField
  • user: StringRelatedField
  • action_flag_name: SerializerMethodField
  • content_type_name: SerializerMethodField
  • action_time: DateTimeField
  • object_id: CharField
  • object_repr: CharField R
  • action_flag: IntegerField R
  • change_message: CharField
  • content_type: PrimaryKeyRelatedField

List all entries

Fields:

  • id: IntegerField
  • type: SerializerMethodField
  • title_pl: CharField R
  • pub_datetime: DateTimeField
  • modified_datetime: DateTimeField
  • slug: SlugField
  • is_published: BooleanField
  • vertical_bg_position: ChoiceField
  • horizontal_bg_position: ChoiceField
  • polymorphic_ctype: PrimaryKeyRelatedField
  • photo: PrimaryKeyRelatedField
  • parent_page: PrimaryKeyRelatedField

No fields.

List all tags, create new tags, update tags

Fields:

  • id: IntegerField
  • pk: IntegerField
  • name: CharField R
  • user: ManyRelatedField

List all staff users, or create a new moderator.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • password: CharField R
  • last_login: DateTimeField
  • is_superuser: BooleanField
  • username: CharField R
  • first_name: CharField
  • last_name: CharField
  • email: EmailField
  • is_staff: BooleanField
  • is_active: BooleanField
  • date_joined: DateTimeField
  • groups: ManyRelatedField
  • user_permissions: ManyRelatedField
  • available_pages: ManyRelatedField

List all staff users, or create a new moderator.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • password: CharField R
  • last_login: DateTimeField
  • is_superuser: BooleanField
  • username: CharField R
  • first_name: CharField
  • last_name: CharField
  • email: EmailField
  • is_staff: BooleanField
  • is_active: BooleanField
  • date_joined: DateTimeField
  • groups: ManyRelatedField
  • user_permissions: ManyRelatedField
  • available_pages: ManyRelatedField

No fields.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • widget: WidgetSerializerManager R
  • sort_value: IntegerField R

No fields.

API For main search input search in articles, events, constant events, movies, people and partners :param request: :return:

No fields.

Fields:

  • title: ReadOnlyField

List all events, or create a new event.

Fields:

  • date: DateField R
  • events: ListSerializer

Retrieve, update or delete an event instance.

No fields.

List all movies, or create a new movie.

Fields:

  • id: IntegerField
  • pk: IntegerField
  • tags: ListSerializer
  • widgets: ListSerializer R
  • occurrences: ListSerializer
  • url: URLField
  • pub_datetime: DateTimeField
  • modified_datetime: DateTimeField
  • slug: SlugField
  • is_published: BooleanField
  • vertical_bg_position: ChoiceField
  • horizontal_bg_position: ChoiceField
  • trailer: URLField
  • title_pl: CharField R
  • title_en: CharField
  • description_pl: CharField
  • description_en: CharField
  • place: CharField
  • is_en_sign: BooleanField
  • tickets_list_url: URLField
  • polymorphic_ctype: PrimaryKeyRelatedField
  • photo: PrimaryKeyRelatedField
  • category: PrimaryKeyRelatedField
  • parent_page: PrimaryKeyRelatedField
  • age_category: ManyRelatedField

List all movies, or create a new movie.

Fields:

  • pk: IntegerField
  • title_pl: CharField R

Retrieve, update or delete an movie instance.

No fields.

List all occurrences, or create a new occurrence.

Fields:

  • id: IntegerField
  • bilety24: Bilety24InfoSerializer R
  • datetime: DateTimeField R

Retrieve, an occurrence instance.

No fields.

Get information about number of events

No fields.

No fields.

List all events method: GET params: search: query page: int ageCategories: list with ints (ids) default put there every id (1,2,3) categories: list with ints (ids) startDay: unix timestamp with start date endDay: unix timestamp with end date

Fields:

  • id: IntegerField
  • title: ReadOnlyField
  • photo: PublicPhotoSerializer R
  • description: ReadOnlyField
  • start_date: SerializerMethodField
  • start_time: TimeField R
  • occurrence: PublicOccurrenceSerializer R
  • place: ReadOnlyField
  • category: StringRelatedField
  • url: ReadOnlyField
  • link: URLField
  • get_type: ReadOnlyField
  • ticket_type: ChoiceField R
  • is_special: BooleanField
  • show_in_header: BooleanField
  • ticket_url: ReadOnlyField
  • lead: ReadOnlyField
  • age_category: ManyRelatedField
  • hide_date: BooleanField
  • is_pinned: BooleanField
  • vertical_bg_position: ChoiceField
  • horizontal_bg_position: ChoiceField
  • end_date: SerializerMethodField

List number of days from calendar --- parameters: - startDay : unix timestamp - endDay : unix timestamp - daysNumber : int (currently unused) - page: int - widgetHash: hash (widget_xxxxx) - categories: list of ids - ageCategories: list of ids - q: string

No fields.

List articles for ArticlesListWidget parameters: - widgetHash: hash (widget_xxxxx) (necessary) - page: number - page_size: number

Fields:

  • pk: IntegerField
  • slug: CharField
  • category: CategorySerializer R
  • age_category: ListSerializer R
  • title: ReadOnlyField
  • lead: ReadOnlyField
  • photo: PublicPhotoSerializer R
  • pub_datetime: DateTimeField
  • url: ReadOnlyField
  • date: SerializerMethodField
  • vertical_bg_position: ChoiceField
  • horizontal_bg_position: ChoiceField