IMPLEMENTACIONES
Page tree

Versions Compared

Old Version 37

changes.mady.by.user Sistemas

Saved on

compared with

New Version 38

changes.mady.by.user Sistemas

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Endpoint: /acreditaciones/ejecutar
  • Método: POST
  • Descripción: Ejecutar una acreditación.
  • Headers:
    • API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled

  • Request Body:

    Code Block
    languagepy
    titlejson
    linenumberstrue
    {
    "acreditacion": {
        "usuario": "test1",
        "idAcreditacion":274
    }
}
    Expand
    titleConsideraciones del Request

    "nroDocumentousuario" => Debe ser numérico, contener el número de documento de la persona a quien se le va a asociar como colaborador de la empresa

    "nroTelefono" => Debe tener ese formato, no debe contener caracteres especiales ni espacios

    "correo" => Debe ser un correo valido> Puede enviar el nombre del usuario que creo la acreditación para asociar esa información a la petición.
    "idAcreditacion" => Debe enviar el ID de la orden de acreditación devuelta por el endpoint anterior.

  • Response Body:

    Code Block
    languagepy
    titlejson
    linenumberstrue
    {
    "header": {
        "codReturn": 0,
        "txtReturn": "SUCCESS"
    },
    "data": {
        "descripcion": "Se proceso correctamente"
    }
}
    asdasdasd
    Expand
    titleRespuestas posibles

    "codReturn": 0, "txtReturn": "SUCCESS", "descripcion": "Se proceso correctamente" => Todos los colaboradores del Request pueden recibir su acreditación sin problemas.
    "codReturn": 1, "txtReturn": "ERROR", "descripcion": "Hubo un problema al ejecutar la acreditacion" => El endpoint tuvo un problema procesando la petición. Sistemas ya fue notificado.
    "codReturn": 2, "txtReturn": "ERROR", "descripcion": "No existe la orden de acreditacio" => Hay usuarios que no pertenecen a la lista de colabores de la empresa, pero si se procesa la orden para el resto.
    "codReturn": 3, "txtReturn": "WARNING", "descripcion": "Esta orden de acreditacion ya fue ejecutada" => Todos los colabores del request, no pertenecen a la empresa.
    "codReturn": 4, "txtReturn": "ERROR", "descripcion": "DINAMICO" => Se devuelve una descripción distinta dependiendo de la validación que rechazo la petición.

Manejo de errores

  • Common HTTP Status Codes:
    • 200 OK: The request was successful.
    • 400 Bad Request: The request could not be understood or was missing required parameters.
    • 401 Unauthorized: Authentication failed or user does not have permissions for the desired action.
    • 404 Not Found: The requested resource could not be found.
    • 500 Internal Server Error: An error occurred on the server.

...