API

Xəbərləri əldə et

GET/api/crm/v2/newsv2
operationId: news.default

İstifadəçinin dilinə tərcümə olunmuş xəbərləri qaytarır. URL-dəki ədədi seqment həmin id-yə malik bir yazını qaytarır.

Avtorizasiya

api-token + language + role

Cavablar

OK

object
statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject
filtersobject
date_fromobject (FilterDateFrom)
valuestringnull ola bilər

Nümunə: 2026-08-01 00:00:00

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

date_rangeobject (FilterDateRange)

Hazır tarix aralığı filtrləri; aşağı sərhəd istifadəçinin saat qurşağında hesablanır. value — cari *_from və *_to-ya uyğun olan aralıq; null — istənilən aralıq. default — serverin tarixsiz sorğuda təyin etdiyi aralıq: həmçinin bölmə ilk dəfə yüklənəndə və sıfırlama zamanı tətbiq olunur. Aralığın yuxarı sərhədi həmişə istifadəçinin cari gününə bərabərdir, buna görə option onu ehtiva etmir: hazır aralıq üçün *_to göndərmək lazım deyil, server onu özü təyin edir. Bir ildən uzun aralıq yeni sərhəd tərəfindən kəsilir.

valuestring (DateRange) null ola bilər

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

defaultstring (DateRange) mütləq

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

typestringmütləq

Nümunə: select

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

optionarray of objectmütləq
valuestring (DateRange) mütləq

Hazır tarix aralığı filtri. Bunun üçün ayrıca sorğu parametri yoxdur: aşağı sərhəd artıq hesablanmış şəkildə option daxilində gəlir və *_from sahəsinə əlavə olunur. Yuxarı sərhəd nə cavabda, nə də sorğuda ötürülmür — o, həmişə istifadəçinin cari gününə bərabərdir və server tərəfindən təyin olunur.

Dəyərlər:todaythree_daysweektwo_weeksmonthquarterhalf_yearyear

Nümunə: today

date_fromstringmütləq

Nümunə: 25/08/2026

date_toobject (FilterDateTo)
valuestringnull ola bilər

Nümunə: 2026-08-31 23:59:59

typestringmütləq

Nümunə: date

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

listarray of object
idintegermütləq

Nümunə: 1

date_publicationstring (DataTimeFormatSQL) mütləq

Nümunə: 2024-05-02 08:31:16

titlestringmütləq

Nümunə: News item

imagestring

Nümunə: https://cdn.foodsoul.test/news/39.jpg?v1724923848

contentstringmütləq

Nümunə: Best regards, the FoodSoul team

paginationobject (Pagination)
max_countintegermütləq

Səhifədəki elementlərin sayı

Nümunə: 30

page_numberintegermütləq

Cari səhifənin nömrəsi; offset 1000-dən çox olmamaqla məhdudlaşdırılıb

Nümunə: 1

has_nextbooleanmütləq

Növbəti səhifə varmı

Nümunə: true

has_previousbooleanmütləq

Əvvəlki səhifə mövcuddurmu

Nümunə: false

Tapılmadı