Acesso e Segurança (sam)

2.0info: 1.61.0 Gestao de terceiros description: Serviço do backend do Gestão de Terceiros do Ronda senior X x-senior-domain: Gestão de Acesso e Segurança x-senior-domain-path: sam x-senior-service-path: third contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /sam/thirdsecurityDefinitions: 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: /getDocumentRangeItens: post: description: Retorna os Itens de Abrangência do Documento 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 Documento 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 /getProcessesList: post: description: Obtém os processos ativos que o usuário logado tem algum tipo de permissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – serviceAction properties: serviceAction: type: string description: Tipo de Ação que indica quais processos serão listado processFilterType: type: string description: Filtro por tipo de processo tagFilter: type: string description: Tag para filtro onlyActiveProcesses: type: boolean description: Apenas retorna processos ativos serviceEventStartDate: type: string description: A partir de qual data buscar eventos de serviços externos responses: 200: description: Ok schema: type: object properties: processes: #/definitions/serviceProcess default: description: Error response schema: #/definitions/genericError get: description: Obtém os processos ativos que o usuário logado tem algum tipo de permissão. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – serviceAction properties: serviceAction: type: string description: Tipo de Ação que indica quais processos serão listado processFilterType: type: string description: Filtro por tipo de processo tagFilter: type: string description: Tag para filtro onlyActiveProcesses: type: boolean description: Apenas retorna processos ativos serviceEventStartDate: type: string description: A partir de qual data buscar eventos de serviços externos responses: 200: description: Ok schema: type: object properties: processes: #/definitions/serviceProcess default: description: Error response schema: #/definitions/genericError /updateThird: post: description: Edita um colaborador de empresa terceira com documentos Não é necessário recursos. ###Utilização: -Usuários terceiros. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – person properties: person: #/definitions/personRecord responses: 200: description: Ok schema: type: object required: – documents properties: id: type: integer description: ID name: type: string description: Nome situation: #/definitions/personSituationType documents: #/definitions/documentRecord registerDate: type: string description: Data de Cadastro gender: #/definitions/gender nationality: type: string description: Nacionalidade birthday: type: string description: Data de Nascimento phones: #/definitions/phoneRecord emails: #/definitions/emailRecord lastModificationDate: type: string description: Data da Última Alteração address: type: string description: Endereço district: type: string description: Bairro city: type: string description: Cidade federalState: type: string description: Estado zipCode: type: string description: Código Postal personSituation: #/definitions/personSituationRecord custom: type: string description: Campos customizados da pessoa default: description: Error response schema: #/definitions/genericError /createThird: post: description: Cria colaborador de empresa terceira com documentos Não é necessário recursos. ###Utilização: -Usuários terceiros. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – person properties: person: #/definitions/personRecord responses: 200: description: Ok schema: type: object required: – documents properties: id: type: integer description: ID name: type: string description: Nome situation: #/definitions/personSituationType documents: #/definitions/documentRecord registerDate: type: string description: Data de Cadastro gender: #/definitions/gender nationality: type: string description: Nacionalidade birthday: type: string description: Data de Nascimento phones: #/definitions/phoneRecord emails: #/definitions/emailRecord lastModificationDate: type: string description: Data da Última Alteração address: type: string description: Endereço district: type: string description: Bairro city: type: string description: Cidade federalState: type: string description: Estado zipCode: type: string description: Código Postal personSituation: #/definitions/personSituationRecord custom: type: string description: Campos customizados da pessoa default: description: Error response schema: #/definitions/genericError /getInformationBPMRequest: post: description: Retorna as informações da solicitação do BPM para o contrato x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – bpmRequestId properties: bpmRequestId: type: integer description: ID da solicitação do BPM responses: 200: description: Ok schema: type: object required: – bpmRequestId – nameResponsableTask – requestStatus – creationDate – startDate – expirationDate – requesterName properties: bpmRequestId: type: integer description: ID da solicitação do BPM nameResponsableTask: type: string description: Nome do responsável atual da tarefa requestStatus: #/definitions/requestStatus creationDate: type: string description: Data de criação do processo startDate: type: string description: Data de início da tarefa/processo expirationDate: type: string description: Data de expiração da tarefa/processo requesterName: type: string description: Nome do solicitante default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações da solicitação do BPM para o contrato x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – bpmRequestId properties: bpmRequestId: type: integer description: ID da solicitação do BPM responses: 200: description: Ok schema: type: object required: – bpmRequestId – nameResponsableTask – requestStatus – creationDate – startDate – expirationDate – requesterName properties: bpmRequestId: type: integer description: ID da solicitação do BPM nameResponsableTask: type: string description: Nome do responsável atual da tarefa requestStatus: #/definitions/requestStatus creationDate: type: string description: Data de criação do processo startDate: type: string description: Data de início da tarefa/processo expirationDate: type: string description: Data de expiração da tarefa/processo requesterName: type: string description: Nome do solicitante default: description: Error response schema: #/definitions/genericError /getThirdPartyCompanyRangeItens: post: description: Retorna os Itens de Abrangência da Empresa Terceira 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 da Empresa Terceira 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 /getContractRangeItens: post: description: Retorna os Itens de Abrangência do Contrato 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 Contrato 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/genericErrordefinitions: personSituationType: type: string enum: – ACTIVE – BLOCKED gender: type: string enum: – UNKNOWN – MALE – FEMALE requestStatus: type: string enum: – IN_PROGRESS – COMPLETED – CANCELED phoneType: type: string enum: – UNDEFINED – WORK – MOBILE – HOME – OTHERS personRecord: type: object required: – documents properties: id: type: integer description: ID name: type: string description: Nome situation: #/definitions/personSituationType documents: type: array items: #/definitions/documentRecord description: Documento registerDate: type: string description: Data de Cadastro format: date-time gender: #/definitions/gender nationality: type: string description: Nacionalidade birthday: type: string description: Data de Nascimento format: date phones: type: array items: #/definitions/phoneRecord description: Telefone emails: type: array items: #/definitions/emailRecord description: Email lastModificationDate: type: string description: Data da Última Alteração format: date-time address: type: string description: Endereço district: type: string description: Bairro city: type: string description: Cidade federalState: type: string description: Estado zipCode: type: string description: Código Postal personSituation: #/definitions/personSituationRecord custom: type: string description: Campos customizados da pessoa format: byte documentRecord: type: object required: – documentType – document properties: id: type: integer description: ID documentType: #/definitions/documentTypeRecord document: type: string description: Documento documentTypeRecord: type: object required: – id – name – label – required properties: id: type: integer description: ID name: type: string description: Nome do tipo de documento label: type: string description: Label do documento mask: type: string description: Máscara do documento required: type: boolean description: Documento obrigatório phoneRecord: type: object required: – number – phoneType properties: id: type: integer description: Id do telefone preferential: type: boolean description: Telefone preferencial idd: type: integer description: DDI/IDD (International Direct Dialing) number: type: string description: Número do Telefone phoneExtension: type: string description: Ramal phoneType: #/definitions/phoneType emailRecord: type: object required: – email properties: id: type: integer description: Id do email preferential: type: boolean description: Email preferencial email: type: string description: Email personSituationRecord: type: object properties: id: type: integer description: ID personId: type: integer description: ID da pessoa blockDate: type: string description: Data do bloqueio format: date-time blockReason: type: string description: Motivo do bloqueio serviceProcess: type: object required: – processId – processName – description properties: processId: type: integer description: Identificador do Processo processName: type: string description: Nome do Processo description: type: string description: Descrição do processo rangeItens: type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro 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 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