Saltar al contenido principal

GET | /:id

Función que Realiza

Obtiene los datos de un cliente específico mediante su ID.


Funcionamiento

  • URL Completa: {domain}/api/v1/clients/:id
  • Acción: GET
  • Requiere Api-Key?: Si
  • Requiere una Sesión?: Si
  • Recibe datos mediante: Params
    • Cantidad de datos: 1
  • Responde con contenido?: Si
  • Responde únicamente con código de estado?: No
    • Código: 200 | Ok
  • Códigos de error: Vea la sección Errores

Contenido que se recibe por Parámetros

id = Int

Contenido que devuelve

{
"client": {
"id": Int,
"socialReason": "String",
"address": "String",
"groupingChannel": "String",
"status": "String",
"frequency": "String",
"gec": "String",
"coords": {
"latitude": "String",
"longitude": "String"
}
} | null
}

Códigos de Error

HTTP CodeCustom CodeMessage
422INVALID_REQUEST_DATALos datos enviados son inválidos o insuficientes.
401INVALID_API_KEYLa API Key proporcionada no es válida.
401INVALID_SESSIONLa sesión no es válida o ha expirado.
401INSUFFICIENT_PERMISSIONSNo tienes los permisos suficientes para acceder.