Como podemos ayudarte?

Group/Add

Publicadooctubre 22, 2024
Updatednoviembre 15, 2024
ByRudolph
POST https://customerapi.geovictoria.com/api/v1/Group/Add

Descripción

Permite crear un grupo en la plataforma.

Request

Request Body

.table-container { width: 100%; max-width: 1000px; overflow-x: auto; border-radius: 5px; } table.request { width: 100%; border-collapse: collapse; border-radius: 5px; overflow: hidden; } table.request th, table.request td { border: 1px; padding: 8px; text-align: left; white-space: nowrap; font-size: 16px; } table.request thead tr th { background-color: #ffbd00; color: white; } table.request tbody tr:nth-child(even) { background-color: #e1e1e1; } table.request tbody tr:nth-child(odd) { background-color: #fafafa; } table.request tbody tr:last-child td:first-child { border-bottom-left-radius: 5px; } table.request tbody tr:last-child td:last-child { border-bottom-right-radius: 5px; } table.request thead tr th:first-child { border-top-left-radius: 5px; } table.request thead tr th:last-child { border-top-right-radius: 5px; } table.request td:nth-child(5) { white-space: normal; word-break: normal; }
Campos Largo Requerido Tipo de dato Descripción
Path 200 Sí String Indica la ruta de la carpeta donde se quiere crear el grupo
ContainerId 30 Sí String Identificador cifrado de la carpeta donde se quiere crear el grupo
Description 100 Sí String Indica el nombre del grupo
GpsLongitude 14 No String Indica la coordenada de longitud del grupo
GpsLatitude 14 No String Indica la coordenada de latitud del grupo
CallSource 1 No String Indica la configuración "Origen llamado" del grupo y puede tomar como valor "0" para indicar "Sin restricción", "1" para indicar "Solo teléfonos de grupo" y "2" para indicar "Teléfonos de la empresa"
AllowPunchOutsideShift 1 No String Indica la configuración "Permite marcar fuera de turno" del grupo, puede tomar como valor "0" para "No permitir" o "1" para "Permitir"
Address 300 No String Indica la dirección asociada al grupo
CostCenter 200 No String Indica el código de centro de costos del grupo
TimeZoneId 30 No String Identificador cifrado de la zona horaria asociada al grupo
UseCasino 1 No Boolean Indica la configuración "Usa casino" del grupo, puede tomar como valor "false" para para indicar que no lo utiliza y "true" para indicar que si lo utiliza
AllowPunchInOtherGroup 1 No String Indica la configuración "Permite marcar en otro grupo" del grupo, puede tomar como valor "0" para "No permitir" o "1" para "Permitir"
UseSlack 5 No String Indica la configuración "Holgura atrasos" del grupo y puede tomar como valor "emp" para indicar empresa o el valor grupo
GroupSlack 5 No String Indica la cantidad de minutos de la holgura de atrasos del grupo
Custom1 300 No String Indica el campo personalizado 1.
ConsiderHolidayHours 1 No String Indica la configuración "Trabaja en feriados" del grupo que solo aparece en empresas de retail, y puede tomar como valor "2" si "Sigue las reglas de la empresa", "1" si el valor es "Si" y "2" si el valor es "No"
StrainActivityInWorkingDay 1 No String Indica la configuración "Marcar actividad solo dentro de la jornada" del grupo, puede tomar como valor "0" si se quiere indicar "No", "1" si el valor es "Si" y "2" si el valor es "Sigue las reglas de la empresa"
SubtractLunch 1 No String Indica la configuración "Descuento de la colación de las horas trabajadas" del grupo, puede tomar como valor "0" si se quiere indicar "No descontar el tiempo de colación", "1" si el valor es "Descontar el tiempo de la colación planificada en el turno" y "2" si el valor es "Sigue las reglas de la empresa".
UseEarlyLeaveSlack 5 No String Indica los valores "grupo" en caso de que el grupo utiliza holgura en casos de adelanto en la salida y "emp" si sigue lo indicado en la empresa
EarlyLeaveSlack 5 No String Indica la cantidad de minutos que se considera la holugra en casos de adelanto en la salida
NightlyAdditional 1 No Boolean Indica la configuración "Contabilizar nocturno adicional " del grupo, puede tomar como valor "false" si se quiere indicar "No contabilizar adicional nocturno", "true" si el valor es "Si contabilizar adicional nocturno"
NightlyAditionalPeriod 1 No String Indica la configuración "Periodo nocturno adicional" del grupo, puede tomar como valor "Área urbana", "Área rural" o "Ganadería"
WorkdayEndNotification 1 No String Indica la configuración "Notificar fin de jornada" del grupo, puede tomar como valor "1" en caso de que esté activado, "0" si está desactivado y "2" si sigue las reglas de la empresa"
AutomaticLeavePunch 1 No String Indica la configuración "Marca salida automática" del grupo, puede tomar como valor "1" en caso de que esté activado, "0" si está desactivado y "2" si sigue las reglas de la empresa"
ConsidersHrt 1 No String Indica la configuración "Considera horas realmente trabajadas" del grupo, puede tomar como valor "1" en caso de que esté activado, "0" si está desactivado y "2" si sigue las reglas de la empresa"
BlockProyectLocation 1 No String Indica la configuración "Bloqueo de actividad por ubicación de proyecto" del grupo, puede tomar como valor "1" en caso de que esté activado, "0" si está desactivado y "2" si sigue las reglas de la empresa"
NoAsociationsAllowed 1 No String Indica la configuración "Permite no asociar grupo" del grupo, puede tomar como valor "1" en caso de que esté activado, "0" si está desactivado y "2" si sigue las reglas de la empresa"
UseWebPunch 1 No String Indica la configuración "Permite marcaje web" del grupo, puede tomar como valor "1" en caso de que esté activado, "0" si está desactivado
ValidationType 1 No String Indica la configuración "Tipo de validación" del grupo, puede tomar como valor "0" si se indica "Sin validación", "1" si se indica "Selfie", "2" si se indica "Firma","3" si se indica "SelfieFirma", "5" si se indica "Patron","6" si se indica "SelfiePatron", "7" si se indica "QrCode", "8" si se indica "QrCodeSelfie", "9" si se indica "QrCodePattern", "10" si se indica "QrCodeSignature"
BlockByLocation 1 No String Indica la configuración "Bloqueo por ubicación" del grupo, puede tomar como valor "1" en caso de que esté activado, "0" si está desactivado y "2" si sigue las reglas de la empresa
GpsAccuracy 5 No String Indica la configuración "Tolerancia Ubicación Grupo (metros)" que permite indicar la distancia máxima entre el usuario y la dirección asociada al grupo al momento de marcar
AppEnabled 5 No String Indica la configuración "Permite uso app" de grupos que permite habilitar las configuraciones de la app. Si es "true" se utiliza la app y si es "false" no se utiliza
UseTracking 1 No String Indica la configuración "Permite tracking gps" de grupos que permite el seguimiento gps del usuario. Si es "true" lo permite y si es "false" no lo permite
BlockUnwantedApps 1 No Boolean Indica la configuración "Bloquear apps no deseadas" de grupos. Si es "true" lo permite y si es "false" no lo permite
UseFaceServices 1 No String Indica la configuración "Reconocimiento facial" de grupos. Si se indica "0" no lo ocupa, si es un "1" si lo ocupa y si es un "2" sigue las reglas de la empresa
UseProyectsAndTasks 1 No String Indica la configuración "Usa proyectos y tareas" de grupos. Si se indica "0" no lo ocupa, si es un "1" si lo ocupa y si es un "2" sigue las reglas de la empresa
ContraintWorkingDay 1 No String Indica la configuración "Usa marcación conjunta de asistencia y actividad" de grupos. Si se indica "0" no lo ocupa, si es un "1" si lo ocupa y si es un "2" sigue las reglas de la empresa.
PunchFromCrewOnly 1 No String Indica la configuración "Marca solo desde cuadrillas" de grupos. Si se indica "0" no lo ocupa, si es un "1" si lo ocupa
CrewEnabled 1 No Boolean Indica la configuración "Marcación en cuadrillas" de grupos. Si se indica "false" no lo ocupa, si es un "true" si lo ocupa
UseAsActivityCrew 1 No String Indica la configuración "Marcar actividad solo dentro de jornada" de grupos. Si se indica "0" no lo ocupa, si es un "1" si lo ocupa

Importante

  • Se puede ver la información en la sección grupos al momento de seleccionar un grupo.
  • Al menos uno de los campos Path o ContainerId se deben incluir en la consulta.
  • Para buscar la carpeta donde se va a crear el grupo primero busca por el campo ContainerId y luego por el campo Path.
  • Algunos campos requieren tener privilegios adicionales para poder utilizarlos.
  • El campo «CostCenter» debe ser único entre los grupos.
{
    "Path": "Test Prueba\\", 
    "ContainerId": "WBlTS2dvAOwN4Kk7XZliiA",          
    "Description": "grupoEjemplo", 
    "GpsLongitude": "72.5671",        
    "GpsLatitude": "-50.0932",         
    "CallSource": "1",    
    "AllowPunchOutsideShift": "1",    
    "Address": "CalleEjemplo", 
    "CostCenter": "codigoEjemplo",
    "TimeZoneId": "A4lTSTdv5OSN3Kk7XZZii4",    
    "UseCasino": true,  
    "AllowPunchInOtherGroup": "1",    
    "UseSlack": "1", 
    "GroupSlack": "5",           
    "Custom1": "Personalizado",  
    "ConsidersHolidayHours": "1", 
    "StrainActivityInWorkingDay": "1",    
    "SubtractLunch": "1", 
    "UseEarlyLeaveSlack": "1", 
    "EarlyLeaveSlack": "0",   
    "NightlyAdditional": true, 
    "NightlyAdditionalPeriod": "1",   
    "WorkdayEndNotification": "1",    
    "AutomaticLeavePunch": "1",  
    "ConsidersHrt":"1",
    "BlockProyectLocation":"1",
    "NoAsociationsAllowed":"1",
    "UseWebPunch":"1",
    "ValidationType":"1",
    "BlockByLocation":"1",
    "GpsAccuracy":"1",
    "AppsEnabled":"1",
    "UseTracking": "1",   
    "BlockUnwantedApps": true,  
    "UseFaceServices": "1",  
    "UseProyectsAndTasks": "1",   
    "ContraintWorkingDay": "1",   
    "PunchFromCrewOnly": "1", 
    "CrewEnabled": true,    
    "UseAsActivityCrew": "1" 
}

Response

Response Body

Campos Tipo de dato Descripción
GroupId String Identificador cifrado del grupo creado

Importante

  • Devuelve directamente el id cifrado del grupo como string.

Códigos

Código Descripción
200 Éxito
400 Error en el request
500 Error no controlado, contactar a GV 
"Na5v5Mwg-5omw0vtfPBa-w"

Postman

Tabla de contenidos
Descripción de la imagen

Av. Los Leones 2061, Providencia.
+56 228976514
ventas@geovictoria.com Education Zone | Desarrollado por Rara Themes. Funciona con WordPress.