API

Iegūt klientu adreses

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

Autorizācija

api-token + language + role

Vaicājuma parametri

chain_idinteger

Piemērs: 1

branch_idinteger
phone_format_idinteger

Piemērs: 1

phone_numberstring

Piemērs: 9999999999

downloadstring

Vērtības:yes

Piemērs: yes

Atbildes

OK

object
statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object
valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

phone_numberobject (FilterInput)
valuestring

Piemērs: example

typestringobligāts

Piemērs: integer or string

placeholderstring

Piemērs: string

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

downloadobject (FilterButtonDownloadCsv)

Lejupielādes poga: nospiežot, pārsūtiet download=yes

valuestring

Piemērs: Download

typestringobligāts

Piemērs: button_download_csv

listarray of object
idintegerobligāts

Piemērs: 1

address_namestringobligāts

Piemērs: test

typestringobligāts

Vērtības:homeworkparentschildrenfriendscountry_househotelother

Piemērs: other

zip_codestring

Piemērs: 680045

line_1string

Piemērs: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Piemērs: example

streetstring

Piemērs: Pobedy street

housestring

Piemērs: 19

buildingstring

Piemērs: 1

entrance_numberstring

Piemērs: 1

entrance_codestring

Piemērs: 11

floorstring

Piemērs: 111

apartmentstring

Piemērs: 111

phone_format_idinteger

Piemērs: 1

phone_numberstring

Piemērs: 9999999999

client_namestring

Piemērs: client name

city_namestring

Piemērs: Khabarovsk

paginationobject (Pagination)
max_countintegerobligāts

Elementu skaits lapā

Piemērs: 30

page_numberintegerobligāts

Pašreizējās lapas numurs; ierobežots tā, lai nobīde nepārsniegtu 1000

Piemērs: 1

has_nextbooleanobligāts

Vai ir nākamā lapa

Piemērs: true

has_previousbooleanobligāts

Vai ir iepriekšējā lapa

Piemērs: false