s-secure-sdk

Ronda senior X SDK API (S-secure-sdk)

89 views 07/11/2018 15/02/2021 integrador 0

{ swagger: 2.0, info: { version: 1.0.0, title: Ronda senior X SDK API }, host: sam.senior.com.br:8080, basePath: /sdk/v1, schemes: [ http, https ], paths: { /device/biometry: { post: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: includeBiometry, description: New biometry, required: true, schema: { $ref: #/definitions/IncludeBiometry } } ], responses: { 200: { description: Biometry added }, 401: { description: ApiKey is invalid }, 404: { description: Person not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /datamart/biometry: { get: { tags: [ Datamart ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: query, name: personId, description: Person ID, required: false, type: integer, format: int64 }, { in: query, name: cardNumber, description: Card number, required: false, type: integer, format: int64 }, { in: query, name: manufacturer, description: Biometry manufacturer, required: false, type: string, enum: [ FINGERPRINT_SAGEM, FINGERPRINT_SUPREMA, FINGERPRINT_VIRDI, FINGERPRINT_NITGEN, FINGERPRINT_CAMA, FINGERPRINT_INNOVATRICS, HANDKEY_IR, FACIAL ] }, { in: query, name: startDate, description: Get biometries update after this date, required: false, type: string } ], responses: { 200: { description: Return a list of biometrics, schema: { type: array, items: { $ref: #/definitions/PersonTemplates } } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /datamart/cardformat: { get: { tags: [ Datamart ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return a list of card format, schema: { type: array, items: { $ref: #/definitions/CardFormatList } } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /datamart/areacontrol: { get: { tags: [ Datamart ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return a list of are control, schema: { type: array, items: { $ref: #/definitions/AreaControlList } } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /datamart/accesslevel: { get: { tags: [ Datamart ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return a list of access level, schema: { type: array, items: { $ref: #/definitions/AccessLevelList } } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /datamart/holiday: { get: { tags: [ Datamart ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return a list of holiday, schema: { type: array, items: { $ref: #/definitions/HolidayList } } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /datamart/timezone: { get: { tags: [ Datamart ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return a list of time zone, schema: { type: array, items: { $ref: #/definitions/TimezoneList } } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /datamart/person/photo: { get: { tags: [ Datamart ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: query, name: managerDeviceId, description: Manager Device Id, required: true, type: integer, format: int64 }, { in: query, name: cardNumber, description: Card number, required: true, type: integer, format: int64 } ], responses: { 200: { description: Return the person and their photo by card number, schema: { $ref: #/definitions/PersonPhoto } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /driver: { get: { tags: [ Driver ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return the driver associate with a ApiKey, schema: { $ref: #/definitions/Driver } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /driver/datetime: { get: { tags: [ Driver ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return date and time, schema: { $ref: #/definitions/DriverDateTime } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /driver/manufacturer: { post: { tags: [ Driver ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: driver_manufacturer, description: The driver manufacturer name, required: true, schema: { $ref: #/definitions/DriverManufacturer } } ], responses: { 200: { description: Driver manufacturer name updated }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /pendency/success: { post: { tags: [ Pendency ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: id, description: Array of pendencies, required: true, schema: { type: array, items: { $ref: #/definitions/PendencyExecuted } } } ], responses: { 200: { description: All pendencies were marked as done }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /pendency/update: { post: { description: Remove or update pendencies, tags: [ Pendency ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: id, description: Array of pendencies, required: true, schema: { type: array, items: { $ref: #/definitions/PendencyUpdated } } } ], responses: { 200: { description: All pendencies updated }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /pendency/: { get: { tags: [ Pendency ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return all pendencies, schema: { $ref: #/definitions/AllPendency } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /pendency/device/{id}: { get: { tags: [ Pendency ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: path, name: id, description: Device Id, required: true, type: integer, format: int64 } ], responses: { 200: { description: Return all pendencies from a device, schema: { $ref: #/definitions/AllPendency } }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/accessrequest: { post: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: access_request, description: AccessRequest, required: true, schema: { $ref: #/definitions/AccessRequest } } ], responses: { 200: { description: Validation response, schema: { $ref: #/definitions/PersonValidationResponse } }, 401: { description: ApiKey is invalid }, 404: { description: AccessRequest not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/accessrequest/healthcheck: { get: { tags: [ Healthcheck ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Access request healthcheck, schema: { $ref: #/definitions/HealthcheckResponse } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/accessrequest/vehicle: { post: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: access_request, description: AccessRequest, required: true, schema: { $ref: #/definitions/VehicleAccessRequest } } ], responses: { 200: { description: Validation response, schema: { $ref: #/definitions/ValidationResponse } }, 401: { description: ApiKey is invalid }, 404: { description: AccessRequest not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /lpr/accessrequest: { post: { tags: [ LPR ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: access_request, description: AccessRequest, required: true, schema: { $ref: #/definitions/LprAccessRequest } } ], responses: { 200: { description: Validation response, schema: { $ref: #/definitions/LprValidationResponse } }, 401: { description: ApiKey is invalid }, 404: { description: AccessRequest not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/accessrequest/qrcode: { post: { description: Access validation using QRCode., tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: accessRequest, description: Access request data., required: true, schema: { $ref: #/definitions/QRCodeAccessRequest } } ], responses: { 200: { description: Validation response., schema: { $ref: #/definitions/PersonValidationResponse } }, 401: { description: ApiKey is invalid. }, 403: { description: Permission denied. }, 404: { description: QRCode not found. }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/{id}/card: { get: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: path, name: id, description: Device Id, required: true, type: integer, format: int64 } ], responses: { 200: { description: Return a list of card, schema: { type: array, items: { $ref: #/definitions/Card } } }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/rep/{id}/credential: { get: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: path, name: id, description: Device Id, required: true, type: integer, format: int64 } ], responses: { 200: { description: Return a list of credentials allowed to use this REP, schema: { type: array, items: { $ref: #/definitions/PersonRep } } }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/access/{id}/card: { get: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: path, name: id, description: Device Id, required: true, type: integer, format: int64 } ], responses: { 200: { description: Return a list of cards allowed to use this access device, schema: { type: array, items: { $ref: #/definitions/CardList } } }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/access/{id}/biometry: { get: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: path, name: id, description: Device Id, required: true, type: integer, format: int64 } ], responses: { 200: { description: Return a list of biometries allowed to use this access device, schema: { type: array, items: { $ref: #/definitions/AccessBiometry } } }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/collect/status: { post: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: status, description: Input status device, required: true, schema: { $ref: #/definitions/CollectEventStatus } } ], responses: { 200: { description: Collect status added }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/input/status: { post: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: status, description: Input status device, required: true, schema: { $ref: #/definitions/DeviceInputStatus } } ], responses: { 200: { description: Input status added. }, 401: { description: ApiKey is invalid }, 404: { description: Device or input not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/status: { post: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: status, description: Status of device, required: true, schema: { $ref: #/definitions/DeviceStatus } } ], responses: { 200: { description: Status added. }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/{id}: { get: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: path, name: id, description: Device Id, required: true, type: integer, format: int64 } ], responses: { 200: { description: Return a manager devices and your childs, schema: { $ref: #/definitions/ManagerDevice } }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device: { get: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Return all manager devices and your childs, schema: { type: array, items: { $ref: #/definitions/ManagerDevice } } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /device/access/{id}/photo: { get: { tags: [ Device ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: path, name: id, description: Manager Device Id, required: true, type: integer, format: int64 } ], responses: { 200: { description: Return a list of person photo , schema: { type: array, items: { $ref: #/definitions/PersonPhotoTemplates } } }, 401: { description: ApiKey is invalid }, 404: { description: Device not found }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/input/alarm: { post: { description: Notify a array of input alarm, tags: [ Notification ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: Alarm, description: Alarm, required: true, schema: { type: array, items: { $ref: #/definitions/Alarm } } } ], responses: { 200: { description: Alarm processed }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/device/event: { post: { description: Notify a array of device event, tags: [ Notification ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: Event, description: Event, required: true, schema: { type: array, items: { $ref: #/definitions/Event } } } ], responses: { 200: { description: Event processed }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/device/resource: { post: { description: Notify a array of device resource, tags: [ Notification ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: Resource, description: Resource, required: true, schema: { type: array, items: { $ref: #/definitions/Resource } } } ], responses: { 200: { description: Resource processed }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/vehicle/access: { post: { description: Notify a array of vehicle access, tags: [ Notification ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: VehicleAccess, description: Vehicle Access, required: true, schema: { type: array, items: { $ref: #/definitions/VehicleAccess } } } ], responses: { 200: { description: Vehicle access processed }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/healthcheck: { get: { tags: [ Healthcheck ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: Notification healthcheck, schema: { $ref: #/definitions/HealthcheckResponse } }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/person/access: { post: { description: Notify a array of person access, tags: [ Notification ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: Access, description: Access, required: true, schema: { type: array, items: { $ref: #/definitions/Access } } } ], responses: { 200: { description: Access processed }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/person/event: { post: { description: Notify a array of person event, tags: [ Notification ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: PersonEvent, description: Person Event, required: true, schema: { type: array, items: { $ref: #/definitions/PersonEvent } } } ], responses: { 200: { description: Access processed }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/person/clockin: { post: { description: Notify a array of person clock in, tags: [ Notification ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: ClockIn, description: ClockIn, required: true, schema: { type: array, items: { $ref: #/definitions/ClockIn } } } ], responses: { 200: { description: ClockIn processed }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/qrcode/access: { post: { description: Delivers QRCode access notifications., tags: [ Notification ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: accessNotifications, description: QRCode access notifications., required: true, schema: { type: array, items: { $ref: #/definitions/QRCodeAccessNotification } } } ], responses: { 200: { description: Access notifications received. }, 401: { description: ApiKey is invalid. }, 500: { description: Server error., schema: { $ref: #/definitions/ErrorResponse } } } } }, /notify/bluetooth/access: { post: { description: Delivers Bluetooth access notifications., tags: [ Notification ], consumes: [ application/json ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string }, { in: body, name: bluetoothAccessNotifications, description: Bluetooth access notifications., required: true, schema: { type: array, items: { $ref: #/definitions/BluetoothAccessNotification } } } ], responses: { 200: { description: Access notifications received. }, 401: { description: ApiKey is invalid. }, 500: { description: Server error., schema: { $ref: #/definitions/ErrorResponse } } } } }, /server/status: { get: { description: Request the status of server, tags: [ Server ], produces: [ application/json ], parameters: [ { in: header, name: driver_key, description: Driver manufacturer identification token, required: false, type: string }, { in: header, name: api_key, description: ApiKey, required: true, type: string } ], responses: { 200: { description: The server is OK }, 401: { description: ApiKey is invalid }, 500: { description: Server error, schema: { $ref: #/definitions/ErrorResponse } } } } } }, definitions: { Device: { type: object, properties: { id: { type: integer, format: int64 }, areaId: { type: integer, format: int64 } } }, ManagerDevice: { type: object, allOf: [ { $ref: #/definitions/Device }, { properties: { networkIdentification: { type: string }, networkPort: { type: integer }, deviceType: { $ref: #/definitions/DeviceType }, displayMessage: { type: string }, numberOfCardRecords: { type: integer }, turnstileBypassTime: { type: integer }, module: { type: array, items: { $ref: #/definitions/ModuleDevice } }, reader: { type: array, items: { $ref: #/definitions/ReaderDevice } }, output: { type: array, items: { $ref: #/definitions/OutputDevice } }, intput: { type: array, items: { $ref: #/definitions/InputDevice } }, accessMessage: { type: array, items: { $ref: #/definitions/AccessMessage } }, portConfiguration: { type: array, items: { $ref: #/definitions/PortConfiguration } }, repConfiguration: { $ref: #/definitions/RepConfiguration }, extensibleConfiguration: { $ref: #/definitions/ExtensibleConfiguration } } } ] }, AccessMessage: { type: object, properties: { accessType: { $ref: #/definitions/AccessType }, message: { type: string } } }, PortConfiguration: { type: object, properties: { id: { type: integer, format: int64 }, portNumber: { type: integer }, communicationMode: { $ref: #/definitions/CommunicationMode }, txdDriverSettleDelay: { type: integer }, receiveDataValidDelay: { type: integer }, interCharacterTimeout: { type: integer }, controllerReplyTimeout: { type: integer }, pollTime: { type: integer }, offlineDevicePollTime: { type: integer } } }, RepConfiguration: { type: object, properties: { id: { type: integer, format: int64 }, companyName: { type: string }, cnpj: { type: string }, cpf: { type: string }, cei: { type: string }, address: { type: string }, taxNumber: { type: string } } }, ModuleDevice: { type: object, allOf: [ { $ref: #/definitions/Device }, { properties: { deviceType: { $ref: #/definitions/DeviceType }, address: { type: integer }, portNumber: { type: integer }, reader: { type: array, items: { $ref: #/definitions/ReaderDevice } }, output: { type: array, items: { $ref: #/definitions/OutputDevice } }, intput: { type: array, items: { $ref: #/definitions/InputDevice } } } } ] }, ReaderDevice: { type: object, allOf: [ { $ref: #/definitions/Device }, { properties: { output: { type: array, items: { $ref: #/definitions/OutputDevice } }, intput: { type: array, items: { $ref: #/definitions/InputDevice } }, readerTechnology: { $ref: #/definitions/ReaderTechnology }, readerDirection: { $ref: #/definitions/ReaderDirection }, biometricManufacturer: { $ref: #/definitions/BiometricManufacturer }, biometricValidation: { $ref: #/definitions/BiometricValidation }, biometricSecurityLevel: { type: integer }, biometricReaderId: { type: integer, format: int64, description: Biometric reader that will be used by this reader to validate 1:1 biometry. }, physicalAddress: { type: integer }, areaLeaving: { type: integer, format: int64 }, areaEntering: { type: integer, format: int64 }, cardFormatList: { type: array, items: { type: integer, format: int64 } }, strikeTime: { type: integer }, heldOpenTime: { type: integer }, offlineMode: { $ref: #/definitions/ReaderMode }, accessMode: { $ref: #/definitions/ReaderMode }, antiPassbackTime: { type: integer }, enablePairing: { type: boolean }, validateVehicle: { type: boolean }, activations: { type: array, items: { $ref: #/definitions/ReaderActivation } }, extensibleConfiguration: { $ref: #/definitions/ExtensibleConfiguration }, urnSensor: { type: integer, format: int64 }, urnSensorTime: { type: integer } } } ] }, ReaderActivation: { type: object, properties: { actionEventType: { type: integer, description: 0=Access Granted, 1=Access Denied }, outputId: { type: integer, format: int64 }, activationTime: { type: integer, description: Amount of time the activation will be executed (zero is forever). Time in millisecond precision. } } }, InputDevice: { type: object, allOf: [ { $ref: #/definitions/Device }, { properties: { address: { type: integer }, defaultState: { $ref: #/definitions/InputOutputState }, activationDelay: { type: integer }, masking: { type: array, items: { $ref: #/definitions/Masking } }, activations: { type: array, items: { $ref: #/definitions/InputActivation } }, extensibleConfiguration: { $ref: #/definitions/ExtensibleConfiguration } } } ] }, InputActivation: { type: object, properties: { outputId: { type: integer, format: int64 }, activationTime: { type: integer, description: Amount of time the activation will be executed (zero is forever). Time in millisecond precision. } } }, OutputDevice: { type: object, allOf: [ { $ref: #/definitions/Device }, { properties: { address: { type: integer }, defaultState: { $ref: #/definitions/InputOutputState }, extensibleConfiguration: { $ref: #/definitions/ExtensibleConfiguration } } } ] }, PendencyExecuted: { type: object, properties: { pendencyId: { type: integer, format: int64 } } }, CredentialOwnerType: { type: string, enum: [ PERSON, VEHICLE ] }, Card: { type: object, properties: { cardNumber: { type: integer, format: int64 }, cardTechnology: { $ref: #/definitions/CardTechnology }, startValidity: { type: string, format: date-time }, finishValidity: { type: string, format: date-time }, checkAntiPassback: { type: boolean }, ownerType: { $ref: #/definitions/CredentialOwnerType }, ownerId: { type: integer, format: int64 }, areaId: { type: integer, format: int64 }, isVisitor: { type: boolean }, isEscort: { type: boolean }, accessLevel: { type: array, items: { type: integer, format: int64 } } } }, CardRep: { type: object, properties: { cardNumber: { type: integer, format: int64 }, cardTechnology: { $ref: #/definitions/CardTechnology } } }, PersonRep: { type: object, properties: { id: { type: integer, format: int64 }, name: { type: string }, pis: { type: integer, format: int64 }, verifyBiometrics: { type: integer }, cards: { type: array, items: { $ref: #/definitions/CardRep } }, biometries: { type: array, items: { $ref: #/definitions/Biometry } } } }, CardList: { type: object, properties: { cardNumber: { type: integer, format: int64 }, cardTechnology: { $ref: #/definitions/CardTechnology }, reader: { type: array, items: { type: integer } } } }, Driver: { type: object, properties: { id: { type: integer, format: int64 }, name: { type: string }, requestIntervalTime: { type: integer }, waitInterval: { type: integer }, sendCardholders: { type: boolean }, packetSize: { type: integer }, extensibleConfiguration: { $ref: #/definitions/ExtensibleConfiguration } } }, PendencyUpdated: { type: object, properties: { pendencyId: { type: integer, format: int64 }, errorCode: { type: integer }, operation: { type: string, default: REMOVE_PENDENCY, enum: [ REMOVE_PENDENCY, KEEP_PENDENCY ] } } }, StatusField: { type: object, properties: { key: { type: string }, value: { type: string } } }, InputStatusField: { type: object, properties: { inputDeviceId: { type: integer, format: int64 }, status: { type: string, enum: [ DEACTIVATE, ACTIVATE ] } } }, DriverDateTime: { type: object, properties: { dateTime: { type: string } } }, DeviceInputStatus: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { status: { type: array, items: { $ref: #/definitions/InputStatusField } } } } ] }, DeviceStatus: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { status: { type: array, items: { $ref: #/definitions/StatusField } } } } ] }, Pendency: { type: object, properties: { pendencyId: { type: integer, format: int64 } } }, DevicePendency: { type: object, allOf: [ { $ref: #/definitions/Pendency }, { properties: { managerDeviceId: { type: integer, format: int64 } } } ] }, DriverPendency: { type: object, allOf: [ { $ref: #/definitions/Pendency }, { properties: { driverId: { type: integer, format: int64 } } } ] }, DatamartUpdatedPendency: { type: object, allOf: [ { $ref: #/definitions/DriverPendency }, { properties: { datamartObjectType: { $ref: #/definitions/DatamartObjectType } } } ] }, NotificationStatus: { description: Status of connection with server., type: string, default: ONLINE, enum: [ ONLINE, OFFLINE ] }, Notification: { type: object, properties: { deviceId: { type: integer, format: int64 }, date: { description: Notification date in UTC, type: string, format: date-time }, timezoneOffset: { description: Offset in minutes, type: integer }, status: { $ref: #/definitions/NotificationStatus } } }, ApolloIncludeCardPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { $ref: #/definitions/Card } ] }, IncludeCardPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { cardNumber: { type: integer, format: int64 }, cardTechnology: { $ref: #/definitions/CardTechnology }, readerIdList: { type: array, items: { type: integer } } } } ] }, DisplayMessageMode: { type: string, enum: [ ENQUEUE, OVERRIDE ] }, DeviceDisplayMessagePendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { message: { type: string, maxLength: 128 }, duration: { description: Message exibition time duration (milliseconds precision)., type: integer, format: int64 }, mode: { $ref: #/definitions/DisplayMessageMode } } } ] }, BlockDevicePendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { deviceId: { type: integer, format: int64 } } } ] }, SetDeviceEmergencyPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { deviceId: { type: integer, format: int64 } } } ] }, UnsetDeviceEmergencyPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { deviceId: { type: integer, format: int64 } } } ] }, UnblockDevicePendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { deviceId: { type: integer, format: int64 } } } ] }, ActiveDeviceOutputPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { deviceId: { type: integer, format: int64 }, activationTime: { description: Activation time in milliseconds, type: integer, format: int64 } } } ] }, DeactiveDeviceOutputPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { deviceId: { type: integer, format: int64 } } } ] }, ApolloExcludeCardPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { card: { type: integer, format: int64 }, personId: { type: integer, format: int64 } } } ] }, ExcludeCardPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { card: { type: integer, format: int64 } } } ] }, IncludeBiometryPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { personId: { type: integer, format: int64 }, cardList: { type: array, items: { $ref: #/definitions/CardAndTechnology } }, biometry: { $ref: #/definitions/Biometry } } } ] }, ExcludeBiometryPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { personId: { type: integer, format: int64 }, cardList: { type: array, items: { $ref: #/definitions/CardAndTechnology } } } } ] }, LoadHolidayListPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { holidayListId: { type: integer, format: int64 } } } ] }, DeviceUpdatedPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { operation: { type: string, default: DEVICE_CREATED, enum: [ DEVICE_CREATED, DEVICE_UPDATED, DEVICE_REMOVED, DEVICE_CONFIG ] } } } ] }, CollectEventStatus: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { accessEventCount: { type: integer, format: int64 }, alarmEventCount: { type: integer, format: int64 } } } ] }, PersonAreaUpdatedPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { personId: { type: integer, format: int64 }, cardNumber: { type: integer, format: int64 }, areaControl: { type: integer, format: int64 } } } ] }, ManufacturerUpdatedPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { documentType: { $ref: #/definitions/DocumentType }, document: { type: string }, companyName: { type: string }, address: { type: string } } } ] }, CollectEventPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { initialDate: { type: string, format: date-time }, finalDate: { type: string, format: date-time }, initialNSR: { type: integer, format: int64 }, finalNSR: { type: integer, format: int64 } } } ] }, IncludePhotoPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { personId: { type: integer, format: int64 }, personName: { type: string }, photoUrl: { type: string }, cardList: { type: array, items: { $ref: #/definitions/CardInformation } } } } ] }, ExcludePhotoPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { personId: { type: integer, format: int64 } } } ] }, AllPendency: { type: object, properties: { deviceStatus: { type: array, items: { $ref: #/definitions/DevicePendency } }, deviceDateTime: { type: array, items: { $ref: #/definitions/DevicePendency } }, resetDevice: { type: array, items: { $ref: #/definitions/DevicePendency } }, blockDevice: { type: array, items: { $ref: #/definitions/BlockDevicePendency } }, unblockDevice: { type: array, items: { $ref: #/definitions/UnblockDevicePendency } }, setDeviceEmergency: { type: array, items: { $ref: #/definitions/SetDeviceEmergencyPendency } }, unsetDeviceEmergency: { type: array, items: { $ref: #/definitions/UnsetDeviceEmergencyPendency } }, apolloIncludeCard: { type: array, items: { $ref: #/definitions/ApolloIncludeCardPendency } }, apolloExcludeCard: { type: array, items: { $ref: #/definitions/ApolloExcludeCardPendency } }, includeBiometry: { type: array, items: { $ref: #/definitions/IncludeBiometryPendency } }, excludeBiometry: { type: array, items: { $ref: #/definitions/ExcludeBiometryPendency } }, device: { type: array, items: { $ref: #/definitions/DeviceUpdatedPendency } }, loadHolidayList: { type: array, items: { $ref: #/definitions/LoadHolidayListPendency } }, removeHolidayList: { type: array, items: { $ref: #/definitions/DevicePendency } }, activateDeviceOutput: { type: array, items: { $ref: #/definitions/ActiveDeviceOutputPendency } }, deactivateDeviceOutput: { type: array, items: { $ref: #/definitions/DeactiveDeviceOutputPendency } }, datamartUpdated: { type: array, items: { $ref: #/definitions/DatamartUpdatedPendency } }, personLocationUpdated: { type: array, items: { $ref: #/definitions/PersonAreaUpdatedPendency } }, collectEvent: { type: array, items: { $ref: #/definitions/CollectEventPendency } }, inputStatus: { type: array, items: { $ref: #/definitions/DevicePendency } }, manufacturerUpdated: { type: array, items: { $ref: #/definitions/ManufacturerUpdatedPendency } }, updatePersonREP: { type: array, items: { $ref: #/definitions/UpdatePersonREPPendency } }, loadAllowCardList: { type: array, items: { $ref: #/definitions/DevicePendency } }, removeAllowCardList: { type: array, items: { $ref: #/definitions/DevicePendency } }, loadBiometryList: { type: array, items: { $ref: #/definitions/DevicePendency } }, removeBiometryList: { type: array, items: { $ref: #/definitions/DevicePendency } }, includeCard: { type: array, items: { $ref: #/definitions/IncludeCardPendency } }, excludeCard: { type: array, items: { $ref: #/definitions/ExcludeCardPendency } }, deviceDisplayMessage: { type: array, items: { $ref: #/definitions/DeviceDisplayMessagePendency } }, updateFirmware: { type: array, items: { $ref: #/definitions/DevicePendency } }, includePhoto: { type: array, items: { $ref: #/definitions/IncludePhotoPendency } }, excludePhoto: { type: array, items: { $ref: #/definitions/ExcludePhotoPendency } } } }, Event: { type: object, allOf: [ { $ref: #/definitions/Notification }, { properties: { eventType: { type: string, default: DEVICE_STARTED, enum: [ DEVICE_STARTED, DEVICE_ONLINE, DEVICE_OFFLINE, ISSUANCE_OF_TIME_AND_ATTENDANCE_REPORT, STARTED_USING_USB_FISCAL_PORT, PAPER_REEL_REPLACED, LACK_OF_PAPER, LOW_MEMORY, NO_MEMORY, BATTERY_REPLACED, STARTED_USING_BATTERY, STARTED_USING_ENERGY, DEVICE_LOCKED, DEVICE_UNLOCKED, TAMPER, DOOR_HELD_OPEN, DOOR_FORCED_OPEN ] } } } ] }, PersonEvent: { type: object, properties: { personId: { type: integer, format: int64 }, deviceId: { type: integer, format: int64 }, date: { description: Notification date in UTC, type: string, format: date-time }, timezoneOffset: { description: Offset in minutes, type: integer }, normalTemperature: { type: boolean }, temperature: { type: number, format: float }, withMask: { type: boolean }, accessAllowed: { type: boolean } } }, Resource: { type: object, allOf: [ { $ref: #/definitions/Notification }, { properties: { resourceType: { type: string, default: MEMORY, enum: [ MEMORY, BATTERY, PAPER ] }, resourcePercent: { type: integer } } } ] }, PersonCredentialFormat: { type: string, enum: [ CARD, PERSON_ID ] }, VehicleCredentialFormat: { type: string, enum: [ CARD, LICENSE_PLATE ] }, AccessNotification: { type: object, allOf: [ { $ref: #/definitions/Notification }, { properties: { accessType: { $ref: #/definitions/AccessType }, accessDirection: { $ref: #/definitions/AccessDirection } } } ] }, Access: { type: object, allOf: [ { $ref: #/definitions/AccessNotification }, { properties: { cardId: { type: integer, format: int64 }, personId: { type: integer, format: int64 }, creditRange: { type: integer } } } ] }, VehicleAccess: { type: object, allOf: [ { $ref: #/definitions/AccessNotification }, { properties: { vehicleCredentialFormat: { $ref: #/definitions/VehicleCredentialFormat }, licensePlate: { type: string }, vehicleCardId: { type: integer, format: int64 }, PersonCredentialFormat: { $ref: #/definitions/PersonCredentialFormat }, personCardId: { type: integer, format: int64 }, personId: { type: integer, format: int64 } } } ] }, QRCodeAccessNotification: { type: object, allOf: [ { $ref: #/definitions/AccessNotification }, { properties: { qrcode: { type: string } } } ] }, BluetoothAccessNotification: { type: object, allOf: [ { $ref: #/definitions/AccessNotification }, { properties: { credentialId: { type: integer, format: int64 } } } ] }, AccessDirection: { type: string, enum: [ UNKNOWN, ENTRANCE, EXIT ] }, ClockIn: { type: object, allOf: [ { $ref: #/definitions/Notification }, { properties: { nsr: { type: integer, format: int64 }, pis: { type: integer, format: int64 } } } ] }, ErrorResponse: { type: object, properties: { code: { type: integer }, message: { type: string } } }, AccessType: { type: string, enum: [ ACCESS_VALID, ACCESS_DENIED_PERMISSION, ACCESS_DENIED_SITUATION, ACCESS_DENIED_CARD_VALIDITY, ACCESS_DENIED_LEVEL_CONTROLER, ACCESS_DENIED_CREDIT_ACCESS, ACCESS_DENIED_ROLE_RANGE, ACCESS_DENIED_LOCAL_RANGE, ACCESS_DENIED_CARD_NOT_FOUND, ACCESS_VALID_ACCOMPANY, ACCESS_DENIED_ACCOMPANY, ACCESS_DENIED_INVALID_AUTHORIZER, ACCESS_DENIED_WAITING_FOR_NEXT_VALIDATION, ACCESS_DENIED_ANTI_PASSBACK, ACCESS_DENIED_CREDIT_RANGE, ACCESS_DENIED_STOCKING_CONTROL, ACCESS_DENIED_NOT_PARKING_SPACE_TYPE, ACCESS_DENIED_NOT_PARKING_SPACE, ACCESS_COERCION, ACCESS_DENIED_BIOMETRY, ACCESS_DENIED_CARD_FORMAT_ERROR, ACCESS_DENIED_FACILITY_CODE, ACCESS_DENIED_PASSWORD, ACCESS_DENIED_SECOND_CARD_NOT_PRESENTED, ACCESS_DESISTENCE, ACCESS_VALID_AUTHORIZER, ACCESS_VALID_FACILITY_CODE, ACCESS_VALID_FRAUD, ACCESS_VALID_OUT_REPOSE, ACCESS_DENIED, ACCESS_DENIED_CREDENTIAL_NOT_FOUND, ACCESS_DENIED_CREDENTIAL_VALIDITY, ACCESS_DENIED_INVALID_VEHICLE_CREDENTIAL_FORMAT, ACCESS_DENIED_INVALID_VEHICLE_CARD_CREDENTIAL, ACCESS_DENIED_WAITING_VEHICLE, ACCESS_DENIED_READER_NOT_VALIDATE_VEHICLE, ACCESS_DENIED_PERSON_NOT_ASSOCIATED_WITH_VEHICLE, ACCESS_DENIED_CUSTOM_VALIDATION, ACCESS_DENIED_BLOCK_PROVISORY_ON_EXIT, ACCESS_DENIED_CONTROLS_IN_BETWEEN_WORKDAYS, ACCESS_DENIED_WITHOUT_MASK, ACCESS_DENIED_ABNORMAL_TEMPERATURE ] }, BiometricValidation: { type: string, enum: [ NONE, ONE_TO_ONE, BOTH ] }, ReaderDirection: { type: string, enum: [ ENTRANCE, EXIT, BOTH ] }, ReaderTechnology: { type: string, default: UNKNOWN, enum: [ UNKNOWN, BARCODE_CARD, RFID_CARD, SMART_CARD, BIOMETRY, QRCODE, KEYBOARD ] }, CardTechnology: { type: string, default: BARCODE_CARD, enum: [ BARCODE_CARD, RFID_CARD, SMART_CARD, QRCODE ] }, DatamartObjectType: { type: string, default: HOLIDAY, enum: [ HOLIDAY, TIMEZONE, ACCESS_LEVEL, AREA_CONTROLLED, CARD_FORMAT ] }, CommunicationMode: { type: string, default: FULL_DUPLEX, enum: [ FULL_DUPLEX, HALF_DUPLEX ] }, DeviceType: { type: string, default: AAN_32, enum: [ AAN_32, AAN_100, AIO_168, AIM_2SL, AIM_4SL, AP_610, AP_620, AP_625, AP_500, AP_510, AP_520, AIM_1SL, AIM_4, AMS_130, AMS_102 ] }, HolidayList: { type: object, properties: { id: { type: integer, format: int64 }, holiday: { type: array, items: { type: string } } } }, Timezone: { type: object, properties: { start: { type: string }, end: { type: string }, monday: { type: boolean }, tuesday: { type: boolean }, wednesday: { type: boolean }, thursday: { type: boolean }, friday: { type: boolean }, saturday: { type: boolean }, sunday: { type: boolean }, holiday: { type: boolean } } }, TimezoneList: { type: object, properties: { id: { type: integer, format: int64 }, timezone: { type: array, items: { $ref: #/definitions/Timezone } } } }, AreaControlList: { type: object, properties: { id: { type: integer, format: int64 }, gmt: { type: integer }, useDaylightSaving: { type: boolean }, startDaylightSaving: { type: string }, endDaylightSaving: { type: string }, daylightSavingOffset: { type: integer }, checkLevel: { type: boolean }, checkAntiPassback: { type: boolean }, checkCapacity: { type: boolean }, checkAccessCredit: { type: boolean }, checkAccessLevel: { type: boolean }, checkTimezoneLocation: { type: boolean }, checkAccessLevelAuthorizer: { type: boolean }, checkLocationAuthorizer: { type: boolean }, antiPassbackTime: { type: integer, format: int64 } } }, AccessLevelList: { type: object, properties: { id: { type: integer, format: int64 }, readerAndTimezoneList: { type: array, items: { $ref: #/definitions/ReaderAndTimezone } } } }, CardFormatList: { type: object, properties: { id: { type: integer, format: int64 }, numOfBitsOnCard: { type: integer }, numOfBitsFromStartForEvenParity: { type: integer }, numOfBitsToEndForOddParity: { type: integer }, numOfBitsIFacilityCode: { type: integer }, indexFromFirstBitToFirstFacilityCodeBit: { type: integer }, numOfBitsInCardNumber: { type: integer }, indexFromFirstBiToFirstCardNumberBit: { type: integer }, facilityCode: { type: integer, format: int64 }, cardNumberOffset: { type: integer, format: int64 } } }, DocumentType: { type: string, enum: [ CNPJ, CEI, CPF ] }, ReaderMode: { type: string, default: LOCKED, enum: [ LOCKED, CARD_ONLY, PIN_OR_CARD, CARD_AND_PIN, UNLOCKED, FACILITY_CODE_ONLY, CIPHER_LOCK_EMULATION ] }, InputOutputState: { type: string, default: ACTIVE, enum: [ INACTIVE, ACTIVE ] }, ReaderAndTimezone: { type: object, properties: { readerId: { type: integer, format: int64 }, timezoneId: { type: integer, format: int64 } } }, Masking: { type: object, properties: { startTime: { type: string }, finishTime: { type: string }, normalDay: { type: boolean }, saturday: { type: boolean }, sunday: { type: boolean }, holiday: { type: boolean } } }, LprValidationResponse: { type: object, properties: { accessType: { $ref: #/definitions/AccessType } } }, ValidationResponse: { type: object, properties: { accessType: { $ref: #/definitions/AccessType }, verifyBiometry: { type: boolean }, currentOwnerLocation: { type: integer, format: int64 }, personCheckLevel: { type: boolean } } }, PersonValidationResponse: { type: object, allOf: [ { $ref: #/definitions/ValidationResponse }, { properties: { personId: { type: integer, format: int64 } } } ] }, AccessRequest: { type: object, properties: { readerId: { type: integer, format: int64 }, cardId: { type: integer, format: int64 }, personId: { type: integer, format: int64 }, requestDateTime: { type: string, format: date-time } } }, LprAccessRequest: { type: object, properties: { readerId: { type: integer, format: int64 }, licensePlate: { type: string }, generateNotification: { type: boolean } } }, VehicleAccessRequest: { type: object, properties: { readerId: { type: integer, format: int64 }, vehicleCredentialFormat: { type: string, enum: [ LICENSE_PLATE, CARD ] }, vehicleCredential: { type: string }, authorizerPersonCardNumber: { type: integer, format: int64 }, authorizerPersonId: { type: integer, format: int64 }, requestDateTime: { type: string, format: date-time } } }, QRCodeAccessRequest: { type: object, properties: { readerId: { type: integer, format: int64 }, qrcode: { type: string }, requestDateTime: { type: string, format: date-time } } }, Alarm: { type: object, allOf: [ { $ref: #/definitions/Notification }, { properties: { inputState: { $ref: #/definitions/InputOutputState } } } ] }, ExtensibleProperty: { type: object, properties: { id: { type: integer, format: int64 }, key: { type: string }, value: { type: string } } }, ExtensibleConfiguration: { type: object, properties: { id: { type: integer, format: int64 }, name: { type: string }, extensiblePropertyList: { type: array, items: { $ref: #/definitions/ExtensibleProperty } } } }, BiometricOrigin: { type: string, default: PERSON, enum: [ PERSON, CARD, PIS ] }, BiometricManufacturer: { type: string, enum: [ NONE, FINGERPRINT_SAGEM, FINGERPRINT_SUPREMA, FINGERPRINT_VIRDI, FINGERPRINT_NITGEN, FINGERPRINT_CAMA, FINGERPRINT_INNOVATRICS, HANDKEY_IR, FACIAL ] }, UpdatePersonREPPendency: { type: object, allOf: [ { $ref: #/definitions/DevicePendency }, { properties: { operationId: { type: string, enum: [ INCLUDE_CARD, EXCLUDE_CARD, EXCLUDE_PERSON ] }, cardNumber: { type: integer, format: int64 }, cardTechnology: { $ref: #/definitions/CardTechnology }, personId: { type: integer, format: int64 }, personName: { type: string }, pis: { type: integer, format: int64 }, biometricStatus: { type: string, enum: [ NOT_CHANGE, CHANGE, EXCLUDE ] }, verifyBiometrics: { type: string, enum: [ NOT_VALID_BIOMETRY, VALID_CARD_AND_BIOMETRY, ONLY_VALID_BIOMETRY ] }, biometry: { type: array, items: { $ref: #/definitions/Biometry } } } } ] }, Biometry: { type: object, properties: { manufacturer: { $ref: #/definitions/BiometricManufacturer }, biometrySecurityLevel: { type: integer }, templateList: { type: array, description: base64 encoded characters, items: { type: string } } } }, AccessBiometry: { allOf: [ { $ref: #/definitions/Biometry }, { properties: { personId: { type: integer, format: int64 }, cardList: { type: array, items: { $ref: #/definitions/CardAndTechnology } } } } ] }, IncludeBiometry: { type: object, properties: { origin: { $ref: #/definitions/BiometricOrigin }, originId: { type: integer, format: int64 }, manufacturer: { $ref: #/definitions/BiometricManufacturer }, templateList: { type: array, description: base64 encoded characters, items: { type: string } } } }, BiometricTechnologyTemplatesList: { type: object, properties: { manufacturer: { $ref: #/definitions/BiometricManufacturer }, biometrySecurityLevel: { type: integer }, templates: { type: array, description: base64 encoded characters, items: { type: string } } } }, CardAndTechnology: { type: object, properties: { cardNumber: { type: integer, format: int64 }, cardTechnology: { $ref: #/definitions/CardTechnology } } }, CardInformation: { type: object, properties: { cardNumber: { type: integer, format: int64 }, cardTechnology: { $ref: #/definitions/CardTechnology }, startDate: { type: string }, expirationDate: { type: string } } }, HealthcheckStatus: { type: string, enum: [ UP, DOWN ] }, HealthcheckItemResponse: { type: object, properties: { name: { type: string }, status: { $ref: #/definitions/HealthcheckStatus } } }, HealthcheckResponse: { type: object, properties: { status: { $ref: #/definitions/HealthcheckStatus }, checks: { type: array, items: { $ref: #/definitions/HealthcheckItemResponse } } } }, PersonTemplates: { type: object, properties: { personId: { type: integer, format: int64 }, cardList: { type: array, items: { $ref: #/definitions/CardAndTechnology } }, technologies: { type: array, items: { $ref: #/definitions/BiometricTechnologyTemplatesList } } } }, PersonPhoto: { type: object, properties: { personId: { type: integer, format: int64 }, personName: { type: string }, photoUrl: { type: string }, card: { $ref: #/definitions/CardInformation } } }, DriverManufacturer: { type: object, properties: { manufacturerName: { type: string } } }, PersonPhotoTemplates: { type: object, properties: { personId: { type: integer, format: int64 }, name : { type : string }, photoURL : { type : string }, cardList: { type: array, items: { $ref: #/definitions/CardInformation } } } } }}

Este artigo foi útil para você?

Leave A Comment