get https://example.com/users/
Descrição: Este endpoint verifica a existência de um usuário no sistema a partir de seu ID, retornando informações essenciais de identificação e status de serviço caso o usuário seja encontrado.
Descrição dos Campos de Resposta
Campo | Descrição | Tipo | Exemplo |
---|---|---|---|
_id | Identificador único do usuário. | String | "user123abc456def789ghi000000" |
username | Nome de usuário. | String | "usuario.exemplo" |
documents | Lista de documentos associados ao usuário. | Array | [ {...} ] |
documents[]._id | Identificador único do documento. | String | "doc123abc456def789ghi000000" |
documents[].type | Tipo do documento (e.g., CPF, RG). | String | "CPF" |
documents[].number | Número do documento. | String | "12345678900" |
E-mail do usuário. | String | "[email protected]" | |
status | Status do usuário, incluindo posição atual, último login e informações de serviço. | Objeto | {...} |
status.position | Posição geográfica atual do usuário. | Objeto | {...} |
status.position.lat | Latitude da posição (Praça da Sé, SP). | Float | -23.55052 |
status.position.lng | Longitude da posição (Praça da Sé, SP). | Float | -46.633308 |
status.position.date | Data e hora da última atualização de posição. | String (ISO) | "2024-10-31T12:44:06.482Z" |
status.position.device | Informações sobre o dispositivo usado pelo usuário. | Objeto | {...} |
status.position.device.battery | Estado da bateria do dispositivo. | Objeto | {...} |
status.position.device.battery.level | Nível da bateria em porcentagem. | Integer | 45 |
status.position.device.battery.plugged | Indica se o dispositivo está conectado à energia. | Boolean | false |
status.position.device._id | Identificador único do dispositivo. | String | "device123abc456def789ghi000000" |
status.position.device.uuid | UUID do dispositivo. | String | "uuid123abc456def789ghi000000" |
status.position.device.connection_type | Tipo de conexão de rede do dispositivo (e.g., wifi, mobile). | String | "wifi" |
status.position.device.app_version | Versão do aplicativo instalada no dispositivo. | String | "2.29.15" |
status.last_login | Dados do último login do usuário. | Objeto | {...} |
status.last_login.date | Data e hora do último login. | String (ISO) | "2024-10-30T17:50:22.236Z" |
status.last_login.device | Informações sobre o dispositivo usado no último login. | Objeto | {...} |
status.last_login.device._id | Identificador único do dispositivo de login. | String | "device987654321000abc123456" |
status.last_login.device.ip_address | Endereço IP do dispositivo durante o login. | String | "192.168.1.1" |
status.last_login.device.user_agent | Informações do navegador ou sistema operacional do dispositivo. | String | "Mozilla/5.0 (Windows NT 10.0; Win64; x64)" |
status.on_duty | Indica se o usuário está em serviço (on duty). | Objeto | {...} |
status.on_duty.value | Status de serviço do usuário (true = em serviço). | Boolean | true |
status.on_duty.updated_at | Data e hora da última atualização do status de serviço. | String (ISO) | "2024-03-06T14:20:27.745Z" |
firstName | Primeiro nome do usuário. | String | "João" |
lastName | Sobrenome do usuário. | String | "Silva" |