Objeto Usuario
Puedes hacer uso de la API para solicitar la información de uno o más usuarios de tu empresa. Por ahora sólo se permite leer información, no crear usuarios o actualizar la información de los usuarios existentes.
Método: getUsers
Método para obtener una lista de usuarios de la empresa según parámetros definidos.
Parámetro | Descripción | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Método | GET | ||||||||||||
URL | https://api.rindegastos.com/v1/getUsers<params> | ||||||||||||
Params |
Parámetros que pueden ser agregados a la solicitud para discriminar qué informes se desea obtener. Los parametros posibles son:
|
A continuación se muestra un ejemplo usando el método getUsers de la API de Rindegastos. Este método permite consultar los usuarios de la empresa.
{ "Records": { "TotalRecords": 4, "Users": 4, "Page": 1, "Pages": 1 }, "Users": [ { "Id": 3, "FirstName": "Mango", "LastName": "Starr", "Identification": "", "CostingCode": "", "EmployeeNumber": "", "Department": "", "Position": "", "CreatedAt": "2017-06-28 00:16:03", "LastLogin": "", "Role": [ { "Admin": false, "Management": false } ] }, { "Id": 5, "FirstName": "George", "LastName": "Pearrison", "Identification": "", "CostingCode": "", "EmployeeNumber": "", "Department": "", "Position": "", "CreatedAt": "2017-06-28 00:16:03", "LastLogin": "", "Role": [ { "Admin": false, "Management": false } ] }, { "Id": 4, "FirstName": "Apple", "LastName": "MacCartney", "Identification": "", "CostingCode": "", "EmployeeNumber": "", "Department": "", "Position": "", "CreatedAt": "2017-06-28 00:16:03", "LastLogin": "2017-06-29 20:32:31", "Role": [ { "Admin": true, "Management": true } ] }, { "Id": 2, "FirstName": "John", "LastName": "Lemon", "Identification": "", "CostingCode": "", "EmployeeNumber": "", "Department": "Gerencia General", "Position": "Presidente", "CreatedAt": "2017-06-28 00:16:03", "LastLogin": "2017-06-29 20:30:21", "Role": [ { "Admin": true, "Management": true } ] } ] }
Método: getUser
Método para obtener un usuario con toda su información.
Parámetro | Descripción | ||||||
---|---|---|---|---|---|---|---|
Método | GET | ||||||
URL | https://api.rindegastos.com/v1/getUser | ||||||
Params |
Para usar este servicio solo podemos comunicar un parámetro el cual corresponde al Id del usuario o en su defecto si no conocemos el Id podemos pasar la dirección de correo electrónico del usuario que queremos recuperar.
|
A continuación se muestra un ejemplo usando el método getUser de la API de Rindegastos. Este método permite consultar un usuario específico de la empresa.
https://api.rindegastos.com/v1/getUser?Id=2 METHOD GET Authorization: Bearer <token>
El resultado ejemplo para esta llamada se muestra a continuación:
{ "Id": 2, "FirstName": "John", "LastName": "Lemon", "Identification": "", "CostingCode": "", "EmployeeNumber": "", "Department": "Gerencia General", "Position": "Presidente", "CreatedAt": "2017-06-28 00:16:03", "LastLogin": "2017-06-29 20:30:21", "Role": [ { "Admin": true, "Management": true } ] }