Recent Posts

Recent Comments

Archives

Categories

AttendanceBook/Get

Publicado
Updated
BySantiago






POST
https://customerapi.geovictoria.com/api/v1/AttendanceBook


Descripción

Muestra la información del libro de asistencia

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 ver la información en Reportes > Gestión de Asistencia.
  • Si se quiere consultar por más de un usuario en el campo “UserIds” se debe añadir más identificadores separados por “,”.
  • 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.
  • Si la empresa es diaria devuelve el periodo de días indicado entre los campos “StartDate” y “EndDate”. Por otro lado, si la empresa es semanal retorna semanas completas dependiendo del periodo indicado, es decir, si solicito un día devolverá la semana completa que incluye ese día.

 

Ejemplo request

{
    "StartDate": "20240801000000",  
    "EndDate": "20240910235959",    
    "UserIds": "167893215"   
}

Response

Response Body






Campos Tipo de dato Descripción
Users Lista Cada uno de los objetos representa a un usuario
– PlannedInterval Objeto Cada uno de los objetos incluye la información de cada día
— Date String Indica la fecha en la que se muestra la información en formato yyyyMMddHHmmss
— Punches Objeto Contiene la información asociado a las marcas de ese día
— 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
— Longitude String Indica la coordenada de longitud de la marca
— Latitude String Indica la coordenada de latitud de la marca
— Accuracy String Indica la precisión de las coordenadas de longitud y latitud de la marca
— 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
— Shifts String Contiene la información asociado al turno en ese día
— Ends String Indica la fecha de término del turno en formato yyyyMMddHHmmss
— Begins String Indica la fecha de comienzo del turno en formato yyyyMMddHHmmss
— Id String Identificador cifrado del turno
— StartTime String Indica la hora de comienzo del turno
— MaxStartTime String Indica la hora máxima en la cual se puede comenzar el turno con normalidad
— ExitTime String Indica la hora de término del turno
— Type String Indica el tipo de turno: fijo, libre, presencial, descanso, etc.
— FixedShiftHours String Indica la cantidad de horas fijas en formato HH:MM del turno
— 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
— Delay String Indica el tiempo de atraso en formato HH:mm del día consultado
— BreakDelay String Indica el tiempo de atraso para el almuerzo en formato HH:mm del día consultado
— EarlyLeave String Indica el tiempo de la salida antes de cumplir el turno en formato HH:mm del día consultado
— TimeOffs Lista Contiene todas la información de los permisos en el día consultado
—- TimeOffTypeId String Identificador cifrado del permiso
—- TimeOffTypeId Description Indica la descripción del permiso
—- Starts String Indica la fecha de inicio del permiso
—- Ends String Indica la fecha de termino del permiso
—- TimeOffTypeDescription String Indica el nombre del permiso
—- TimeOffOrigin String Indica el origen desde el cual se asigno el permiso, por ejemplo API
—- StartTime String Indica la hora de inicio del permiso
—- EndTime String Indica la hora de fin del permiso
—- AmountHours String Indica la cantidad de horas del permiso
— WorkedHours String Indica la cantidad de horas trabajadas en formato HH:mm del día consultado
— Absent String Indica si el día consultado es o no un día ausente (True o False)
— Holiday String Indica si el día consultado es o no un día festivo o feriado (True o False)
— Worked String Indica si el día consultado es o no un día trabajado (True o False)
— NonWorkedHours String Indica la cantidad de horas no trabajadas en formato HH:mm en el día consultado
— ActuallyNocturnalWorkedHours String Indica la cantidad de horas nocturnas trabajadas en formato HH:mm del día consultado
— CoveredNonWorkingHours String Indica la cantidad de horas no trabajadas cubiertas en formato HH:mm en el día consultado
— AuthorizedOvertimeBefore String Indica la cantidad de horas extras autorizadas antes del turno en formato HH:mm del día consultado
— AuthorizedOvertimeAfter String Indica la cantidad de horas extras autorizadas después del turno en formato HH:mm del día consultado
— TotalAuthorizedOvertime String Indica la cantidad total de horas extras autorizadas en formato HH:mm del día consultado
— AccomplishedExtratimeBefore String Indica la cantidad de horas extras logradas antes del turno en formato HH:mm del día consultado
— AccomplishedExtratimeAfter String Indica la cantidad de horas extras logradas después del turno en formato HH:MM del día consultado
— AccomplishedExtraTime String Indica la cantidad total de horas extras logradas en formato HH:mm del día consultado
— AssignedExtraTimeBefore String Indica la cantidad de horas extras asignadas antes del turno en formato HH:mm del día consultado
— AssignedExtraTimeAfter String Indica la cantidad de horas extras asignadas después del turno en formato HH:MM del día consultado
— AssignedExtraTime String Indica la cantidad total de horas extras asignadas en formato HH:mm del día consultado
— ExtraTimeBeforeShift String Indica la cantidad de tiempo extra antes del turno del día consultado
— ExtraTimeAfterShift String Indica la cantidad de tiempo extra después del turno del día asignado
— TotalWorkedHours String Indica el total de horas trabajadas del usuario en el periodo consultado
— WorkedDays Integer Indica el total de días trabajados del usuario en el periodo consultado
— NonWorkedDays Integer Indica el total de días no trabajados del usuario en el periodo consultado
— Absences Integer Indica la cantidad de ausencias del usuario en el periodo consultado
— Holidays Integer Indica la cantidad de feriados del usuario en el periodo consultado
— Vacation Integer Indica la cantidad de vacaciones del usuario en el periodo consultado
— DaysLeaveWithPay Integer Indica la cantidad de días de licencia con sueldo del usuario en el periodo consultado
— DaysLeaveWithoutPay Integer Indica la cantidad de días de licencia sin sueldo del usuario en el periodo consultado
— AbsenceDaysWithoutPay Integer Indica la cantidad de días ausentes sin sueldo del usuario en el periodo consultado
— AbsencesDateLicence Integer Indica la cantidad de días ausentes del usuario en el periodo consultado
— WorkedSundays Integer Indica la cantidad de días domingo trabajados del usuario en el periodo consultado
— WorkedHolidays Integer Indica la cantidad de días festivos/feriados trabajados del usuario en el periodo consultado
— DaysAttended Integer Indica la cantidad de días asistidos del usuario en el periodo consultado
— 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
— Email String Indica el correo electrónico del usuario
— GroupDescription String Indica el nombre del grupo del 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.
ExtraTimeValues String Lista de objetos que tienen información de las horas extras registradas en la empresa
— ValueId String Identificador cifrado de la hora extra
— Value String Valor de la hora extra
— IsActive String Indica el estado de la hora extra. Si es 1 está activado, por otro lado, si es 0 está desactivado.


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
  • La información en los campos:
    •  “AccomplishedExtraTimeBefore”
    • “AccomplishedExtraTimeAfter”
    • “AccomplishedExtraTime”
    • “AssignedExtraTimeBefore”
    • “AssignedExtraTimeAfter”
    • “AssignedExtraTime”

      está basada en los valores de horas extras que haya registrado y asignado la empresa, y por ende, va a variar caso a caso el contenido de estos.
      Un ejemplo de como se muestra la información es: “ValorHoraExtra”:”HH:mm”, donde HH son las horas y mm minutos.

 

Códigos






Código Descripción
200 Éxito
400 Error en el request
500 Error no controlado, contactar a GV



Ejemplo response

{ 
    "Users": [ 
        { 
            "PlannedInterval": [ 
                { 
                    "Date": "20240801000000", 
                    "Punches": [ 
                        { 
                            "Type": "Ingreso", 
                            "Date": "20240801000000", 
                            "Origin": "web", 
                            "Longitude": "-72.9377408", 
                            "Latitude": "-41.461239", 
                            "Accuracy": "5.5", 
                            "GroupDescription": "grupobase", 
                            "UploadDate": "20240801000000", 
                            "ShiftPunchType": "Ingreso", 
                            "AssignedInBook": true, 
                            "BoxSn": "OGT7080057072700147", 
                            "IdTask": "WBlTS2dvAOwN4Kk7XZliiA", 
                            "IdProject": "A4lTSTdv5OSN3Kk7XZZii4", 
                            "Checksum": "OU8S8_DXd-sFsaEAUUbsFnEkTNZNJ4Zh2FNJDu34EQDMAPcgfBhWd418_X30RRiA7WIECVJRmFypAiP2QNgMA18MjBZd3XZMbJYN0B0oetD9zTYlcVdAY33WX7gu-hp6" 
                       }
                    ], 
                    "Shifts": [ 
                        { 
                            "Ends": "20240910235959", 
                            "Begins": "20240801000000", 
                            "Id": "C4wtS4dv5OSN3uk4XZZi3A", 
                            "StartTime": "08:00", 
                            "MaxStartTime": "09:00", 
                            "ExitTime": "17:00", 
                            "Type": "FixedShift", 
                            "FixedShiftHours": "00:00", 
                            "ShiftDisplay": "08:00 - 17:00 (30 mins)", 
                            "BreakType": "FreeLunch", 
                            "BreakMinutes": "30", 
                            "BreakStart": "00:00", 
                            "BreakEnd": "00:00", 
                            "Status": "enabled", 
                            "Custom": "Texto de ejemplo" 
                        } 
                    ], 
                    "Delay": "00:00", 
                    "BreakDelay": "00:00", 
                    "EarlyLeave": "00:00", 
                   "TimeOffs": [
                       {
                           "TimeOffTypeId": "1GlTS2dv3UwN4K58iblhi3",
                           "Description": "Descriçión de ejemplo",
                           "Starts": "20241007000000",
                           "Ends": "20241015235959",
                           "TimeOffTypeDescription": "Vacaciones",
                           "TimeOffOrigin": "API",
                           "StartTime": "00:00:00",
                           "EndTime": "00:00:00",
                           "AmountHours": "00:00:00"
                       }
                    ], 
                    "WorkedHours": "00:00", 
                    "Absent": "False", 
                    "Holiday": "False", 
                    "Worked": "True", 
                    "NonWorkedHours": "00:00", 
                    "ActuallyNocturnalWorkedHours": "00:00", 
                    "CoveredNonWorkingHours": "00:00", 
                    "AuthorizedOvertimeBefore": "00:00", 
                    "AuthorizedOvertimeAfter": "00:00", 
                    "TotalAuthorizedOvertime": "00:00", 
                   "AccomplishedExtraTimeBefore": {
                       "50": "00:00"
                   },
                   "AccomplishedExtraTimeAfter": {
                       "50": "00:00" 
                    },
                   "AccomplishedExtraTime": {
                       "50": "00:00"                                       },
                   "AssignedExtraTimeBefore": {
                       "50": "00:00"                                       },
                   "AssignedExtraTimeAfter": {
                       "50": "00:00"                                       },
                   "AssignedExtraTime": {
                       "50": "00:00"  
                    }, 
                    "ExtraTimeBeforeShift": "00:00", 
                    "ExtraTimeAfterShift": "00:00" 
                } 
            ], 
            "TotalWorkedHours": "1", 
            "WorkedDays": 0, 
            "NonWorkedDays": 0, 
            "Absences": 0, 
            "Holidays": 0, 
            "Vacation": 0, 
            "DaysLeaveWithPay": 1, 
            "DaysLeaveWithoutPay": 0, 
            "AbsenceDaysWithoutJustification": 0, 
            "AbsenceDaysLicense": 0, 
            "WorkedSundays": 0, 
            "WorkedHolidays": 0, 
            "DaysAttended": 1, 
            "Id": "_GmOwOxS03RDuOZ70PjBdQ", 
            "Identifier": "167893215", 
            "Enabled": "1", 
            "Name": "Armando", 
            "LastName": "Flores", 
            "Email": "correoejemplo@gmail.com", 
            "GroupDescription": "grupobase", 
            "PositionId": "F4rmv7y6MpRMLuPh30GahA", 
            "PositionDescription": "CargoEjemplo", 
            "WeeklyWorkingHoursCodeId": "sDzBzlFnefikfhnZoFXLiw", 
            "IsHiddenForReports": "False" 
        } 
    ], 
    "ExtraTimeValues": [ 
        { 
            "ValueId": "judTqeB_AX2cYpwUJ5EmgA", 
            "Value": "50", 
            "IsActive": "1" 
        } 
    ] 
}

Postman

Ejemplo 1
Ejemplo 1

Tabla de contenidos