API

Hangi klientide aadressid

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

Autoriseerimine

api-token + language + role

Päringu parameetrid

chain_idinteger

Näide: 1

branch_idinteger
phone_format_idinteger

Näide: 1

phone_numberstring

Näide: 9999999999

downloadstring

Väärtused:yes

Näide: yes

Vastused

OK

object
statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject
filtersobject
branch_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

phone_format_idobject (FilterSelectInteger)
valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object
valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

phone_numberobject (FilterInput)
valuestring

Näide: example

typestringkohustuslik

Näide: integer or string

placeholderstring

Näide: string

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

downloadobject (FilterButtonDownloadCsv)

Allalaadimisnupp: vajutamisel edastage download=yes

valuestring

Näide: Download

typestringkohustuslik

Näide: button_download_csv

listarray of object
idintegerkohustuslik

Näide: 1

address_namestringkohustuslik

Näide: test

typestringkohustuslik

Väärtused:homeworkparentschildrenfriendscountry_househotelother

Näide: other

zip_codestring

Näide: 680045

line_1string

Näide: 19, Pobedy street, Khabarovsk, 680045, Russia

line_2string

Näide: example

streetstring

Näide: Pobedy street

housestring

Näide: 19

buildingstring

Näide: 1

entrance_numberstring

Näide: 1

entrance_codestring

Näide: 11

floorstring

Näide: 111

apartmentstring

Näide: 111

phone_format_idinteger

Näide: 1

phone_numberstring

Näide: 9999999999

client_namestring

Näide: client name

city_namestring

Näide: Khabarovsk

paginationobject (Pagination)
max_countintegerkohustuslik

Elementide arv lehel

Näide: 30

page_numberintegerkohustuslik

Praeguse lehekülje number; piiratud nii, et nihe ei ületaks 1000

Näide: 1

has_nextbooleankohustuslik

Kas on järgmine lehekülg

Näide: true

has_previousbooleankohustuslik

Kas eelmine lehekülg on olemas

Näide: false