OverTime/GetReasons

 


POST https://customerapi.geovictoria.com/api/v1/OverTime/GetReasons

 

Descripción

Obtener el listado de motivos de hora extra habilitados en la empresa asociada al token de autenticación.
Devuelve un array de motivos, cada uno con su identificador y su nombre. El identificador obtenido en
este endpoint es el que debe enviarse en el campo OvertimeReason del endpoint OverTime/Add.

Request

Request Body

Este endpoint no recibe parámetros. El request se envía sin body.

Importante

  • Solo se devuelven los motivos habilitados de la empresa. Los motivos deshabilitados no
    aparecen en la respuesta.
  • Si la empresa no tiene motivos habilitados, la respuesta es exitosa y el campo Response
    viene como un array vacío.
  • El campo Id debe utilizarse tal cual se recibe, sin modificaciones, al enviarlo en el campo OvertimeReason de OverTime/Add.
  • La empresa no se envía en el request: se determina a partir del token de autenticación.

Response

Response Body

La respuesta es un objeto con el resultado de la operación:

Campos Tipo de dato Descripción
Success Boolean Indica si la operación fue exitosa.
Message String Mensaje descriptivo del resultado (vacío o informativo en caso de éxito, detalle del error en caso de fallo).
Response Array Array con los motivos de hora extra habilitados de la empresa.

 

Cada objeto del array Response contiene:

Campos Tipo de dato Descripción
Id String Identificador del motivo de hora extra. Es el valor que debe enviarse en el campo
OvertimeReason del endpoint OverTime/Add.
Name String Nombre o descripción del motivo de hora extra.

 

Códigos

 

Código Descripción
200 Éxito
400 Error en el request

Ejemplo response

{
              "Success": true,
              "Message": "",
              "Response": [
                  {
                      "Id": "kK9xQ2vHtA==",
                      "Name": "Cierre de mes"
                  },
                  {
                      "Id": "pL3mR7bXyC==",
                      "Name": "Turno extraordinario"
                  }
              ]
          }
Tabla de contenidos