Shift/ListByState
Descripción
Obtiene una lista de los turnos según el estado indicado
Request
Request Body
| Campos | Largo | Requerido | Tipo de dato | Descripción |
|---|---|---|---|---|
| State | 1 | Sí | Number | Si es 0 se retornan turnos inactivos, si es 1 se retornan los turnos activados. |
Importante
- El estado activado se retorna como «Status»: «enabled»
- El estado inactivo se retorna como «Status»: «disabled»
{
"State": 0
}
{
"State": 1
}
Response
Response Body
| Campos | Tipo de dato | Descripción |
|---|---|---|
| Id | String | Identificador encriptado y único del turno |
| StartTime | String | Hora de inicio del turno en formato hh:mm.
Se utiliza en Turno Fijo y Banda Horaria. |
| MaxStartTime | String | Hora máxima de inicio del turno en formato hh:mm.
Se utiliza solo para Banda Horaria. |
| ExitTime | String | Hora de fin del turno en formato hh:mm.
Se utiliza solo para Turno Fijo. |
| Type | String | Tipo de turno.
Existen seis tipos: FixedShift, FixedHours, NotWorking, FreeShift, NoShift y InPerson. |
| FixedShiftHours | String | Horas de trabajo del turno.
Se utiliza para Fijo por Horas y Banda Horaria. |
| ShiftDisplay | String | Nombre del turno que se muestra en la plataforma. |
| BreakType | String | Tipo de colación.
Existe tres tipos: NoLunch, FreeLunch y FixedLunch |
| BreakMinutes | String | Minutos de colación. Se utiliza solo para Colación Libre. |
| BreakStart | String | Hora de inicio de colación en formato hh:mm.
Se utiliza solo para Colación Fija. |
| BreakEnd | String | Hora de fin de colación en formato hh:mm.
Se utiliza solo para Colación Fija. |
| Status | String | Status del turno, si está activo (enabled) o inactivo (disabled). |
| Custom | String | Campo personalizado del turno. |
Importante
Existe dos tipos de turnos según cómo se crean:
a. Se crean por plataforma:
- «FixedShift»:
Turno Fijo - «FixedHours»:
Fijo por Horas y Banda Horaria
b. Turnos por defecto de la plataforma, tienen IDs negativos
- «NotWorking»: Descanso
ID: -1
Días en que un empleado no tiene que trabajar.
GV2: «No trabaja»
GV3: «Descanso” - «FreeShift»: Horario libre
ID: -2
Turno en el que no se define la hora de marcaje, por lo que se asigna para todo el día. Se utiliza para situaciones en las que el empleado no tiene un horario fijo de marcaje, por ejemplo, en el caso de marcajes de casino.
GV2 y GV3: “Horario libre” - «NoShift»: Sin Turno
ID: -3
Turno que indica que el empleado no tiene un turno asignado.
GV2: “Sin Turno”, se asigna por defecto al libro de asistencia.
GV3: “Presencial” - «InPerson»: Presencial
ID: -4
Equivalente a “FreeShift: Horario Libre”.
Término creado por solicitud de cambio de nombre del turno realizado por una empresa en particular.
GV2: No existe
GV3: “Presencial»
- «FixedShift»:
Existen tres tipos de colaciones/almuerzo:
“NoLunch”: Sin Colación
Sin Colación“FreeLunch”: Colación Libre
Colación Libre“FixedLunch”: Colación Fija
Colación Fija
Códigos
| Código | Descripción |
|---|---|
| 200 | Éxito |
| 400 | Error en el request |
| 500 | Error no controlado, contactar a GV |
[
{
"Id": "jtZn9MPNMgEe6A0VgMzyfQ",
"StartTime": "09:30",
"MaxStartTime": "",
"ExitTime": "19:00",
"Type": "FixedShift",
"FixedShiftHours": "00:00",
"ShiftDisplay": "09:30 - 19:00 ( No Lunch )",
"BreakType": "NoLunch",
"BreakMinutes": "",
"BreakStart": "00:00",
"BreakEnd": "00:00",
"Status": "disabled",
"Custom": "TFijoSinColacDesa"
},
{
"Id": "JkzKc_Nm2-4eKZUurL9cfg",
"StartTime": "09:30",
"MaxStartTime": "",
"ExitTime": "19:00",
"Type": "FixedShift",
"FixedShiftHours": "00:00",
"ShiftDisplay": "09:30 - 19:00 (60 mins)",
"BreakType": "FreeLunch",
"BreakMinutes": "60",
"BreakStart": "00:00",
"BreakEnd": "00:00",
"Status": "disabled",
"Custom": "TFijoColaciLibrDesac"
}
]
[
{
"Id": "KT0rO5j3XqnluiKuZTQFsA",
"StartTime": "09:30",
"MaxStartTime": "",
"ExitTime": "19:00",
"Type": "FixedShift",
"FixedShiftHours": "00:00",
"ShiftDisplay": "09:30 - 19:00 (60 mins)",
"BreakType": "FreeLunch",
"BreakMinutes": "60",
"BreakStart": "00:00",
"BreakEnd": "00:00",
"Status": "enabled",
"Custom": "TurnoFijoColaciLibre"
},
{
"Id": "t7N0zTJqUltcLT6nLMz1eA",
"StartTime": "08:30",
"MaxStartTime": "09:00",
"ExitTime": "00:00",
"Type": "FixedHours",
"FixedShiftHours": "08:00",
"ShiftDisplay": "08:00:00 hrs. ( No Lunch )",
"BreakType": "NoLunch",
"BreakMinutes": "",
"BreakStart": "00:00",
"BreakEnd": "00:00",
"Status": "enabled",
"Custom": "BandaHorarSinColaci"
}
]
Postman
Ejemplo 1
Ejemplo 2
Ejemplo 1
Turnos Inactivos
Ejemplo 2
Turnos Activos
