...
- Endpoint:
/colaboradores/alta - Method:
POST - Description: Creates a new collaborator.
- Headers:
API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
Request Body:
Code Block language py title json linenumbers true { "colaborador": { "nroDocumento": 4040440, "nombres": "Arturo", "apellidos": "Sosa Bagnoli", "nroTelefono": "0971159618", "correo": "asosa@cabal.com.py" } }Expand title Consideraciones del Request "nroDocumento" => 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
Response:
Code Block language py title json linenumbers true { "header": { "codReturn": 3, "txtReturn": "WARNING" }, "data": { "info": "El colaborador ya existe", "nroTarjeta": "", "tarjetaMask": "" } }Expand title Respuestas posibles asdasdasd"codReturn": 0, "txtReturn": "SUCCESS", "info": "Registrado como colaborador, ya tiene cuenta Dimo" => Se agregó correctamente al colaborador y ese colaborador ya tiene una cuenta Dimo, por lo que se le creo la tarjeta prepaga asociada a la empresa.
"codReturn": 0, "txtReturn": "SUCCESS", "info": "Registrado como colaborador, aun no tiene cuenta DIMO" => Se agregó correctamente al colaborador y ese colaborador aún no tiene una cuenta dimo. Por lo tanto no se le creó la tarjeta prepaga de la empresa.
"codReturn": 1, "txtReturn": "ERROR", "info": "Hubo un problema al procesar la solicitud" => Hubo un problema interno por el cual no se pudo procesar la solicitud. Se notifico al equipo de Sistemas para su revisión.
"codReturn": 2, "txtReturn": "WARNING", "info": "Valores del request no validos" => No corresponde los valores del request. (telefono o correo)
"codReturn": 3, "txtReturn": "WARNING", "info": "El colaborador ya existe" => El colaborador ya se encuentra vinculado a la empresa y ya tiene su tarjeta prepaga creada.
"codReturn": 4, "txtReturn": "ERROR", "info": "Hubo un problema en el registro del colaborador" => Hubo un problema al crear al usuario, sistemas ya fue notificado.
ListarColaborador
- Endpoint:
/colaboradores/listar - Method:
POST - Description: Lists a collaborator by document number.
- Headers:
API-KEY: BMMyeLpIomvnnGwmN8IOydFCON4AQelKTIY4C44Fljg8AjFled
Request Body:
Code Block language py title json linenumbers true { "nroDocumento": 4040440 }Expand title Consideraciones del Request "nroDocumento" => 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
Response Body:
Code Block language py title json linenumbers true { "header": { "codReturn": 0, "txtReturn": "SUCCESS" }, "data": [ { "apellidos": "Sosa", "correo": "asosa@cabal.com.py", "documento": "4040440", "estado": "Usuario registrado", "nombres": "Arturo", "nroTarjeta": "6043512000595678", "nroTelefono": "0986215487", "tarjetaMask": "6043-XXXX-XXXX-5678" } ] }Expand title Respuestas posibles asdasdasd
...