Buscar Personas

GET 
/user/:idUser/v3/persons/search

Busqueda de personas

Para consultar los tipos de roles, tendremos que usar los servicios auxiliares de personas. A continuación, se presentan los enlaces para consultar los tipos de roles y perfiles de personas:

• Tipos de rol de persona
• Tipos de persona

Para establecer el tipo de agricultor, tendrán que consultar: Tipos de agricultor

Request

Path Parameters

idUser integerrequired

ID del usuario

application/json

Body

required

idPersona integer

Id. de la persona

compIdPersona string

Possible values: [=, <, <=, >, >=, <>]

Tipo de filtro para idPersona

idPersonaExt string

Id. Externo

textodescrip string

Nombre de la persona

nid string

Número de identificación (dni, nie)

numsocio integer

Número de socio

compNumSocio string

Possible values: [=]

Tipo de filtro para numsocio

codigoPersona integer

Código de persona

idTipoPersona integer

Possible values: [1, 2]

1 → Persona física, 2 → Persona jurídica

idTipoAgricultor integer

Possible values: [1, 2, 3, 4]

1 → Socio, 2 → No socio, 3 → Colaborador, 4 → Pre socio

idRol integer

Possible values: [1, 2, 3, 4, 5, 8, 9]

1 → Productor, 2 → Técnico, 3 → Representante, 4 → Comercial, 5 → Aplicador, 8 → Trabajador, 9 → Aplicador

hasFechaBaja boolean

Indicador si la persona está activa o no. Se deja vacío si es indiferente.

restrictToFarm boolean

Indicador de si se muestran solo las personas que pertenecen a una parcela.

pais integer

Id. del país

comunidad integer

Id. de la comunidad

provincia integer

Id. de provincia

municipio integer

Id. municipio

idTipoCarneAplicador integer

Possible values: [2, 3, 4]

2 → Cualificado, 3 → Fumigador, 4 → Piloto

fechaVigencia date

Fecha en formato YYYY-MM-DD.

esropo boolean

Si está inscrito en el ROPO. Si se deja vacío, es indiferente.

esasesor boolean

Si está inscrito como asesor. Si se deja vacío, es indiferente.

idOrganizacion integer

Id. de la organización

Responses

200

La solicitud se ha procesado correctamente y se devuelve la lista de datos.

application/json

Schema

Schema

totalCount integer

Número total de registros

totalCountDeleted integer

Número total de registros eliminados

deleted object[]
Array [
id integer
Id.
fechaBaja integer
Fecha de baja
]
resultado string

Resultado de la operación

version string

Versión de la API

data object[]
Array [
idPersona integer
Id. de la persona
idPersonaExt string
Id. Externo
idOrganizacion integer
Id. de la organización
idTipo integer
Id. tipo de persona
Nombre string
Nombre de la persona
Apellidos string
Apellidos de la persona
Nid string
Número de identificación (dni, nie)
telefono1 string
Teléfono de contacto
telefono2 string
Otro teléfono de contacto
email string
Email
idPais integer
Id. del país
idComunidad integer
Id. de la comunidad
idProvincia integer
Id. de la provincia
idMunicipio integer
Id. del municipio
idLocalidad integer
Id. de la localidad
direccion string
Dirección postal
observaciones string
Observaciones
idTipoAgricultor integer
Id. del tipo de agricultor
numSocio string
Número de socio
esAsesor boolean
Identifica si es o no asesor
numCarneRopo string
Número de carné de ROPO
numCarneAplicador string
Número de carné de aplicador
fechaCaducidadCarne string
Fecha de caducidad del carné de aplicador
roles object
Nodo con los roles del usuario
perfiles object
Nodo con los perfiles del usuario
]

Example (from schema)

{
  "totalCount": 0,
  "totalCountDeleted": 0,
  "deleted": [
    {
      "id": 0,
      "fechaBaja": 0
    }
  ],
  "resultado": "string",
  "version": "string",
  "data": [
    {
      "idPersona": 0,
      "idPersonaExt": "string",
      "idOrganizacion": 0,
      "idTipo": 0,
      "Nombre": "string",
      "Apellidos": "string",
      "Nid": "string",
      "telefono1": "string",
      "telefono2": "string",
      "email": "string",
      "idPais": 0,
      "idComunidad": 0,
      "idProvincia": 0,
      "idMunicipio": 0,
      "idLocalidad": 0,
      "direccion": "string",
      "observaciones": "string",
      "idTipoAgricultor": 0,
      "numSocio": "string",
      "esAsesor": true,
      "numCarneRopo": "string",
      "numCarneAplicador": "string",
      "fechaCaducidadCarne": "string",
      "roles": {},
      "perfiles": {}
    }
  ]
}

Error

{
  "errors": "Mensaje de error",
  "resultado": "Resultado de la operación",
  "version": "Versión de la API"
}

Loading...