📚post

Get information about published contents

Request Object

In a post action (not to be confused with HTTP POST method !) there must be two object:

• filter : an object that describes the characteristics of the desired contents

• select : an array containing content properties.

filter object

you can filter your content based of various options, these options will be applied together..

keyword	type	description
id	number	post unique id it will be useful for selecting single content.
type	string	content type can only accepts sims OR videos don't send it if you want all content types.
class	string	content Scientific field options:ریاضی , فیزیک , زیست , علوم , شیمی
category	number	category id
relatedto	number	contents related to a post id
search	string	text based search in content
sort	string	sort content (DESC) can only accepts posts (default, based on posts id) , views , likes
limit	number	number of contents default is 20
offset	number	number of skipping contents

select array

you can choose which content properties should be returned in respond object.

keyword	description	respond object example
id	post unique id	"id": 8
title	post title	"title": "مدار الکتریکی"
views	post views	"views": 4852
likes	post likes	"likes": 985
poster	Featured image for post in webp format	"poster": { "src": "https://example.com/img.webp", "minsrc": "https://example.com/img_min.webp" }
class	content Scientific field	"class": "فیزیک"
category	content category id and name	"category": { "id": 3, "name": "مغناطیس" }
date	post date	"date": { "fa": "۲۷ فروردین ۱۴۰۲", "en": "2023-04-16" }
author	post author	"author": { "id": 1, "name": "علی کرمی", "src": "https://example.com/profile.webp" }
tags	an array of tag objects	"tags": [ { "id": 88, "name": "اهنربا" }, { "id": 75, "name": "میدان مغناطیسی" } ]
points	an array of education points of post	"points": [ "نکته اول", "نکته دوم" ]
description	post description in HTML format	"description": "<p>در این مبحث..."
iframe	post iframe link	"iframe": "https://example.com/index.html"

Import css files! description needs to be styled so you need to have these files on your page, also we don't hardcoded any fonts so feel free to use your own!

https://byazma.ir/res/css/quill2.min.css https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css

Respond Object

Similar to request object there is filter and select in respond object.

filter object

This contains useful information about filtered content.

keyword	type	description
count	number	number of total selectable contents
class	string[]	all unique class names in selectable contents
limit	number	number of contents default is 20
offset	number	number of skipping contents
category	object[]	array of all selectable contents category objects

select object

an array of post objects containing selected properties.

Example Request

request object

{
  "post": {
    "filter": {
      "type" : "sims",
      "limit": 2
    },
    "select": [
      "id","title","poster","category","author","class"
    ]
  }
}

respond object

{
  "status": 200,
  "body": {
    "post": {
      "filter": {
        "count": 138,
        "limit": 2,
        "offset": 0,
        "class": [
          "ریاضی","زیست","شیمی","علوم","فیزیک"           
        ],
        "category": [
          {
            "category_id": 1,
            "category_name": "الکتریسیته ساکن"
          },
          {
            "category_id": 2,
            "category_name": "کار و انرژی"
          },
          {
            "category_id": 3,
            "category_name": "مغناطیس"
          },
          {
            "category_id": 4,
            "category_name": "نور و تابش"
          },
          {
            "category_id": 5,
            "category_name": "گرما"
          }
          ...
        ]
      },
      "select": [
        {
          "id": 145,
          "title": "جک هیدرولیک",
          "poster": {
            "src": "https://byazma.ir/res/posters/sims_poster_37188.webp",
            "minsrc": "https://byazma.ir/res/posters/min_sims_poster_37188.webp"
          },
          "class": "فیزیک",
          "category": {
            "id": 10,
            "name": "شاره ها"
          },
          "author": {
            "id": 9,
            "name": "فاطمه فرشادی",
            "src": "https://byazma.ir/res/profile/f.farshadi2.webp"
          }
        },
        {
          "id": 144,
          "title": "پیل سوختی",
          "poster": {
            "src": "https://byazma.ir/res/posters/sims_poster_29633.webp",
            "minsrc": "https://byazma.ir/res/posters/min_sims_poster_29633.webp"
          },
          "class": "شیمی",
          "category": {
            "id": 18,
            "name": "الکتروشیمی"
          },
          "author": {
            "id": 11,
            "name": "شهره امیرقلی",
            "src": "https://byazma.ir/res/profile/sh.amirgholi.webp"
          }
        }
      ]
    }
  }
}