Get multiple Identifier items with link_id
Get multiple Identifier items with link_id
.
This can be used by 3d-patry management system. Link adds to each identifier and apartment link_id
and apartment_link_id
to link them together.
Query Parameters
- limit integer required
Possible values: [
10
,20
,30
,50
]Default value:
10
Number of items. Value by default is 10
- page_number integer required
Possible values:
>= 1
Default value:
1
Page number
- order_by string
sorting expression:
[field name 1], [field name 2]... <order (asc or desc)>
- filter string
Filtering expression:
[field name] [compare operator] [value] <logical operator>...
field name see the list of available fields in filter.available_fields[].field_name
value see the list of available values in filter.available_fields[].options object
, may be missingcompare operator see the list of available operators in filter.available_fields[].compare_operators array
Compare operators Description Example eq Equal name eq 'Sherlock Holmes' gt Greater than building gt 10 lt Less than building lt 10 nq Not equal name nq 'Sherlock Holmes' ge Greater than or equal floor ge 5 le Less than or equal floor le 5 Logical operators and logical AND floor le 10 and floor gt 3 or logical OR floor le 3 or floor gt 10 not logical NOT not floor le 3 group operations () group by priority (name eq 'Sherlock Holmes' or building eq 221) and floor gt 10
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
- list_items object[]
list of identifiers
list_options object
Available options for sorting, filtering and pagination of lists
pagination object
Available pagination options for tables
total_items integerThe total number of items found and reflected across all pages
items_limit integerPossible values: [
10
,25
,50
]Limiting the display of the amount of data for one page
total_pages integerPossible values:
>= 1
The number of pages that hold the requested data
current_page integerPossible values:
>= 1
Current page number
sort object
this schema describes identifier sort options
is_sorted booleantrue - sorted, false - unsorted
order stringPossible values: [
asc
,desc
]order of sorting, asc - ascending, desc - descending
available_fields string[]Possible values: [
name
,identifier_number
]Available for sorting fields names
filter object
Available fields
field name compare operators type values owner_name eq, nq string owner_type eq, nq string owner, guest identifier_number eq, nq string identifier_type eq, nq string card, ukey, inputCode, qr available_filtering booleanis filtering available
is_filtered booleanis filter applied
available_fields object[]
list of fields available for filtering
field_name stringcompare_operators string[]Possible values: [
eq
,gt
,lt
,nq
,ge
,le
]data_type stringPossible values: [
string
,integer
,timestamp
]options object
anyOf- MOD1
- MOD2
- MOD3
- MOD4
available_values object[]Possible values:
>= 1
This model provide filter available values
available_range integer[]Possible values:
>= 2
,<= 2
This model provide filter integer range
available_values_localized string[]the field is used only for UI localization and is not a filter value.
has_date booleanDefault value:
false
true - has date, false - doesn't
has_time booleanDefault value:
false
true - has time, false - doesn't
has_milliseconds booleanDefault value:
false
true - has milliseconds, false - doesn't
{
"list_items": [
{
"identifier_owner": {
"name": "Sherlock Holmes",
"type": "owner"
},
"identifier_type": "ukey",
"identifier_number": "12345678",
"lock": "first",
"valid": {
"time": {
"is_permanent": true,
"from": 1540819272,
"to": 1540819272
},
"passes": {
"is_permanent": true,
"max_passes": 2
}
},
"time_profiles": {
"link_ids": [
"91c615e3-1040-4815-8ecb-039a18b756b5"
]
},
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"apartment_link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"additional": {
"passes_left": 4
}
}
],
"list_options": {
"pagination": {
"total_items": 18,
"items_limit": 10,
"total_pages": 2,
"current_page": 1
},
"sort": {
"is_sorted": true,
"order": "asc",
"available_fields": [
"identifier_number"
]
},
"filter": {
"available_filtering": true,
"is_filtered": true,
"available_fields": [
{
"field_name": "category",
"compare_operators": [
"eq"
],
"data_type": "string",
"options": {
"available_values": [
"string",
0
]
}
}
]
}
}
}
{
"list_items": [
{
"identifier_owner": {
"name": "Sherlock Holmes",
"type": "owner"
},
"identifier_type": "ukey",
"identifier_number": "12345678",
"lock": "first",
"valid": {
"time": {
"is_permanent": true,
"from": 1540819272,
"to": 1540819272
},
"passes": {
"is_permanent": true,
"max_passes": 0
}
},
"time_profiles": {
"link_ids": [
"91c615e3-1040-4815-8ecb-039a18b756b5"
]
},
"link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"apartment_link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
"additional": {
"passes_left": 0
}
}
],
"list_options": {
"pagination": {
"total_items": 18,
"items_limit": 10,
"total_pages": 2,
"current_page": 1
},
"sort": {
"is_sorted": true,
"order": "asc",
"available_fields": [
"name",
"identifier_number"
]
},
"filter": {
"available_filtering": true,
"is_filtered": true,
"available_fields": [
{
"field_name": "link_id",
"compare_operators": [
"eq",
"nq"
],
"data_type": "string",
"options": {}
}
]
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- error string
error message
{
"error": "Log In"
}
{
"error": "Log In"
}