API

კლიენტების მისამართების მიღება

GET/api/crm/v2/clients_addressesv2
operationId: clientsAddresses.default

ავტორიზაცია

api-token + language + role

მოთხოვნის პარამეტრები

chain_idinteger

მაგალითი: 1

branch_idinteger
phone_format_idinteger

მაგალითი: 1

phone_numberstring

მაგალითი: 9999999999

downloadstring

მნიშვნელობები:yes

მაგალითი: yes

პასუხები

OK

object
statusstringსავალდებულო

მნიშვნელობები:successerror

მაგალითი: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

მაგალითი: 8920

typestringსავალდებულო

მაგალითი: select

optionarray of object
valueintegerსავალდებულო

მაგალითი: 8920

namestringსავალდებულო

მაგალითი: Green Basket | Kaliningrad

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

მაგალითი: 8920

typestringსავალდებულო

მაგალითი: select

optionarray of object
valueintegerსავალდებულო

მაგალითი: 8920

namestringსავალდებულო

მაგალითი: Green Basket | Kaliningrad

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

phone_numberobject (FilterInput)
valuestring

მაგალითი: example

typestringსავალდებულო

მაგალითი: integer or string

placeholderstring

მაგალითი: string

modestring (FilterMode)

როგორ ამუშავებს ინტერფეისი ფილტრს; ჩვეულებრივ ფილტრს mode არ აქვს. force_shown — ყოველთვის ნაჩვენებია, დამალვა შეუძლებელია. value_required — განყოფილების შესვლის წერტილი: ყოველთვის ნაჩვენებია, ცარიელი მნიშვნელობა არ აქვს (სანამ მნიშვნელობა არ არის არჩეული, სია ცარიელია; ვარიანტი „ყველა“ არ არსებობს), საერთო გასუფთავება მას არ აშორებს.

მნიშვნელობები:force_shownvalue_required

მაგალითი: value_required

downloadobject (FilterButtonDownloadCsv)

ჩამოტვირთვის ღილაკი: დაჭერისას გადააგზავნეთ download=yes

valuestring

მაგალითი: Download

typestringსავალდებულო

მაგალითი: button_download_csv

listarray of object
idintegerსავალდებულო

მაგალითი: 1

address_namestringსავალდებულო

მაგალითი: test

typestringსავალდებულო

მნიშვნელობები:homeworkparentschildrenfriendscountry_househotelother

მაგალითი: other

zip_codestring

მაგალითი: 680045

line_1string

მაგალითი: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

მაგალითი: example

streetstring

მაგალითი: Pobedy street

housestring

მაგალითი: 19

buildingstring

მაგალითი: 1

entrance_numberstring

მაგალითი: 1

entrance_codestring

მაგალითი: 11

floorstring

მაგალითი: 111

apartmentstring

მაგალითი: 111

phone_format_idinteger

მაგალითი: 1

phone_numberstring

მაგალითი: 9999999999

client_namestring

მაგალითი: client name

city_namestring

მაგალითი: Khabarovsk

paginationobject (Pagination)
max_countintegerსავალდებულო

გვერდზე ელემენტების რაოდენობა

მაგალითი: 30

page_numberintegerსავალდებულო

მიმდინარე გვერდის ნომერი; შეზღუდულია ისე, რომ წანაცვლება არ აღემატებოდეს 1000-ს

მაგალითი: 1

has_nextbooleanსავალდებულო

არის თუ არა შემდეგი გვერდი

მაგალითი: true

has_previousbooleanსავალდებულო

არის თუ არა წინა გვერდი

მაგალითი: false