2.0info: 1.0.1 Integração SAM description: Serviço para integração do YMS com SAM (Ronda) x-senior-domain: Integrações do YMS x-senior-domain-path: yms_int x-senior-service-path: sam 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/yms_intsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /sam/queries/findRoleIdSam: post: description: Busca o ID do role no SAM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – roleId properties: roleId: type: integer format: int64 description: Id do role 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o ID do role no SAM tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – roleId properties: roleId: type: integer format: int64 description: Id do role 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/queries/findCredentialValues: post: description: Busca o ID do role, scheduling e person no SAM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – motoristaIdYMS – agendaIdYMS properties: motoristaIdYMS: type: string description: Id do motorista agendaIdYMS: type: string description: Id da agenda responses: 200: description: Ok schema: type: object required: – schedulingId – personId – roleId properties: schedulingId: type: integer format: int64 description: Id do agendamento do SAM personId: type: integer format: int64 description: Id da pessoa do SAM roleId: type: integer format: int64 description: Id do papel do SAM 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca o ID do role, scheduling e person no SAM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: motoristaIdYMS description: Id do motorista in: query required: true type: string – name: agendaIdYMS description: Id da agenda in: query required: true type: string responses: 200: description: Ok schema: type: object required: – schedulingId – personId – roleId properties: schedulingId: type: integer format: int64 description: Id do agendamento do SAM personId: type: integer format: int64 description: Id da pessoa do SAM roleId: type: integer format: int64 description: Id do papel do SAM 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/queries/findVisitorsBySchedulingIdYMS: post: description: Busca visitantes com base no id da agenda do YMS e retorna os visitantes vinculados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaIdYMS properties: agendaIdYMS: type: string description: Id da agenda do YMS responses: 200: description: Ok schema: type: object required: – visitors properties: visitors: type: array items: type: object allOf: – #/definitions/visitorWithCredentials minimum: 1 description: Lista de visitantes e credencias ativas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca visitantes com base no id da agenda do YMS e retorna os visitantes vinculados tags: – Queries x-senior-visibility: PRIVATE parameters: – name: agendaIdYMS description: Id da agenda do YMS in: query required: true type: string responses: 200: description: Ok schema: type: object required: – visitors properties: visitors: type: array items: type: object allOf: – #/definitions/visitorWithCredentials minimum: 1 description: Lista de visitantes e credencias ativas 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/queries/findPersonIdSam: post: description: Verifica se o ID do papel existe no SAM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – motoristaIdYMS properties: motoristaIdYMS: type: string description: Id do motorista responses: 200: description: Ok schema: type: object required: – personId properties: personId: type: integer format: int64 description: Id da pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o ID do papel existe no SAM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: motoristaIdYMS description: Id do motorista in: query required: true type: string responses: 200: description: Ok schema: type: object required: – personId properties: personId: type: integer format: int64 description: Id da pessoa 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/queries/findSchedulingIdSam: post: description: Verifica se o ID da agenda do YMS está integrado no SAM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – agendaIdYMS properties: agendaIdYMS: type: string description: Id da agenda responses: 200: description: Ok schema: type: object required: – schedulingId properties: schedulingId: type: integer format: int64 description: Id do agendamento do SAM 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verifica se o ID da agenda do YMS está integrado no SAM tags: – Queries x-senior-visibility: PRIVATE parameters: – name: agendaIdYMS description: Id da agenda in: query required: true type: string responses: 200: description: Ok schema: type: object required: – schedulingId properties: schedulingId: type: integer format: int64 description: Id do agendamento do SAM 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/queries/getVisited: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da agenda no YMS responses: 200: description: Ok schema: type: object required: – name properties: name: type: string description: Nome do Visitado contactPhone: type: string description: Fone de Contato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id da agenda no YMS in: query required: true type: string responses: 200: description: Ok schema: type: object required: – name properties: name: type: string description: Nome do Visitado contactPhone: type: string description: Fone de Contato 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/queries/getSchedulingByYms: post: description: Obtem um agendamento de visitantes pelo número agenda YMS tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id da agenda do YMS responses: 200: description: Ok schema: type: object allOf: – #/definitions/schedulingWithVisitors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtem um agendamento de visitantes pelo número agenda YMS tags: – Queries x-senior-visibility: PRIVATE parameters: – name: id description: Id da agenda do YMS in: query required: true type: string responses: 200: description: Ok schema: type: object allOf: – #/definitions/schedulingWithVisitors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/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 /sam/queries/exportVehicle: 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 /sam/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 /sam/queries/exportScheduling: 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 /sam/queries/exportVisitor: 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 /sam/queries/exportCredentialCard: 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 /sam/queries/exportLogEvent: 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 /sam/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 /sam/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/actions/saveScheduling: post: description: Salva agendamento de visitantes tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object allOf: – #/definitions/schedulingWithVisitors responses: 200: description: Ok schema: type: object allOf: – #/definitions/schedulingWithVisitors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/actions/startScheduling: post: description: Inicia o processo de agendamento no Ronda tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Id do agendamento criado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/actions/importVehicle: 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 /sam/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 /sam/actions/importScheduling: 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 /sam/actions/importVisitor: 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 /sam/actions/importCredentialCard: 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 /sam/actions/importLogEvent: 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 /sam/events/importVehicleEvent: 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 /sam/events/exportVehicleEvent: 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 /sam/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 /sam/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 /sam/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 /sam/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 /sam/events/importVisitorEvent: 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 /sam/events/exportVisitorEvent: 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 /sam/events/importCredentialCardEvent: 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 /sam/events/exportCredentialCardEvent: 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 /sam/events/importLogEventEvent: 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 /sam/events/exportLogEventEvent: 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 /sam/entities/vehicle: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vehicle responses: 200: description: The created resource schema: #/definitions/vehicle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/vehicle responses: 200: description: The created resource schema: #/definitions/vehicle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/vehicle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/vehicle/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editVehicle responses: 200: description: Ok schema: #/definitions/editVehicle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/vehicle responses: 200: description: Ok schema: #/definitions/vehicle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/vehicle 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/vehicle/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/vehicle responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/person: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/person responses: 200: description: The created resource schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/person responses: 200: description: The created resource schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/person/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editPerson responses: 200: description: Ok schema: #/definitions/editPerson 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/person/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/person responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/scheduling: post: 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: 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: 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/scheduling/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editScheduling responses: 200: description: Ok schema: #/definitions/editScheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/scheduling responses: 200: description: Ok schema: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/scheduling 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/scheduling/bulk: post: 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 /sam/entities/visitor: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitor responses: 200: description: The created resource schema: #/definitions/visitor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/visitor responses: 200: description: The created resource schema: #/definitions/visitor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/visitor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/visitor/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editVisitor responses: 200: description: Ok schema: #/definitions/editVisitor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/visitor responses: 200: description: Ok schema: #/definitions/visitor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/visitor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/visitor/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/visitor responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/credentialCard: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/credentialCard responses: 200: description: The created resource schema: #/definitions/credentialCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/credentialCard responses: 200: description: The created resource schema: #/definitions/credentialCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/credentialCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/credentialCard/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editCredentialCard responses: 200: description: Ok schema: #/definitions/editCredentialCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/credentialCard responses: 200: description: Ok schema: #/definitions/credentialCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/credentialCard 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/credentialCard/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/credentialCard responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/logEvent: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/logEvent responses: 200: description: The created resource schema: #/definitions/logEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/logEvent responses: 200: description: The created resource schema: #/definitions/logEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – 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: object properties: totalPages: description: Quantidade total de páginas: total de registros dividido pelo tamanho solicitado da página, arredondado pra cima type: integer format: int64 totalElements: description: Quantidade total de registros type: integer format: int64 contents: type: array items: #/definitions/logEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/logEvent/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/editLogEvent responses: 200: description: Ok schema: #/definitions/editLogEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/logEvent responses: 200: description: Ok schema: #/definitions/logEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/logEvent 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /sam/entities/logEvent/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/logEvent responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: visitorSituation: type: string enum: – CHECK_IN_PENDING – CHECK_IN_REALIZED – VISITING – CHECK_OUT_REALIZED – CHECK_IN_NOT_REALIZED – CHECK_IN_EXPIRED description: Situação do visitante: * `CHECK_IN_PENDING` – Check-in pendente * `CHECK_IN_REALIZED` – Check-in realizado * `VISITING` – Visitante já está com a visita em andamento * `CHECK_OUT_REALIZED` – Check-out realizado * `CHECK_IN_NOT_REALIZED` – Check-in não realizado * `CHECK_IN_EXPIRED` – Check-in expirado cardTechnology: type: string enum: – BARCODE_CARD – RFID_CARD – SMART_CARD description: Tecnologia do cartão: * `BARCODE_CARD` – Código de Barras * `RFID_CARD` – RFID * `SMART_CARD` – Smart visitSituation: type: string enum: – PENDING – IN_PROGRESS – FINISHED – NOT_OCCURRED description: Situação da visita: * `PENDING` – Pendente * `IN_PROGRESS` – Em andamento * `FINISHED` – Finalizada * `NOT_OCCURRED` – Não realizada userNotificationKind: type: string enum: – Operational – Management – News description: User notification kind.: * `Operational` – Operational * `Management` – Management * `News` – News userNotificationPriority: type: string enum: – Error – Alert – None description: User notification priority.: * `Error` – Error * `Alert` – Alert * `None` – None eventEmailFormat: type: string enum: – HTML – PLAIN_TEXT description: Format of the email: * `HTML` – Html * `PLAIN_TEXT` – Plain Text fieldType: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME description: FieldType: * `BINARY` – Binary * `BOOLEAN` – Boolean * `DATE` – Date * `DATETIME` – Datetime * `LOCALDATETIME` – Localdatetime * `DOUBLE` – Double * `ENUM` – Enum * `INTEGER` – Integer * `MONEY` – Money * `STRING` – String * `TIME` – Time fileFormat: type: string enum: – CSV – FLAT – JSON – XML description: FileFormat: * `CSV` – Csv * `FLAT` – Flat * `JSON` – Json * `XML` – Xml hookFunction: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE description: HookFunction: * `BEFORE_PARSE` – Before parse * `BEFORE_CONVERSION` – Before conversion * `ON_ERROR` – On error * `VALIDATE` – Validate eventType: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START description: EventType: * `CHUNK` – Chunk * `DOWNLOAD` – Download * `ERROR` – Error * `FINISH` – Finish * `START` – Start errorStrategy: type: string enum: – CALL_SCRIPT – IGNORE – STOP description: ErrorStrategy: * `CALL_SCRIPT` – Call script * `IGNORE` – Ignore * `STOP` – Stop status: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING description: Status: * `DONE` – Done * `DONE_WITH_ERRORS` – Done with errors * `DOWNLOADING` – Downloading * `ERROR` – Error * `NOT_STARTED` – Not started * `RUNNING` – Running errorType: type: string enum: – CONVERT_ERROR – SERVICE_ERROR description: ErrorType: * `CONVERT_ERROR` – Convert error * `SERVICE_ERROR` – Service error healthcheckDTO: type: string enum: – UP – DOWN description: Status do healthcheck: * `UP` – Saudável * `DOWN` – Ruim vehicle: description: Veículo, replicado do SAM e YMS type: object required: – plate properties: id: type: string format: uuid description: ID do veículo idSAM: type: integer format: int64 description: ID do veículo do SAM idYMS: type: string description: ID do veículo do YMS plate: type: string description: Placa do veículo createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editVehicle: type: object required: – id allOf: – #/definitions/vehicle person: description: Pessoa (SAM) ou motorista (YMS), replicado do SAM e YMS type: object required: – document properties: id: type: string format: uuid description: ID da pessoa/motorista idSAM: type: integer format: int64 description: ID da pessoa/motorista do SAM idYMS: type: string description: ID da pessoa/motorista do YMS document: type: string description: Documento da pessoa/motorista createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editPerson: type: object required: – id allOf: – #/definitions/person scheduling: description: Agendamento, replicado do SAM e YMS type: object required: – description – expectedStartDate – expectedEndDate properties: id: type: string format: uuid description: ID do agendamento idSAM: type: integer format: int64 description: ID do agendamento do SAM idYMS: type: string description: ID do agendamento do YMS lobbyIdSAM: type: integer format: int64 description: ID da Portaria do SAM description: type: string description: Motivo do agendamento expectedStartDate: type: string format: date-time description: Data de entrada esperada expectedEndDate: type: string format: date-time description: Data de saída esperada visitSituation: type: string allOf: – #/definitions/visitSituation description: Status do agendamento createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editScheduling: type: object required: – id allOf: – #/definitions/scheduling visitor: description: Visitante para integração com SAM type: object required: – name – document – documentType – contact properties: id: type: string format: uuid description: ID idSAM: type: integer format: int64 description: ID do visitante do SAM person: type: string format: uuid description: Id do motorista integrado scheduling: type: string format: uuid description: Id da agenda integrado name: type: string description: Nome do visitante document: type: string description: Documento do visitante documentType: type: string description: Tipo do documento contact: type: string description: Contato do visitante nationality: type: string description: Nacionalidade do visitante visitorSituation: type: string allOf: – #/definitions/visitorSituation description: Situação do visitante urlImage: type: string description: URL da imagem de perfil do visitante createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editVisitor: type: object required: – id allOf: – #/definitions/visitor credentialCard: description: Cartão de credencial do visitante para integração com SAM type: object required: – cardTechnology – cardNumber – endDate properties: id: type: string format: uuid description: ID idSAM: type: integer format: int64 description: ID do cartão de credencial do SAM visitor: type: object allOf: – #/definitions/visitor description: Vistante do cartão de credencial cardTechnology: type: string allOf: – #/definitions/cardTechnology description: Tecnologia do cartão cardNumber: type: integer format: int64 description: Número do cartão endDate: type: string format: date-time description: Data e hora da validade da credencial createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editCredentialCard: type: object required: – id allOf: – #/definitions/credentialCard logEvent: description: Log de eventos de integração type: object required: – endpoint – entryPayload properties: id: type: string format: uuid description: ID endpoint: type: string description: Endpoint do evento entryPayload: type: string description: Payload de entrada exitPayload: type: string description: Payload de saída integratedBySAM: type: boolean description: Integrado pelo SAM default: false integratedByYMS: type: boolean description: Integrado pelo YMS default: false integratedDateBySAM: type: string format: date-time description: Data e horário de integração do SAM integratedDateByYMS: type: string format: date-time description: Data e horário de integração do YMS createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: editLogEvent: type: object required: – id allOf: – #/definitions/logEvent credentialCardData: description: Dados do cartão de credencial type: object required: – cardTechnology – cardNumber – endDate properties: id: type: string description: Id cardTechnology: type: string allOf: – #/definitions/cardTechnology description: Tecnologia do cartão cardNumber: type: integer format: int64 description: Número do cartão endDate: type: string format: date-time description: Data e hora da validade da credencial schedulingWithVisitors: description: Agendamento completo com os visitantes type: object required: – scheduling properties: scheduling: type: object allOf: – #/definitions/scheduling description: Agendamento de Visiatntes visitors: type: array items: type: object allOf: – #/definitions/visitorWithCredentials description: Visitantes com Credenciais visitorWithCredentials: description: Dados do visitante e suas credenciais type: object required: – visitor properties: visitor: type: object allOf: – #/definitions/visitor description: Visitante credentialCards: type: array items: type: object allOf: – #/definitions/credentialCard description: Credenciais associadas 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 checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE description: A symbolic code identifying the category of the reason of the error: * `BAD_REQUEST` – Bad Request * `UNAUTHORIZED` – Unauthorized * `PAYMENT_REQUIRED` – Payment Required * `OBJECT_NOT_FOUND` – Object Not Found * `REQUEST_TIMEOUT` – Request Timeout * `GONE` – Gone * `UNPROCESSABLE` – Unprocessable * `INTERNAL_ERROR` – Internal Error * `NOT_IMPLEMENTED` – Not Implemented * `SERVICE_UNAVAILABLE` – Service Unavailable * `INSUFFICIENT_STORAGE` – Insufficient Storage