2.0info: 2.6.2 Gestão de Rotinas description: Serviço do backend do Gestão de Rotinas 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: api.senior.com.br /sam/patrolsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /lastStatusMobileDevice: post: description: Busca o último status de um determinado dispositvo móvel ativo, pelo seu id x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: integer description: Id do dispositivo móvel responses: 200: description: Ok schema: type: object required: – status properties: status: #/definitions/lastStatusMobileDeviceRecord default: description: Error response schema: #/definitions/genericError get: description: Busca o último status de um determinado dispositvo móvel ativo, pelo seu id x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – id properties: id: type: integer description: Id do dispositivo móvel responses: 200: description: Ok schema: type: object required: – status properties: status: #/definitions/lastStatusMobileDeviceRecord default: description: Error response schema: #/definitions/genericError /getPositionRangeItens: post: description: Retorna os Itens de Abrangência do Plano de Rotina x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer description: Valor para busca por identificador de um registro parameters: type: array items: #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/rangeItens default: description: Error response schema: #/definitions/genericError get: description: Retorna os Itens de Abrangência do Plano de Rotina x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer description: Valor para busca por identificador de um registro parameters: type: array items: #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/rangeItens default: description: Error response schema: #/definitions/genericError /listOfLastStatusMobileDevice: post: description: Busca o último status dos dispositivos móveis ativos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status properties: status: #/definitions/lastStatusMobileDeviceRecord default: description: Error response schema: #/definitions/genericError get: description: Busca o último status dos dispositivos móveis ativos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – status properties: status: #/definitions/lastStatusMobileDeviceRecord default: description: Error response schema: #/definitions/genericError /getRoutinePlanTypeRangeItens: post: description: Retorna os Itens de Abrangência dos tipos de plano de rotinas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer description: Valor para busca por identificador de um registro parameters: type: array items: #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/rangeItens default: description: Error response schema: #/definitions/genericError get: description: Retorna os Itens de Abrangência dos tipos de plano de rotinas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuário searchValue: type: integer description: Valor para busca por identificador de um registro parameters: type: array items: #/definitions/searchParametersItens description: Nome e valor de outros campos filtros responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/rangeItens default: description: Error response schema: #/definitions/genericError /getRoutinePlanType: post: description: Retorna os tipos de plano de rotinas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – routinePlanTypes properties: routinePlanTypes: #/definitions/routinePlanType default: description: Error response schema: #/definitions/genericError get: description: Retorna os tipos de plano de rotinas x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – routinePlanTypes properties: routinePlanTypes: #/definitions/routinePlanType default: description: Error response schema: #/definitions/genericError /apis/routineTemplate: post: description: The create request primitive for the routineTemplate facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/routineTemplateFacadeInput responses: 200: description: Ok schema: #/definitions/routineTemplateFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The list request primitive for the routineTemplate facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: object required: – contents properties: contents: #/definitions/routineTemplateFacadeOutput default: description: Error response schema: #/definitions/genericError /apis/routineTemplate/{id}: put: description: The update request primitive for the routineTemplate facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: input in: body required: true schema: #/definitions/routineTemplateFacadeInput responses: 200: description: Ok schema: #/definitions/routineTemplateFacadeOutput default: description: Error response schema: #/definitions/genericError get: description: The retrieve request primitive for the routineTemplate facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/routineTemplateFacadeOutput default: description: Error response schema: #/definitions/genericError delete: description: The delete request primitive for the routineTemplate facade. deprecated: false tags: – Apis security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericErrordefinitions: routinePlanType: 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 recurrenceType: type: string enum: – DAILY – WEEKLY – HOLIDAY – MONTHLY weekDay: type: string enum: – SUNDAY – MONDAY – TUESDAY – WEDNESDAY – THURSDAY – FRIDAY – SATURDAY weeklyOrdinal: type: string enum: – FIRST – SECOND – THIRD – FOURTH – LAST checkpointType: type: string enum: – QRCODE – GEOLOCATION – BASIC incidentPriority: type: string enum: – PLANNED – LOW – MEDIUM – HIGH – CRITICAL lastStatusMobileDeviceRecord: 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 description: Nível da Bateria latitude: type: number description: Latitude da localização format: double longitude: type: number description: Longitude da localização format: double searchParametersItens: 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: type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro routineTemplateFacadeInput: type: object required: – name – startDate – active – position – routeCheckpoint properties: id: type: integer description: ID name: type: string description: Nome do template startDate: type: string description: Data de início format: date endDate: type: string description: Data final format: date active: type: boolean description: Estado do template position: #/definitions/positionRecord schedules: type: array items: #/definitions/schedulingRecord description: Agendamentos routeCheckpoint: type: array items: #/definitions/routeCheckpointRecord description: Rota checkpoint incidentType: #/definitions/incidentTypeRecord scheduled: type: boolean description: Rotina agendada maxRoutines: type: integer description: Quantidade máxima de rotinas que podem ser executadas quando a rotina não é agendada positionRecord: type: object required: – id properties: id: type: integer description: ID holidayListId: type: integer description: Id da lista de feriados cadastrada schedulingRecord: type: object required: – startHour – endHour – recurrenceType – active properties: id: type: integer description: ID startHour: type: string description: Hora inicial endHour: type: string description: Hora final recurrenceType: #/definitions/recurrenceType interval: type: integer description: Intervalo da recorrência monday: type: boolean description: Segunda tuesday: type: boolean description: Terça wednesday: type: boolean description: Quarta thursday: type: boolean description: Quinta friday: type: boolean description: Sexta saturday: type: boolean description: Sábado sunday: type: boolean description: Domingo active: type: boolean description: Estado do agendamento createdBy: type: string description: Responsável pela criação createdDate: type: string description: Data da criação format: date-time lastModifiedBy: type: string description: Responssável pela ultima modificação lastModifiedDate: type: string description: Data da ultima modificação format: date-time executeInHoliday: type: boolean description: Executa em um feriado quantityMaxRoutines: type: integer description: Quantidade máxima de rotinas a serem geradas dayOfMonth: type: integer description: Dia do mês weekDay: #/definitions/weekDay weekOfMonth: #/definitions/weeklyOrdinal routeCheckpointRecord: type: object required: – order properties: id: type: integer description: ID order: type: integer description: Ordem checkpoint: #/definitions/checkpointRecord checklist: #/definitions/checklistTemplateRecord checkpointRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome checkpointType: #/definitions/checkpointType physicalLocationId: type: integer description: Local físico checklistTemplateRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome incidentTypeRecord: type: object properties: id: type: integer description: ID name: type: string description: Nome defaultPriority: #/definitions/incidentPriority description: type: string description: Descrição do tipo do incidente routineTemplateFacadeOutput: type: object required: – name – startDate – endDate – active – position – maxRoutines – routinesCount properties: id: type: integer description: ID name: type: string description: Nome do template startDate: type: string description: Data de início format: date endDate: type: string description: Data final format: date active: type: boolean description: Estado do template position: #/definitions/positionRecord schedules: type: array items: #/definitions/schedulingRecord description: Agendamentos routeCheckpoint: type: array items: #/definitions/routeCheckpointRecord description: Rota checkpoint scheduled: type: boolean description: Rotina agendada maxRoutines: type: integer description: Quantidade máxima de rotinas que podem ser executadas quando a rotina não é agendada routinesCount: type: integer description: Quantidade de rotinas createdBy: type: string description: Responsável pela criação createdDate: type: string description: Data da criação format: date-time lastModifiedBy: type: string description: Responsável pela ultima modificação lastModifiedDate: type: string description: Data da ultima modificação format: date-time incidentType: #/definitions/incidentTypeRecord 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