Aplicação (application)

Aplicação (application)

25 views 17/03/2021 11/05/2021 integrador 0

2.0info: 4.21.4 Aplicação description: Serviço do backend da aplicação do Ronda senior X x-senior-domain: Gestão de Acesso e Segurança x-senior-domain-path: sam x-senior-service-path: application contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /sam/application/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /entities/credential: get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/credential default: description: Error response schema: #/definitions/genericError /entities/credential/{id}:definitions: gender: type: string enum: – UNKNOWN – MALE – FEMALE physicalLocationStatus: type: string enum: – DISABLED – ENABLED offsetDaylightSavingType: type: string enum: – NONE_OFFSET – MINUS_ONE_HOUR – PLUS_ONE_HOUR deviceType: type: string enum: – MANAGER – READER – MODULE – INPUT – OUTPUT deviceSituation: type: string enum: – INACTIVE – ACTIVE deviceCommunicationStatus: type: string enum: – OFFLINE – ONLINE dvrServerType: type: string enum: – DIGIFORT – CAMERITE – MILESTONE – AXXON cameraStatus: type: string enum: – ACTIVE – INACTIVE weekDay: type: string enum: – SUNDAY – MONDAY – TUESDAY – WEDNESDAY – THURSDAY – FRIDAY – SATURDAY validationSetup: type: string enum: – DISABLED – ENABLED – NOT_CONFIGURED statusHistoric: type: string enum: – FUTURE – PRESENT – PAST personSituationType: type: string enum: – ACTIVE – BLOCKED phoneType: type: string enum: – UNDEFINED – WORK – MOBILE – HOME – OTHERS biometricManufacturer: type: string enum: – NONE – FINGERPRINT_SAGEM – FINGERPRINT_SUPREMA – FINGERPRINT_VIRDI – FINGERPRINT_NITGEN – FINGERPRINT_CAMA – FINGERPRINT_INNOVATRICS – HANDKEY_IR – FACIAL vehicleUse: type: string enum: – PRIVATE_USE – COMMON_USE – FREE_USE vehicleColor: type: string enum: – UNDEFINED – BLACK – WHITE – SILVER – RED – GREY – BLUE – YELLOW – GREEN – ORANGE – OTHERS credentialOwner: type: string enum: – PERSON – VEHICLE credentialSituation: type: string enum: – RELEASED – BLOCKED credentialType: type: string enum: – HOLDER – PROVISORY credentialFormat: type: string enum: – CARD – BIOMETRY – LICENSE_PLATE – QRCODE – BLUETOOTH cardTechnology: type: string enum: – NONE – BARCODE_CARD – RFID_CARD – SMART_CARD virtualLobbySituation: type: string enum: – INACTIVE – ACTIVE virtualLobbyMovementType: type: string enum: – ISSUE_ACCESS_CREDENTIAL – REGISTER_LEAVE – REGISTER_ENTRY virtualLobbyActionType: type: string enum: – DISABLE_ACTION – ENABLE_ACTION – ENABLE_ACTION_WITH_TIMEOUT callGenerationType: type: string enum: – DISABLED – ALWAYS – ON_ACCESS_ALLOWED – ON_ACCESS_DENIED accessCallStatus: type: string enum: – CALLING – IN_PROGRESS – FINISHED_TIMED_OUT – FINISHED_ACCESS_ALLOWED – FINISHED_ACCESS_DENIED accessCallOrigin: type: string enum: – DEVICE_INPUT – DEVICE_READER – SELFSERVICE_TERMINAL movementDirection: type: string enum: – EXIT – ENTRANCE inputState: type: string enum: – INACTIVE – ACTIVE incidentPriority: type: string enum: – PLANNED – LOW – MEDIUM – HIGH – CRITICAL outputState: type: string enum: – INACTIVE – ACTIVE readerDeviceTechnology: type: string enum: – BARCODE_CARD – RFID_CARD – SMART_CARD – BIOMETRIC – QRCODE – BLUETOOTH – KEYBOARD biometricValidation: type: string enum: – NONE – ONE_TO_ONE – ONE_TO_MANY readerDirection: type: string enum: – EXIT – ENTRANCE – BOTH biometricOneToOneValidationType: type: string enum: – NONE – OPTIONAL – REQUIRED readerValidationType: type: string enum: – BLOCK_ACCESS – CARD – CARD_OR_PIN – CARD_AND_PIN – ALLOW_ACCESS – FACILITY_CODE accessType: type: string enum: – ACCESS_VALID – ACCESS_DENIED accessEventType: 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 credential: type: object required: – credentialOwner – startDate – credentialSituation – credentialType – credentialFormat – status properties: id: type: integer description: ID person: #/definitions/person vehicle: #/definitions/vehicle credentialOwner: #/definitions/credentialOwner startDate: type: string description: Data Início format: date-time credentialSituation: #/definitions/credentialSituation credentialType: #/definitions/credentialType credentialFormat: #/definitions/credentialFormat biometry: #/definitions/biometry role: #/definitions/role group: #/definitions/group endDate: type: string description: Data Fim format: date-time visitedPerson: #/definitions/person status: #/definitions/statusHistoric cardCredentialList: type: array items: #/definitions/cardCredential description: Credênciais de Cartão virtualLobby: #/definitions/virtualLobby provisoryCredentialReasonId: type: integer description: ID do Motivo da Credencial Provisória accessCall: #/definitions/accessCall scheduling: #/definitions/scheduling lobby: #/definitions/lobby person: type: object required: – name properties: id: type: integer description: ID name: type: string description: Nome gender: #/definitions/gender birthday: type: string description: Data de Nascimento format: date registry: type: string description: Matricula registerDate: type: string description: Data de Cadastro format: date-time lastModificationDate: type: string description: Data da Última Alteração format: date-time photoDate: type: string description: Data da Atualização da Foto format: date-time address: type: string description: Endereço district: type: string description: Bairro city: type: string description: Cidade federalState: type: string description: Estado zipCode: type: string description: Código Postal nationality: type: string description: Nacionalidade lastAccessDate: type: string description: Último Acesso format: date-time currentPhysicalLocation: #/definitions/physicalLocation situation: #/definitions/personSituationType lastAccessAllowedDate: type: string description: Data do Último Acesso Permitido format: date-time lastAccessAllowedPhysicalLocation: #/definitions/physicalLocation physicalLocationWhereLevelUpdated: #/definitions/physicalLocation documents: type: array items: #/definitions/document description: Documento phones: type: array items: #/definitions/phone description: Telefone emails: type: array items: #/definitions/email description: Email personRoles: type: array items: #/definitions/personRole description: Papéis da Pessoa biometries: type: array items: #/definitions/biometry description: Biometrias da Pessoa credentials: type: array items: #/definitions/credential description: Credênciais da pessoa situations: type: array items: #/definitions/personSituation description: Lista de Situação da Pessoa personVehicle: type: array items: #/definitions/personVehicle description: Veículos da Pessoa groups: type: array items: #/definitions/groupPerson description: Grupos organizationalStructuresPerson: type: array items: #/definitions/organizationalStructurePerson description: Estruturas organizacionais da pessoa user: type: array items: #/definitions/user description: Usuário workSchedulePeriods: type: array items: #/definitions/personWorkSchedulePeriod description: Faixas horárias da pessoa physicalLocation: type: object required: – parent – name – status – localTimezone – roleSuspensionValidation – levelValidation – antiPassbackValidation – capacityValidation – accessCreditValidation – roleValidation – slotTimeRoleValidation – slotTimePhysicalValidation – roleAuthorizerValidation – physicalLocationAuthorizerValidation – checkInBetweenWorkdays – antiPassbackTimeout – customValidation – externalPhysicalLocation properties: id: type: integer description: ID parent: type: integer description: Local Físico Pai name: type: string description: Nome status: #/definitions/physicalLocationStatus timeSlotList: #/definitions/timeSlotList localTimezone: #/definitions/localTimezone roleSuspensionValidation: type: boolean description: Realiza Validação da Suspensão do Papel levelValidation: type: boolean description: Realiza Validação do Nível antiPassbackValidation: type: boolean description: Realiza Validação da Antidupla capacityValidation: type: boolean description: Realiza Validação de Lotação accessCreditValidation: type: boolean description: Realiza Validação de Crédito de Acesso roleValidation: type: boolean description: Realiza Validação de Papel slotTimeRoleValidation: type: boolean description: Realiza Validação da Faixa Horária do Papel slotTimePhysicalValidation: type: boolean description: Realiza Validação da Faixa Horária do Local Físico roleAuthorizerValidation: type: boolean description: Realiza Validação do Autorizador do Papel physicalLocationAuthorizerValidation: type: boolean description: Realiza Validação do Autorizador do Local Físico checkInBetweenWorkdays: type: boolean description: Realiza validação de interjonada antiPassbackTimeout: type: integer description: Tempo da Antidupla customValidation: type: boolean description: Realiza Validação Customizada customValidationUrl: type: string description: Url da Validação Customizada externalPhysicalLocation: type: boolean description: Local Físico Externo blueprint: #/definitions/blueprint roleAccessPhysicalLocations: type: array items: #/definitions/roleAccessPhysicalLocation description: Papel Acessa Local Físico timeSlotList: type: object required: – name properties: id: type: integer description: ID name: type: string description: Nome holidayList: #/definitions/holidayList timeSlots: type: array items: #/definitions/timeSlot description: Lista de Faixas holidayList: type: object required: – name properties: id: type: integer description: ID name: type: string description: Nome da Lista de Feriados holiday: type: array items: #/definitions/holiday description: Lista de Feriados holiday: type: object required: – name – holidayDate – recurrent properties: id: type: integer description: ID holidayList: #/definitions/holidayList name: type: string description: Nome do feriado holidayDate: type: string description: Data do Feriado format: date recurrent: type: boolean description: Feriado Recorrente timeSlot: type: object required: – startHour – endHour – monday – tuesday – wednesday – thursday – friday – saturday – sunday – holiday properties: id: type: integer description: ID startHour: type: string description: Hora Inicial endHour: type: string description: Hora Final monday: type: boolean description: Segunda tuesday: type: boolean description: Terça wednesday: type: boolean description: Quarta thursday: type: boolean description: Quinta friday: type: boolean description: Sexta saturday: type: boolean description: Sábado sunday: type: boolean description: Domingo holiday: type: boolean description: Feriado timeSlotList: #/definitions/timeSlotList createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time localTimezone: type: object required: – name – timezone – daylightSaving properties: id: type: integer description: ID name: type: string description: Nome do Local timezone: #/definitions/timezone daylightSaving: type: boolean description: Horário de verão offsetDaylightSaving: #/definitions/offsetDaylightSavingType daylightSavingStartDate: type: string description: Data início do horário de verão format: date daylightSavingFinishDate: type: string description: Data fim do horário de verão format: date timezone: type: object required: – name – timezoneOffset properties: id: type: integer description: ID name: type: string description: Nome do Timezone timezoneOffset: type: integer description: Offset em Minutos do Timezone blueprint: type: object required: – invertedColors properties: id: type: integer description: ID invertedColors: type: boolean description: Cores Invertidas devices: type: array items: #/definitions/blueprintDevice description: Lista de Dispositivos cameras: type: array items: #/definitions/blueprintCamera description: Lista de Câmeras physicalLocationsChildren: type: array items: #/definitions/blueprintPhysicalLocation description: Lista de Locais Físicos physicalLocation: type: array items: #/definitions/physicalLocation description: Local físico blueprintDevice: type: object required: – latitude – longitude – device properties: id: type: integer description: ID latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double device: #/definitions/device blueprint: #/definitions/blueprint device: type: object required: – description – deviceType – situation – physicalLocation – communicationStatus – integrated properties: id: type: integer description: ID parent: #/definitions/device managerDeviceId: type: integer description: Dispositivo gerenciador description: type: string description: Descrição do Dispositivo deviceType: #/definitions/deviceType situation: #/definitions/deviceSituation physicalLocation: #/definitions/physicalLocation communicationStatus: #/definitions/deviceCommunicationStatus integrated: type: boolean description: Dispositivo Integrado extensibleConfiguration: #/definitions/extensibleConfiguration extensibleConfiguration: type: object required: – name properties: id: type: integer description: ID name: type: string description: Nome da Configuração Extensível extensibleProperty: type: array items: #/definitions/extensibleProperty description: Lista de Propriedade Extensível extensibleProperty: type: object required: – key – value properties: id: type: integer description: ID extensibleConfiguration: #/definitions/extensibleConfiguration key: type: string description: Chave value: type: string description: Valor createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time blueprintCamera: type: object required: – latitude – longitude – camera properties: id: type: integer description: ID latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double camera: #/definitions/camera blueprint: #/definitions/blueprint camera: type: object required: – name – isPTZ – physicalLocation – status properties: id: type: integer description: ID name: type: string description: Nome isPTZ: type: boolean description: Câmera PTZ dvrServer: #/definitions/dvrServer cameraServerId: type: string description: Servidor da Câmera streamLink: type: string description: Link do Stream da Câmera physicalLocation: #/definitions/physicalLocation status: #/definitions/cameraStatus cctvProxy: #/definitions/cctvProxy devices: type: array items: #/definitions/cameraDevice description: Relação Câmera e Dispositivos urlStreaming: type: string description: Url de streaming dvrServer: type: object required: – name – dvrServerType – user – password properties: id: type: integer description: ID name: type: string description: Nome do Servidor dvrServerType: #/definitions/dvrServerType user: type: string description: Usuário de Acesso password: type: string description: Senha de Acesso host: type: string description: Identificador de Rede port: type: integer description: Porta de Comunicação networkDomain: type: string description: Domínio de Rede serverId: type: string description: Identificador do Servidor urlPrefix: type: string description: Prefixo da URL cctvProxy: type: object required: – name – host – port properties: id: type: integer description: ID name: type: string description: Nome do Proxy CFTV host: type: string description: Host port: type: integer description: Porta de Comunicação cameraDevice: type: object required: – device properties: id: type: integer description: ID camera: #/definitions/camera device: #/definitions/device blueprintPhysicalLocation: type: object required: – latitude – longitude – physicalLocation properties: id: type: integer description: ID latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double physicalLocation: #/definitions/physicalLocation blueprint: #/definitions/blueprint roleAccessPhysicalLocation: type: object properties: id: type: integer description: ID role: #/definitions/role physicalLocation: #/definitions/physicalLocation role: type: object required: – name – levelValidation – antiPassbackValidation – stockingValidation – creditAccessValidation – workScheduleValidation – timeSlotValidation – roleAuthorizerValidation – physicalLocationAuthorizerValidation – parkingSpaceValidation – physicalLocationValidation – customValidation – inBetweenWorkdaysValidation – usedByProvisory – receiveVisit – integrated properties: id: type: integer description: ID name: type: string description: Nome workSchedule: #/definitions/workSchedule levelValidation: #/definitions/validationSetup antiPassbackValidation: #/definitions/validationSetup stockingValidation: #/definitions/validationSetup creditAccessValidation: #/definitions/validationSetup workScheduleValidation: #/definitions/validationSetup timeSlotValidation: #/definitions/validationSetup roleAuthorizerValidation: #/definitions/validationSetup physicalLocationAuthorizerValidation: #/definitions/validationSetup parkingSpaceValidation: #/definitions/validationSetup physicalLocationValidation: #/definitions/validationSetup customValidation: #/definitions/validationSetup inBetweenWorkdaysValidation: #/definitions/validationSetup usedByProvisory: type: boolean description: Papel Utilizado pelo Provisório receiveVisit: type: boolean description: Papel que Recebe Visita customValidationUrl: type: string description: Url de Validação Customizada inBetweenWorkdaysTimeInHours: type: integer description: Tempo em horas da validação de interjornada inBetweenWorkdaysToleranceInMinutes: type: integer description: Tempo em minutos para tolerância da validação de interjornada personRoles: type: array items: #/definitions/personRole description: Relação Pessoa Papel roleAccessPhysicalLocations: type: array items: #/definitions/roleAccessPhysicalLocation description: Relação de Papel que Acessa o Local Físico roleAccessDevices: type: array items: #/definitions/roleAccessDevice description: Relação de Papel que Acessa o Dispositivo roleAuthorizePhysicalLocations: type: array items: #/definitions/roleAuthorizePhysicalLocation description: Relação de Papel que Autoriza Local Físico authorizerRoles: type: array items: #/definitions/roleAuthorizeRole description: Relação dos Papéis Autorizadores authorizedRoles: type: array items: #/definitions/roleAuthorizeRole description: Relação dos Papéis Autorizados integrated: type: boolean description: Integrado com Ronda Senior inheritSuspensionByImportedRole: type: boolean description: Herdar Suspensões de Papéis Importados roleAccessCreditRangeLists: type: array items: #/definitions/roleAccessCreditRangeList description: Relação Papel Lista de Faixas de Crédito de Acesso workSchedule: type: object required: – name – startDate properties: id: type: integer description: ID name: type: string description: Nome startDate: type: string description: Data Inicial format: date periods: type: array items: #/definitions/workSchedulePeriod description: Períodos da Escala createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time workSchedulePeriod: type: object required: – weekDay properties: id: type: integer description: ID workSchedule: #/definitions/workSchedule weekDay: #/definitions/weekDay slotTimes: type: array items: #/definitions/workScheduleSlotTime description: Faixas Horárias da Escala createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time workScheduleSlotTime: type: object required: – startHour – endHour properties: id: type: integer description: ID workSchedulePeriod: #/definitions/workSchedulePeriod startHour: type: string description: Hora Inicial endHour: type: string description: Hora Final createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personRole: type: object required: – startDate properties: id: type: integer description: ID person: #/definitions/person role: #/definitions/role startDate: type: string description: Data Início format: date-time endDate: type: string description: Data Fim format: date-time status: #/definitions/statusHistoric personRoleSuspensions: type: array items: #/definitions/personRoleSuspension description: Suspensões de Papéis personRoleSuspension: type: object required: – startDate – justification properties: id: type: integer description: ID personRole: #/definitions/personRole startDate: type: string description: Data Início format: date-time endDate: type: string description: Data Fim format: date-time justification: type: string description: Justificativa status: #/definitions/statusHistoric roleAccessDevice: type: object properties: id: type: integer description: ID role: #/definitions/role device: #/definitions/device roleAuthorizePhysicalLocation: type: object properties: id: type: integer description: ID role: #/definitions/role physicalLocation: #/definitions/physicalLocation roleAuthorizeRole: type: object properties: id: type: integer description: ID authorizerRole: #/definitions/role authorizedRole: #/definitions/role roleAccessCreditRangeList: type: object properties: id: type: integer description: ID accessCreditRangeList: #/definitions/accessCreditRangeList role: #/definitions/role accessCreditRangeList: type: object required: – name properties: id: type: integer description: ID name: type: string description: Nome da Lista holidayList: #/definitions/holidayList accessCreditRanges: type: array items: #/definitions/accessCreditRange description: Lista de Faixas de Crédito de Acesso accessCreditRange: type: object required: – startHour – endHour – monday – tuesday – wednesday – thursday – friday – saturday – sunday – holiday properties: id: type: integer description: ID startHour: type: string description: Hora Inicial endHour: type: string description: Hora Final monday: type: boolean description: Segunda tuesday: type: boolean description: Terça wednesday: type: boolean description: Quarta thursday: type: boolean description: Quinta friday: type: boolean description: Sexta saturday: type: boolean description: Sábado sunday: type: boolean description: Domingo holiday: type: boolean description: Feriado accessCreditRangeList: #/definitions/accessCreditRangeList document: type: object required: – documentType – document properties: id: type: integer description: ID person: #/definitions/person documentType: #/definitions/documentType document: type: string description: Documento documentType: type: object required: – name – label – required – useOnREP properties: id: type: integer description: ID name: type: string description: Nome do Tipo de Documento label: type: string description: Label de Apresentação mask: type: string description: Máscara required: type: boolean description: Documento Obrigatório useOnREP: type: boolean description: Documento Utilizado pelo REP phone: type: object required: – number properties: id: type: integer description: ID person: #/definitions/person preferential: type: boolean description: Telefone Preferencial idd: type: integer description: DDI/IDD (International Direct Dialing) number: type: string description: Número do Telefone phoneExtension: type: string description: Ramal phoneType: #/definitions/phoneType email: type: object required: – email properties: id: type: integer description: ID person: #/definitions/person preferential: type: boolean description: Email Preferencial email: type: string description: Documento biometry: type: object required: – biometricManufacturer properties: id: type: integer description: ID person: #/definitions/person biometricManufacturer: #/definitions/biometricManufacturer templates: type: array items: #/definitions/biometryTemplate description: Templates Biométricos biometryTemplate: type: object required: – template properties: id: type: integer description: ID biometry: #/definitions/biometry template: type: string description: Template format: byte personSituation: type: object required: – blockDate properties: id: type: integer description: ID person: #/definitions/person blockDate: type: string description: Data do Bloqueio format: date-time blockReason: type: string description: Motivo do Bloqueio unblockDate: type: string description: Data do Desbloqueio format: date-time unblockProcedure: type: string description: Procedimento de Desbloqueio unblockJustification: type: string description: Justificativa do Desbloqueio personVehicle: type: object properties: id: type: integer description: ID person: #/definitions/person vehicle: #/definitions/vehicle startDate: type: string description: Data Início format: date-time endDate: type: string description: Data Fim format: date-time status: #/definitions/statusHistoric vehicle: type: object required: – vehicleUse – manufacturer – model – plate properties: id: type: integer description: ID vehicleUse: #/definitions/vehicleUse manufacturer: type: string description: Fabricante model: type: string description: Modelo plate: type: string description: Placa role: #/definitions/role physicalLocation: #/definitions/physicalLocation lastAccess: type: string description: Data do Último Acesso format: date-time personVehicles: type: array items: #/definitions/personVehicle description: Pessoa Veículo credentials: type: array items: #/definitions/credential description: Credênciais do Veículo color: #/definitions/vehicleColor groupPerson: type: object properties: id: type: integer description: ID person: #/definitions/person group: #/definitions/group group: type: object required: – name – parkingSpace – parkingSpaceInUse properties: id: type: integer description: ID parent: #/definitions/group name: type: string description: Nome do Grupo physicalLocation: #/definitions/physicalLocation parkingSpace: type: integer description: Vaga de Estacionamento parkingSpaceInUse: type: integer description: Vaga de Estacionamento em Uso people: type: array items: #/definitions/groupPerson description: Pessoas do Grupo fullHierarchicalPath: type: string description: Caminho hierárquico completo organizationalStructurePerson: type: object properties: id: type: integer description: ID organizationalStructure: #/definitions/organizationalStructure person: #/definitions/person organizationalStructure: type: object required: – parent – organizationalStructureType – description – integrated properties: id: type: integer description: ID parent: type: integer description: Estrutura organizacional pai organizationalStructureType: #/definitions/organizationalStructureType description: type: string description: Descrição integrated: type: boolean description: Realiza Validação de Papel organizationalStructurePeople: type: array items: #/definitions/organizationalStructurePerson description: Pessoas da estrutura organizacional organizationalStructureType: type: object required: – name properties: id: type: integer description: ID name: type: string description: Nome user: type: object required: – person – login properties: id: type: integer description: ID person: #/definitions/person login: type: string description: Login localTimeZone: #/definitions/localTimezone credentialStandardRole: #/definitions/role personWorkSchedulePeriod: type: object required: – weekDay properties: id: type: integer description: ID person: #/definitions/person weekDay: #/definitions/weekDay timeSlots: type: array items: #/definitions/personWorkScheduleTimeSlot description: Faixas Horárias da Escala createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time personWorkScheduleTimeSlot: type: object required: – startHour – endHour properties: id: type: integer description: ID workSchedulePeriod: #/definitions/personWorkSchedulePeriod startHour: type: string description: Hora Inicial endHour: type: string description: Hora Final createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time cardCredential: type: object required: – cardTechnology – cardNumber properties: id: type: integer description: ID credential: #/definitions/credential cardTechnology: #/definitions/cardTechnology cardNumber: type: integer description: Número do Cartão virtualLobby: type: object required: – name – physicalLocation – originPhysicalLocation – destinationPhysicalLocation – situation properties: id: type: integer description: ID name: type: string description: Nome description: type: string description: Descrição physicalLocation: #/definitions/physicalLocation originPhysicalLocation: #/definitions/physicalLocation destinationPhysicalLocation: #/definitions/physicalLocation group: #/definitions/group situation: #/definitions/virtualLobbySituation cameras: type: array items: #/definitions/virtualLobbyCamera description: Câmeras da Portaria Virtual actions: type: array items: #/definitions/virtualLobbyAction description: Acionamentos da Portaria Virtual devices: type: array items: #/definitions/virtualLobbyDevice description: Dispositivos da Portaria Virtual virtualLobbyCamera: type: object required: – camera properties: id: type: integer description: ID camera: #/definitions/camera virtualLobby: #/definitions/virtualLobby virtualLobbyAction: type: object required: – name – isActive properties: id: type: integer description: ID name: type: string description: Nome virtualLobby: #/definitions/virtualLobby virtualLobbyMovementType: #/definitions/virtualLobbyMovementType isActive: type: boolean description: Acionamento Ativo outputs: type: array items: #/definitions/virtualLobbyActionOutput description: Saídas do Acionamento virtualLobbyActionOutput: type: object required: – outputDevice – virtualLobbyActionType properties: id: type: integer description: ID virtualLobbyAction: #/definitions/virtualLobbyAction outputDevice: #/definitions/device virtualLobbyActionType: #/definitions/virtualLobbyActionType actionTime: type: integer description: Tempo do Acionamento virtualLobbyDevice: type: object required: – device – callGenerationType – virtualLobbyAction properties: id: type: integer description: ID device: #/definitions/device virtualLobby: #/definitions/virtualLobby callGenerationType: #/definitions/callGenerationType virtualLobbyAction: #/definitions/virtualLobbyAction accessCall: type: object required: – creationDate – accessCallStatus – accessCallOrigin – virtualLobbyMovementType properties: id: type: integer description: ID creationDate: type: string description: Data da Criação format: date-time startDate: type: string description: Data Início format: date-time endDate: type: string description: Data Fim format: date-time accessCallStatus: #/definitions/accessCallStatus accessCallOrigin: #/definitions/accessCallOrigin userName: type: string description: Nome usuário virtualLobby: #/definitions/virtualLobby virtualLobbyMovement: #/definitions/virtualLobbyMovement virtualLobbyMovementType: #/definitions/virtualLobbyMovementType visitAccessCall: #/definitions/visitAccessCall inputDeviceAccessCall: #/definitions/inputDeviceAccessCall readerDeviceAccessCall: #/definitions/readerDeviceAccessCall virtualLobbyMovement: type: object required: – virtualLobby – visitor – visited – responsible – movementDirection – createdAt – role properties: id: type: integer description: ID virtualLobby: #/definitions/virtualLobby visitor: #/definitions/person visited: #/definitions/person responsible: #/definitions/person movementDirection: #/definitions/movementDirection createdAt: type: string description: Data de criação format: date-time role: #/definitions/role accessCall: #/definitions/accessCall visitAccessCall: type: object required: – personCaller – scheduledCredential properties: id: type: integer description: ID personCaller: #/definitions/person accessCall: #/definitions/accessCall scheduledCredential: #/definitions/scheduledCredential scheduledCredential: type: object required: – person – scheludingDate – group – endDate properties: id: type: integer description: ID person: #/definitions/person scheludingDate: type: string description: Data do Agendamento format: date-time credentialFormat: #/definitions/credentialFormat role: #/definitions/role group: #/definitions/group endDate: type: string description: Data Final format: date-time visitedPerson: #/definitions/person locator: type: string description: Localizador visitedPlace: #/definitions/physicalLocation inputDeviceAccessCall: type: object required: – inputDevice properties: id: type: integer description: ID accessCall: #/definitions/accessCall inputDevice: #/definitions/inputDevice inputDevice: type: object required: – generateIncident – address – defaultState – activationDelay – incidentType – incidentPriority – description – deviceType – situation – physicalLocation – communicationStatus – integrated properties: id: type: integer description: ID generateIncident: type: boolean description: Gera Incidente address: type: integer description: Endereço defaultState: #/definitions/inputState activationDelay: type: integer description: Delay de Ativação da Entrada inputState: #/definitions/inputState incidentType: #/definitions/incidentType incidentPriority: #/definitions/incidentPriority masks: type: array items: #/definitions/inputMasking description: Mascaramentos da Entrada activations: type: array items: #/definitions/outputDeviceActivations description: Acionamentos parent: #/definitions/device description: type: string description: Descrição do Dispositivo deviceType: #/definitions/deviceType situation: #/definitions/deviceSituation physicalLocation: #/definitions/physicalLocation communicationStatus: #/definitions/deviceCommunicationStatus integrated: type: boolean description: Dispositivo Integrado extensibleConfiguration: #/definitions/extensibleConfiguration incidentType: type: object required: – name – defaultPriority properties: id: type: integer description: ID name: type: string description: Nome defaultPriority: #/definitions/incidentPriority inputMasking: type: object required: – startHour – endHour – businessDays – saturday – sunday – holiday properties: id: type: integer description: ID inputDevice: #/definitions/inputDevice startHour: type: string description: Hora Inicial endHour: type: string description: Hora Final businessDays: type: boolean description: Dias da Semana saturday: type: boolean description: Sábado sunday: type: boolean description: Domingo holiday: type: boolean description: Feriado outputDeviceActivations: type: object required: – outputDevice – activationTime properties: id: type: integer description: ID inputDevice: #/definitions/inputDevice outputDevice: #/definitions/outputDevice activationTime: type: integer description: Tempo do Acionamento outputDevice: type: object required: – address – defaultState – description – deviceType – situation – physicalLocation – communicationStatus – integrated properties: id: type: integer description: ID address: type: integer description: Endereço defaultState: #/definitions/outputState parent: #/definitions/device description: type: string description: Descrição do Dispositivo deviceType: #/definitions/deviceType situation: #/definitions/deviceSituation physicalLocation: #/definitions/physicalLocation communicationStatus: #/definitions/deviceCommunicationStatus integrated: type: boolean description: Dispositivo Integrado extensibleConfiguration: #/definitions/extensibleConfiguration readerDeviceAccessCall: type: object required: – readerDevice – credential – accessEventType properties: id: type: integer description: ID accessCall: #/definitions/accessCall readerDevice: #/definitions/readerDevice credential: #/definitions/credential accessEventType: #/definitions/accessEventType readerDevice: type: object required: – address – readerDeviceTechnology – biometricValidation – biometricOneToOneValidationType – validateVehicle – description – deviceType – situation – physicalLocation – communicationStatus – integrated properties: id: type: integer description: ID address: type: integer description: Endereço readerDeviceTechnology: #/definitions/readerDeviceTechnology biometricValidation: #/definitions/biometricValidation biometricManufacturer: #/definitions/biometricManufacturer relatedReader: #/definitions/readerDevice biometryLevel: type: integer description: Nível de Conferência Biométrica readerDirection: #/definitions/readerDirection urnSensorTime: type: integer description: Tempo do Sensor de Urna urnSensor: #/definitions/device parkingSpaceControll: type: boolean description: Controla Vagas accessTime: type: integer description: Tempo de Acesso biometricOneToOneValidationType: #/definitions/biometricOneToOneValidationType onlineReaderValidationType: #/definitions/readerValidationType offlineReaderValidationType: #/definitions/readerValidationType originPhysicalLocation: #/definitions/physicalLocation destinyPhysicalLocation: #/definitions/physicalLocation releaseProvisoryOnExit: type: boolean description: Baixa Provisório na Saída blockProvisoryOnExit: type: boolean description: Bloqueia Provisório na Saída validateVehicle: type: boolean description: Valida Veículo heldOpenTime: type: integer description: Tempo do Alarme de Porta Aberta pairingInReaderInterface: type: boolean description: Leitora Pairada headKeyId: type: string description: Identificador da Leitora HeadKey cardFormats: type: array items: #/definitions/readerDeviceCardFormat description: Formatos de Cartão activations: type: array items: #/definitions/readerDeviceAction description: Saídas do Acionamento parent: #/definitions/device description: type: string description: Descrição do Dispositivo deviceType: #/definitions/deviceType situation: #/definitions/deviceSituation physicalLocation: #/definitions/physicalLocation communicationStatus: #/definitions/deviceCommunicationStatus integrated: type: boolean description: Dispositivo Integrado extensibleConfiguration: #/definitions/extensibleConfiguration readerDeviceCardFormat: type: object required: – cardFormat properties: id: type: integer description: ID readerDevice: #/definitions/readerDevice cardFormat: #/definitions/cardFormat cardFormat: type: object required: – name – facilityCode – bitsShift – cardLength – oddBitsLength – evenBitsLength – facilityCodeLength – facilityCodeStart – cardNumberLength – cardNumberStart – defaultAllReaders properties: id: type: integer description: ID name: type: string description: Nome do Formato facilityCode: type: integer description: Código de Acesso bitsShift: type: integer description: Deslocamento de Bits cardLength: type: integer description: Quantidade de Bits do Cartão oddBitsLength: type: integer description: Quantidade de Bits de Paridade Ímpar evenBitsLength: type: integer description: Quantidade de Bits de Paridade Par facilityCodeLength: type: integer description: Quantidade de Bits do Código de Acesso facilityCodeStart: type: integer description: Bit de Ínicio do Código de Acesso cardNumberLength: type: integer description: Quantidade de Bits do Número do Cartão cardNumberStart: type: integer description: Bit de Ínicio do Número do Cartão defaultAllReaders: type: boolean description: Padrão Para Todas as Leitoras createdBy: type: string description: createdDate: type: string description: format: date-time lastModifiedBy: type: string description: lastModifiedDate: type: string description: format: date-time readerDeviceAction: type: object required: – accessType – activationTime properties: id: type: integer description: ID readerDevice: #/definitions/readerDevice outputDevice: #/definitions/outputDevice accessType: #/definitions/accessType activationTime: type: integer description: Tempo do Acionamento scheduling: type: object properties: id: type: integer description: ID lobby: type: object properties: id: type: integer description: ID name: type: string description: Nome da portaria isActive: type: boolean description: Estado da portaria genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment