listLabels
List label values from zbozi PLA feed.
Parameters
| struct |
user { |
|
| string |
session |
Session (as retrieved from client.loginByToken())
|
| int |
userId |
(optional) Managed user ID
|
|
} |
|
|
| struct |
restrictionFilter { |
restrict results with these options
|
| int |
premiseId |
zbozi premise id
|
| array |
labels ( |
(optional) restrict result to these labels only (labels must be in lowercase format)
|
|
|
) |
|
|
|
} |
|
|
| struct |
displayOptions { |
|
| int |
offset |
index of first instance in the result
|
| int |
limit |
max number of returned instances in the result
|
| string |
lang |
(optional) language choice [default: cz]:
-
cz:
label names in czech
-
en:
label names in english
|
|
} |
|
|
Response
| struct |
{ |
|
| int |
status |
Status code (see bellow)
|
| string |
statusMessage |
Status code description
|
| string |
session |
(optional) Refreshed session
|
| array |
labels ( |
|
| struct |
{ |
|
| string |
label |
name of label
|
| string |
labelTitle |
name of label (human readable)
|
| string |
labelType |
type of label
|
| array |
values ( |
|
| struct |
{ |
|
| string |
value |
value for given label
|
| string |
valueTitle |
(optional) human readable value, if applicable
|
|
} |
|
|
|
) |
|
|
|
} |
|
|
|
) |
|
|
| array |
diagnostics ( |
(optional) Various diagnostics(warnings, errors, other information)
|
|
|
) |
|
|
|
} |
|
|
Response status codes:
List of all possible response status codes:
200: OK206: Partially OK301: User is serviced400: Bad arguments401: Invalid session403: Access Denied404: Not found406: Bad values of attributes413: Too many items requested.429: Too many requests. Has to wait.500: Server Error.409: Conflict
Diagnostics:
List of all possible diagnostics:
missing_attributeunknown_labeluser_access_denieduser_not_linked_to_plawrong_label_typewrong_param_value
