Documentación API

API GeoVictoria
Conjunto de Endpoints

En este documento se incluyen instrucciones sobre el uso y métodos de la API de GeoVictoria.

1
 Tabla de Contenidos
API GEOVICTORIA ......................................................................................................................................... 1

TABLA DE CONTENIDOS................................................................................................................................. 2

USO DE LA API .............................................................................................................................................. 5

PROBAR LA API CON REQUESTS MANUALES ........................................................................................................................................ 7

MÉTODOS Y TERMINOLOGÍA ......................................................................................................................... 9

LOGIN ......................................................................................................................................................................... 10
LOGIN ........................................................................................................................................................................................ 10
LIBRO DE ASISTENCIA....................................................................................................................................................... 11
ATTENDANCEBOOK ...................................................................................................................................................................... 11
REMUNERACIONES ......................................................................................................................................................... 16
CONSOLIDATED ............................................................................................................................................................................ 16
EXTENDED .................................................................................................................................................................................. 18
PUNCH ........................................................................................................................................................................ 20
LISTPENDING ............................................................................................................................................................................... 20
LISTPENDINGCHECKPOINT ............................................................................................................................................................. 21
UPDATETIMEOFFCREATIONDATECHECKPOINT .................................................................................................................................. 23
SHIFT .......................................................................................................................................................................... 24
INSERT ....................................................................................................................................................................................... 24
LIST ........................................................................................................................................................................................... 26
TIMEOFF...................................................................................................................................................................... 28
GETTYPES ................................................................................................................................................................................... 28
GET ........................................................................................................................................................................................... 29
GETPENDING............................................................................................................................................................................... 30
UPDATETIMEOFFCREATIONDATECHECKPOINT .................................................................................................................................. 31
UPSERT ...................................................................................................................................................................................... 32
DELETE ....................................................................................................................................................................................... 33
ACTIVITY ...................................................................................................................................................................... 34
GETACTIVITIES ............................................................................................................................................................................. 34
ADDACTIVITYPUNCH .................................................................................................................................................................... 36

2
DELETEACTIVITYPUNCH ................................................................................................................................................................ 37
GROUP ........................................................................................................................................................................ 38
PATHS ........................................................................................................................................................................................ 38
LISTGROUP ................................................................................................................................................................................. 39
ADDGROUP ................................................................................................................................................................................ 40
ADDPATH ................................................................................................................................................................................... 43
ADDPATHNOCC .......................................................................................................................................................................... 44
PATHSCC .................................................................................................................................................................................... 45
ASSIGNGROUPLEADER .................................................................................................................................................................. 46
REMOVEGROUPLEADERS............................................................................................................................................................... 48
REMOVEALLGROUPLEADER ........................................................................................................................................................... 50
EDITGROUPDESCRIPTION .............................................................................................................................................................. 52
RENAMEFOLDER .......................................................................................................................................................................... 53
USER........................................................................................................................................................................... 54
DISABLE...................................................................................................................................................................................... 54
ENABLE ...................................................................................................................................................................................... 55
ADD ........................................................................................................................................................................................... 56
EDIT........................................................................................................................................................................................... 58
MOVEGENERAL ............................................................................................................................................................................ 60
LIST ........................................................................................................................................................................................... 61
PROFILELIST ................................................................................................................................................................................ 63
EDITPROFILE ................................................................................................................................................................................ 64
HIDE .......................................................................................................................................................................................... 65
SHOW ........................................................................................................................................................................................ 66
TASK ........................................................................................................................................................................... 67
LIST ........................................................................................................................................................................................... 67
LISTBYUSER ................................................................................................................................................................................ 68
ADD ........................................................................................................................................................................................... 69
SET ............................................................................................................................................................................................ 70
PROJECT ...................................................................................................................................................................... 71
LIST ........................................................................................................................................................................................... 71
LISTBYUSER ................................................................................................................................................................................ 72
ADD ........................................................................................................................................................................................... 73
ADDPROJECTS ............................................................................................................................................................................. 74
SET ............................................................................................................................................................................................ 75
POSITION ..................................................................................................................................................................... 76
LIST ........................................................................................................................................................................................... 76
ADD ........................................................................................................................................................................................... 77
DISABLE...................................................................................................................................................................................... 78
ENABLE ...................................................................................................................................................................................... 79

3
PLANIFICADOR............................................................................................................................................................... 80
PLANNER .................................................................................................................................................................................... 80
PLANIFICACIÓN .............................................................................................................................................................. 81
PLANNING .................................................................................................................................................................................. 81
SETSCHEDULE .............................................................................................................................................................................. 83

4
Uso de la API
GeoVictoria, entrega a sus clientes, una serie de métodos que permiten consultar e ingresar
datos a la plataforma a través de una API.
Es necesario poseer una cuenta de empresa para poder acceder a las credenciales utilizadas en la
autenticación de la API.
A continuación, se describen los pasos a seguir si usted ya dispone de un acceso a al portal de
GeoVictoria.

1. Dentro de la plataforma de GeoVictoria, haga click en el ícono de engranaje de opciones

2. Haga click en "Configuraciones Empresa"

3. En el menú desplegable, haga click en la opción "Acceso API"

5
4. Copiar las credenciales que aparecen en los campos "Clave Api" y "Secreto"

Con estas credenciales podrá obtener acceso a los distintos métodos de GeoVictoria.
En el siguiente punto se tratan las diferentes condiciones para la correcta utilización de las
credenciales.

6
Probar la API con requests manuales

Para enviar solicitudes a la API de forma manual se pueden utilizar clientes REST como Postman
([Link] ) o Insomnia ([Link] ).

Debe tener presente, que existen un conjunto de métodos que solicitan autenticación por Token,
mientras que otros, la autenticación es a través de OAuth 1.0.

• Los métodos que requieren una autenticación por Token, los encontrará en el subdominio
customerapi.

• Los métodos que requieren autenticación a través de OAuth 1.0 los encontrará en el
subdominio apiv3.

• Para distinguir fácilmente un método que requiere una autenticación por Token
encontrará, en el título del método, el Token
recuadro

• Para distinguir fácilmente un método que requiere una autenticación por OAuth 1.0
encontrará, en el título del método, el recuadro OAut
h
• Es importante considerar que la duración del Token, expira a las 5 horas de haberlo
solicitado, por lo que se recomienda obtener uno nuevo en cada petición.

Por último, pero no menos importante, el jefe de proyectos asignado, le dará las instrucciones
para diferenciar los ambientes disponibles en GeoVictoria ya que se dispone de un ambiente de
prueba separado al de producción.

[Link]
*Su jefe de proyectos asignado debe confirmar cual es el ambiente que debe usar.

7
Nota: Para utilizar cualquiera de los métodos de la API en alguna implementación,
se deben utilizar los Status Code, de la respuesta, como indicadores del estado de
la petición. En ningún caso se debe utilizar el mensaje que se incluye en el cuerpo
de la respuesta. Los mensajes que se entregan como respuesta a una petición
están sujetos a cambios y cualquier lógica que se aplique a ellos podría dejar de
funcionar en caso de una actualización, en cambio, los códigos de respuesta son
standard y pueden utilizarse sin problemas.

Los Status Code para respuestas HTTP son:

['100', '101', '200', '201','202', '203', '204', '205', '206', '300', '300', '301', '301',
'302', '302', '303', '303', '304', '305', '306', '307', '307', '400', '401', '402', '403', '404', '405',
'406', '407', '408', '409', '410','411', '412', '413', '414', '415', '416', '417', '426', '500','501', '502',
'503', '504', '505']

Los significados de cada Status Code se pueden encontrar en:

[Link]

8
 Métodos y terminología
• Todos los métodos, descritos en este documento, utilizan la notación JSON como medio de
comunicación entre los sistemas.

• Todos los métodos aquí descritos deben utilizar el verbo HTTP POST.

• Para los casos en que se aprecie un método, que el formato de respuesta está encerrado
entre símbolos de mayor y menor, corresponde a un diccionario. El primer campo es el índice
y el segundo es el valor. Ejemplo:

<interger, string>
El resultado de esta petición retorna un campo que es de tipo diccionario donde el índice es interger (numérico) y el
valor es string (cadena de texto).

• Para los casos en que un campo retorne una lista o requiera pasar una lista, se indicará con la
palabra “List” seguida de los símbolos de mayor y menor, donde, en el interior indicará el tipo
de valor esperado. Ejemplo:

List<string>
Se espera un listado con valores de tipo string (cadena de texto).

• Para los casos en que un campo retorne un arreglo o requiera pasar un arreglo, se indicará
con la palabra “Array” seguida de los símbolos de mayor y menor, donde, en el interior
indicará el tipo de valor esperado. Ejemplo:

Array<string>
Se espera un arreglo con valores de tipo string (cadena de texto).

9
 Login

Login

Este método permite, a través de las credenciales de uso de la API (Clave Api y Secreto), la obtención de un
Token, para poder autenticarse en los demás métodos que lo requieren.
Las credenciales deben ser enviadas en el cuerpo de la petición con la estructura descrita abajo.
Es el único método que no requiere especificar nivel de autenticación.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Tipo Estado Descripción

User string Requerido Clave API

Password string Requerido Secreto

Respuesta

La respuesta contiene el token que se debe utilizar la autenticación, en los distintos métodos descritos en este
documento.

Campo Largo Tipo Descripción

token N/A string Token utilizado para la autenticación en
los distintos métodos.

10
*Una vez obtenido el Token, éste debe ser enviado en la cabecera de las siguientes peticiones a través
de la clave Authorization.

Libro de asistencia

AttendanceBook Token

Este método retorna la información del libro de asistencia de/del colaborador. La información, además, lista el turno
asignado para los días consultados, los permisos, horas extras aprobadas y asignadas, atraso, entre otro.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

StartDate 14 string Requerido yyyyMMddHHmmss Día y hora en la que debe partir la
búsqueda
EndDate 14 string Requerido yyyyHHddHHmmss Día y hora en la que debe finalizar la
búsqueda
UserIds N/A List<string> Requerido Listado de identificadores de los
colaboradores. Deben ser los mismos que
los que se encuentren registrados en la
página.
Para indicar más de un valor debe
separarse por comas.

Respuesta

La respuesta contiene un listado información de los usuarios solicitados y sus intervalos planificados, separada por
fecha.

11
Los tipos de permisos, define las bases para la asignación de tiempos, descuentos, parcialidad, etc. Puede encontrar,
crear y editar permisos en la sección tipos de permisos, en la configuración de empresa.

Los porcentajes de horas extras deben ser configurados en la plataforma. Para que un rango de tiempo sea
considerado como hora extra primero debe ser aprobada como tal.
El desglose de las horas se realiza listando la cantidad de horas aprobadas por porcentaje.

Se debe tener en cuenta, para la correcta lectura en el listado de turnos, que la información a
mostrar está ligada a la configuración del turno asignado, es decir, los resultados entregados
dependerán si el turno es: Turno Fijo, Fijo por Horas o Banda Horaria. Puede agregar y
modificar turnos en la sección Configuración Empresa -> Turnos, de nuestro sitio Web.

Campo Largo Tipo Jerarquía Descripción

Users Listado Raíz Raíz de la respuesta.
PlannedInterval Listado Users Listado de valores relacionados con el intervalo
planificado.
Date 14 string PlannedInterval Fecha correspondiente a la información
mostrada dentro del rango de fechas solicitado
en la consulta.
Punches Listado PlannedInterval Marcas realizadas por el colaborador. En este
listado se pueden apreciar las marcas de ingreso
y salida de turno además de las de colación.
Type 7 string Punches Acción asociada a la marca. Los valores posibles
que puede representar este campo son:
“Ingreso”, para las marcas de entrada y “Salida”,
para las marcas de salida.
Date 14 string Punches Día y hora de la marca.
Origin 10 string Punches Lugar de origen o procedencia desde donde fue
hecha la marca. Ejemplo: API, Web, reloj control,
etc.
UploadDate 14 string Punches Para los casos en que la marca haya sufrido una
modificación se mostrará el día y hora en que
fue alterada. En el caso que no se haya
producido ninguna modificación se mostrará la
fecha de marcaje. Se debe considerar que el
formato de salida para este campo está en GMT-
0.
Shifts Listado PlannedInterval Listado de los turnos asignados al colaborador.

12
Id N/A string Shifts Identificador del turno.
StartTime 5 string Shifts Hora en la que inicia el turno planificado.
ExitTime 5 string Shifts Hora en la que finaliza el turno planificado.
FixedShiftHours 20 string Shifts Número de horas, fijas para el turno, a cumplir.
Ends 14 string Shifts Fecha y hora de termino, configurada, para el
turno asignado.
Begins 14 string Shifts Fecha y hora de inicio, configurada, para el turno
asignado.
ShiftDisplay 30 string Shifts Nombre del turno asignado.
BreakType 20 string Shifts Tipo de colación.
BreakMinutes 4 string Shifts Minutos totales de colación del turno. Este
campo se condiciona con la configuración del
turno.
BreakStart 5 string Shifts Inicio de la hora de colación. Este campo se
condiciona con la configuración del turno.
BreakEnd 5 string Shifts Término de la hora de colación. Este campo se
condiciona con la configuración del turno.
Delay 5 string Shifts Sumatoria de horas y minutos de atrasos para el
rango de fecha consultado.
BreakDelay 5 string Shifts Total, de horas y minutos correspondiente al
atraso en la entrada de colación.
EarlyLeave 5 string Shifts Total, de horas y minutos correspondiente a la
salida anticipada del colaborador.
TimeOffs Listado PlannedInterval Contiene el listado de permisos asignados al
colaborador.
TimeOffTypeId N/A string TimeOffs Identificador del permiso asignado al
colaborador. Este valor se puede recuperar y
relacionar con los valores que retorna el método
GetTypes.
Starts 14 string TimeOffs Fecha en la que inicia el permiso asignado.
Ends 14 string TimeOffs Fecha en la que finaliza el permiso asignado.
TimeOffTypeDescription 16 string TimeOffs Nombre del permiso.
TimeOffOrigin 4 string TimeOffs Origen o procedencia desde donde fue hecho el
permiso. Ejemplo: API, Web, reloj control, etc.
StartTime 8 string TimeOffs Para los casos en que se asigne un tipo de
permiso parcial se podrá observar el valor la
hora en la que inicia el permiso.
EndTime 8 string TimeOffs Para los casos en que se asigne un tipo de
permiso parcial se podrá observar el valor la
hora en la que finaliza el permiso.

13
WorkedHours 5 string PlannedInterval Total de horas trabajas para los días buscados.
Absent 5 string PlannedInterval Indica si el día consultado estuvo ausente. En
caso de estar ausente se aprecia el valor “True”,
en caso contrario el valor “False”.
Holiday 5 string PlannedInterval Indica si el día consultado fue un día de
vacaciones o feriado. En el caso de ser un día de
vacaciones el valor será “True”, en caso contrario
el valor será “False”.
Worked 5 string PlannedInterval Este campo indica si el día consultado el
colaborador trabajó. En caso de ser afirmativo el
valor retornado será “True”, en caso contrario el
valor será “False”.
NonWorkedHours 5 string PlannedInterval Total de horas no trabajas para los días
buscados.
AccomplishedExtraTimeBefore N/A <string,string> PlannedInterval Total de hora extras aprobadas antes del inicio
del turno.
AccomplishedExtraTimeAfter N/A <string,string> PlannedInterval Total de hora extras aprobadas después del
término del turno.
AccomplishedExtraTime N/A <string,string> PlannedInterval Total de hora extras aprobadas antes del inicio
del turno y después del término del turno.
AssignedExtraTimeBefore N/A <string,string> PlannedInterval Total de hora extras asignadas antes del inicio
del turno.
AssignedExtraTimeAfter N/A <string,string> PlannedInterval Total de hora extras asignadas después del
término del turno.
AssignedExtraTime N/A <string,string> PlannedInterval Total de hora extras asignadas antes del inicio
del turno y después del término del turno.
Identifier 16 string Users Campo identificador del colaborador.
Name 256 string Users Nombre del colaborador.
LastName 100 string Users Apellido del colaborador.
Enabled 1 string Users Campo que indica el estado del colaborador en
GeoVictoria. Cuando el valor es “1” el
colaborador se encuentra en el sistema. Cuando
el valor es “0” el colaborador se encuentra
desactivado en el sistema.
GroupDescription 100 string Users Nombre del grupo al que pertenece.
Email 200 string Users Correo electrónico del colaborador.
ExtraTimeValues Listado Raíz Listado de los diferentes porcentajes de horas
extras configurados en la plataforma.
ValueId N/A string ExtraTimeValues Identificador, encriptado, del registro.
Value 8 string ExtraTimeValues Valor que representa el porcentaje de hora

14
 extra.
IsActive 1 string ExtraTimeValues Cuando el valor es “1” indica que el porcentaje se
encuentra activo en el sistema. Cuando el
porcentaje de hora extra está desactivado no se
muestra en este listado.

15
 Remuneraciones

Consolidated Token

Este método entrega un resumen de lo que es el reporte de remuneraciones de GeoVictoria.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

IncludeAll 1 interger Requerido Cuando este valor es 0 sólo se recuperan los usuarios
activos. En el caso que el valor sea 1 recuperará usuarios
activos y desactivados.
StartDate 14 string Requerido yyyyHHddHHmmss Día y hora en la que debe partir la búsqueda.
EndDate 14 string Requerido yyyyHHddHHmmss Día y hora en la que debe finalizar la búsqueda.
UserIds N/A List<string> Requerido Listado de identificadores de los colaboradores. Deben
ser los mismos que los que se encuentren registrados en
la página.
Para indicar más de un valor debe separarse por comas.

16
 Respuesta

La respuesta es el consolidado del reporte de remuneraciones, a partir del filtro aplicado en la

consulta.

Campo Largo Tipo Descripción

Identifier 16 string Identificador del colaborador.
WorkedHours 5 string Total de horas trabajadas, calculadas, para el periodo solicitado.
NonWorkedHours 5 string Total de horas no trabajadas calculadas para el periodo solicitado.
TotalAuthorizedExtraTime 5 string Total de horas extras autorizadas calculadas para el periodo
solicitado.
Absent 1 interger Cantidad de inasistencias para el periodo solicitado.
AccomplishedExtraTime N/A <string, string> Desglose, por porcentaje de hora extra, aprobadas. Este campo
contiene la sumatoria por cada porcentaje.

17
Extended Token

Este método entrega el detallado de lo que es el reporte de remuneraciones de GeoVictoria.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

IncludeAll 1 interger Requerido Cuando este valor es 0 sólo se recuperan los usuarios
activos. En el caso que el valor sea 1 recuperará usuarios
activos y desactivados.
StartDate 14 string Requerido yyyyHHddHHmmss Día y hora en la que debe partir la búsqueda.
EndDate 14 string Requerido yyyyHHddHHmmss Día y hora en la que debe finalizar la búsqueda.
UserIds N/A List<string> Requerido Listado de identificadores de los colaboradores. Deben
ser los mismos que los que se encuentren registrados en
la página.
Para indicar más de un valor debe separarse por comas.

18
 Respuesta

La respuesta es el consolidado del reporte de remuneraciones, a partir del filtro aplicado en la

consulta.

Campo Largo Tipo Descripción

Identifier 16 string Identificador del colaborador.
WorkedHours 5 string Total de horas trabajadas, calculadas, para el periodo solicitado.
NonWorkedHours 5 string Total de horas no trabajadas calculadas para el periodo
solicitado.
TotalAuthorizedExtraTime 5 string Total de horas extras autorizadas calculadas para el periodo
solicitado.
Absent 1 integer Cantidad de inasistencias para el periodo solicitado.
AccomplishedExtraTime N/A <string, Desglose, por porcentaje de hora extra, aprobadas. Este campo
string> contiene la sumatoria por cada porcentaje.
WorkedSundays N/A integer Total de domingos trabajados para el periodo solicitado.
WorkedSundaysHours 5 string Total de horas trabajadas, en domingos, para el periodo
solicitado.
ActuallyWorkedSundaysHours 5 string Total de horas realmente trabajadas, en domingos, para el
periodo solicitado.
WorkedHolidays N/A integer Total de feriados trabajados para el periodo solicitado.
WorkedHolidaysHours 5 string Total de horas trabajadas, en feriados, para el periodo
solicitado.
ActuallyWorkedHolidaysHours 5 string Total de horas realmente trabajadas, en feriados, para el
periodo solicitado.
[Link] N/A integer Días totales considerados como remunerados.
[Link] N/A integer Días totales considerados como no remunerados.
[Link] N/A integer Días remunerados que corresponden a descansos.
[Link] N/A integer Días remunerados que corresponden a días asistidos.
[Link] N/A integer Días remunerados que corresponden a feriados.
[Link] N/A integer Días remunerados que corresponden a vacaciones.
[Link] N/A integer Días remunerados que son permisos con goce de sueldo.
[Link] N/A integer Días no remunerados que son inasistencias sin justificación.
[Link] N/A integer Días no remunerados que corresponden a licencias.
[Link] N/A integer Días no remunerados que corresponden a permisos sin goce de
sueldo.
[Link] N/A integer Días no remunerados que corresponden a feriados
renunciables no trabajados.

19
 Punch

ListPending Token

Obtiene un listado con 1.000 marcas, iniciando la consulta desde el último registro listado anteriormente.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

El método retorna un listado con la información de las marcas.

Campo Largo Tipo Descripción

Type 7 string Cuando la marca es de entrada se recupera el valor “Ingreso”, en caso de que la marca
sea de salida se recupera el valor “Salida”.
Date 14 string Hora y día de la marca.
Origin 10 string Lugar de origen o procedencia desde donde fue hecha la marca. Ejemplo: API, Web, reloj
control, etc.
UploadDate 14 string Hora y día de registro de la marca.
UserIdentifier 16 string Identificador del colaborador.

20
ListPendingCheckPoint OAut
h

Lista las marcas pendientes para el usuario especificado, a partir de la fecha brindada.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

CheckpointDate 14 string Requerido yyyyMMddHHmmss Hora y día en la que en la que parte la recuperación de
las marcas.
Range N/A string Requerido Separar por comas Listado de colaboradores a buscar en la consulta.
para consultar por
más de uno.

Respuesta

Retorna un listado de las marcas, de un colaborador, con la siguiente estructura:

Campo Largo Tipo Descripción

Date 14 string Hora y día en la que se realizó la marca.
biometric_satus 8 string Indica el estado biométrico de la marca.
box_sn 50 string Número de serie del reloj control.
caller_id 50 string Número hacia el cual se realiza la marcación.
custom1 100 string Campo personalizado 1 del colaborador.
custom2 100 string Campo personalizado 2 del colaborador.
custom3 300 string Campo personalizado 3 del colaborador.
email 200 string Correo electrónico del colaborador.
gps_latitude 14 string Latitud del GPS.
gps_longitude 14 string Longitud del GPS.
group 4 string Grupo al que pertenece el colaborador.
id_punch 256 string Identificador encriptado de la marca.
identifier 16 string Identificador del colaborador.

21
lastModifiedDate 14 string Última modificación de la marca.
mask 1 string Indica si la marca fue hecha con mascarilla.
name 256 string Nombre del colaborador.
system 10 string Origen de la marca.
temperature 6 string Temperatura con la que se realizó la marca.
type 5 string El valor para marca de entrada es “entry”, en caso que la marca sea de salida se
recupera “exit”.

22
UpdateTimeOffCreationDateCheckpoint Token

Restablece la fecha de recuperación de las marcas. Esto se debe a que el listado de marcas, método ListPending,
anota la última marca listada como el registro de partida para la siguiente consulta.

POST
[Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

CheckpointDate 14 string Requerido yyyyMMddHHmmss Fecha a la que se restablece el punto de partida de
recuperación de las marcas, a través de la API.

Respuesta

La respuesta que entrega el método si la acción ha sido exitosa es true, en caso que no se haya
llevado a cabo la modificación el método responderá con información del error.

23
 Shift

Insert Token

Ingresa un nuevo turno en la plataforma.

POST [Link]

Petición

Los campos “BreakStart” y “BreakEnd” son excluyentes al campo “BreakMinutes”.

Los campos “ShiftHours” y “MaxStartHour” son excluyentes con los campos “StarHour” y
“EndHour”.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

StartHour 5 string Requerido HH:mm Hora de inicio del turno.
MaxStartHour 5 string Requerido HH:mm Hora límite de inicio de turno.
EndHour 5 string Requerido HH:mm Hora de fin de turno
BreakStart 5 string Requerido HH:mm Hora de inicio de colación.
BreakEnd 5 string Requerido HH:mm Hora fin de colación
BreakMinutes 4 interger >0 Minutos que puede tomarse el colaborador para
almorzar.
ShiftHours 5 string Requerido HH:mm Cantidad de horas del turno.
Custom 20 string Opcional <= 20 Detalle/comentario que se le puede agregar al turno.
ShiftDay 3 string Opcional Para los turnos que tienen terminan el mismo día que
inicia se debe agregar el valor “fin”. Para los turnos
que terminan posterior al día de inicio no se debe
indicar valor.

Respuesta

24
El método retorna el identificador del turno encriptado como cadena de texto.

25
List OAut
h

Entrega una lista de todos los turnos.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

El método retorna una lista de los turnos:

Campo Largo Tipo Estado Formato Descripción

ID_SHIFT N/A string Requerido Identificador del turno.
DESCRIPTION 26 string Requerido Descripción/nombre del turno.
TYPE_SHIFT 10 string Opcional • Fijo por horas Describe el tipo de turno asignado.
• No trabaja
• Presencial
• Sin turno
• Turno fijo
• Turno libre
START_HOUR 5 string Opcional Hora de inicio para un turno fijo.
END_HOUR 5 string Opcional Hora de salida para un turno fijo.
START_BREAK 5 string Opcional Hora a la que inicia la colación de tipo fija.
END_BREAK 5 string Opcional Hora a la que finaliza la colación de tipo
fija.
BREAK_TYPE 10 string Opcional • Colación fija Descripción del tipo de colación.
• Colación libre
• Sin colación
BREAK_MINUTES 4 List<user> Opcional Tiempo total de colación para del tipo
libre.
SHIFT_HOURS 5 interger Opcional Horas totales para un turno de tipo fijo por
horas.

26
CUSTOM 20 interger Opcional Campo personalizado referente al turno.
EXTERNAL_SHIFT_ID 4 interger Opcional Identificador, auto incremental, del turno
que se genera al momento de crear un
nuevo turno. Éste puede ser observado en
la sección “Turnos”, en la plataforma, y
corresponde a la columna ID.
ENABLED boolean Opcional Indica si el turno está activo o desactivado.

27
 TimeOff

GetTypes Token

Lista los tipos de permisos configurados para la empresa.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

El método retorna una lista con la información de los tipos de permisos existentes.

Campo Largo Tipo Descripción

Id N/A string Identificador, encriptado, del tipo de permiso.
TranslatedDescription 256 string Descripción del tipo de permiso.
Status 7 string En los casos en que el tipo de permiso esté habilitado se observa el texto
“enabled” como resultado. Los tipos de permisos desactivados no aparecen en
la lista.
IsPayable 5 string Los tipos de permisos configurados con goce de sueldo se retorna el texto
“True”. En el caso que el tipo de permiso sea sin goce de sueldo se observa el
texto “False”.

28
Get Token

Retorna una lista de los permisos asignados a los colaboradores solicitados en el rango de fecha indicado.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

StartDate 14 string Requerido yyyyMMddHHmmss Día y hora en la que debe partir la búsqueda.
EndDate 14 string Requerido yyyyMMddHHmmss Día y hora en la que debe terminar la
búsqueda.
UserIds N/A List<int> Requerido Listado de los identificadores de los
colaboradores a recuperar.

Respuesta

Considerar que los permisos parciales son los únicos que pueden establecer horas al/los
permiso(s).
El método retorna una lista con la información de los tipos de permisos asignados:

Campo Largo Tipo Descripción

TimeOffTypeId N/A string Identificador, encriptado, del tipo de permiso
Starts 14 string Día en el que inicia el permiso.
Ends 14 string Día en el que finaliza el permiso.
TimeOffTypeDescription 256 string Descripción del tipo de permiso.
TimeOffOrigin 10 string Origen o procedencia desde donde fue hecho el permiso. Ejemplo: API,
Web, reloj control, etc.
StartTime 8 string Hora en el que inicia el permiso.
EndTime 8 string Hora en el que finaliza el permiso.
UserIdentifier 16 string Identificador del colaborador.

29
GetPending Token

Lista los permisos asociados de los distintos colaboradores de la empresa. Este método retornar un total de 1.000
permisos por cada petición. El último permiso listado será marcado para iniciar que la siguiente consulta inicie de
este último.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

El método retorna una lista con la información de los tipos de permisos asignados:

Campo Largo Tipo Descripción

TimeOffTypeId N/A string Identificador, encriptado, del tipo de permiso
Starts 14 string Día en el que inicia el permiso.
Ends 14 string Día en el que finaliza el permiso.
TimeOffTypeDescription 256 string Descripción del tipo de permiso.
TimeOffOrigin 10 string Origen o procedencia desde donde fue hecho el permiso. Ejemplo: API,
Web, reloj control, etc.
StartTime 8 string Hora en el que inicia el permiso.
EndTime 8 string Hora en el que finaliza el permiso.
UserIdentifier 16 string Identificador del colaborador.

30
UpdateTimeOffCreationDateCheckpoint Token

Restablece la fecha de recuperación de los permisos. Esto se debe a que el listado de permisos, método
GetPending, anota el último permiso consultada como el registro de partida para la siguiente consulta.

POST [Link]
UpdateTimeOffCreationDateCheckpoint

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

CheckpointDate 14 string Requerido yyyyMMddHHmmss Fecha a la que se restablece el punto de
partida de recuperación de los permisos, a
través de la API.

Respuesta

La respuesta que entrega el método si la acción ha sido exitosa es true, en caso que no se haya
llevado a cabo la modificación el método responderá con información del error.

31
Upsert Token

Crea o actualiza un permiso para un colaborador dada en una fecha específica.

POST [Link]

Petición

Los “StartTime” y “EndTime” sólo se pueden rellenar en el caso que se quiera asignar un permiso
de tipo parcial. Pude revisar la configuración de los tipos de permisos desde la sección
Configuración Empresa -> Permisos, de nuestro sitio Web.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

UserIdentifier 16 string Requerido Identificador del colaborador
TimeOffTypeId N/A string Requerido Identificador, encriptado, del tipo de
permiso asociado.
StartDate 14 string Requerido yyyyMMddHHmmss Día en el que inicia el permiso.
EndDate 14 string Requerido yyyyMMddHHmmss Día en el que finaliza el permiso.
CreatedByIdentifier 16 string Requerido Identificador de la persona que crea o
actualiza el permiso.
Description N/A string Opcional Obsoleto Descripción/nota del permiso.
StartTime 5 string Requerido HH:mm Hora en el que inicia el permiso.
EndTime 5 string Requerido HH:mm Hora en el que finaliza el permiso.
Origin N/A string Opcional Obsoleto Origen o procedencia desde donde fue
hecho el permiso. Ejemplo: API, Web,
reloj control, etc.

Respuesta

La respuesta que entrega el método si la acción ha sido exitosa es true, en caso que no se haya
llevado a cabo la modificación el método responderá con información del error.

32
Delete Token

Elimina un permiso para un colaborador dada en una fecha específica.

POST [Link]

Petición

Elimina un permiso existente para un colaborador en una fecha dada. Los campos de tiempo no
pueden considerar un rango de fechas, debe ser un día por petición.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

UserIdentifier 16 string Requerido Identificador del colaborador
Start 14 string Requerido yyyyMMddHHmmss Día en el que inicia el permiso a eliminar.
End 14 string Requerido yyyyMMddHHmmss Día en el que finaliza el permiso a eliminar.
TypeIdentifier N/A string Requerido Identificador, encriptado, del tipo de
permiso.

Respuesta

La respuesta que entrega el método si la acción ha sido exitosa es true, en caso que no se haya
llevado a cabo la modificación el método responderá con información del error.

33
 Activity

GetActivities OAut
h

Retorna las actividades vigentes, de los proyectos asociados a los usuarios solicitados, para un rango de fechas.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Range N/A List<interger> Requerido No debe contener Identificador del colaborador.
ni puntos ni guion.
Para más de un
valor separar por
comas.
from 14 string Requerido yyyyMMddHHmmss Fecha de inicio, del rango de búsqueda.
to 14 string Requerido yyyyMMddHHmmss Fecha de término, del rango de búsqueda.
includeAll 1 string Opcional El valor 0 indica recuperar sólo los
colaboradores activos. El valor 1 indica que
se recuperan los activos y desactivados.
En caso de no indicarse el valor por defecto
para este campo será 0.

34
Respuesta

El método retorna una lista con la información de las actividades vigentes, para el colaborador
consultado.

Campo Largo Tipo Descripción

Identifier 16 string Identificador del colaborador.
UserName 256 string Nombre y apellidos del colaborador.
IdActivity 8 string Identificador de la actividad.
IdTask N/A string Identificador de la tarea.
IdProject N/A string Identificador del proyecto.
IdStartPunch N/A string Identificador de la marca de inicio.
IdEndPunch N/A string Identificador de la marca de término.
StartDate 14 string Fecha inicio de la marca.
EndDate 14 string Fecha de término de la marca.
OriginStartPunch 10 string Aplicación/sistema donde se produce la marca de inicio.
OriginEndPunch 10 string Aplicación/sistema donde se produce la marca de término.
StartDateIsModified 5 boolean Indica si la fecha de inicio ha sido modificada.
EndDateIsModified 5 boolean Indica si la fecha de término ha sido modificada.
WorkedHours 5 string Total de horas trabajadas.
ProjectDescription 600 string Descripción del proyecto.
TaskDescription string Descripción de la tarea.
Commentary 300 string Comentario de la actividad
ActivityEnabled boolean Estado de la tarea.
StartPunchGPSLatitude 14 string Latitud de la marca de inicio.
StartPunchGPSLongitude 14 string Longitud de la marca de inicio.
EndPunchGPSLatitude 14 string Latitud de la marca de término.
EndPunchGPSLongitude 14 string Longitud de la marca de término.

35
AddActivityPunch OAut
h

Adiciona una marca manual correspondiente al “fin” de la jornada.

POST [Link]

Petición

El identificador de la actividad debe estar encriptado. Este valor se puede obtener del método
GetActivities.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier N/A List<interger> Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor
separar por comas.
IdActivity N/A string Requerido Identificador de la actividad.
Date 14 string Requerido yyyyMMddHHmmss Fecha en la que se quiere establecer la
marca.
Type 3 string Requerido Se debe incluir el valor “end”.
CreatedBy 100 Requerido Nombre del creador de la marca.

Respuesta

Si la ejecución ha sido exitosa retorna el mensaje “Activity Punch created”.

36
DeleteActivityPunch OAut
h

Elimina una marca manual correspondiente al “fin” de la jornada.

POST [Link]

Petición

El identificador de la actividad debe estar encriptado. Este valor se puede obtener del método
de GetActivities.
El identificador de la marca debe estar encriptado. Este valor se puede obtener del método
GetActivities.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier N/A List<interger> Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor separar
por comas.
IdActivity N/A string Requerido Identificador de la actividad.
IdPunch N/A string Requerido Identificador de la marca.
Date 14 string Requerido yyyyMMddHHmmss Fecha en la que se quiere establecer la
marca.
Type 3 string Requerido Se debe incluir el valor “end”.

Respuesta

Si la ejecución ha sido exitosa retorna el mensaje “Activity Punch hide correctly”.

37
 Group

Paths OAut
h

Retorna un listado, con la ruta de los grupos, para la empresa autenticada.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

Retorna una lista de los grupos separados entre sí con dos barras invertidas, “\\”. El primer
grupo pertenece al grupo base de la empresa, los predecesores a éste, son sus subgrupos.

38
ListGroup OAut
h

Retorna un listado, con la con la información de los grupos y los supervisores asignados a cada grupo.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

La respuesta es un listado de las rutas de cada grupo:

Campo Largo Tipo Descripción

Address 300 string Ubicación geográfica.
CostCenter 200 string Código del centro de costos.
Custom1 300 string Campo personalizado para el grupo.
Description 100 string Nombre del grupo.
GpsAccuracy 2 interger Precisión del GPS para la realización de los marcajes asociada al grupo.
GpsLatitude 14 string Latitud que representa la ubicación geográfica del grupo.
GpsLongitude 14 string Longitud que representa la ubicación geográfica del grupo.
Identifier N/A string Identificador del grupo, este campo está cifrado.
Path N/A string Ruta del grupo.
Supervisors N/A List<user> Listado de los supervisores asociados al grupo. Corresponde a la estructura del
tipo usuario.

39
AddGroup OAut
h

Adiciona un grupo a la empresa autenticada.

POST [Link]

Petición

La ruta del grupo, campo Path, se puede obtener desde el método Paths.
El listado de supervisores corresponde a un listado con la estructura del colaborador. Puede
obtener la estructura revisando el método List.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Description 100 string Requerido <= 100 Nombre del grupo.
Path N/A string Requerido La separación entre Ruta donde estará incluido el grupo.
grupos se realiza
utilizando doble barra
invertida. La cadena
de texto no debe
terminar con doble
barra invertida.
Address 300 string Opcional <= 300 Ubicación geográfica.
GpsLatitude 14 string Opcional <= 14 Latitud referente a la ubicación
geográfica.
GpsLongitude 14 string Opcional <= 14 Longitud referente a la ubicación
geográfica.
GpsAccuracy 2 string Opcional Precisión del GPS.
CostCenter 200 string Opcional <= 200 Centro de costo asociado.
Custom1 300 string Opcional <= 300 Campo personalizado del grupo.
Supervisor N/A List<user> Opcional Listado de los supervisores asociados
al grupo.
ValidationType 1 interger Opcional 0. Sin validación Tipo de validación que se usará desde
1. Selfie la aplicación celular.
2. Firma
3. Selfie o firma

40
 5. Patrón
6. Selfie o patrón
UseProyectsAndTask 1 interger Opcional 0. No Determina si el grupo puede usar
1. Sí proyectos y tareas desde la aplicación
2. Sigue reglas de de celular. Por defecto el valor es
empresa “Sigue reglas de empresa”
BlockByLocation 1 interger Opcional 0. No Determina si se pueden realizar
1. Sí, por ubicación marcas fuera de la ubicación de las
del grupo coordenadas establecidas en el grupo.
2. Sigue reglas de Por defecto se asume “Sigue reglas de
empresa empresa”
3. Sí, por ubicación
del usuario
4. Sí, por ubicación
del proyecto
BlockUnwantedApps boolean Opcional Este campo especifica si se deben
bloquear aplicaciones que modifican
las coordenadas en los dispositivos
celulares.
UseCasino boolean Opcional Determina si el grupo tiene acceso y
uso de las opciones de la plataforma
casino.
CrewEnabled boolean Opcional Determina si el grupo está habilitado o
deshabilitado para marcaje por
cuadrillas.
PunchFromCrewOny boolean Opcional Determina si el grupo tiene
restricciones por cuadrilla. En caso de
ser “true” se habilita la restricción por
cuadrilla, en caso contrario se
deshabilita. Por defecto el valor es
deshabilitado.
CallSource 1 interger Opcional 0. Sin restricción Determina el origen de llamado para el
1. Sólo teléfonos del grupo. Por defecto el valor es “Sólo
grupo teléfonos del grupo”
2. Teléfonos de la
empresa
AppEnabled boolean Opcional Determina si los colaboradores del
grupo pueden hacer uso de la
aplicación de celular.

41
Respuesta

La respuesta es el código, encriptado, del nuevo grupo.

42
AddPath OAut
h

Crea las carpetas (contenedores) en la ruta recibida, para los grupos con Centro de Costo/ Código Integración (CC)
definidos.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Descripción

Path N/A string Requerido Ruta del grupo con código de centro de costos/código de integración.
Cada uno de los niveles de esta ruta debe ser separada por una doble
barra invertida, donde, el último nivel será el nombre del grupo. Al final
de la ruta se debe indicar el código de centro de costos/código de
integración entre paréntesis. Revisar ejemplo.

Ejemplo:
Grupo principal\\Subgrupo 1\\Subgrupo n(código de centro de costos/integración)

Respuesta

Si la inserción ha sido correcta retorna el mensaje “OK”.

43
AddPathNoCC OAut
h

Crea las carpetas (contenedores) para grupos sin Centro de Costo/Código Integración (CC).

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Descripción

Path N/A string Requerido Ruta del grupo sin código de centro de costos/código de integración.
Cada uno de los niveles de esta ruta debe ser separada por una doble
barra invertida, donde, el último nivel será el nombre del grupo. Al final
de la ruta se debe indicar un paréntesis, sin nada en su interior. Revisar
ejemplo.

Ejemplo:
Grupo principal\\Subgrupo 1\\Subgrupo n()

Respuesta

Si la inserción ha sido correcta retorna el mensaje “OK”.

44
PathsCC OAut
h

Retorna todos los grupos con su respectivo código de centro de costos/código de integración, si tiene.

POST [Link]

Petición

La petición contiene parámetros de entrada:

Respuesta

Retorna un arreglo, de una sola dimensión. Por cada registro, se separan los niveles por dos
barras invertidas, “\\”. El primer grupo pertenece al grupo base de la empresa, los predecesores
a éste, son sus subgrupos. En caso que el/los grupos tengan un código de centro de
costos/integración asignado, éste, se mostrará al final encerrado entre paréntesis.

45
AssignGroupLeader OAut
h

Establece colaboradores como jefes de grupo, a un grupo en particular.

POST [Link]

Petición

La ruta del grupo, campo Path, se puede obtener desde el método Paths.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

PATH N/A string Requerido La separación entre grupos se realiza Ruta del grupo a asignar el
utilizando doble barra invertida. La supervisor. Revisar ejemplo
cadena de texto no debe terminar
con doble barra invertida. Se debe
indicar el código de centro de
costos/código de integración al final
del último grupo entre paréntesis.
USERSCSV N/A List<string> Requerido No debe contener ni puntos ni guion. Identificador(es) del
Para más de un valor separar por colaborador(es).
comas y sin espacios entre comas.

Ejemplo:
Grupo principal\\Subgrupo 1\\Subgrupo n(código de centro de costos/integración)

Respuesta

Si la inserción ha sido correcta la siguiente estructura:

Campo Largo Tipo Descripción

estadoRespuesta 1 string Para los casos en que la ejecución sea correcta se retorna un 0 en caso
contrario el valor -1.
mensajeRespuesta N/A string Para los casos en que la ejecución sea correcta se retorna null en caso
contrario se aprecia un mensaje con el error.

46
detalleRespuesta N/A string Para los casos en que la ejecución sea correcta se retorna null en caso
contrario se aprecia un detalle del error.

47
RemoveGroupLeaders OAut
h

Remueve el/los jefes de grupo, de un grupo en particular.

POST [Link]

Petición

La ruta del grupo, campo Path, se puede obtener desde el método Paths.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

PATH N/A string Requerido La separación entre grupos se realiza Ruta del grupo a remover el
utilizando doble barra invertida. La supervisor(es).
cadena de texto no debe terminar Revisar ejemplo.
con doble barra invertida. Se debe
indicar el código de centro de
costos/código de integración al final
del último grupo entre paréntesis.
USERSCSV N/A List<string> Requerido No debe contener ni puntos ni guion. Identificador(es) del
Para más de un valor separar por colaborador(es).
comas y sin espacios entre comas.

Ejemplo:
Grupo principal\\Subgrupo 1\\Subgrupo n(código de centro de costos/integración)

Respuesta

Si la inserción ha sido correcta la siguiente estructura:

Campo Largo Tipo Descripción

estadoRespuesta 1 string Para los casos en que la ejecución sea correcta se retorna un 0 en caso
contrario el valor -1.
mensajeRespuesta N/A string Para los casos en que la ejecución sea correcta se retorna null en caso

48
 contrario se aprecia un mensaje con el error.
detalleRespuesta N/A string Para los casos en que la ejecución sea correcta se retorna null en caso
contrario se aprecia un detalle del error.

49
RemoveAllGroupLeader OAut
h

Remueve todos los jefes de grupo, de un grupo en particular.

POST [Link]

Petición

La ruta del grupo, campo Path, se puede obtener desde el método Paths.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

PATH N/A string Requerido La separación entre grupos se Ruta del grupo a remover el
realiza utilizando doble barra supervisor(es).
invertida. La cadena de texto no Revisar ejemplo.
debe terminar con doble barra
invertida. Se debe indicar el código
de centro de costos/código de
integración al final del último grupo
entre paréntesis.

Ejemplo:
Grupo principal\\Subgrupo 1\\Subgrupo n(código de centro de costos/integración)

Respuesta

Si la inserción ha sido correcta la siguiente estructura:

Campo Largo Tipo Descripción

estadoRespuesta 1 string Para los casos en que la ejecución sea correcta se retorna un 0 en caso
contrario el valor -1.
mensajeRespuesta N/A string Para los casos en que la ejecución sea correcta se retorna null en caso
contrario se aprecia un mensaje con el error.
detalleRespuesta N/A string Para los casos en que la ejecución sea correcta se retorna null en caso
contrario se aprecia un detalle del error.

50
51
EditGroupDescription OAut
h

Modifica la descripción de un grupo dentro del árbol de grupos.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

CostCenter 200 string Requerido <= 200 caracteres Centro de costo asociado
Description 100 string Requerido <= 100 Nueva descripción del grupo

Ejemplo:
{
" CostCenter ": " V0001",
" Description ": "Ventas"
}

Respuesta

La respuesta tiene la siguiente estructura:

Campo Tipo Descripción

estadoRespuesta string Para los casos en que la ejecución sea correcta se retorna un 0
en caso contrario el valor 1 su hubo un warning o -1 si hubo un
error.
mensajeRespuesta string Para los casos en que la ejecución sea correcta se retorna null
en caso contrario se aprecia un mensaje con el warning o el
error.
detalleRespuesta string Para los casos en que la ejecución sea correcta se retorna null
en caso contrario se aprecia un detalle del error.

52
RenameFolder OAut
h

Modifica el nombre de una carpeta dentro del árbol de grupos.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Path N/A string Requerido La separación entre carpetas se realiza Ruta de la carpeta a
utilizando doble barra invertida. La renombrar.
cadena de texto no debe terminar con Revisar ejemplo.
doble barra invertida. El último elemento
de la ruta es la carpeta que se desea
renombrar.
Name 100 string Requerido <= 100 caracteres Nuevo nombre para la
carpeta

Ejemplo:
{
"Path": "Grupo ATCOM\\Zona Centro\\Santiago2",
"Name": "Santiago"
}

Respuesta

La respuesta tiene la siguiente estructura:

Campo Tipo Descripción

estadoRespuesta string Para los casos en que la ejecución sea correcta se retorna un 0
en caso contrario el valor 1 su hubo un warning o -1 si hubo un
error.
mensajeRespuesta string Para los casos en que la ejecución sea correcta se retorna null
en caso contrario se aprecia un mensaje con el warning o el
error.
detalleRespuesta string Para los casos en que la ejecución sea correcta se retorna null

53
 en caso contrario se aprecia un detalle del error.

User

Disable OAut
h

Desactiva a un usuario.

POST [Link]

Petición

Para este método se puede especificar ambos campos o uno de ellos. No son excluyentes.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni puntos ni guion. Identificador del colaborador.
Para más de un valor separar por comas.
Email 200 string Requerido Correo electrónico del colaborador.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna “WARNING:user

didn´t exist”

54
Enable OAut
h

Activa a un usuario.

POST [Link]

Petición

Para este método se puede especificar ambos campos o uno de ellos. No son excluyentes.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor separar
por comas.
Email 200 string Requerido Correo electrónico del colaborador.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna “ERROR:there is a

user active with the same identifiers”

55
Add OAut
h

Añade un nuevo usuario a la plataforma.

POST [Link]

Petición

No se pueden ingresar correos ya existentes en la plataforma.

El nombre de código de jornada sólo aplica para empresas con compensación semanal.
El identificador del cargo, campo positionIdentifier, se puede obtener desde el método List.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor
separar por comas.
Name 256 string Requerido Nombres del colaborador.
LastName 100 string Requerido Apellidos del colaborador.
Email 200 string Requerido Correo electrónico del colaborador.
Adress 100 string Opcional Dirección geográfica del colaborador.
Phone 15 string Opcional Número telefónico del colaborador.
Enabled 1 interger Opcional El valor 0 indica que el colaborador se
crea desactivado, el valor 1 indica que
el colaborador se crea activado. Si no
se indica un valor se asume 1.
Custom1 100 string Opcional Campo que permite agregar un valor
personalizado para el colaborador.
Custom2 100 string Opcional Campo que permite agregar un valor
personalizado para el colaborador.
Custom3 300 string Opcional Campo que permite agregar un valor
personalizado para el colaborador.
GroupIdentifier N/A string Opcional Código del centro de
costos/integración del grupo al que
pertenecerá el colaborador.

56
ContractDate 14 string Opcional yyyyMMddHHmmss Fecha de inicio de contrato.
userCompanyIdentifier 15 string Opcional Identificador de la razón social a la que
pertenecerá.
weeklyHoursCode 200 string Opcional Nombre del código de jornada.
endContractDate 14 string Opcional yyyyMMddHHmmss Fecha de término de contrato. Al
especificar una fecha de fin de
contrato, una vez llegada dicha fecha,
el colaborador será desactivado
automáticamente.
positionIdentifier N/A string Opcional Identificador del cargo a asignar.
integrationCode 100 string Opcional Identificador de la integración. Este
campo sólo puede ser utilizado en los
casos que se realice una integración.
userCard 30 string Opcional Tarjeta del usuario HID.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna “ERROR:there is a

user active with the same identifiers”

57
Edit OAut
h

Edita un usuario de acuerdo con los parámetros.

POST [Link]

Petición

No se pueden ingresar correos ya existentes en la plataforma.

El nombre de código de jornada sólo aplica para empresas con compensación semanal.
El identificador del cargo, campo positionIdentifier, se puede obtener desde el método List.
El campo, legalSundayIndicator, se puede utilizar sólo para empresas Retail.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor
separar por comas.
Name 256 string Requerido Nombres del colaborador.
LastName 100 string Requerido Apellidos del colaborador.
Email 200 string Requerido Correo electrónico del colaborador.
Adress 100 string Opcional Dirección geográfica del colaborador.
Phone 15 string Opcional Número telefónico del colaborador.
Enabled 1 interger Opcional El valor 0 indica que el colaborador se
crea desactivado, el valor 1 indica que
el colaborador se crea activado. Si no
se indica un valor se asume 1.
Custom1 100 string Opcional Campo que permite agregar un valor
personalizado para el colaborador.
Custom2 100 string Opcional Campo que permite agregar un valor
personalizado para el colaborador.
Custom3 300 string Opcional Campo que permite agregar un valor
personalizado para el colaborador.
ContractDate 14 string Opcional yyyy/MM/ddHHmmss Fecha de inicio de contrato.

58
userCompanyIdentifier 15 string Opcional Identificador de la razón social a la que
pertenecerá.
weeklyHoursCode 200 string Opcional Nombre del código de jornada.
endContractDate 14 string Opcional yyyy/MM/ddHHmmss Fecha de término de contrato. Al
especificar una fecha de fin de
contrato, una vez llegada dicha fecha,
el colaborador será desactivado
automáticamente.
positionIdentifier N/A string Opcional Identificador del cargo a asignar.
integrationCode 100 string Opcional Identificador de la integración. Este
campo sólo puede ser utilizado en los
casos que se realice una integración.
userCard 14 string Opcional Tarjeta del usuario HID.
legalSundayIndicator 1 interger Opcional Indica si se deben aplicar los domingos
como un día legal.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

59
moveGeneral OAut
h

Mueve a un usuario de un grupo a otro.

POST [Link]

Petición

Para este método se pueden especificar los campos Identifier y Email campos o uno de ellos. No
son excluyentes.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor separar
por comas.
Email 200 string Requerido Correo electrónico del colaborador.
GroupIdentifier N/A string Requerido Identificador del centro de costos del grupo.
Este código se puede obtener desde el
listado de grupos con código de centro de
costos o desde la plataforma de GeoVictoria,
en la sección Grupos.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

60
List OAut
h

Entrega una lista de todos los usuarios de la empresa.

POST [Link]

Petición

La petición no contiene parámetros de entrada:

Respuesta

El nombre de código de jornada sólo aplica para empresas con compensación semanal.
El campo, legalSundayIndicator, se puede utilizar sólo para empresas Retail.
El método retorna una lista con la información de todos los colaboradores de la empresa:

Campo Largo Tipo Descripción

Identifier 16 string Identificador del colaborador.
Name 256 string Nombres del colaborador.
LastName 100 string Apellidos del colaborador.
Email 200 string Correo electrónico del colaborador.
Adress 100 string Dirección geográfica del colaborador.
Phone 15 string Número telefónico del colaborador.
Enabled 1 interger El valor 0 indica que el colaborador se crea desactivado, el valor 1 indica que
el colaborador se crea activado. Si no se indica un valor se asume 1.

Custom1 100 string Campo que permite agregar un valor personalizado para el colaborador.
Custom2 100 string Campo que permite agregar un valor personalizado para el colaborador.
Custom3 300 string Campo que permite agregar un valor personalizado para el colaborador.
GroupIdentifier N/A string Código del centro de costos/integración del grupo al que pertenecerá el
colaborador.
GroupDescription 14 string Nombre/descripción del grupo al que pertenece el colaborador.
ContractDate 15 string Fecha de inicio de contrato.
UserProfile 30 string Nombre del perfil.

61
userCompanyIdentifier 15 string Identificador de la razón social a la que pertenecerá.
weeklyHoursCode 200 string Nombre del código de jornada.
endContractDate 14 string Fecha de término de contrato. Al especificar una fecha de fin de contrato, una
vez llegada dicha fecha, el colaborador será desactivado automáticamente.
positionIdentifier N/A string Identificador del cargo a asignar.
positionName 100 string Nombre del cargo.
integrationCode 100 string Identificador de la integración. Este campo sólo puede ser utilizado en los
casos que se realice una integración.
userCard 14 string Tarjeta del usuario HID.
legalSundayIndicator 1 interger Indica si se deben aplicar los domingos como un día legal.
legacyHash N/A string Identificador encriptado del colaborador.

62
ProfileList OAut
h

Entrega una lista de los perfiles de usuario.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

Retorna un listado de perfiles de usuarios con la siguiente estructura:

Campo Largo Tipo Descripción

NOMBRE_PERFIL 30 string Nombre del perfil.
Identifier N/A string Identificador del perfil encriptado.

63
editProfile OAut
h

Edita el perfil para el usuario especificado.

POST [Link]

Petición

El identificador del perfil se puede obtener del método ProfilesList.

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor separar
por comas.
UserProfile N/A string Requerido Identificador encriptado del perfil.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

64
Hide OAut
h

Oculta un colaborador. Esta acción no deshabilita al colaborador, sólo lo oculta de los reportes. Entiéndase como
reporte todos los que se ven en la plataforma Web y los descargables.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor separar
por comas.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

65
Show OAut
h

Muestra un colaborador. Esta acción no habilita al colaborador, sólo lo muestra en los reportes. Entiéndase como
reporte todos los que se ven en la plataforma Web y los descargables.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor separar
por comas.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

66
 Task

List OAut
h

Entrega la lista de tareas definidas para la empresa.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

El método retorna una lista de las tareas de la empresa:

Campo Largo Tipo Descripción

TaskHasheId N/A string Identificador de la tarea.
TaskDescription 512 string Descripción de la tarea.
TaskValid boolean Indica si la tarea está todavía vigente.
TaskEnabled boolean El valor “true” indica que la tarea está activa, en caso contrario lo indicará con un
“false”.

67
ListByUser OAut
h

Entrega las tareas declaradas para el colaborador recibido.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor separar
por comas.

Respuesta

El método retorna una lista de las tareas de la empresa por usuario:

Campo Largo Tipo Descripción

TaskHasheId N/A string Identificador de la tarea.
TaskDescription 512 string Descripción de la tarea.
TaskValid boolean Indica si la tarea está todavía vigente.
TaskEnabled boolean El valor “true” indica que la tarea está activa, en caso contrario lo indicará con un
“false”.

68
Add OAut
h

Crea una tarea nueva en la empresa. La tarea queda habilitada y vigente por defecto.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

TaskDescription 150 string Requerido <= 150 Descripción de la nueva tarea.

Respuesta

Retorna el código de la tarea encriptado.

69
Set OAut
h

Asigna una o varias tareas al colaborador especificado

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor
separar por comas.
TaskIdentifier N/A List<string> Requerido Código de la tarea encriptado.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

70
 Project

List OAut
h

Entrega la lista de proyectos definidos para la empresa.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

El método retorna una lista de los proyectos de la empresa:

Campo Largo Tipo Descripción

ProjectHashedId N/A string Identificador del proyecto encriptado.
ProjectDescripcion 512 string Descripción del proyecto.
ProjectAddress 1000 string Ubicación geográfica.
ProjectLatitude 14 string Latitud de la marca de inicio.
ProjectLongitude 14 string Longitud de la marca de inicio.
ProjectGpsAccuracy 2 interger Precisión del GPS.
ProjectStatus 1 interger El valor 0 indica que el proyecto se encuentra inactivo. El valor 1 indica que
el proyecto se encuentra activo.

71
ListByUser OAut
h

Entrega los proyectos en los que está asociado el colaborador recibido.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion. Para
más de un valor separar
por comas.

Respuesta

El método retorna una lista de las tareas de la empresa por usuario:

Campo Largo Tipo Descripción

ProjectHashedId N/A string Identificador del proyecto encriptado.
ProjectDescripcion 512 string Descripción del proyecto.
ProjectAddress 1000 string Ubicación geográfica.
ProjectLatitude 14 string Latitud de la marca de inicio.
ProjectLongitude 14 string Longitud de la marca de inicio.
ProjectGpsAccuracy 2 interger Precisión del GPS.
ProjectStatus 1 interger El valor 0 indica que el proyecto se encuentra inactivo. El valor 1 indica que el
proyecto se encuentra activo.

72
Add OAut
h

Crea un nuevo proyecto en la empresa.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

ProjectHashedId N/A string Requerid Identificador del proyecto encriptado.
o
ProjectDescription 512 string Requerid <= 100 Descripción del proyecto.
o
ProjectAddress 1000 string Requerid <= 1000 Ubicación geográfica.
o
ProjectLatitude 14 string Requerid <= 14 Latitud de la marca de inicio.
o
ProjectLongitude 14 string Requerid <= 14 Longitud de la marca de inicio.
o
ProjectGpsAccuracy 2 interge Opcional Precisión del GPS.
r
ProjectStatus 1 interge Opcional El valor 0 indica que el proyecto se
r encuentra inactivo. El valor 1 indica que
el proyecto se encuentra activo.

Respuesta

Retorna el código del proyecto encriptado.

73
AddProjects OAut
h

Recibe una lista de proyectos a crear en la empresa.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Descripción

ProjectHashedId N/A string Requerido Identificador del proyecto encriptado.
ProjectDescripcion 512 string Requerido Descripción del proyecto.
ProjectAddress 1000 string Requerido Ubicación geográfica.
ProjectLatitude 14 string Requerido Latitud de la marca de inicio.
ProjectLongitude 14 string Requerido Longitud de la marca de inicio.
ProjectGpsAccuracy 2 interger Opcional Precisión del GPS.
ProjectStatus 1 interger Opcional El valor 0 indica que el proyecto se encuentra inactivo. El valor 1
indica que el proyecto se encuentra activo.

Respuesta

Si la creación de los proyectos ha sido exitosa retorna “true”, en caso contrario retorna “false”.

74
Set OAut
h

Asigna al colaborador a un proyecto específico.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

Identifier 16 string Requerido No debe contener ni Identificador del colaborador.
puntos ni guion.
Para más de un
valor separar por
comas.
ProjectIdentifier N/A Array<string> Requerido Arreglo con el/los identificadores de los
proyectos, encriptados.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

75
 Position

List OAut
h

Lista todos los cargos de la empresa.

POST [Link]

Petición

La petición no contiene parámetros de entrada.

Respuesta

El método retorna una lista con los cargos de la empresa:

Campo Largo Tipo Descripción

CARGO_PRIORITARIO boolean Con el valor "true" indica si el cargo es prioritario, en caso contrario se
recibe el valor "false".
CRITICO boolean Con el valor "true" indica si es un cargo crítico, en caso contrario se recibe
el valor "false".
DESCRIPCION_CARGO 100 string Nombre/descripción para diferenciar de los demás cargos de la empresa.
ESTADO_CARGO 9 string El texto “enabled” indica que el cargo se encuentra activo. Por el contrario,
si se encuentra desactivado se retorna “disabled”.
IDENTIFICADOR N/A string Identificador del cargo encriptado.

76
Add OAut
h

Crea un nuevo cargo en la empresa.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Descripción

DESCRIPCION_CARGO 100 string Requerido Nombre/descripción para diferenciar de los demás cargos de la
empresa.
CARGO_PRIORITARIO boolean Opcional Con el valor "true" indica si el cargo es prioritario, en caso
contrario se recibe el valor "false".
CRITICO boolean Opcional Con el valor "true" indica si es un cargo crítico, en caso contrario
se recibe el valor "false".
ESTADO_CARGO 9 string Opcional El texto “enabled” indica que el cargo se encuentra activo. Por el
contrario, si se encuentra desactivado se retorna “disabled”.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

77
Disable OAut
h

Deshabilita un cargo.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Descripción

IDENTIFICADOR N/A string Requerido Identificador del cargo encriptado.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

78
Enable OAut
h

Habilita un cargo.

POST [Link]

Petición

La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Descripción

IDENTIFICADOR N/A string Requerido Identificador del cargo encriptado.

Respuesta

Si la ejecución es correcta retorna el mensaje “OK”. En caso contrario retorna un mensaje de

error.

79
 Planificador

Planner Token

Obtiene los planificadores y sus detalles, únicamente activos. Los planificadores devueltos no tienen detalles “sin
asignar”.

POST [Link]

Petición

El identificador del turno se puede obtener del método List.

El cuerpo corresponde a un arreglo con el listado de planificaciones, por colaborador y fecha.
La petición recibe una lista con la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

User 16 string Requerido No debe contener Identificador del colaborador.
ni puntos ni guion.
Para más de un
valor separar por
comas.
Shift N/A List<ShiftContract> Requerido Listado del tipo ShiftContract.

ShiftContract

Campo Largo Tipo Estado Formato Descripción

ShiftId N/A string Requerido Identificador encriptado del turno.
Date 14 string Requerido yyyyMMddHHmmss Hora y día para la planificación.

Respuesta

Si la ejecución se ha realizado con éxito se retorna verdadero. En caso contrario se retorna el

mensaje con información del error.

80
 Planificación

Planning Token

Establece una planificación, diaria, a un colaborador. La planificación no se repite en el tiempo.

POST [Link]

Petición

El identificador del turno se puede obtener del método List.

El cuerpo corresponde a un arreglo con el listado de planificaciones, por colaborador y fecha.
La petición recibe una lista con la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

User 16 string Requerido No debe contener Identificador del colaborador.
ni puntos ni guion.
Para más de un
valor separar por
comas.
Shift N/A List<ShiftContract> Requerido Listado del tipo ShiftContract.

ShiftContract

Campo Largo Tipo Estado Formato Descripción

ShiftId N/A string Requerido Identificador encriptado del turno.
Date 14 string Requerido yyyyMMddHHmmss Hora y día para la planificación.

Respuesta

81
Si la ejecución se ha realizado con éxito se retorna verdadero. En caso contrario se retorna el
mensaje con información del error.

82
SetSchedule OAut Obsolet
h o

Este método se encuentra en proceso de quedar obsoleto. Por favor utilizar el método Planning.
Establece una planificación, diaria, a un colaborador. La planificación no se repite en el tiempo.

POST [Link]

Petición

El identificador del turno se puede obtener del método List.

El cuerpo corresponde a un arreglo con el listado de planificaciones, por colaborador y fecha.
La petición contiene la siguiente estructura:

Campo Largo Tipo Estado Formato Descripción

user 16 string Requerido No debe contener Identificador del colaborador.
puntos ni guion.
Para más de un
valor separar por
comas.
shift N/A List<ShiftContract> Requerido Listado del tipo ShiftContract.

ShiftContract

Campo Largo Tipo Estado Formato Descripción

SHIFT_ID N/A string Requerido Identificador encriptado del turno.
DATE 14 string Requerido yyyyMMddHHmmss Hora y día para la planificación.

Respuesta

El método retorna una lista con los cargos de la empresa:

Campo Largo Tipo Descripción

83
estadoRespuesta 1 string Si la ejecución sea correcta se retorna un 0 en caso contrario el valor -1.
mensajeRespuesta N/A string Para los casos en que la ejecución sea correcta se retorna null en caso
contrario se aprecia un mensaje con el error.
detalleRespuesta N/A string Para los casos en que la ejecución sea correcta se retorna null en caso
contrario se aprecia un detalle del error.

84