sam

lobby

23 views 10/07/2019 14/11/2019 integrador 0

2.0info: 2.6.3 lobby description: Gestao de Portaria x-senior-domain: sam x-senior-domain-path: sam x-senior-service-path: lobby contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/samsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /lobby/queries/healthcheck: post: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck default: description: Error response schema: #/definitions/genericError get: description: Endpoint para verificação da saúde do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckStatus description: Status geral do healthcheck checks: type: array items: type: object allOf: – #/definitions/healthcheckItem minimum: 1 description: Itens verificados no healthcheck default: description: Error response schema: #/definitions/genericError /lobby/queries/validateVisitor: post: description: Realiza as validações para um novo visitante em um novo agendamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visitor – scheduling properties: visitor: type: object allOf: – #/definitions/visitor description: O visitante que será validado scheduling: type: object allOf: – #/definitions/scheduling description: O agendamento ao qual o visitante será validado responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/queries/getPhotoServiceURL: post: description: Busca a URL para o serviço de fotos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – photoServiceURL properties: photoServiceURL: type: string description: A URL do serviço default: description: Error response schema: #/definitions/genericError get: description: Busca a URL para o serviço de fotos tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – photoServiceURL properties: photoServiceURL: type: string description: A URL do serviço default: description: Error response schema: #/definitions/genericError /lobby/queries/getLatestRealizedProceduresByPeople: post: description: Busca informações sobre procedimentos realizados por pessoas. Traz a ocorrência mais recente em caso de múltiplas ocorrências do mesmo procedimento para uma pessoa. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – peopleIds – procedureIds properties: peopleIds: type: array items: type: integer format: int64 minimum: 1 description: Identificadores de pessoas procedureIds: type: array items: type: integer format: int64 minimum: 1 description: Identificadores de procedimentos responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/personProcedure description: Procedimentos realizados pelas pessoas default: description: Error response schema: #/definitions/genericError get: description: Busca informações sobre procedimentos realizados por pessoas. Traz a ocorrência mais recente em caso de múltiplas ocorrências do mesmo procedimento para uma pessoa. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: peopleIds description: Identificadores de pessoas in: query required: true type: array items: type: integer format: int64 minimum: 1 – name: procedureIds description: Identificadores de procedimentos in: query required: true type: array items: type: integer format: int64 minimum: 1 responses: 200: description: Ok schema: type: object properties: contents: type: array items: type: object allOf: – #/definitions/personProcedure description: Procedimentos realizados pelas pessoas default: description: Error response schema: #/definitions/genericError /lobby/queries/getCurrentDateTime: post: description: Busca a data e hora atual do banco de dados (precisão de hora somente até minutos) tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – currentDateTime properties: currentDateTime: type: string format: date-time description: A data e hora (precisão de hora somente até minutos, os millisegundos são descartados) default: description: Error response schema: #/definitions/genericError get: description: Busca a data e hora atual do banco de dados (precisão de hora somente até minutos) tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – currentDateTime properties: currentDateTime: type: string format: date-time description: A data e hora (precisão de hora somente até minutos, os millisegundos são descartados) default: description: Error response schema: #/definitions/genericError /lobby/queries/getLastCardProvisoryCredential: post: description: Busca a última credencial provisória pelo identificador da pessoa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId properties: personId: type: integer format: int64 description: Identificador da pessoa responses: 200: description: Ok schema: type: object required: – credential properties: credential: type: object allOf: – #/definitions/provisoryCredentialRecord description: A credencial que foi encontrada default: description: Error response schema: #/definitions/genericError get: description: Busca a última credencial provisória pelo identificador da pessoa tags: – Queries x-senior-visibility: PRIVATE parameters: – name: personId description: Identificador da pessoa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – credential properties: credential: type: object allOf: – #/definitions/provisoryCredentialRecord description: A credencial que foi encontrada default: description: Error response schema: #/definitions/genericError /lobby/queries/getSchedulingDetails: post: description: Retorna um registro com os detalhes do agendamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – schedulingId properties: schedulingId: type: integer format: int64 description: Identificador do agendamento responses: 200: description: Ok schema: type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/schedulingRecord description: O registro com os detalhes do agendamento default: description: Error response schema: #/definitions/genericError get: description: Retorna um registro com os detalhes do agendamento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: schedulingId description: Identificador do agendamento in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/schedulingRecord description: O registro com os detalhes do agendamento default: description: Error response schema: #/definitions/genericError /lobby/queries/getSchedulingListForSchedulerView: post: description: Retorna uma lista de agendamentos para a visão do agendador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: situation: type: string allOf: – #/definitions/visitSituation description: Filtro opcional da situação da visita visitorName: type: string description: Filtro opcional por nome do visitante size: type: integer format: int64 description: Filtro opcional da quantidade de registros offset: type: integer format: int64 description: Filtro opcional de offset dos registros responses: 200: description: Ok schema: type: object required: – schedulingList – totalElements properties: schedulingList: type: array items: type: object allOf: – #/definitions/schedulingForSchedulerViewRecord minimum: 1 description: A lista de registros de agendamento totalElements: type: integer format: int64 description: Total de registros existentes default: description: Error response schema: #/definitions/genericError /lobby/queries/getPhysicalLocation: post: description: Retorna uma lista com locais físicos ativos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: name: type: string description: Filtro opcional do nome do local físico size: type: integer format: int64 description: Filtro opcional da quantidade de registros minimum: 1 default: 10 offset: type: integer format: int64 description: Filtro opcional de offset dos registros minimum: 0 default: 0 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – physicalLocations properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Total de registros existentes physicalLocations: type: array items: type: object allOf: – #/definitions/physicalLocationRecord minimum: 1 description: Lista com os locais físicos default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com locais físicos ativos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Filtro opcional do nome do local físico in: query type: string – name: size description: Filtro opcional da quantidade de registros in: query type: integer format: int64 – name: offset description: Filtro opcional de offset dos registros in: query type: integer format: int64 responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – physicalLocations properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Total de registros existentes physicalLocations: type: array items: type: object allOf: – #/definitions/physicalLocationRecord minimum: 1 description: Lista com os locais físicos default: description: Error response schema: #/definitions/genericError /lobby/queries/listVisitedPeople: post: description: Retorna a lista de pessoas visitadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: name: type: string description: Nome da pessoa document: type: string description: Documento documentTypeId: type: integer format: int64 description: Identificador do Tipo de Documento searchDate: type: string format: date-time description: Data a ser considerada na validação do papel size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 orderby: type: string description: Parâmetro de ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/personRecord minimum: 1 description: Lista de pessoas default: description: Error response schema: #/definitions/genericError get: description: Retorna a lista de pessoas visitadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Nome da pessoa in: query type: string – name: document description: Documento in: query type: string – name: documentTypeId description: Identificador do Tipo de Documento in: query type: integer format: int64 – name: searchDate description: Data a ser considerada na validação do papel in: query type: string format: date-time – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 – name: orderby description: Parâmetro de ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos contents: type: array items: type: object allOf: – #/definitions/personRecord minimum: 1 description: Lista de pessoas default: description: Error response schema: #/definitions/genericError /lobby/queries/listPersonLookup: post: description: Retorna uma lista de Pessoas para ser utilizado no componente Lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Campo de busca por nome ou documento documentTypeId: type: integer format: int64 description: Identificador do Tipo de Documento size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Número da página minimum: 0 default: 0 orderby: type: string description: Parâmetro de ordenação responses: 200: description: Ok schema: type: object required: – contents – totalPages – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/personRecord minimum: 1 description: Lista de pessoas totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista de Pessoas para ser utilizado no componente Lookup tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchText description: Campo de busca por nome ou documento in: query type: string – name: documentTypeId description: Identificador do Tipo de Documento in: query type: integer format: int64 – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Número da página in: query type: integer format: int64 – name: orderby description: Parâmetro de ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – contents – totalPages – totalElements properties: contents: type: array items: type: object allOf: – #/definitions/personRecord minimum: 1 description: Lista de pessoas totalPages: type: integer format: int64 description: Número total de páginas totalElements: type: integer format: int64 description: Número total de elementos default: description: Error response schema: #/definitions/genericError /lobby/queries/getSchedulingFromDocument: post: description: Retorna o agendamento de um visitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – document – documentTypeId – lobbyId properties: document: type: string description: Documento documentTypeId: type: integer format: int64 description: Identificador do Tipo de Documento lobbyId: type: integer format: int64 description: Identificador da portaria responses: 200: description: Ok schema: type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/schedulingForVisitorRecord description: Agendamento default: description: Error response schema: #/definitions/genericError get: description: Retorna o agendamento de um visitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: document description: Documento in: query required: true type: string – name: documentTypeId description: Identificador do Tipo de Documento in: query required: true type: integer format: int64 – name: lobbyId description: Identificador da portaria in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/schedulingForVisitorRecord description: Agendamento default: description: Error response schema: #/definitions/genericError /lobby/queries/getSchedulingFromPerson: post: description: Retorna o agendamento de um visitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId – lobbyId properties: personId: type: integer format: int64 description: Identificador da pessoa lobbyId: type: integer format: int64 description: Identificador da portaria responses: 200: description: Ok schema: type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/schedulingForVisitorRecord description: Agendamento default: description: Error response schema: #/definitions/genericError get: description: Retorna o agendamento de um visitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: personId description: Identificador da pessoa in: query required: true type: integer format: int64 – name: lobbyId description: Identificador da portaria in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/schedulingForVisitorRecord description: Agendamento default: description: Error response schema: #/definitions/genericError /lobby/queries/faceMatch: post: description: Retorna a pessoa reconhecida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – photo – fileName – similarity properties: photo: type: string format: byte description: Foto fileName: type: string description: Nome da foto similarity: type: integer format: int64 description: Similaridade responses: 200: description: Ok schema: type: object required: – faceVerificationResult properties: faceVerificationResult: type: array items: type: object allOf: – #/definitions/faceVerificationResultRecord minimum: 1 description: Resultado do reconhecimento facial default: description: Error response schema: #/definitions/genericError get: description: Retorna a pessoa reconhecida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: photo description: Foto in: query required: true type: string format: byte – name: fileName description: Nome da foto in: query required: true type: string – name: similarity description: Similaridade in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – faceVerificationResult properties: faceVerificationResult: type: array items: type: object allOf: – #/definitions/faceVerificationResultRecord minimum: 1 description: Resultado do reconhecimento facial default: description: Error response schema: #/definitions/genericError /lobby/queries/faceVerification: post: description: Retorna a pessoa reconhecida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – photo – fileName – similarity – personId properties: photo: type: string format: byte description: Foto fileName: type: string description: Nome da foto similarity: type: integer format: int64 description: Similiaridade personId: type: integer format: int64 description: Identificador da pessoa responses: 200: description: Ok schema: type: object required: – faceVerificationResult properties: faceVerificationResult: type: object allOf: – #/definitions/faceVerificationResultRecord description: Resultado do reconhecimento facial default: description: Error response schema: #/definitions/genericError get: description: Retorna a pessoa reconhecida tags: – Queries x-senior-visibility: PRIVATE parameters: – name: photo description: Foto in: query required: true type: string format: byte – name: fileName description: Nome da foto in: query required: true type: string – name: similarity description: Similiaridade in: query required: true type: integer format: int64 – name: personId description: Identificador da pessoa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – faceVerificationResult properties: faceVerificationResult: type: object allOf: – #/definitions/faceVerificationResultRecord description: Resultado do reconhecimento facial default: description: Error response schema: #/definitions/genericError /lobby/queries/getSchedulingFromLocator: post: description: Retorna o agendamento de um visitante via código localizador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – locator – lobbyId properties: locator: type: string description: Código localizador lobbyId: type: integer format: int64 description: Identificador da portaria responses: 200: description: Ok schema: type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/schedulingForVisitorRecord description: Agendamento default: description: Error response schema: #/definitions/genericError get: description: Retorna o agendamento de um visitante via código localizador tags: – Queries x-senior-visibility: PRIVATE parameters: – name: locator description: Código localizador in: query required: true type: string – name: lobbyId description: Identificador da portaria in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/schedulingForVisitorRecord description: Agendamento default: description: Error response schema: #/definitions/genericError /lobby/queries/physicalLocationLookup: post: description: Busca locais físicos contendo texto no nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: Termo de busca default: size: type: integer format: int64 description: Quantidade de registros por página minimum: 1 default: 10 offset: type: integer format: int64 description: Índice da página (inicia em zero) minimum: 0 default: 0 orderBy: type: string description: Parâmetro de ordenação default: responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/simplePhysicalLocationRecord minimum: 1 description: Locais com nome contendo termo de busca default: description: Error response schema: #/definitions/genericError get: description: Busca locais físicos contendo texto no nome tags: – Queries x-senior-visibility: PRIVATE parameters: – name: searchTerm description: Termo de busca in: query type: string – name: size description: Quantidade de registros por página in: query type: integer format: int64 – name: offset description: Índice da página (inicia em zero) in: query type: integer format: int64 – name: orderBy description: Parâmetro de ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements – contents properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de elementos contents: type: array items: type: object allOf: – #/definitions/simplePhysicalLocationRecord minimum: 1 description: Locais com nome contendo termo de busca default: description: Error response schema: #/definitions/genericError /lobby/queries/getVisitorSchedulingExceededTheLimitOnWeek: post: description: Retorna se o visitante excedeu o limite de dias de agendamentos da semana atual ou excedeu o limite de dias de visitas desde o início do domingo anterior até o momento atual. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visitorSituation – personId – expectedStartDateOfScheduling properties: visitorId: type: integer format: int64 description: Id do visitante visitorSituation: type: string allOf: – #/definitions/visitorSituation description: Situação do visitante personId: type: integer format: int64 description: Id da pessoa lobbyId: type: integer format: int64 description: Id da portaria expectedStartDateOfScheduling: type: string format: date-time description: Data prevista de início do agendamento atual responses: 200: description: Ok schema: type: object required: – visitLimit properties: visitLimit: type: string allOf: – #/definitions/visitLimit description: Limite de visitas default: description: Error response schema: #/definitions/genericError /lobby/queries/getHasFacialRecognition: post: description: Retorna se tenant usa reconhecimento facial tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hasFacialRecognition properties: hasFacialRecognition: type: boolean description: Usa reconhecimento facial default: description: Error response schema: #/definitions/genericError get: description: Retorna se tenant usa reconhecimento facial tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hasFacialRecognition properties: hasFacialRecognition: type: boolean description: Usa reconhecimento facial default: description: Error response schema: #/definitions/genericError /lobby/queries/getDocumentType: post: description: Retorna todos os tipos de documento tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – documentTypeRecord properties: documentTypeRecord: type: array items: type: object allOf: – #/definitions/documentTypeRecord minimum: 1 description: Tipos de documento default: description: Error response schema: #/definitions/genericError get: description: Retorna todos os tipos de documento tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – documentTypeRecord properties: documentTypeRecord: type: array items: type: object allOf: – #/definitions/documentTypeRecord minimum: 1 description: Tipos de documento default: description: Error response schema: #/definitions/genericError /lobby/queries/getPersonFromDocument: post: description: Busca pessoa por documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – document – documentTypeId properties: document: type: string description: Documento documentTypeId: type: integer format: int64 description: Identificador do Tipo de Documento responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa default: description: Error response schema: #/definitions/genericError get: description: Busca pessoa por documento tags: – Queries x-senior-visibility: PRIVATE parameters: – name: document description: Documento in: query required: true type: string – name: documentTypeId description: Identificador do Tipo de Documento in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa default: description: Error response schema: #/definitions/genericError /lobby/queries/getPerson: post: description: Busca pessoa por ID tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId properties: personId: type: integer format: int64 description: Id da pessoa responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa default: description: Error response schema: #/definitions/genericError get: description: Busca pessoa por ID tags: – Queries x-senior-visibility: PRIVATE parameters: – name: personId description: Id da pessoa in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa default: description: Error response schema: #/definitions/genericError /lobby/queries/getPersonByIdWithConstraints: post: description: Busca uma pessoa pelo ID podendo aplicar restrições tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId properties: personId: type: integer format: int64 description: Id da pessoa constraints: type: array items: type: string allOf: – #/definitions/personConstraint description: Restrições responses: 200: description: Ok schema: type: object required: – person properties: person: type: object allOf: – #/definitions/personRecord description: Pessoa encontrada default: description: Error response schema: #/definitions/genericError /lobby/queries/getVisitorEmailTemplateUploadUrl: post: description: Retorna a url para upload do arquivo do template de email para o visitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lobbyId properties: lobbyId: type: integer format: int64 description: ID da portaria responses: 200: description: Ok schema: type: object required: – templateId – uploadUrl properties: templateId: type: string description: ID do arquivo do template uploadUrl: type: string description: Url para upload do arquivo default: description: Error response schema: #/definitions/genericError get: description: Retorna a url para upload do arquivo do template de email para o visitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: lobbyId description: ID da portaria in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – templateId – uploadUrl properties: templateId: type: string description: ID do arquivo do template uploadUrl: type: string description: Url para upload do arquivo default: description: Error response schema: #/definitions/genericError /lobby/queries/getVisitorEmailTemplateDownloadUrl: post: description: Retorna a url para download do arquivo do template de email para o visitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lobbyId properties: lobbyId: type: integer format: int64 description: ID da portaria responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url para download do arquivo default: description: Error response schema: #/definitions/genericError get: description: Retorna a url para download do arquivo do template de email para o visitante tags: – Queries x-senior-visibility: PRIVATE parameters: – name: lobbyId description: ID da portaria in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url para download do arquivo default: description: Error response schema: #/definitions/genericError /lobby/queries/hasOpenProvisoryCredential: post: description: Valida se a pessoa possuí credencial provisória em aberto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId – credentialFormat – endDate properties: personId: type: integer format: int64 description: Id da pessoa credentialFormat: type: string allOf: – #/definitions/credentialFormat description: Formato da credencial endDate: type: string format: date-time description: Data fim (validade da credencial) responses: 200: description: Ok schema: type: object required: – hasOpenProvisoryCredential properties: hasOpenProvisoryCredential: type: boolean description: Possuí credencial provisória em aberto default: description: Error response schema: #/definitions/genericError /lobby/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportLobbyResource: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportProcedure: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportVisitType: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportPersonProcedure: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportScheduling: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportLobby: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportRole: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportPhysicalLocation: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportVisitorCompany: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportSelfServiceTerminal: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportProvisoryCredentialReason: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/exportSelfServiceTerminalProperty: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /lobby/actions/checkoutPerson: post: description: Realiza o checkout da pessoa de outra visita tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – personId properties: personId: type: integer format: int64 description: O identificador da pessoa responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/actions/createCustomVisitor: post: description: Cria relacionamento entre uma pessoa e um agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visitor properties: visitor: type: object allOf: – #/definitions/visitor description: O objeto de relação entre uma pessoa e um agendamento options: type: array items: type: string allOf: – #/definitions/visitorUpdateOption description: Opções de alteração do visitante responses: 200: description: Ok schema: type: object required: – visitor properties: visitor: type: object allOf: – #/definitions/visitor description: O objeto de relação entre uma pessoa e um agendamento default: description: Error response schema: #/definitions/genericError /lobby/actions/updateCustomVisitor: post: description: Atualiza o relacionamento entre uma pessoa e um agendamento tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visitor properties: visitor: type: object allOf: – #/definitions/visitor description: O objeto de relação entre uma pessoa e um agendamento options: type: array items: type: string allOf: – #/definitions/visitorUpdateOption description: Opções de alteração do visitante responses: 200: description: Ok schema: type: object required: – visitor properties: visitor: type: object allOf: – #/definitions/visitor description: O objeto de relação entre uma pessoa e um agendamento default: description: Error response schema: #/definitions/genericError /lobby/actions/createCardProvisoryCredential: post: description: Cria credencial provisória tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – createCredential properties: createCredential: type: object allOf: – #/definitions/createProvisoryCredentialRecord description: Record com os parâmetros para criação de credencial provisória responses: 200: description: Ok schema: type: object required: – credential properties: credential: type: object allOf: – #/definitions/provisoryCredentialRecord description: A credencial que foi criada default: description: Error response schema: #/definitions/genericError /lobby/actions/finalizeCardProvisoryCredential: post: description: Finaliza credencial provisória tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – credential properties: credential: type: object allOf: – #/definitions/provisoryCredentialRecord description: A credencial responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/actions/getVisitorListForReceptionistView: post: description: Retorna uma lista de agendamentos para a visão da recepcionista tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: visitorSituations: type: array items: type: string allOf: – #/definitions/visitorSituation description: Filtro opcional da situação da visita lobbyId: type: integer format: int64 description: Filtro opcional por portaria schedulingDate: type: string format: date description: Filtro opcional por data visitorName: type: string description: Filtro opcional por nome do visitante size: type: integer format: int64 description: Filtro opcional da quantidade de registros offset: type: integer format: int64 description: Filtro opcional de offset dos registros responses: 200: description: Ok schema: type: object required: – visitors – totalElements properties: visitors: type: array items: type: object allOf: – #/definitions/visitorRecord minimum: 1 description: A lista de registros de agendamento totalElements: type: integer format: int64 description: Total de registros existentes default: description: Error response schema: #/definitions/genericError /lobby/actions/updateIntegratedProcedure: post: description: Permite alterar procedimento integrado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – procedure properties: procedure: type: object allOf: – #/definitions/procedure description: Procedimento responses: 200: description: Ok schema: type: object required: – procedure properties: procedure: type: object allOf: – #/definitions/procedure description: Procedimento alterado default: description: Error response schema: #/definitions/genericError /lobby/actions/deleteIntegratedProcedure: post: description: Permite excluir procedimento integrado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: procedureId: type: integer format: int64 description: ID do procedimento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/actions/updateIntegratedVisitType: post: description: Permite alterar tipo de visita integrado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visitType properties: visitType: type: object allOf: – #/definitions/visitType description: Tipo de visita responses: 200: description: Ok schema: type: object required: – visitType properties: visitType: type: object allOf: – #/definitions/visitType description: Tipo de visita alterado default: description: Error response schema: #/definitions/genericError /lobby/actions/deleteIntegratedVisitType: post: description: Permite excluir tipo de visita integrado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: visitTypeId: type: integer format: int64 description: ID do tipo de visita responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/actions/updateIntegratedVisitProcedure: post: description: Permite alterar procedimento de tipo de visita integrado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visitProcedure properties: visitProcedure: type: object allOf: – #/definitions/visitProcedure description: Procedimento de tipo de visita responses: 200: description: Ok schema: type: object required: – visitProcedure properties: visitProcedure: type: object allOf: – #/definitions/visitProcedure description: Procedimento de tipo de visita alterado default: description: Error response schema: #/definitions/genericError /lobby/actions/deleteIntegratedVisitProcedure: post: description: Permite excluir procedimento de tipo de visita integrado tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: visitTypeId: type: integer format: int64 description: ID do tipo de visita procedureId: type: integer format: int64 description: ID do procedimento responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/actions/updateIntegratedLobby: post: description: Permite alterar portaria integrada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lobby properties: lobby: type: object allOf: – #/definitions/lobby description: Portaria responses: 200: description: Ok schema: type: object required: – lobby properties: lobby: type: object allOf: – #/definitions/lobby description: Portaria alterada default: description: Error response schema: #/definitions/genericError /lobby/actions/deleteIntegratedLobby: post: description: Permite excluir portaria integrada tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: lobbyId: type: integer format: int64 description: ID da portaria responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/actions/faceIndexVisitor: post: description: Realiza indexação síncrona tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – visitorId properties: visitorId: type: integer format: int64 description: Identificador do visitante responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/actions/updateSelfServiceTerminalInUse: post: description: Alterar o Terminal de Autoatendimento informando se está em uso ou não tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – selfServiceTerminalId – inUse properties: selfServiceTerminalId: type: integer format: int64 description: ID do terminal de autoatendimento inUse: type: boolean description: Em uso responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /lobby/actions/saveVisitorEmailTemplate: post: description: Salva o arquivo do template de email para o visitante tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – lobbyId – templateId properties: lobbyId: type: integer format: int64 description: ID da portaria templateId: type: string description: ID do arquivo do template responses: 200: description: Ok schema: type: object required: – uploadFileOperationResponse properties: uploadFileOperationResponse: type: string allOf: – #/definitions/uploadFileOperationResponse description: Resposta da Operação default: description: Error response schema: #/definitions/genericError /lobby/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /lobby/actions/importLobbyResource: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importProcedure: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importVisitType: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importPersonProcedure: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importScheduling: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importLobby: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importRole: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importPhysicalLocation: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importVisitorCompany: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importSelfServiceTerminal: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importProvisoryCredentialReason: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/actions/importSelfServiceTerminalProperty: post: description: tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: default: description: Error response schema: #/definitions/genericError /lobby/signals/faceIndexVisitorsAsync: post: description: Realiza indexação assíncrona tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – visitorIdList properties: visitorIdList: type: array items: type: integer format: int64 minimum: 1 description: Lista de identificadores dos visitantes responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /lobby/entities/lobbyResource: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lobbyResource responses: 200: description: The created resource schema: #/definitions/lobbyResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lobbyResource responses: 200: description: The created resource schema: #/definitions/lobbyResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/lobbyResource default: description: Error response schema: #/definitions/genericError /lobby/entities/lobbyResource/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lobbyResource responses: 200: description: Ok schema: #/definitions/lobbyResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lobbyResource responses: 200: description: Ok schema: #/definitions/lobbyResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lobbyResource default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/lobbyResource/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lobbyResource responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/procedure: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/procedure responses: 200: description: The created resource schema: #/definitions/procedure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/procedure responses: 200: description: The created resource schema: #/definitions/procedure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/procedure default: description: Error response schema: #/definitions/genericError /lobby/entities/procedure/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/procedure responses: 200: description: Ok schema: #/definitions/procedure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/procedure responses: 200: description: Ok schema: #/definitions/procedure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/procedure default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/procedure/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/procedure responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/visitType: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitType responses: 200: description: The created resource schema: #/definitions/visitType default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitType responses: 200: description: The created resource schema: #/definitions/visitType default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitType default: description: Error response schema: #/definitions/genericError /lobby/entities/visitType/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitType responses: 200: description: Ok schema: #/definitions/visitType default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitType responses: 200: description: Ok schema: #/definitions/visitType default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitType default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/visitType/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visitType responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/visitProcedure: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitProcedure responses: 200: description: The created resource schema: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitProcedure responses: 200: description: The created resource schema: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError /lobby/entities/visitProcedure/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitProcedure responses: 200: description: Ok schema: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitProcedure responses: 200: description: Ok schema: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/visitType/{parentId}/visitProcedures: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitProcedure responses: 200: description: The created resources schema: type: array items: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitProcedure responses: 200: description: The created resources schema: type: array items: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError /lobby/entities/visitType/{parentId}/visitProcedures/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitProcedure responses: 200: description: Ok schema: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitProcedure responses: 200: description: Ok schema: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitProcedure default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/visitProcedure/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visitProcedure responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/visitResource: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitResource responses: 200: description: The created resource schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitResource responses: 200: description: The created resource schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError /lobby/entities/visitResource/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitResource responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitResource responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/lobbyResource/{parentId}/visitResources: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitResource responses: 200: description: The created resources schema: type: array items: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitResource responses: 200: description: The created resources schema: type: array items: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError /lobby/entities/visitType/{parentId}/visitResources: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitResource responses: 200: description: The created resources schema: type: array items: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitResource responses: 200: description: The created resources schema: type: array items: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError /lobby/entities/lobbyResource/{parentId}/visitResources/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitResource responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitResource responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/visitType/{parentId}/visitResources/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitResource responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitResource responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitResource default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/visitResource/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visitResource responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/visitedPerson: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitedPerson responses: 200: description: The created resource schema: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitedPerson responses: 200: description: The created resource schema: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError /lobby/entities/visitedPerson/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitedPerson responses: 200: description: Ok schema: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitedPerson responses: 200: description: Ok schema: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling/{parentId}/visitedPeople: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitedPerson responses: 200: description: The created resources schema: type: array items: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitedPerson responses: 200: description: The created resources schema: type: array items: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling/{parentId}/visitedPeople/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitedPerson responses: 200: description: Ok schema: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitedPerson responses: 200: description: Ok schema: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitedPerson default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/visitedPerson/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visitedPerson responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/visitor: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitor responses: 200: description: The created resource schema: #/definitions/visitor default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitor responses: 200: description: The created resource schema: #/definitions/visitor default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitor default: description: Error response schema: #/definitions/genericError /lobby/entities/visitor/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitor responses: 200: description: Ok schema: #/definitions/visitor default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitor responses: 200: description: Ok schema: #/definitions/visitor default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitor default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling/{parentId}/visitors: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitor responses: 200: description: The created resources schema: type: array items: #/definitions/visitor default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/visitor responses: 200: description: The created resources schema: type: array items: #/definitions/visitor default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitor default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling/{parentId}/visitors/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitor responses: 200: description: Ok schema: #/definitions/visitor default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitor responses: 200: description: Ok schema: #/definitions/visitor default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitor default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/visitor/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visitor responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/personProcedure: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personProcedure responses: 200: description: The created resource schema: #/definitions/personProcedure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/personProcedure responses: 200: description: The created resource schema: #/definitions/personProcedure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/personProcedure default: description: Error response schema: #/definitions/genericError /lobby/entities/personProcedure/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personProcedure responses: 200: description: Ok schema: #/definitions/personProcedure default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/personProcedure responses: 200: description: Ok schema: #/definitions/personProcedure default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/personProcedure default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/personProcedure/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/personProcedure responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/schedulingResource: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/schedulingResource responses: 200: description: The created resource schema: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/schedulingResource responses: 200: description: The created resource schema: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError /lobby/entities/schedulingResource/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/schedulingResource responses: 200: description: Ok schema: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/schedulingResource responses: 200: description: Ok schema: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling/{parentId}/schedulingResources: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/schedulingResource responses: 200: description: The created resources schema: type: array items: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/schedulingResource responses: 200: description: The created resources schema: type: array items: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling/{parentId}/schedulingResources/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/schedulingResource responses: 200: description: Ok schema: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/schedulingResource responses: 200: description: Ok schema: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/schedulingResource default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/schedulingResource/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/schedulingResource responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduling responses: 200: description: The created resource schema: #/definitions/scheduling default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/scheduling responses: 200: description: The created resource schema: #/definitions/scheduling default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/scheduling default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/scheduling responses: 200: description: Ok schema: #/definitions/scheduling default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/scheduling responses: 200: description: Ok schema: #/definitions/scheduling default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/scheduling default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/scheduling/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scheduling responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/lobby: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lobby responses: 200: description: The created resource schema: #/definitions/lobby default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lobby responses: 200: description: The created resource schema: #/definitions/lobby default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/lobby default: description: Error response schema: #/definitions/genericError /lobby/entities/lobby/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lobby responses: 200: description: Ok schema: #/definitions/lobby default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lobby responses: 200: description: Ok schema: #/definitions/lobby default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lobby default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/lobby/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lobby responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/lobbyCredentialTechnology: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lobbyCredentialTechnology responses: 200: description: The created resource schema: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/lobbyCredentialTechnology responses: 200: description: The created resource schema: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError /lobby/entities/lobbyCredentialTechnology/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lobbyCredentialTechnology responses: 200: description: Ok schema: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lobbyCredentialTechnology responses: 200: description: Ok schema: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/lobby/{parentId}/lobbyCredentialTechnologies: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/lobbyCredentialTechnology responses: 200: description: The created resources schema: type: array items: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/lobbyCredentialTechnology responses: 200: description: The created resources schema: type: array items: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError /lobby/entities/lobby/{parentId}/lobbyCredentialTechnologies/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lobbyCredentialTechnology responses: 200: description: Ok schema: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/lobbyCredentialTechnology responses: 200: description: Ok schema: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/lobbyCredentialTechnology default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/lobbyCredentialTechnology/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/lobbyCredentialTechnology responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/role: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/role responses: 200: description: The created resource schema: #/definitions/role default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/role responses: 200: description: The created resource schema: #/definitions/role default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/role default: description: Error response schema: #/definitions/genericError /lobby/entities/role/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/role responses: 200: description: Ok schema: #/definitions/role default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/role responses: 200: description: Ok schema: #/definitions/role default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/role default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/role/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/role responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/physicalLocation: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/physicalLocation responses: 200: description: The created resource schema: #/definitions/physicalLocation default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/physicalLocation responses: 200: description: The created resource schema: #/definitions/physicalLocation default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/physicalLocation default: description: Error response schema: #/definitions/genericError /lobby/entities/physicalLocation/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/physicalLocation responses: 200: description: Ok schema: #/definitions/physicalLocation default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/physicalLocation responses: 200: description: Ok schema: #/definitions/physicalLocation default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/physicalLocation default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/physicalLocation/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/physicalLocation responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/visitorCompany: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitorCompany responses: 200: description: The created resource schema: #/definitions/visitorCompany default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitorCompany responses: 200: description: The created resource schema: #/definitions/visitorCompany default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/visitorCompany default: description: Error response schema: #/definitions/genericError /lobby/entities/visitorCompany/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitorCompany responses: 200: description: Ok schema: #/definitions/visitorCompany default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitorCompany responses: 200: description: Ok schema: #/definitions/visitorCompany default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitorCompany default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/visitorCompany/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visitorCompany responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/selfServiceTerminal: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/selfServiceTerminal responses: 200: description: The created resource schema: #/definitions/selfServiceTerminal default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/selfServiceTerminal responses: 200: description: The created resource schema: #/definitions/selfServiceTerminal default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/selfServiceTerminal default: description: Error response schema: #/definitions/genericError /lobby/entities/selfServiceTerminal/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/selfServiceTerminal responses: 200: description: Ok schema: #/definitions/selfServiceTerminal default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/selfServiceTerminal responses: 200: description: Ok schema: #/definitions/selfServiceTerminal default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/selfServiceTerminal default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/selfServiceTerminal/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/selfServiceTerminal responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/dispenserPort: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dispenserPort responses: 200: description: The created resource schema: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/dispenserPort responses: 200: description: The created resource schema: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError /lobby/entities/dispenserPort/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dispenserPort responses: 200: description: Ok schema: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dispenserPort responses: 200: description: Ok schema: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/selfServiceTerminal/{parentId}/dispenserPorts: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/dispenserPort responses: 200: description: The created resources schema: type: array items: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: entity in: body required: true schema: type: array items: #/definitions/dispenserPort responses: 200: description: The created resources schema: type: array items: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError /lobby/entities/selfServiceTerminal/{parentId}/dispenserPorts/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dispenserPort responses: 200: description: Ok schema: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/dispenserPort responses: 200: description: Ok schema: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/dispenserPort default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: parentId in: path required: true type: string – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/dispenserPort/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/dispenserPort responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/provisoryCredentialReason: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/provisoryCredentialReason responses: 200: description: The created resource schema: #/definitions/provisoryCredentialReason default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/provisoryCredentialReason responses: 200: description: The created resource schema: #/definitions/provisoryCredentialReason default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/provisoryCredentialReason default: description: Error response schema: #/definitions/genericError /lobby/entities/provisoryCredentialReason/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/provisoryCredentialReason responses: 200: description: Ok schema: #/definitions/provisoryCredentialReason default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/provisoryCredentialReason responses: 200: description: Ok schema: #/definitions/provisoryCredentialReason default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/provisoryCredentialReason default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/provisoryCredentialReason/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/provisoryCredentialReason responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /lobby/entities/selfServiceTerminalProperty: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/selfServiceTerminalProperty responses: 200: description: The created resource schema: #/definitions/selfServiceTerminalProperty default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/selfServiceTerminalProperty responses: 200: description: The created resource schema: #/definitions/selfServiceTerminalProperty default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/selfServiceTerminalProperty default: description: Error response schema: #/definitions/genericError /lobby/entities/selfServiceTerminalProperty/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/selfServiceTerminalProperty responses: 200: description: Ok schema: #/definitions/selfServiceTerminalProperty default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/selfServiceTerminalProperty responses: 200: description: Ok schema: #/definitions/selfServiceTerminalProperty default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/selfServiceTerminalProperty default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /lobby/entities/selfServiceTerminalProperty/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/selfServiceTerminalProperty responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN credentialSituation: description: Situação da Credencial type: string enum: – RELEASED – BLOCKED timeValidityType: description: Tipo de Validação de Tempo type: string enum: – HOUR – DAY biometricManufacturer: description: Fabricante Biométrico type: string enum: – NONE – FINGERPRINT_SAGEM – FINGERPRINT_SUPREMA – FINGERPRINT_VIRDI – FINGERPRINT_NITGEN – FINGERPRINT_CAMA – FINGERPRINT_INNOVATRICS – HANDKEY_IR cardTechnology: description: Tecnologia do Cartão type: string enum: – BARCODE_CARD – RFID_CARD – SMART_CARD visitorSituation: description: Situação do visitante type: string enum: – CHECK_IN_PENDING – CHECK_IN_REALIZED – VISITING – CHECK_OUT_REALIZED – CHECK_IN_NOT_REALIZED – CHECK_IN_EXPIRED visitSituation: description: Situação da visita type: string enum: – PENDING – IN_PROGRESS – FINISHED – NOT_OCCURRED statusHistoric: description: Status de um histórico type: string enum: – FUTURE – PRESENT – PAST personSituationType: description: Situação da pessoa type: string enum: – ACTIVE – BLOCKED physicalLocationStatus: description: Status do local físico type: string enum: – DISABLED – ENABLED availability: description: Disponibilidade da pessoa type: string enum: – ABSENT – AVAILABLE typeOfVisit: description: Tipo de Visita type: string enum: – NOT_SCHEDULED – SCHEDULED selfServiceTerminalManufacturerType: description: Fabricante do Terminal de Autoatendimento type: string enum: – ACESSO_REMOTO – PERTO – VIDEOSOFT visitLimitControl: description: Controle de limite de visitas type: string enum: – DOES_NOT_CONTROL – ALERT – BLOCK visitLimit: description: Limite de visitas type: string enum: – NOT_EXCEEDED – EXCEEDED_WITH_ALERT – EXCEEDED_WITH_BLOCK personConstraint: description: Restrições da pessoa type: string enum: – MUST_HAVE_VALID_ROLE visitorUpdateOption: description: Opções de alteração de visitante type: string enum: – IGNORE_END_OF_SCHEDULING – CHECKOUT_AUTOMATICALLY_FROM_OTHER_SCHEDULING uploadFileOperationResponse: description: Resposta da Operação do Upload do Arquivo type: string enum: – ERROR – SUCCESS credentialFormat: description: Formato da Credencial type: string enum: – CARD – BIOMETRY – LICENSE_PLATE – QRCODE – BLUETOOTH userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckItem: description: Item verificado no healthcheck type: object required: – name – status properties: name: type: string description: Nome do item status: type: string allOf: – #/definitions/healthcheckStatus description: Status da saúde createProvisoryCredentialRecord: description: Informações para a criação de uma credencial type: object required: – isCheckedOverlap – cardCredentialList – endDate properties: isCheckedOverlap: type: boolean description: Se deve suspender a credencial existente cardCredentialList: type: array items: type: object allOf: – #/definitions/informationCardCredentialRecord minimum: 1 description: Lista de credenciais de cartão provisoryCredentialReasonId: type: integer format: int64 description: Id do motivo da credencial provisória roleId: type: integer format: int64 description: O papel da credencial personId: type: integer format: int64 description: O identificador da pessoa que receberá a credencial visitor: type: object allOf: – #/definitions/visitor description: O visitante que receberá a credencial schedulingId: type: integer format: int64 description: O agendamento relacionado à credencial startDate: type: string format: date-time description: A data de início da credencial endDate: type: string format: date-time description: A data de expiração da credencial biometricManufacturer: type: string allOf: – #/definitions/biometricManufacturer description: o tipo de tecnologia biométrica e o fabricante biometricId: type: integer format: int64 description: O identificador da biometria da pessoa virtualLobbyId: type: integer format: int64 description: O identificador da portaria virtual lobbyId: type: integer format: int64 description: O identificador da portaria informationCardCredentialRecord: description: Informações da credencial de cartão type: object required: – cardTechnology – cardNumber properties: id: type: integer format: int64 description: Código identificador cardTechnology: type: string allOf: – #/definitions/cardTechnology description: Tecnologia do Cartão cardNumber: type: integer format: int64 description: Número do Cartão minimum: 1 provisoryCredentialRecord: description: Credencial type: object required: – id properties: id: type: integer format: int64 description: Identificador da credencial situation: type: string allOf: – #/definitions/credentialSituation description: Situação da credencial endDate: type: string format: date-time description: Data de expiração da credencial startDate: type: string format: date-time description: Data de início da credencial person: type: object allOf: – #/definitions/personRecord description: Pessoa da credencial role: type: object allOf: – #/definitions/roleRecord description: Papel utilizado para criar a credencial schedulingId: type: integer format: int64 description: Identificador do agendamento cardCredentialList: type: array items: type: object allOf: – #/definitions/informationCardCredentialRecord description: A lista de credenciais de cartão virtualLobbyId: type: integer format: int64 description: A portaria virtual onde foi emitida a credencial provisoryCredentialReason: type: object allOf: – #/definitions/provisoryCredentialReasonRecord description: O motivo da credencial provisória lobbyId: type: integer format: int64 description: A portaria onde foi emitida a credencial provisoryCredentialReasonRecord: description: Motivo da Credencial Provisória type: object required: – reasonInPortuguese – reasonInEnglish – reasonInSpanish – validityTime – timeValidityType – isActive properties: id: type: integer format: int64 description: ID reasonInPortuguese: type: string maxLength: 30 description: Motivo em Português reasonInEnglish: type: string maxLength: 30 description: Motivo em Inglês reasonInSpanish: type: string maxLength: 30 description: Motivo em Espanhol validityTime: type: integer format: int64 description: Tempo de Validade minimum: 0 maximum: 99 timeValidityType: type: string allOf: – #/definitions/timeValidityType description: Tipo de Validade do Tempo isActive: type: boolean description: Motivo Ativo schedulingForSchedulerViewRecord: description: Resumo do agendamento para listagem da visão do agendador type: object required: – id – title – expectedStartDate – expectedEndDate – visitedPerson – visitorPerson – numberOfVisitedPeople – numberOfVisitors properties: id: type: integer format: int64 description: ID type: string description: Título da visita expectedStartDate: type: string format: date-time description: Data prevista de início do agendamento expectedEndDate: type: string format: date-time description: Data prevista de fim do agendamento visitSituation: type: string allOf: – #/definitions/visitSituation description: Situação da visita visitedPerson: type: object allOf: – #/definitions/personRecord description: Visitados visitorPerson: type: object allOf: – #/definitions/personRecord description: Visitantes numberOfVisitedPeople: type: integer format: int64 description: Quantidade de visitados numberOfVisitors: type: integer format: int64 description: Quantidade de visitantes schedulingRecord: description: Detalhes do agendamento type: object required: – id – title – expectedStartDate – expectedEndDate – visitType – visitedPeople – visitors – physicalLocation properties: id: type: integer format: int64 description: ID type: string description: Título da visita expectedStartDate: type: string format: date-time description: Data prevista de início do agendamento expectedEndDate: type: string format: date-time description: Data prevista de fim do agendamento visitType: type: object allOf: – #/definitions/visitTypeRecord description: Tipo de visita schedulingResources: type: array items: type: object allOf: – #/definitions/schedulingResource description: Recursos da visita visitSituation: type: string allOf: – #/definitions/visitSituation description: Situação da visita visitedPeople: type: array items: type: object allOf: – #/definitions/visitedPersonRecord minimum: 1 description: Visitados visitors: type: array items: type: object allOf: – #/definitions/visitorRecord minimum: 1 description: Visitantes physicalLocation: type: object allOf: – #/definitions/simplePhysicalLocationRecord description: Local físico da visita lobby: type: object allOf: – #/definitions/lobby description: Portaria schedulingForVisitorRecord: description: Detalhes do agendamento para visitante type: object required: – id – expectedStartDate – expectedEndDate – visitor – visitedPeople – physicalLocation properties: id: type: integer format: int64 description: Id expectedStartDate: type: string format: date-time description: Data prevista de início do agendamento expectedEndDate: type: string format: date-time description: Data prevista de fim do agendamento visitor: type: object allOf: – #/definitions/visitorRecord description: Visitante visitedPeople: type: array items: type: object allOf: – #/definitions/visitedPersonRecord minimum: 1 description: Visitados physicalLocation: type: object allOf: – #/definitions/simplePhysicalLocationRecord description: Local físico da visita visitTypeRecord: description: Tipo de visita type: object required: – id – name – role – usedBySelfServiceTerminal – sendEmailToVisited properties: id: type: integer format: int64 description: ID name: type: string description: Nome do tipo de visita visitProcedures: type: array items: type: object allOf: – #/definitions/visitProcedure description: Procedimentos da visita role: type: object allOf: – #/definitions/roleRecord description: Papel padrão para o tipo de visita visitResources: type: array items: type: object allOf: – #/definitions/visitResource description: Recursos padrão do tipo de visita usedBySelfServiceTerminal: type: boolean description: Flag se o tipo de visita é utilizado pelo totem sendEmailToVisited: type: boolean description: Flag se envia email de notificação ao visitado physicalLocationRecord: description: Local físico type: object required: – parent – name – status properties: id: type: integer format: int64 description: ID parent: type: integer format: int64 description: Local físico pai name: type: string description: Nome status: type: string allOf: – #/definitions/physicalLocationStatus description: Status do local físico simplePhysicalLocationRecord: description: Local físico type: object required: – id – name – parentId – status – fullHierarchicalPath properties: id: type: integer format: int64 description: Id name: type: string maxLength: 50 description: Nome parentId: type: integer format: int64 description: Id do local físico pai status: type: string allOf: – #/definitions/physicalLocationStatus description: Status do local físico fullHierarchicalPath: type: string description: Caminho hierárquico completo visitorRecord: description: Detalhes do visitante type: object required: – id – person – scheduling – visitorSituation properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/personRecord description: Visitante scheduling: type: object allOf: – #/definitions/scheduling description: Agendamento visitorSituation: type: string allOf: – #/definitions/visitorSituation description: Situação do visitante personProcedures: type: array items: type: object allOf: – #/definitions/personProcedure description: Procedimentos company: type: object allOf: – #/definitions/visitorCompany description: Empresa do visitante visitedPersonRecord: description: Detalhes da pessoa visitada type: object required: – id – person – scheduling properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/personRecord description: Pessoa scheduling: type: object allOf: – #/definitions/scheduling description: Agendamento documentTypeRecord: description: Tipo de documento type: object required: – id – name – label – required properties: id: type: integer format: int64 description: ID name: type: string description: Nome do tipo de documento label: type: string description: Label do documento mask: type: string description: Máscara do documento required: type: boolean description: Documento obrigatório documentRecord: description: Documento type: object required: – id – documentType – document properties: id: type: integer format: int64 description: ID documentType: type: object allOf: – #/definitions/documentTypeRecord description: Tipo de documento document: type: string description: Documento phoneRecord: description: Telefone type: object required: – id – number properties: id: type: integer format: int64 description: ID preferential: type: boolean description: Telefone Preferencial idd: type: integer format: int64 description: DDI/IDD (International Direct Dialing) number: type: string description: Número do telefone phoneExtension: type: string description: Ramal emailRecord: description: Email type: object required: – id – email properties: id: type: integer format: int64 description: ID preferential: type: boolean description: Email Preferencial email: type: string description: Endereço do email personRecord: description: Pessoa type: object required: – id properties: id: type: integer format: int64 description: ID name: type: string description: Nome photoDate: type: string format: date-time description: Data da atualização da foto lastAccessDate: type: string format: date-time description: Último acesso currentPhysicalLocation: type: object allOf: – #/definitions/physicalLocationRecord description: Local atual da pessoa situation: type: string allOf: – #/definitions/personSituationType description: Situação da pessoa lastAccessAllowedDate: type: string format: date-time description: Data do último acesso permitido lastAccessAllowedPhysicalLocation: type: object allOf: – #/definitions/physicalLocationRecord description: Local físico do último acesso permitido documents: type: array items: type: object allOf: – #/definitions/documentRecord description: Documento phones: type: array items: type: object allOf: – #/definitions/phoneRecord description: Telefone emails: type: array items: type: object allOf: – #/definitions/emailRecord description: Email personRoles: type: array items: type: object allOf: – #/definitions/personRoleRecord description: Papéis da pessoa situations: type: array items: type: object allOf: – #/definitions/personSituationRecord description: Lista de situação da pessoa groups: type: array items: type: object allOf: – #/definitions/groupPersonRecord description: Grupos availability: type: string allOf: – #/definitions/availability description: Disponibilidade personSituationRecord: description: Situação da pessoa type: object required: – id – person – blockDate – blockReason properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/personRecord description: Pessoa blockDate: type: string format: date-time description: Data do bloqueio blockReason: type: string description: Motivo do bloqueio unblockDate: type: string format: date-time description: Data do desbloqueio unblockProcedure: type: string description: Procedimento de desbloqueio unblockJustification: type: string description: Justificativa do desbloqueio groupPersonRecord: description: Relação grupo pessoa type: object required: – id – person – group properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/personRecord description: Pessoa group: type: object allOf: – #/definitions/groupRecord description: Grupo groupRecord: description: Grupo type: object required: – id – parent – name properties: id: type: integer format: int64 description: ID parent: type: integer format: int64 description: ID do pai name: type: string description: Nome do grupo physicalLocation: type: object allOf: – #/definitions/physicalLocationRecord description: Local físico people: type: array items: type: object allOf: – #/definitions/groupPersonRecord description: Pessoas do grupo personRoleRecord: description: Papel da pessoa type: object required: – id – startDate properties: id: type: integer format: int64 description: ID person: type: object allOf: – #/definitions/personRecord description: Pessoa role: type: object allOf: – #/definitions/roleRecord description: Papel startDate: type: string format: date-time description: Data início endDate: type: string format: date-time description: Data fim status: type: string allOf: – #/definitions/statusHistoric description: Status personRoleSuspensions: type: array items: type: object allOf: – #/definitions/personRoleSuspensionRecord description: Suspensões de papéis personRoleSuspensionRecord: description: Papéis suspensos da pessoa type: object required: – id – startDate – justification properties: id: type: integer format: int64 description: ID personRole: type: object allOf: – #/definitions/personRoleRecord description: Ligação pessoa papel startDate: type: string format: date-time description: Data início endDate: type: string format: date-time description: Data fim justification: type: string description: Justificativa status: type: string allOf: – #/definitions/statusHistoric description: Status roleRecord: description: Papel type: object required: – id – name – usedByProvisory – receiveVisit properties: id: type: integer format: int64 description: ID name: type: string description: Nome usedByProvisory: type: boolean description: Papel utilizado pelo provisório receiveVisit: type: boolean description: Papel que Recebe Visita personRoles: type: array items: type: object allOf: – #/definitions/personRoleRecord description: Relação pessoa papel roleAccessPhysicalLocations: type: array items: type: object allOf: – #/definitions/roleAccessPhysicalLocationRecord description: Relação de papel que acessa o local físico roleAccessPhysicalLocationRecord: description: Papel acessa local físico type: object required: – id – role – physicalLocation properties: id: type: integer format: int64 description: ID role: type: object allOf: – #/definitions/roleRecord description: Papel physicalLocation: type: object allOf: – #/definitions/physicalLocationRecord description: Local físico faceVerificationResultRecord: description: Resultado do reconhecimento facial type: object required: – personId – similarity properties: personId: type: integer format: int64 description: Identificador da pessoa similarity: type: integer format: int64 description: Semelhança BlobServiceReturnRecord: description: Retorno do BlobService type: object properties: type: string description: Versão do arquivo url: type: string description: Url do arquivo lobbyResource: description: Recurso de visita type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do recurso visitResources: type: array items: type: object allOf: – #/definitions/visitResource description: Tipo de Visita ligados ao Recurso createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: procedure: description: Procedimento (Política da empresa) type: object required: – name – validityDays properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do procedimento description: type: string maxLength: 500 description: Descrição do procedimento validityDays: type: integer format: int64 description: Validade do procedimento em dias minimum: 0 integratedWithGAS: type: boolean description: Possui integração com GAS default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: visitType: description: Tipo de visita type: object required: – name – role – usedBySelfServiceTerminal – sendEmailToVisited properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do tipo de visita visitProcedures: type: array items: type: object allOf: – #/definitions/visitProcedure description: Procedimentos da visita role: type: object allOf: – #/definitions/role description: Papel padrão para o tipo de visita visitResources: type: array items: type: object allOf: – #/definitions/visitResource description: Recursos padrão do tipo de visita usedBySelfServiceTerminal: type: boolean description: Flag se o tipo de visita é utilizado pelo totem sendEmailToVisited: type: boolean description: Flag se envia email de notificação ao visitado integratedWithGAS: type: boolean description: Possui integração com GAS default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: visitProcedure: description: Relação Visita Procedimento type: object required: – required properties: id: type: integer format: int64 description: ID visitType: type: object allOf: – #/definitions/visitType description: Tipo da visita procedure: type: object allOf: – #/definitions/procedure description: Procedimento required: type: boolean description: Flag sinalizando se execução do procedimento é obrigatória integratedWithGAS: type: boolean description: Possui integração com GAS default: false createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: visitResource: description: Relação Visita Recurso type: object properties: id: type: integer format: int64 description: ID visitType: type: object allOf: – #/definitions/visitType description: Tipo da visita lobbyResource: type: object allOf: – #/definitions/lobbyResource description: Recurso createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: visitedPerson: description: Relação Agendamento Visitado type: object properties: id: type: integer format: int64 description: ID personId: type: integer format: int64 description: Visitado scheduling: type: object allOf: – #/definitions/scheduling description: Agendamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: visitor: description: Relação Agendamento Visitante type: object properties: id: type: integer format: int64 description: ID personId: type: integer format: int64 description: Visitante scheduling: type: object allOf: – #/definitions/scheduling description: Agendamento visitorSituation: type: string allOf: – #/definitions/visitorSituation description: Situação do visitante company: type: object allOf: – #/definitions/visitorCompany description: Empresa do visitante locator: type: string maxLength: 6 description: Código localizador createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: personProcedure: description: Relação Pessoa Procedimento type: object required: – personId – procedure properties: id: type: integer format: int64 description: ID personId: type: integer format: int64 description: Visitante procedure: type: object allOf: – #/definitions/procedure description: Procedimento completionDate: type: string format: date-time description: Data de finalização do procedimento responsibleUser: type: string description: Responsável pela finalização do procedimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: schedulingResource: description: Relação Agendamento Recurso type: object properties: id: type: integer format: int64 description: ID scheduling: type: object allOf: – #/definitions/scheduling description: Agendamento lobbyResource: type: object allOf: – #/definitions/lobbyResource description: Recurso quantity: type: integer format: int64 description: Quantidade minimum: 0 note: type: string maxLength: 500 description: Observação createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: scheduling: description: Agendamento type: object required: – title – expectedEndDate – visitType – visitSituation properties: id: type: integer format: int64 description: ID type: string maxLength: 50 description: Título da visita expectedStartDate: type: string format: date-time description: Data prevista de início do agendamento expectedEndDate: type: string format: date-time description: Data prevista de fim do agendamento visitType: type: object allOf: – #/definitions/visitType description: Tipo de visita physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico da visita visitedPeople: type: array items: type: object allOf: – #/definitions/visitedPerson description: Lista de visitados visitors: type: array items: type: object allOf: – #/definitions/visitor description: Lista de visitantes schedulingResources: type: array items: type: object allOf: – #/definitions/schedulingResource description: Recursos da visita visitSituation: type: string allOf: – #/definitions/visitSituation description: Situação da visita lobby: type: object allOf: – #/definitions/lobby description: Portaria createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: lobby: description: Portaria type: object required: – name – physicalLocation – provisoryCredentialValidityInDays – schedulingCredentialValidityInHours – isActive – visitLimitControl properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome da portaria physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico provisoryCardPhotoValidityInDays: type: integer format: int64 description: Validade da foto do colaborador em dias minimum: 0 scheduledVisitPhotoValidityInDays: type: integer format: int64 description: Validade da foto do visitante em dias minimum: 0 provisoryCredentialValidityInDays: type: integer format: int64 description: Validade da credencial provisória em dias minimum: 1 schedulingCredentialValidityInHours: type: integer format: int64 description: Validade da credencial de visitante em horas minimum: 1 schedulingToleranceInMinutes: type: integer format: int64 description: Tolerância no agendamento em minutos minimum: 0 provisoryCredentialsMonthlyLimit: type: integer format: int64 description: Limite mensal de credenciais provisórias minimum: 0 isActive: type: boolean description: Estado da portaria integratedWithGAS: type: boolean description: Possui integração com GAS default: false schedulingReportId: type: string maxLength: 50 description: Identificador do Relatório de Agendamento na Plataforma usesCredential: type: boolean description: Utiliza credencial default: true lobbyCredentialTechnologies: type: array items: type: object allOf: – #/definitions/lobbyCredentialTechnology description: Tecnologia disponível para credencial visitLimitControl: type: string allOf: – #/definitions/visitLimitControl description: Controle de limite de visitas limitOfDaysWithVisitPerWeek: type: integer format: int64 description: Limite de dias com visita por semana minimum: 0 maximum: 7 createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: lobbyCredentialTechnology: description: Entidade de relacionamento entre uma portaria e as tecnologias de credencial disponíveis type: object properties: id: type: integer format: int64 description: ID lobby: type: object allOf: – #/definitions/lobby description: Identificador da portaria cardTechnology: type: string allOf: – #/definitions/cardTechnology description: Tecnologia de credencial createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: role: description: Papel type: object required: – name – usedByProvisory – receiveVisit properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome usedByProvisory: type: boolean description: Papel Utilizado pelo Provisório receiveVisit: type: boolean description: Papel que Recebe Visita physicalLocation: description: Local Físico type: object required: – parent – name – status properties: id: type: integer format: int64 description: ID parent: type: integer format: int64 description: Local Físico Pai name: type: string maxLength: 50 description: Nome status: type: string allOf: – #/definitions/physicalLocationStatus description: Status do Local Físico visitorCompany: description: Empresa do visitante type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: selfServiceTerminal: description: Terminal de Autoatendimento type: object required: – name – active – lobby – manufacturer – propertySelfServiceTerminal properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome active: type: boolean description: Situação lobby: type: object allOf: – #/definitions/lobby description: Portaria manufacturer: type: string allOf: – #/definitions/selfServiceTerminalManufacturerType description: Fabricante multiplePorts: type: boolean description: Utiliza Multiplas Portas inUse: type: boolean description: Em Uso dispenserPorts: type: array items: type: object allOf: – #/definitions/dispenserPort description: Lista de portas do dispenser propertySelfServiceTerminal: type: object allOf: – #/definitions/selfServiceTerminalProperty description: Propriedades do Terminal createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: dispenserPort: description: Porta do Dispenser type: object required: – port properties: id: type: integer format: int64 description: ID port: type: string maxLength: 100 description: Porta typeOfVisit: type: string allOf: – #/definitions/typeOfVisit description: Tipo de Visita selfServiceTerminal: type: object allOf: – #/definitions/selfServiceTerminal description: Terminal de Autoatendimento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: provisoryCredentialReason: description: Motivo da Credencial Provisória type: object required: – reasonInPortuguese – reasonInEnglish – reasonInSpanish – validityTime – timeValidityType – isActive properties: id: type: integer format: int64 description: ID reasonInPortuguese: type: string maxLength: 30 description: Motivo em Português reasonInEnglish: type: string maxLength: 30 description: Motivo em Inglês reasonInSpanish: type: string maxLength: 30 description: Motivo em Espanhol validityTime: type: integer format: int64 description: Tempo de Validade minimum: 0 maximum: 99 timeValidityType: type: string allOf: – #/definitions/timeValidityType description: Tipo de Validade do Tempo isActive: type: boolean description: Motivo Ativo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: selfServiceTerminalProperty: description: Propriedades do Terminal de Autoatendimento type: object required: – name – backgroundColor – useWithdrawalProvisoryCredential – useScheduling – useFacialRecognitionScheduledVisit – useFacialRecognitionNotScheduledVisit – useFacialRecognitionValidadionNotScheduledVisit – allowsEntryByLocatorCode – allowsEntryByQrCode – allowsEntryByDocument properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome backgroundColor: type: string maxLength: 11 description: Cor de fundo useWithdrawalProvisoryCredential: type: boolean description: Utiliza retirada de credencial provisória useScheduling: type: boolean description: Utiliza agendamento useFacialRecognitionScheduledVisit: type: boolean description: Utiliza reconhecimento facial para localizar visita agendada useFacialRecognitionNotScheduledVisit: type: boolean description: Utiliza reconhecimento facial para localizar visita não agendada useFacialRecognitionValidadionNotScheduledVisit: type: boolean description: Utiliza reconhecimento facial para validar identidade na visita não agendada reliabilityPercentage: type: integer format: int64 description: Percentual de confiabilidade minimum: 75 maximum: 100 allowsEntryByLocatorCode: type: boolean description: Permite entrada pelo código localizador allowsEntryByQrCode: type: boolean description: Permite entrada pelo QRCode allowsEntryByDocument: type: boolean description: Permite entrada pelo documento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service 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