Gestão de Pessoas (hcm)

2.0info: 1.31.0 pontomobile description: Ponto mobile x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: pontomobile contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /hcm/pontomobile/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /actions/clockingEventExport: post: description: API DEPRECIADA: Data de deprecação | DATA: 2021-09-01 | Exporta marcações não exportada x-senior-event: false deprecated: true tags: – Endpoints security: – bearerAuth: [] parameters: responses: 200: description: Ok schema: type: object required: – locationURI properties: locationURI: type: string description: Url para donwload do arquivo default: description: Error response schema: #/definitions/genericError /actions/clockingEventExport (v2): post: description: Exporta marcações não exportada x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – in: header name: accept description: _MIME type_ e versão do endpoint utilizado na requisição. [SAIBA MAIS](https://dev.senior.com.br/documentacao/guia-de-api/versionamento/). type: string default: application/json;seniorx.version=2 – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – locationURI properties: locationURI: type: string description: Url para donwload do arquivo default: description: Error response schema: #/definitions/genericError /queries/getLookupEmployee: post: description: Serviço de lookup para usuario x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuario searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/lookupDto default: description: Error response schema: #/definitions/genericError /actions/clockingEventExportByPeriod: post: description: Exporta marcações conforme periodo informado x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – period properties: period: #/definitions/periodDto fileType: #/definitions/fileType exportGeolocation: type: boolean description: Exportar geolocalização exportNotChecked: type: boolean description: Exportar não verificados responses: 200: description: Ok schema: type: object required: – locationURI properties: locationURI: type: string description: Url para donwload do arquivo default: description: Error response schema: #/definitions/genericError /actions/blobServiceRequestUploadFile: post: description: Solicitação para realizar o upload de um arquivo. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – fileName properties: fileName: type: string description: Nome do arquivo que será carregado. responses: 200: description: Ok schema: type: object required: – fileId – version – locationURI properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. locationURI: type: string description: URI onde o upload deve ser realizado. default: description: Error response schema: #/definitions/genericError /queries/getLookupFence: post: description: Serviço de lookup para cerca virtual x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/lookupDto default: description: Error response schema: #/definitions/genericError /actions/blobServiceCommitUploadedFile: post: description: Realiza o commit de um arquivo que foi carregado anteriormente. x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – fileId – version properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). type: string description: Versão do arquivo. responses: 200: description: Ok schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). default: description: Error response schema: #/definitions/genericError /actions/employeesImportByFileId: post: description: Importa os colaboradores para a base da G7 e vincula aos usuários da plataforma by File id x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object required: – fileId properties: fileId: type: string description: O identificador único do arquivo. Composto pelo ID + o nome do arquivo (separados por /). responses: 200: description: Ok schema: type: object required: – importResult properties: importResult: #/definitions/employeeImportResultDto default: description: Error response schema: #/definitions/genericError /queries/getLookupDevice: post: description: Serviço de lookup para device x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – name: input in: body required: true schema: type: object properties: searchText: type: string description: Valor da busca informada pelo usuario searchValue: type: string description: Valor para busca exata por um registro responses: 200: description: Ok schema: type: object required: – records properties: records: #/definitions/lookupDto default: description: Error response schema: #/definitions/genericError /queries/getLookupCompany: post: description: Serviço de lookup para empresa x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] 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: #/definitions/lookupDto default: description: Error response schema: #/definitions/genericErrordefinitions: fileType: type: string enum: – TXT – CSV dataOriginType: type: string enum: – G5 – MANUAL geometricFormType: type: string enum: – CIRCLE employeeImportResultDto: type: object required: – importErros properties: importErros: type: array items: #/definitions/employeeImportErrorDto description: Conjunto de erros da importação employeeImportErrorDto: type: object required: – errors – employee properties: errors: type: array items: type: string description: Erros encontrados durante a importação employee: #/definitions/employee employee: type: object required: – name – pis – mail – company properties: id: type: string description: format: uuid externalId: type: string description: Identificador Externo name: type: string description: Nome pis: type: string description: PIS mail: type: string description: Email company: #/definitions/company manager: #/definitions/manager managers: type: array items: #/definitions/manager description: Gestores platformUserName: type: string description: Id usuario SeniorX platformUsers: type: array items: #/definitions/platformUsers description: Id usuarios SeniorX biometricPatterns: type: array items: #/definitions/biometricPattern description: Id usuarios biometricPatterns lastUpdate: type: string description: Última atualização format: date-time nfcCode: type: string description: Código NFC fences: type: array items: #/definitions/fence description: Cercas virtuais enabled: type: boolean description: Status do empregado dataOrigin: #/definitions/dataOriginType company: type: object required: – cnpj – name properties: id: type: string description: format: uuid cnpj: type: string description: CNPJ name: type: string description: Nome dataOrigin: #/definitions/dataOriginType timeZone: type: string description: Timezone manager: type: object required: – employees properties: id: type: string description: format: uuid mail: type: string description: Email platformUserName: type: string description: Id usuario SeniorX platformUsers: type: array items: #/definitions/platformUsers description: List de usuarios SeniorX employees: type: array items: #/definitions/employee description: Lista de colaboradores platformUsers: type: object required: – username properties: id: type: string description: format: uuid username: type: string description: Nome do usuário da plataforma biometricPattern: type: object required: – pattern – patternNumber – vendor – clientId – createdAt – updatedAt properties: id: type: string description: format: uuid employee: #/definitions/employee pattern: type: string description: Padrão da dígital patternNumber: type: integer description: Número do padrão da digital vendor: type: string description: Fornecedor clientId: type: string description: format: uuid createdAt: type: string description: Data de criação format: date-time updatedAt: type: string description: Data de alteração format: date-time fence: type: object required: – name properties: id: type: string description: format: uuid name: type: string description: Nome perimeters: type: array items: #/definitions/perimeter description: Perimetros employees: type: array items: #/definitions/employee description: Colaboradores Vinculados perimeter: type: object required: – type properties: id: type: string description: format: uuid type: #/definitions/geometricFormType startPoint: #/definitions/location radius: type: integer description: Raio location: type: object required: – latitude – longitude – dateAndTime properties: id: type: string description: format: uuid latitude: type: number description: Latitude format: double longitude: type: number description: Longitude format: double dateAndTime: type: string description: Date e hora format: date-time perimeter: #/definitions/perimeter periodDto: type: object required: – initialDate – finalDate properties: initialDate: type: string description: Data inicial format: date finalDate: type: string description: Data final format: date initialTime: type: string description: Hora inicial finalTime: type: string description: Hora final lookupDto: type: object required: – text – value properties: text: type: string description: Texto a ser apresentado value: type: string description: Valor armazenado no filtro 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