Get multiple Identifier items with link_id
Get multiple Identifier items with link_id
.
This can be used by 3d-party management system. Link adds to each identifier and apartment link_id
and apartment_link_id
to link them together.
Query Parameters
- limit integer
Possible values: [
10
,20
,30
,50
]Number of items. Value by default is 10
- page_number integer
Possible values:
>= 1
Page number
- sort_field string
Field name (JSON Key in item entity)
- sort_type string
Possible values: [
asc
,desc
]Default value:
asc
Sort type (asc/desc)
- filter object
Filtering options for Identifiers
- 200
- 401
- 403
OK
- application/json
- Schema
- Example (from schema)
- Example-1
Schema
list_items object[]
Identifier with link ID
identifier_owner object
Identifier owner information
name stringUser name
type stringPossible values: [
owner
,guest
]Identifier owner type
identifier_type stringPossible values: [
card
,ukey
,inputCode
,face_id
,qr
,license_plate
]Identifier type
identifier_number string-
hex, number or face eigenvalue data in Base64 - This param ignored if you create face identifier by uploading image
-
hex or dec if identifier_type is card or ukey
-
dec if identifier_type is inputCode
-
uuid if identifier_type is qr
-
pattern for hex and dec - [0-9]{1,10} or ([0-9A-Fa-f]{2}[:-]){1,7}([0-9A-Fa-f]{2})
lock stringPossible values: [
first
,second
,all
]Lock
valid object
Access restriction by time and passes
time object
Restriction by time
is_permanent booleanIf enabled Identifier will has permanent access by time
from int64Unix Timestamp Date
to int64Unix Timestamp Date
passes object
Restriction by passes
is_permanent booleanIf enabled Identifier will has permanent access by passes
max_passes integerPossible values:
>= 1
Max passes count. If Identifier is permanent this field is not required
face_image stringOptional field which allow to add face images in base64 format via link_id, if face_image field is defined, identifier_number ignored, and generates automatically
time_profiles object
List of unique entity ids of apartments, identifiers, timeprofiles, forwards. Typically used for bulk delete operations
link_ids uuid[]List of Link IDs
link_id uuidUnique entity set by the server to bind some parameters with each other. By default return null value
apartment_link_id uuidUnique entity set by the server to bind some parameters with each other. By default return null value
additional object
Passes left
passes_left int32Passes left
list_option object
This model provides the options can be used to sort, filter and pagination when getting list of identifiers
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
filter object
Available set of filters for the identifier table
anyOf- MOD1
- MOD2
- MOD3
filter_field stringField available for filtering
filter_type stringPossible values: [
equal
]Available filtering type, only equal here
filter_format stringData format, only string here
filter_value stringIdentifier name
filter_field stringField available for filtering
filter_type stringPossible values: [
equal
]Available filtering type, only equal here
filter_format stringData format, only string here
filter_value stringIdentifier number
filter_field stringField available for filtering
filter_type stringPossible values: [
equal
]Available filtering type, only equal here
filter_format stringlink_id format, only string here
filter_value stringLink id
sort object
Available sorting options for the identifiers table
field stringSorting field name
asc booleanSort direction
available_fields string[]Available for sorting fields names
{
"list_items": [
{
"identifier_owner": {
"name": "Sherlock Holmes",
"type": "owner"
},
"identifier_type": "ukey",
"identifier_number": "12345678",
"lock": "first",
"valid": {
"time": {
"is_permanent": false,
"from": 1540819272,
"to": 1540819272
},
"passes": {
"is_permanent": false,
"max_passes": 3
}
},
"face_image": "/9j/4RVGRXhpZgAATU0AKgAAAAgADAEAAAMAAAABA8IAAAEBAAMAAAABBQAAAAECAAMAAAADAAAAngEGAAMAAAABAAIAAAESAAMAAAABAAEAAA",
"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": 5
}
}
],
"list_option": {
"pagination": {
"total_items": 18,
"items_limit": 10,
"total_pages": 2,
"current_page": 1
},
"filter": {
"filter_field": "name",
"filter_type": "equal",
"filter_format": "string",
"filter_value": "Sherlock Holmes"
},
"sort": {
"field": "name",
"asc": true,
"available_fields": [
"name"
]
}
}
}
{
"list_items": [
{
"identifier_owner": {
"name": "Sherlock Holmes",
"type": "owner"
},
"identifier_type": "ukey",
"identifier_number": "12345678",
"face_image": "ZXabXBsZSBmb3IgZmFjZSBpZA==",
"lock": "first",
"valid": {
"time": {
"is_permanent": false,
"from": 1540819272,
"to": 1540819272
},
"passes": {
"is_permanent": false,
"max_passes": 3
}
},
"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_option": {
"pagination": {
"total_items": 18,
"items_limit": 10,
"total_pages": 2,
"current_page": 1
},
"filter": {
"filter_field": "name",
"filter_type": "equal",
"filter_format": "string",
"filter_value": "Sherlock Holmes",
"available_filtering": true,
"available_fields": [
"identifier_number",
"link_id"
],
"is_filtered": true
},
"sort": {
"field": "name",
"asc": true,
"available_fields": [
"name"
]
}
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Example
Schema
- error string
Error message
{
"error": "Log In"
}
{
"error": "Log In"
}
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
- error string
Error message
{
"error": "Administrator rights required"
}
{
"error": "Administrator rights required"
}