AttendanceBook/PunchesByShifts
POST
https://customerapi.geovictoria.com/api/v1/AttendanceBook/PunchesByShifts
Descripción
Muestra las marcas asociadas a los turnos de uno o más trabajadores
Request
Request Body
| Campos | Largo | Requerido | Tipo de dato | Descripción |
|---|---|---|---|---|
| StartDate | 14 | Sí | String | Indica la fecha de inicio en formato YYYYMMDDHHMMSS |
| EndDate | 14 | Sí | String | Indica la fecha de fin en formato YYYYMMDDHHMMSS |
| UserIds | 16 | Sí | String | Identificador del usuario separado por “,” |
Importante
- Se puede apreciar la información en Reportes > Gestión de Asistencia.
- El campo EndDate debe ser como máximo 12 meses en el futuro a partir de la fecha actual.
- El máximo de usuarios que se pueden consultar son 200.
- El máximo de registros que se pueden devolver son 1500.
- La máxima cantidad de días que se pueden solicitar entre la fecha de inicio y término son 62 días.
{
"StartDate": "20241023000000",
"EndDate": "20241023235959",
"UserIds": "111111111,111111112"
}
Response
Response Body
| Campos | Tipo de dato | Descripción |
|---|---|---|
| Shifts | Lista de objetos | En cada posición contiene de un turno del usuario |
| – Date | String | Indica la fecha en formato YYYYMMDDHHMMSS en que se está monstrando la información |
| – Punches | Lista de objetos | En cada posición contiene la información de una marca |
| — Type | String | Indica el tipo de marca, es decir Ingreso o Salida |
| — Date | String | Indica la fecha de la marca en formato YYYYMMDDHHMMSS |
| — Origin | String | Indica el origen de la marca, por ejemplo, web, app, etc |
| — GroupDescription | String | Indica el nombre del grupo asociado de la marca |
| — UploadDate | String | Indica la fecha en la que se cargó en el sistema la marca en formato YYYYMMDDHHMMSS |
| — ShiftPunchType | String | Indica el tipo de marca en el contexto del turno, es decir: Entrada, SalidaColación, EntradaColación, Salida |
| — AssignedInBook | Boolean | Indica si la marca está asignada en el libro de asistencia (visible en libro de Asistencia) |
| — BoxSn | String | Indica el número de serie del reloj que registró la marca |
| — IdTask | String | Identificador cifrado de la tarea asociada a la marca |
| — IdProject | String | Identificador cifrado del proyecto asociada a la marca |
| — Checksum | String | Identificador cifrado de la operación asociada a la marca |
| – Id | String | Identificador cifrado del turno |
| – StartTime | String | Indica la hora de inicio del turno en formato HH:MM |
| – MaxStartTime | String | Indica la hora máxima de inicio del turno en formato HH:MM |
| – ExitTime | String | Indica la hora de salida del turno en formato HH:MM |
| – Type | String | Indica el tipo de turno, por ejemplo libre, presencial, descanso, etc |
| – FixedShiftHours | String | Indica la cantidad de horas fijas en formato HH:MM |
| – ShiftDisplay | String | Indica la información resumida del turno (hora inicio, hora fin y tiempo colación) |
| – BreakType | String | Indica el tipo de colación del turno: fija, libre, preasignada, sin colación, etc |
| – BreakMinutes | String | Indica la cantidad de minutos de la colación del turno |
| – BreakStart | String | Indica la hora en formato HH:MM en que comienza la colación del turno |
| – BreakEnd | String | Indica la hora en formato HH:MM en que termina la colación del turno |
| – Status | String | Indica el estado del turno, es decir si está activado (enabled) o desactivado (disabled) |
| – Custom | String | Indica el valor de la columna personalizada del turno |
| Id | String | Indica el identificador cifrado del usuario |
| Identifier | String | Identificador del usuario (por ejemplo: RUT, DNI, etc) |
| Enabled | String | Indica el estado del usuario. Si es un 1 está activo, por otro lado, si es un 0 está desactivado. a |
| Name | String | Indica el nombre del usuario |
| Lastname | String | Indica el apellido del usuario |
| String | Indica el correo electrónico del usuario | |
| GroupDescription | String | Indica el nombre del grupo del usuario |
| CostCenterCode | String | Indica el código de centro de costos del grupo asociado al usuario |
| PositionId | String | Identificador cifrado del cargo del usuario. |
| PositionDescription | String | Indica el nombre del cargo del usuario |
| WeeklyWorkingsHoursCodeId | String | Identificador cifrado del código de jornada del usuario |
| CustomColumn1 | String | Indica el valor de la columna personalizada 1 del usuario |
| CustomColumn2 | String | Indica el valor de la columna personalizada 2 del usuario |
| CustomColumn3 | String | Indica el valor de la columna personalizada 3 del usuario |
| IsHiddenForReports | String | Indica si está oculto para los reportes (no se considera para la gestión de asistencia). Si tiene 1 está oculto, por otro lado, si tiene 0 no está oculto. |
| ContractDate | String | Indica la fecha de inicio de contrato del usuario |
| EndContractDate | String | Indica la fecha de fin de contrato del usuario |
| SchedulerId | String | Identificador cifrado del planificador del usuario |
| SchedulerId | String | Indica la fecha de inicio del planificador |
| SchedulerId | String | Indica la fecha del periodo de inicio del planificador |
| UserCompanyIdentifier | String | Indentificador único de la razón social externa |
Importante
- Los guiones permiten representar los campos que están en el interior de otro campo. Por ejemplo:
Campo 1
– Campo 1.1
— Campo 1.1.1
Códigos
| Código | Descripción |
|---|---|
| 200 | Éxito |
| 400 | Error en el request |
| 500 | Error no controlado, contactar a GV |
[
{
"Shifts": [
{
"Date": "20241023000000",
"Punches": [
{
"Type": "Ingreso",
"Date": "20241023090000",
"Origin": "web",
"GroupDescription": "GrupoEjemplo",
"UploadDate": "20241023135044",
"ShiftPunchType": "Entrada",
"UserIdentifier": "111111111",
"AssignedInBook": true,
"BoxSn": "OGT7080057072700147",
"IdTask": "WBlTS2dvAOwN4Kk7XZliiA"
"IdProject": "A4lTSTdv5OSN3Kk7XZZii4",
"Checksum": "Or0W1Y0QTo_P6OU-CvheJh20bhm3WkmH-ECtDNWc2JgCN5Q0vzloK9pQsFrax0knuL10zWIlKPz4O5m3qpXhlY1s2CTjIs8UDdrOSYnsfuLBr6vC7zJ__Ee0FDPquZXX"
},
{
"Type": "Salida",
"Date": "20241023183000",
"Origin": "web",
"GroupDescription": "GrupoEjemplo",
"UploadDate": "20241023135048",
"ShiftPunchType": "Salida",
"UserIdentifier": "111111111",
"AssignedInBook": true,
"BoxSn": "OGT7080057072700147",
"IdTask": "WBlTS2dvAOwN4Kk7XZliiA",
"IdProject": "A4lTSTdv5OSN3Kk7XZZii4",
"Checksum": "Or0W1Y0QTo_P6OU-CvheJsjMYKbIcOUhAQXudukCVOmNAV_e9hinNakyVxeE4S7_oEUwFLAPpYdzG1tZJKRIU5lICM01fdtGh8MK-HdUlWzayTSytA_LDbtcM9GOskZz"
}
],
"Id": "8CM8Hc0xYN9wN7v_di_rAQ",
"StartTime": "09:00",
"MaxStartTime": "09:15",
"ExitTime": "18:30",
"Type": "FixedShift",
"FixedShiftHours": "00:00",
"ShiftDisplay": "09:00 - 18:30 (60 mins)",
"BreakType": "FreeLunch",
"BreakMinutes": "60",
"BreakStart": "00:00",
"BreakEnd": "00:00",
"Status": "enabled",
"Custom": "base"
}
],
"Id": "lHkQYOv3c87ClN0yWWSaLQ",
"Identifier": "111111111",
"Enabled": "1",
"Name": "Eduardo",
"LastName": "Sanchez",
"Email": "correoejemplo2@gmail.com",
"GroupDescription": "GrupoEjemplo",
"CostCenterCode": "base",
"PositionId": "sXRGS9wLs7E5zu09Yqyn3Q",
"PositionDescription": "Desarrollo",
"WeeklyWorkingHoursCodeId": "sDzBzlFnefikfhnZoFXLiw",
"CustomColumn1": "Campo Personalizado 1",
"CustomColumn2": "Campo Personalizado 2",
"CustomColumn3": "Campo Personalizado 3",
"IsHiddenForReports": "False",
"ContractDate": "20240911000000",
"EndContractDate": "20240911000000",
"SchedulerId": "o-BlEQI5ek22lgEkRnk4ug",
"SchedulerStart": "20240911000000",
"SchedulerPeriodStart": "20240911000000",
"UserCompanyIdentifier": "45678"
}
Postman
Ejemplo 1
Ejemplo 1
