2.0info: 1.31.0 Gestao de vigilância description: Serviço do backend do Gestão de Vigilância do Ronda senior X x-senior-domain: Gestão de Acesso e Segurança x-senior-domain-path: sam x-senior-service-path: patrol contact: name: Senior X Platform url: https://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: /patrol/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 401: description: Invalid Credentials 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/generatePositionQRCode: post: description: Gera um Código QR com informações do posto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – positionId properties: positionId: type: integer format: int64 description: ID do posto responses: 200: description: Ok schema: type: object required: – qrcode properties: qrcode: type: string description: Código QR em Base64 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gera um Código QR com informações do posto tags: – Queries x-senior-visibility: PRIVATE parameters: – name: positionId description: ID do posto in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – qrcode properties: qrcode: type: string description: Código QR em Base64 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/generateCheckpointQRCode: post: description: Gera um Código QR com informações do ponto de controle tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checkpointId properties: checkpointId: type: integer format: int64 description: ID do ponto de controle responses: 200: description: Ok schema: type: object required: – qrcode properties: qrcode: type: string description: Código QR em Base64 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Gera um Código QR com informações do ponto de controle tags: – Queries x-senior-visibility: PRIVATE parameters: – name: checkpointId description: ID do ponto de controle in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – qrcode properties: qrcode: type: string description: Código QR em Base64 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/findPositionsByGeolocation: post: description: Busca os postos pelas coordenadas geográficas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – latitude – longitude properties: latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 responses: 200: description: Ok schema: type: object required: – positions properties: positions: type: array items: type: object allOf: – #/definitions/nearbyPositionRecord minimum: 1 description: Postos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os postos pelas coordenadas geográficas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: latitude description: Latitude in: query required: true type: number format: double – name: longitude description: Longitude in: query required: true type: number format: double responses: 200: description: Ok schema: type: object required: – positions properties: positions: type: array items: type: object allOf: – #/definitions/nearbyPositionRecord minimum: 1 description: Postos encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getTourPlan: post: description: Busca um plano de ronda 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: – schedulingRecord properties: schedulingRecord: type: object allOf: – #/definitions/schedulingRecord description: Agendamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca um plano de ronda 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: – schedulingRecord properties: schedulingRecord: type: object allOf: – #/definitions/schedulingRecord description: Agendamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/duplicateTourPlan: post: description: Duplica um plano de ronda 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: – schedulingRecord properties: schedulingRecord: type: object allOf: – #/definitions/schedulingRecord description: Agendamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Duplica um plano de ronda 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: – schedulingRecord properties: schedulingRecord: type: object allOf: – #/definitions/schedulingRecord description: Agendamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPendingTours: post: description: Busca as rondas para execução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – positionId properties: deviceUUID: type: string description: Identificador do dispositivo positionId: type: integer format: int64 description: Identificador do posto 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 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/tourRecord minimum: 1 description: Lista de rondas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as rondas para execução tags: – Queries x-senior-visibility: PRIVATE parameters: – name: deviceUUID description: Identificador do dispositivo in: query required: true type: string – name: positionId description: Identificador do posto in: query required: true 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 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/tourRecord minimum: 1 description: Lista de rondas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getTourStatusReportFilter: post: description: Busca os status de rondas para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os status de rondas para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPositionReportFilter: post: description: Busca os postos para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os postos para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPersonReportFilter: post: description: Busca as pessoas para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as pessoas para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getChecklistStatusReportFilter: post: description: Busca a situação dos checklists para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca a situação dos checklists para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getCheckpointReportFilter: post: description: Busca os pontos de controle para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os pontos de controle para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getSchedulingReportFilter: post: description: Busca os agendamentos para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os agendamentos para o campo de lookup do relatório tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchText description: Valor da busca informada pelo usuário in: query type: string – name: searchValue description: Valor para busca exata por um registro in: query type: string responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/reportFilterData minimum: 1 description: Lista de registros encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/listOfLastStatusMobileDevice: post: description: Busca o último status dos dispositivos móveis ativos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status properties: status: type: array items: type: object allOf: – #/definitions/lastStatusMobileDeviceRecord minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o último status dos dispositivos móveis ativos tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – status properties: status: type: array items: type: object allOf: – #/definitions/lastStatusMobileDeviceRecord minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/lastStatusMobileDevice: post: description: Busca o último status de um determinado dispositvo móvel ativo, pelo seu id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: integer format: int64 description: Id do dispositivo móvel responses: 200: description: Ok schema: type: object required: – status properties: status: type: object allOf: – #/definitions/lastStatusMobileDeviceRecord description: Dispositivo móvel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o último status de um determinado dispositvo móvel ativo, pelo seu id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id description: Id do dispositivo móvel in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – status properties: status: type: object allOf: – #/definitions/lastStatusMobileDeviceRecord description: Dispositivo móvel 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getChecklistAssociatedWithIncident: post: description: Retorna o checklist associao ao incidente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – incidentId properties: incidentId: type: integer format: int64 description: Identificador do incidente responses: 200: description: Ok schema: type: object required: – checklistId – tourId – tourCheckpointId properties: checklistId: type: integer format: int64 description: Id do checklist tourId: type: integer format: int64 description: Id da ronda tourCheckpointId: type: integer format: int64 description: Id do ponto de controle da ronda 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o checklist associao ao incidente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: incidentId description: Identificador do incidente in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – checklistId – tourId – tourCheckpointId properties: checklistId: type: integer format: int64 description: Id do checklist tourId: type: integer format: int64 description: Id da ronda tourCheckpointId: type: integer format: int64 description: Id do ponto de controle da ronda 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getTourDetails: post: description: Busca os detalhes da ronda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tourId properties: tourId: type: integer format: int64 description: Identificador da ronda responses: 200: description: Ok schema: type: object required: – tour properties: tour: type: object allOf: – #/definitions/tourDetailsRecord description: Detalhes da ronda 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca os detalhes da ronda tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tourId description: Identificador da ronda in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – tour properties: tour: type: object allOf: – #/definitions/tourDetailsRecord description: Detalhes da ronda 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getPositionRangeItens: post: description: Retorna os Itens de Abrangência do Posto tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getRoutinePlanTypeRangeItens: post: description: Retorna os Itens de Abrangência dos tipos de plano de rotinas tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer format: int64 description: Valor para busca por identificador de um registro parameters: type: array items: type: object allOf: – #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: type: array items: type: object allOf: – #/definitions/rangeItens minimum: 1 description: Lista de registros encontrados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getRoutinePlanType: post: description: Retorna os tipos de plano de rotinas tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – routinePlanTypes properties: routinePlanTypes: type: array items: type: string allOf: – #/definitions/routinePlanType minimum: 1 description: Lista de planos de rotinas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna os tipos de plano de rotinas tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – routinePlanTypes properties: routinePlanTypes: type: array items: type: string allOf: – #/definitions/routinePlanType minimum: 1 description: Lista de planos de rotinas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/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: 401: description: Invalid Credentials 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportPosition: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportContact: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportPhysicalLocation: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportRejectedTour: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportPerson: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportMobileDevice: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportIncidentType: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/exportIncident: post: description: tags: – Queries x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE 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 401: description: Invalid Credentials 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: PRIVATE 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createTours: post: description: Cria as instâncias de rondas tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – executionDate properties: executionDate: type: string format: date-time description: Data da execução responses: 200: description: Ok schema: type: object properties: successfulSchedules: type: array items: type: integer format: int64 description: Agendamentos processados com sucesso schedulesWithErrors: type: array items: type: integer format: int64 description: Agendamentos processados com erro 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createTourPlan: post: description: Cria o plano de ronda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – schedulingRecord properties: schedulingRecord: type: object allOf: – #/definitions/schedulingRecord description: Agendamento responses: 200: description: Ok schema: type: object required: – schedulingRecord properties: schedulingRecord: type: object allOf: – #/definitions/schedulingRecord description: Agendamento criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/updateTourPlan: post: description: Altera um plano de ronda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – schedulingRecord properties: schedulingRecord: type: object allOf: – #/definitions/schedulingRecord description: Agendamento responses: 200: description: Ok schema: type: object required: – schedulingRecord properties: schedulingRecord: type: object allOf: – #/definitions/schedulingRecord description: Agendamento alterado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/finishTour: post: description: Finaliza a ronda em execução tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – tourId – personId – finishDate – justification properties: deviceUUID: type: string description: Identificador do dispositivo móvel tourId: type: integer format: int64 description: Identificador da ronda personId: type: integer format: int64 description: Identificador da pessoa que finalizou a ronda finishDate: type: string description: Data/hora da finalização da ronda no formato ISO8601 justification: type: string maxLength: 500 description: Justificativa para finalizar a ronda responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/registerCheckpoints: post: description: Registra a execução de uma lista de pontos de controle tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – checkpoints properties: deviceUUID: type: string description: Identificador do dispositivo móvel checkpoints: type: array items: type: object allOf: – #/definitions/registerCheckpointRecord minimum: 1 description: Checkpoints responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getMobileDevice: post: description: Busca um dispositivo móvel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: mobileDeviceId: type: integer format: int64 description: ID responses: 200: description: Ok schema: type: object required: – mobileDeviceRecord properties: mobileDeviceRecord: type: object allOf: – #/definitions/mobileDeviceRecord description: Dispositivo móvel encontrado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createMobileDevice: post: description: Cria um dispositivo móvel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – active – platform properties: name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observação phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 active: type: boolean description: Estado do dispositivo móvel platform: type: string allOf: – #/definitions/platform description: Plataforma responses: 200: description: Ok schema: type: object required: – mobileDeviceRecord properties: mobileDeviceRecord: type: object allOf: – #/definitions/mobileDeviceRecord description: Dispositivo móvel criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/updateMobileDevice: post: description: Atualiza um dispositivo móvel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – active – platform properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observação phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 active: type: boolean description: Estado do dispositivo móvel platform: type: string allOf: – #/definitions/platform description: Plataforma responses: 200: description: Ok schema: type: object required: – mobileDeviceRecord properties: mobileDeviceRecord: type: object allOf: – #/definitions/mobileDeviceRecord description: Dispositivo móvel alterado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/deleteMobileDevice: post: description: Apaga um dispositivo móvel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: mobileDeviceId: type: integer format: int64 description: ID responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/generateActivationCode: post: description: Gera um código de ativação para um dispositivo móvel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – mobileDeviceId properties: mobileDeviceId: type: integer format: int64 description: ID do dispositivo móvel responses: 200: description: Ok schema: type: object required: – activationCode properties: activationCode: type: string description: Código de ativação gerado para o dispositivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/activateMobileDevice: post: description: Ativa um dispositivo móvel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – activationCode properties: activationCode: type: string description: Código de ativação responses: 200: description: Ok schema: type: object properties: deviceUUID: type: string description: Identificador gerado para o dispositivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getChecklistAttachmentUploadUrl: post: description: Retorna a URL para o upload do anexo de um checklist tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – checklistId – fileName properties: deviceUUID: type: string description: Identificador do dispositivo móvel checklistId: type: integer format: int64 description: ID do checklist fileName: type: string description: Nome do arquivo no formato timestamp.extensão responses: 200: description: Ok schema: type: object required: – version – uploadUrl properties: type: string description: Versão do arquivo uploadUrl: type: string description: Url para upload do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/saveChecklistAttachment: post: description: Salva o anexo de um checklist tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – deviceUUID – checklistId – personId – fileName – version – fileType properties: deviceUUID: type: string description: Identificador do dispositivo móvel checklistId: type: integer format: int64 description: ID do checklist personId: type: integer format: int64 description: ID da pessoa fileName: type: string description: Nome do arquivo no formato timestamp.extensão type: string description: Versão do arquivo fileType: type: string allOf: – #/definitions/fileType description: Tipo do arquivo responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/getChecklistAttachmentDownloadUrl: post: description: Retorna a URL para download do anexo de um checklist tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – checklistId – fileName properties: checklistId: type: integer format: int64 description: ID do checklist fileName: type: string description: Nome do arquivo responses: 200: description: Ok schema: type: object required: – downloadUrl properties: downloadUrl: type: string description: Url para download do arquivo 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createMobileDeviceStatus: post: description: Salva o status do dispositivo móvel tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – mobileDevicesStatus properties: mobileDevicesStatus: type: array items: type: object allOf: – #/definitions/mobileDeviceStatusRecord minimum: 1 description: Lista de records do status dos dispositivos móveis responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/createPerson: post: description: API DEPRECIADA: Serviço descontinuado | DATA: 2023-07-05 | Salva a pessoa tags: – Actions deprecated : true x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name – documentTypeId – document – user – email properties: name: type: string description: Nome do usuário documentTypeId: type: integer format: int64 description: Identificador do tipo de documento document: type: string description: Número do documento user: type: string description: Usuário da plataforma email: type: string description: E-mail do usuário responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importPosition: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importContact: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importPhysicalLocation: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importRejectedTour: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importPerson: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importMobileDevice: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importIncidentType: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/actions/importIncident: post: description: tags: – Actions x-senior-visibility: PRIVATE 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: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/events/checklistThatGeneratesIncidentRegistered: post: description: Checklist configurado para registrar incidentes registrado x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – checklist properties: checklist: type: object allOf: – #/definitions/checklistThatGeneratesIncidentRecord description: Checklist em não conformidade responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importSchedulingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportSchedulingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importContactEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportContactEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importPositionContactEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportPositionContactEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importPhysicalLocationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportPhysicalLocationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importChecklistTemplateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportChecklistTemplateEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importChecklistTemplateItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportChecklistTemplateItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importCheckpointEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportCheckpointEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importRouteCheckpointEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportRouteCheckpointEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importTourEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportTourEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importTourCheckpointEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportTourCheckpointEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importChecklistEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportChecklistEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importRejectedTourEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportRejectedTourEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importPersonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportPersonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importMobileDeviceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportMobileDeviceEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importMobileDeviceActivationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportMobileDeviceActivationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importChecklistAttachmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportChecklistAttachmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importChecklistNotificationEmailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportChecklistNotificationEmailEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importIncidentTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportIncidentTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importIncidentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportIncidentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/importMobileDeviceStatusEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/events/exportMobileDeviceStatusEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /patrol/entities/position: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/position responses: 200: description: The created resource schema: #/definitions/position 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/position responses: 200: description: The created resource schema: #/definitions/position 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/position 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/position responses: 200: description: Ok schema: #/definitions/position 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/position responses: 200: description: Ok schema: #/definitions/position 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/position 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/position responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/scheduling: post: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/scheduling/{id}: put: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/schedules: post: description: Esta entidade pode ser customizada. 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/scheduling responses: 200: description: The created resources schema: type: array items: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/scheduling responses: 200: description: The created resources schema: type: array items: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/schedules/{id}: put: description: Esta entidade pode ser customizada. 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/scheduling responses: 200: description: Ok schema: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/scheduling responses: 200: description: Ok schema: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/scheduling/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/scheduling responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/contact: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/contact/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: Ok schema: #/definitions/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: Ok schema: #/definitions/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/contact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/positionContact: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/positionContact responses: 200: description: The created resource schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/positionContact responses: 200: description: The created resource schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/positionContact/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/positionContact: post: description: Esta entidade pode ser customizada. 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/positionContact responses: 200: description: The created resources schema: type: array items: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/positionContact responses: 200: description: The created resources schema: type: array items: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/contact/{parentId}/positionContact: post: description: Esta entidade pode ser customizada. 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/positionContact responses: 200: description: The created resources schema: type: array items: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/positionContact responses: 200: description: The created resources schema: type: array items: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/positionContact/{id}: put: description: Esta entidade pode ser customizada. 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/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/contact/{parentId}/positionContact/{id}: put: description: Esta entidade pode ser customizada. 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/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/positionContact responses: 200: description: Ok schema: #/definitions/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/positionContact 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/positionContact/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/positionContact responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/physicalLocation: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/physicalLocation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/checklistTemplate responses: 200: description: The created resource schema: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/checklistTemplate responses: 200: description: The created resource schema: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/checklistTemplate responses: 200: description: Ok schema: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/checklistTemplate responses: 200: description: Ok schema: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/checklists: post: description: Esta entidade pode ser customizada. 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/checklistTemplate responses: 200: description: The created resources schema: type: array items: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklistTemplate responses: 200: description: The created resources schema: type: array items: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/checklists/{id}: put: description: Esta entidade pode ser customizada. 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/checklistTemplate responses: 200: description: Ok schema: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklistTemplate responses: 200: description: Ok schema: #/definitions/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/checklistTemplate 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checklistTemplate responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplateItem: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/checklistTemplateItem responses: 200: description: The created resource schema: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/checklistTemplateItem responses: 200: description: The created resource schema: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplateItem/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/checklistTemplateItem responses: 200: description: Ok schema: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/checklistTemplateItem responses: 200: description: Ok schema: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{parentId}/items: post: description: Esta entidade pode ser customizada. 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/checklistTemplateItem responses: 200: description: The created resources schema: type: array items: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklistTemplateItem responses: 200: description: The created resources schema: type: array items: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{parentId}/items/{id}: put: description: Esta entidade pode ser customizada. 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/checklistTemplateItem responses: 200: description: Ok schema: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklistTemplateItem responses: 200: description: Ok schema: #/definitions/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/checklistTemplateItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplateItem/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checklistTemplateItem responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/checkpoint responses: 200: description: The created resource schema: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/checkpoint responses: 200: description: The created resource schema: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/checkpoint responses: 200: description: Ok schema: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/checkpoint responses: 200: description: Ok schema: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/checkpoints: post: description: Esta entidade pode ser customizada. 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/checkpoint responses: 200: description: The created resources schema: type: array items: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checkpoint responses: 200: description: The created resources schema: type: array items: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/position/{parentId}/checkpoints/{id}: put: description: Esta entidade pode ser customizada. 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/checkpoint responses: 200: description: Ok schema: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checkpoint responses: 200: description: Ok schema: #/definitions/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/checkpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checkpoint responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/scheduling/{parentId}/routeCheckpoint: post: description: Esta entidade pode ser customizada. 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/routeCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/routeCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{parentId}/routeCheckpoint: post: description: Esta entidade pode ser customizada. 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/routeCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/routeCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/scheduling/{parentId}/routeCheckpoint/{id}: put: description: Esta entidade pode ser customizada. 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/routeCheckpoint responses: 200: description: Ok schema: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/routeCheckpoint responses: 200: description: Ok schema: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{parentId}/routeCheckpoint/{id}: put: description: Esta entidade pode ser customizada. 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/routeCheckpoint responses: 200: description: Ok schema: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/routeCheckpoint responses: 200: description: Ok schema: #/definitions/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/routeCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tour responses: 200: description: The created resource schema: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tour responses: 200: description: The created resource schema: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tour responses: 200: description: Ok schema: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tour responses: 200: description: Ok schema: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/scheduling/{parentId}/tours: post: description: Esta entidade pode ser customizada. 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/tour responses: 200: description: The created resources schema: type: array items: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/tour responses: 200: description: The created resources schema: type: array items: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/scheduling/{parentId}/tours/{id}: put: description: Esta entidade pode ser customizada. 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/tour responses: 200: description: Ok schema: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/tour responses: 200: description: Ok schema: #/definitions/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/tour 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tour responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{parentId}/tourCheckpoints: post: description: Esta entidade pode ser customizada. 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/tourCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/tourCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour/{parentId}/checkpoints: post: description: Esta entidade pode ser customizada. 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/tourCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/tourCheckpoint responses: 200: description: The created resources schema: type: array items: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checkpoint/{parentId}/tourCheckpoints/{id}: put: description: Esta entidade pode ser customizada. 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/tourCheckpoint responses: 200: description: Ok schema: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/tourCheckpoint responses: 200: description: Ok schema: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tour/{parentId}/checkpoints/{id}: put: description: Esta entidade pode ser customizada. 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/tourCheckpoint responses: 200: description: Ok schema: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/tourCheckpoint responses: 200: description: Ok schema: #/definitions/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/tourCheckpoint 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tourCheckpoint/{parentId}/checklists: post: description: Esta entidade pode ser customizada. 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/checklist responses: 200: description: The created resources schema: type: array items: #/definitions/checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklist responses: 200: description: The created resources schema: type: array items: #/definitions/checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/tourCheckpoint/{parentId}/checklists/{id}: put: description: Esta entidade pode ser customizada. 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/checklist responses: 200: description: Ok schema: #/definitions/checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklist responses: 200: description: Ok schema: #/definitions/checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/checklist 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/person: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/mobileDevice 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDeviceActivation: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice/{parentId}/activations: post: 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/mobileDeviceActivation responses: 200: description: The created resources schema: type: array items: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/mobileDeviceActivation responses: 200: description: The created resources schema: type: array items: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice/{parentId}/activations/{id}: put: 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/mobileDeviceActivation responses: 200: description: Ok schema: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: 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/mobileDeviceActivation responses: 200: description: Ok schema: #/definitions/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: 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/mobileDeviceActivation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklist/{parentId}/attachments: post: description: Esta entidade pode ser customizada. 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/checklistAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/checklistAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklistAttachment responses: 200: description: The created resources schema: type: array items: #/definitions/checklistAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checklistAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklist/{parentId}/attachments/{id}: put: description: Esta entidade pode ser customizada. 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/checklistAttachment responses: 200: description: Ok schema: #/definitions/checklistAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklistAttachment responses: 200: description: Ok schema: #/definitions/checklistAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/checklistAttachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistNotificationEmail: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/checklistNotificationEmail responses: 200: description: The created resource schema: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/checklistNotificationEmail responses: 200: description: The created resource schema: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistNotificationEmail/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/checklistNotificationEmail responses: 200: description: Ok schema: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/checklistNotificationEmail responses: 200: description: Ok schema: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{parentId}/checklistNotificationEmail: post: description: Esta entidade pode ser customizada. 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/checklistNotificationEmail responses: 200: description: The created resources schema: type: array items: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklistNotificationEmail responses: 200: description: The created resources schema: type: array items: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistTemplate/{parentId}/checklistNotificationEmail/{id}: put: description: Esta entidade pode ser customizada. 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/checklistNotificationEmail responses: 200: description: Ok schema: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/checklistNotificationEmail responses: 200: description: Ok schema: #/definitions/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/checklistNotificationEmail 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/checklistNotificationEmail/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/checklistNotificationEmail responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/incidentType: get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/incidentType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDeviceStatus: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice/{parentId}/mobileDeviceStatus: post: description: Esta entidade pode ser customizada. 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/mobileDeviceStatus responses: 200: description: The created resources schema: type: array items: #/definitions/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/mobileDeviceStatus responses: 200: description: The created resources schema: type: array items: #/definitions/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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 – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /patrol/entities/mobileDevice/{parentId}/mobileDeviceStatus/{id}: put: description: Esta entidade pode ser customizada. 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/mobileDeviceStatus responses: 200: description: Ok schema: #/definitions/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. 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/mobileDeviceStatus responses: 200: description: Ok schema: #/definitions/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. 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/mobileDeviceStatus 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. 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 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: healthcheckStatus: description: Status do healthcheck type: string enum: – UP – DOWN platform: description: Plataforma do dispositivo móvel type: string enum: – ANDROID – IOS checkpointType: description: Tipo de Checkpoint type: string enum: – QRCODE – GEOLOCATION – BASIC tourStatus: description: Status da ronda type: string enum: – PENDING – IN_PROGRESS – FINISHED_SUCCESSFULLY – INCOMPLETE – INTERRUPTED – NOT_CARRIED_OUT recurrenceType: description: Tipo de recorrência type: string enum: – DAILY – WEEKLY – DOES_NOT_REPEAT checklistSituation: description: Situação do checklist type: string enum: – OK – NOK rejectedReason: description: Motivos das rondas serem rejeitadas type: string enum: – NOT_FOUND – EXECUTED – PERSON_NOT_FOUND – INVALID_DATE_TIME – OUTSIDE_OF_DEFINED_TIME – MOBILE_DEVICE_NOT_FOUND fileType: description: Tipos de arquivos type: string enum: – PHOTO – AUDIO – VIDEO incidentPriority: description: Prioridades do incidente type: string enum: – PLANNED – LOW – MEDIUM – HIGH – CRITICAL routinePlanType: description: Tipos de plano de rotina type: string enum: – OTHERS – PERIMETER_TOUR – MAINTENANCE – OCCUPATIONAL_SAFETY – PROPERTY_SECURITY – SERVICES – ASSETS_CONTROL – LOBBY – LOGISTICS – ADMINISTRATIVE – ISO – PDCA – QUALITY – HUMAN_RESOURCES – STOCK – WAREHOUSE – CERTIFICATION – DELIVERIES – INSPECTIONS – VEHICLES – LOAD_UNLOAD 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 – LOCALDATETIME – 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 checklistThatGeneratesIncidentRecord: description: Checklist configurado para registrar incidentes type: object required: – checklistId – description – checkInDate – timezoneOffset – incidentTypeId – incidentPriority – physicalLocationId – latitude – longitude properties: checklistId: type: integer format: int64 description: ID description: type: string description: Descrição do checklist checkInDate: type: string format: date-time description: Data do checkIn timezoneOffset: type: integer format: int64 description: TimezoneOffset do checkIn incidentTypeId: type: integer format: int64 description: ID do Tipo de incident incidentPriority: type: string allOf: – #/definitions/incidentPriority description: Prioridade do incidente physicalLocationId: type: integer format: int64 description: ID do local físico latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude 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 nearbyPositionRecord: description: Informações básicas dos postos encontrados nas proximidades type: object required: – id – name – latitude – longitude – radius – distance properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do posto latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude radius: type: integer format: int64 description: Raio (em metros) distance: type: number format: double description: Distância aproximada (em metros) incidentType: type: object allOf: – #/definitions/incidentType description: Tipo de incidente physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico registerCheckpointRecord: description: Informações do registro de ponto de controle type: object required: – id – tourId – personId – checkInDate properties: id: type: integer format: int64 description: ID tourId: type: integer format: int64 description: ID da ronda personId: type: integer format: int64 description: ID da pessoa que executou o ponto de controle checkInDate: type: string description: Data/hora do checkIn no formato ISO8601 justification: type: string description: Justificativa para erros na leitura do ponto de controle latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 checklists: type: array items: type: object allOf: – #/definitions/registerChecklistRecord description: Checklists registerChecklistRecord: description: Informações do registro de checklist type: object required: – id – situation properties: id: type: integer format: int64 description: ID note: type: string maxLength: 500 description: Observação situation: type: string allOf: – #/definitions/checklistSituation description: Situação schedulingRecord: description: Agendamento type: object required: – name – startHour – endHour – startDate – recurrenceType – active – positionId – routeCheckpoint properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do agendamento startHour: type: string description: Hora inicial endHour: type: string description: Hora final startDate: type: string format: date description: Data de início recurrenceType: type: string allOf: – #/definitions/recurrenceType description: Recorrência interval: type: integer format: int64 description: Intervalo da recorrência minimum: 1 monday: type: boolean description: Segunda default: false tuesday: type: boolean description: Terça default: false wednesday: type: boolean description: Quarta default: false thursday: type: boolean description: Quinta default: false friday: type: boolean description: Sexta default: false saturday: type: boolean description: Sábado default: false sunday: type: boolean description: Domingo default: false active: type: boolean description: Estado do agendamento positionId: type: integer format: int64 description: Posto routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpointRecord minimum: 1 description: Rota checkpoint createBy: type: string description: Responsável pela criação createDate: type: string format: date-time description: Data da criação lastModifiedBy: type: string description: Responssável pela ultima modificação lastModifiedDate: type: string format: date-time description: Data da ultima modificação routeCheckpointRecord: description: Rota checkpoint type: object required: – order properties: id: type: integer format: int64 description: ID order: type: integer format: int64 description: Ordem minimum: 1 checkpoint: type: object allOf: – #/definitions/checkpointRecord description: Checkpoint checklist: type: object allOf: – #/definitions/checklistTemplateRecord description: Checklist checkpointRecord: description: Checkpoint type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome checkpointType: type: string allOf: – #/definitions/checkpointType description: Tipo checklistTemplateRecord: description: Modelo de checklist type: object properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome tourRecord: description: Record da ronda type: object required: – startDate – endDate – schedulingName – status – tourCheckpoints properties: id: type: integer format: int64 description: ID startDate: type: string description: Data e hora inicial da ronda no formato ISO-8601 endDate: type: string description: Data e hora final da ronda no formato ISO-8601 schedulingName: type: string description: Nome do agendamento status: type: string allOf: – #/definitions/tourStatus description: Status tourCheckpoints: type: array items: type: object allOf: – #/definitions/tourCheckpointRecord minimum: 1 description: Pontos de controle tourCheckpointRecord: description: Record do ponto de controle da ronda type: object required: – order – checkpointId – checkInDate properties: id: type: integer format: int64 description: ID order: type: integer format: int64 description: Ordem minimum: 1 checkpointId: type: integer format: int64 description: Id do ponto de controle checkInDate: type: string description: Data e hora do check in formato ISO-8601 latitude: type: number format: double description: Latitude no momento do check in minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude no momento do check in minimum: -180.0 maximum: 180.0 checklists: type: array items: type: object allOf: – #/definitions/checklistRecord description: Checklists checklistRecord: description: Record do checklist type: object required: – situation properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição note: type: string maxLength: 500 description: Observação situation: type: string allOf: – #/definitions/checklistSituation description: Situação mobileDeviceRecord: description: Record do dispositivo móvel type: object required: – name – active – platform – activationCodeCreatedBy – activationCodeCreatedDate – activatedBy – activationDate properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observação phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 active: type: boolean description: Estado do dispositivo móvel platform: type: string allOf: – #/definitions/platform description: Plataforma activationCode: type: string description: Código de ativação deviceUUID: type: string description: Identificador gerado para o dispositivo activationCodeCreatedBy: type: string description: Usuário que gerou o código de ativação activationCodeCreatedDate: type: string format: date-time description: Data da geração do código de ativação activatedBy: type: string description: Usuário que ativou o dispositivo activationDate: type: string format: date-time description: Data da ativação reportFilterData: description: Record relatorio filtro dados type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro lastStatusMobileDeviceRecord: description: Record último status de um dispositivo móvel type: object required: – mobileDeviceName – personName – collectDate – batteryLevel – latitude – longitude properties: mobileDeviceName: type: string description: Nome do dispositivo personName: type: string description: Nome da pessoa logada no dispositivo collectDate: type: string description: Data da Coleta batteryLevel: type: integer format: int64 description: Nível da Bateria latitude: type: number format: double description: Latitude da localização minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude da localização minimum: -180.0 maximum: 180.0 mobileDeviceStatusRecord: description: Record do status do dispositivo móvel type: object required: – deviceUUID – batteryLevel – collectDate – personId properties: deviceUUID: type: string description: ID batteryLevel: type: integer format: int64 description: Bateria do dispositivo minimum: 0 maximum: 100 latitude: type: number format: double description: Latitude no momento da coleta do status minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude no momento da coleta do status minimum: -180.0 maximum: 180.0 collectDate: type: string description: Data/hora da coleta do status no formato ISO8601 personId: type: integer format: int64 description: Identificador da pessoa logada no dispositivo tourDetailsRecord: description: Detalhes da ronda type: object required: – id – position – scheduling – startDate – endDate – startedIn – finishedIn – person – status – justification – tourCheckpoints properties: id: type: integer format: int64 description: ID position: type: string description: Posto de vigia scheduling: type: string description: Agendamento startDate: type: string description: Data início endDate: type: string description: Data fim startedIn: type: string description: Data e hora que a ronda foi iniciada finishedIn: type: string description: Data e hora que a ronda foi finalizada person: type: string description: Pessoa status: type: string allOf: – #/definitions/tourStatus description: Status justification: type: string description: Justificativa para finalizar a ronda tourCheckpoints: type: array items: type: object allOf: – #/definitions/tourCheckpointDetailsRecord minimum: 1 description: Pontos de controle tourCheckpointDetailsRecord: description: Detalhes do ponto de controle type: object required: – id – name – checkInDate – latitude – longitude – justification – checklists properties: id: type: integer format: int64 description: ID name: type: string description: Nome checkInDate: type: string description: Data e hora do check in latitude: type: number format: double description: Latitude no momento do check in longitude: type: number format: double description: Longitude no momento do check in justification: type: string description: Justificativa para erros na leitura do ponto de controle checklists: type: array items: type: object allOf: – #/definitions/checklistDetailsRecord minimum: 1 description: Checklists checklistDetailsRecord: description: Detalhes do checklist type: object required: – id – description – situation – note – attachments properties: id: type: integer format: int64 description: ID description: type: string description: Descrição situation: type: string allOf: – #/definitions/checklistSituation description: Situação note: type: string description: Observação attachments: type: array items: type: object allOf: – #/definitions/attachmentDetailsRecord minimum: 1 description: Anexos attachmentDetailsRecord: description: Detalhes do anexo do checklist type: object required: – id – fileType – fileName – url properties: id: type: integer format: int64 description: ID fileType: type: string allOf: – #/definitions/fileType description: Tipo do arquivo fileName: type: string description: Nome do arquivo url: type: string description: URL do anexo searchParametersItens: description: Parâmetros de Pesquisa da Abrangência type: object required: – key – value properties: key: type: string description: Nome do campo filtro que está sendo enviado como parâmetro value: type: string description: Valor do campo filtro que está sendo enviado como parâmetro rangeItens: description: Itens da Abrangência type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro position: description: Posto type: object required: – name – physicalLocation – active properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do posto note: type: string maxLength: 255 description: Observação physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 radius: type: integer format: int64 description: Raio (em metros) minimum: 10 active: type: boolean description: Estado do posto positionContact: type: array items: type: object allOf: – #/definitions/positionContact description: Contatos do posto checklists: type: array items: type: object allOf: – #/definitions/checklistTemplate description: Checklists do posto checkpoints: type: array items: type: object allOf: – #/definitions/checkpoint description: Checkpoints schedules: type: array items: type: object allOf: – #/definitions/scheduling description: Agendamentos incidentType: type: object allOf: – #/definitions/incidentType description: Tipo do incidente routinePlanType: type: string allOf: – #/definitions/routinePlanType description: Tipo do plano de rotina allowsManualSelection: type: boolean description: Seleção manual do plano de rotina default: false 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: – name – startHour – endHour – startDate – recurrenceType – active properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome do agendamento startHour: type: string description: Hora inicial endHour: type: string description: Hora final startDate: type: string format: date description: Data de início recurrenceType: type: string allOf: – #/definitions/recurrenceType description: Recorrência interval: type: integer format: int64 description: Intervalo da recorrência minimum: 1 monday: type: boolean description: Segunda default: false tuesday: type: boolean description: Terça default: false wednesday: type: boolean description: Quarta default: false thursday: type: boolean description: Quinta default: false friday: type: boolean description: Sexta default: false saturday: type: boolean description: Sábado default: false sunday: type: boolean description: Domingo default: false active: type: boolean description: Estado do agendamento position: type: object allOf: – #/definitions/position description: Posto routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpoint description: Rota checkpoint tours: type: array items: type: object allOf: – #/definitions/tour description: Rondas lastGeneration: type: string format: date-time description: Data/hora da última geração de rondas createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: contact: description: Contato type: object required: – name – phoneNumber properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 positionContact: type: array items: type: object allOf: – #/definitions/positionContact description: Postos do contato createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: positionContact: description: Relação Posto Contato type: object properties: id: type: integer format: int64 description: ID contact: type: object allOf: – #/definitions/contact description: Contato position: type: object allOf: – #/definitions/position description: Posto physicalLocation: description: Local Físico type: object required: – name – externalLocation properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome parent: type: integer format: int64 description: ID do Pai fullHierarchicalPath: type: string description: Caminho hierárquico completo externalLocation: type: boolean description: Local externo checklistTemplate: description: Modelo de checklist type: object required: – name – items – active properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome items: type: array items: type: object allOf: – #/definitions/checklistTemplateItem minimum: 1 description: Itens position: type: object allOf: – #/definitions/position description: Posto routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpoint description: Rota checkpoint active: type: boolean description: Status do checklist checklistNotificationEmail: type: array items: type: object allOf: – #/definitions/checklistNotificationEmail description: Email para notificação tourCheckpoint: type: array items: type: object allOf: – #/definitions/tourCheckpoint description: Ronda checkpoint createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checklistTemplateItem: description: Item do modelo de checklist type: object required: – description properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição checklistTemplate: type: object allOf: – #/definitions/checklistTemplate description: Modelo de checklist incidentType: type: object allOf: – #/definitions/incidentType description: Tipo de ocorrência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checkpoint: description: Checkpoint type: object required: – name – checkpointType – active properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome position: type: object allOf: – #/definitions/position description: Posto checkpointType: type: string allOf: – #/definitions/checkpointType description: Tipo latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 radius: type: integer format: int64 description: Raio (em metros) minimum: 10 maximum: 50 active: type: boolean description: Estado do checkpoint routeCheckpoint: type: array items: type: object allOf: – #/definitions/routeCheckpoint description: Rota checkpoint tourCheckpoints: type: array items: type: object allOf: – #/definitions/tourCheckpoint description: Checkpoint de ronda physicalLocation: type: object allOf: – #/definitions/physicalLocation description: Local físico note: type: string maxLength: 255 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: routeCheckpoint: description: Rota checkpoint type: object required: – order properties: id: type: integer format: int64 description: ID order: type: integer format: int64 description: Ordem minimum: 1 checkpoint: type: object allOf: – #/definitions/checkpoint description: Checkpoint scheduling: type: object allOf: – #/definitions/scheduling description: Scheduling checklist: type: object allOf: – #/definitions/checklistTemplate description: Checklist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tour: description: Ronda type: object required: – startDate – startDateTimezoneOffset – endDate – endDateTimezoneOffset – status properties: id: type: integer format: int64 description: ID startDate: type: string format: date-time description: Data e hora inicial da ronda startDateTimezoneOffset: type: integer format: int64 description: Offset da data inicial da ronda endDate: type: string format: date-time description: Data e hora final da ronda endDateTimezoneOffset: type: integer format: int64 description: Offset da data final da ronda scheduling: type: object allOf: – #/definitions/scheduling description: Agendamento checkpoints: type: array items: type: object allOf: – #/definitions/tourCheckpoint description: Checkpoints status: type: string allOf: – #/definitions/tourStatus description: Status da ronda person: type: object allOf: – #/definitions/person description: Pessoa que executou a ronda startedIn: type: string format: date-time description: Data e hora que a ronda foi iniciada startedInTimezoneOffset: type: integer format: int64 description: Offset da data e hora que a ronda foi iniciada finishedIn: type: string format: date-time description: Data e hora que a ronda foi finalizada finishedInTimezoneOffset: type: integer format: int64 description: Offset da data e hora que a ronda foi finalizada justification: type: string maxLength: 500 description: Justificativa para finalizar a ronda mobileDevice: type: object allOf: – #/definitions/mobileDevice description: Dispositivo móvel createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: tourCheckpoint: description: Ponto de controle da ronda type: object required: – order – checkInDate – timezoneOffset properties: id: type: integer format: int64 description: ID order: type: integer format: int64 description: Ordem minimum: 1 checkInDate: type: string format: date-time description: Data e hora do check in timezoneOffset: type: integer format: int64 description: Offset do check In latitude: type: number format: double description: Latitude no momento do check in minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude no momento do check in minimum: -180.0 maximum: 180.0 checkpoint: type: object allOf: – #/definitions/checkpoint description: Checkpoint tour: type: object allOf: – #/definitions/tour description: Ronda checklists: type: array items: type: object allOf: – #/definitions/checklist description: Checklists justification: type: string maxLength: 500 description: Justificativa para erros na leitura do ponto de controle checklistTemplate: type: object allOf: – #/definitions/checklistTemplate description: Modelo do checklist insideGeofence: type: boolean description: Leitura do ponto de controle foi feita dentro do perímetro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checklist: description: Checklist do ponto de controle type: object required: – description – situation properties: id: type: integer format: int64 description: ID description: type: string maxLength: 255 description: Descrição note: type: string maxLength: 500 description: Observação situation: type: string allOf: – #/definitions/checklistSituation description: Situação tourCheckpoint: type: object allOf: – #/definitions/tourCheckpoint description: Checkpoint attachments: type: array items: type: object allOf: – #/definitions/checklistAttachment description: Anexos incidentType: type: object allOf: – #/definitions/incidentType description: Tipo de ocorrência incident: type: object allOf: – #/definitions/incident description: Ocorrência createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: rejectedTour: description: Ronda rejeitada type: object required: – reason properties: id: type: integer format: int64 description: ID checkInDate: type: string format: date-time description: Data e hora do check in timezoneOffset: type: integer format: int64 description: Offset da ronda rejeitada reason: type: string allOf: – #/definitions/rejectedReason description: Motivo tour: type: integer format: int64 description: Ronda tourCheckpoint: type: integer format: int64 description: Checkpoint personId: type: integer format: int64 description: Id da pessoa que executou a ronda createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: person: description: Pessoa type: object required: – name properties: id: type: integer format: int64 description: ID name: type: string maxLength: 100 description: Nome mobileDevice: description: Dispositivo móvel type: object required: – name – active – platform properties: id: type: integer format: int64 description: ID name: type: string maxLength: 255 description: Nome note: type: string maxLength: 255 description: Observação phoneNumber: type: string maxLength: 50 description: Número de telefone com o formato esperado E.164 active: type: boolean description: Estado do dispositivo móvel platform: type: string allOf: – #/definitions/platform description: Plataforma activationCode: type: string description: Código de ativação deviceUUID: type: string description: Identificador gerado para o dispositivo activationCodeCreatedBy: type: string description: Usuário que gerou o código de ativação activationCodeCreatedDate: type: string format: date-time description: Data da geração do código de ativação activatedBy: type: string description: Usuário que ativou o dispositivo activationDate: type: string format: date-time description: Data da ativação activations: type: array items: type: object allOf: – #/definitions/mobileDeviceActivation description: Ativações do dispositivo mobileDeviceStatus: type: array items: type: object allOf: – #/definitions/mobileDeviceStatus description: Status do dispositivo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: mobileDeviceActivation: description: Ativação do dispositivo móvel type: object required: – deviceUUID – activationCodeCreatedBy – activationCodeCreatedDate – activatedBy – activationDate properties: id: type: integer format: int64 description: ID deviceUUID: type: string maxLength: 255 description: Identificador gerado para dispositivo activationCodeCreatedBy: type: string description: Usuário que gerou o código de ativação activationCodeCreatedDate: type: string format: date-time description: Data da geração do código de ativação activatedBy: type: string description: Usuário ativou o dispositivo activationDate: type: string format: date-time description: Data da ativação mobileDevice: type: object allOf: – #/definitions/mobileDevice description: Dispositivo móvel createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checklistAttachment: description: Anexo de checklist type: object required: – fileName – fileType properties: id: type: integer format: int64 description: ID fileName: type: string maxLength: 255 description: Nome do arquivo fileType: type: string allOf: – #/definitions/fileType description: Tipo do arquivo checklist: type: object allOf: – #/definitions/checklist description: Checklist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: checklistNotificationEmail: description: Notificacao de emails type: object required: – email properties: id: type: integer format: int64 description: ID email: type: string maxLength: 100 description: Email checklistTemplate: type: object allOf: – #/definitions/checklistTemplate description: Checkist createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: incidentType: description: Tipo do incidente type: object required: – name – defaultPriority – description properties: id: type: integer format: int64 description: ID name: type: string maxLength: 50 description: Nome defaultPriority: type: string allOf: – #/definitions/incidentPriority description: Prioridade Padrão description: type: string maxLength: 200 description: Descrição do tipo do incidente incident: description: Ocorrência type: object properties: id: type: integer format: int64 description: ID createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: mobileDeviceStatus: description: Status do dispositivo móvel type: object required: – collectDate – collectDateTimezoneOffset – batteryLevel properties: id: type: integer format: int64 description: ID collectDate: type: string format: date-time description: Data/hora collectDateTimezoneOffset: type: integer format: int64 description: Offset da data batteryLevel: type: integer format: int64 description: Nível de bateria minimum: 0 maximum: 100 latitude: type: number format: double description: Latitude minimum: -90.0 maximum: 90.0 longitude: type: number format: double description: Longitude minimum: -180.0 maximum: 180.0 mobileDevice: type: object allOf: – #/definitions/mobileDevice description: Dispositivo móvel person: type: object allOf: – #/definitions/person description: Pessoa logada no dispositivo 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