Petición| Info |
|---|
POST /expedientes/search
|
Petición con opciones de paginación| Info |
|---|
POST /expedientes/search?PageSize=<size>&PageNumber=<number>
|
Request URL| Code Block |
|---|
http://<dominio>:<puerto>/expedientes/search' |
Request URL con opciones de paginación| Code Block |
|---|
http://<dominio>:<puerto>/expedientes/search?PageSize=<size>&PageNumber=<number>' |
Parámetro | Descripción | Obligatorio | Ejemplo | <size> | Número de elementos por página | No | 10 | <number> | Número de página | No | 2 |
cURL| Code Block |
|---|
| curl --location --request POST 'http://<dominio>:<puerto>/expedientes/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
cURL con opciones de paginación| Code Block |
|---|
| curl --location --request POST 'http://<dominio>:<puerto>/expedientes/search?PageSize=<size>&PageNumber=<number>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio | <body> | Conjunto de filtros a aplicar sobre la búsqueda | No |
Body (request)| Code Block |
|---|
{
"titulares": [
{
"campo": <campo>,
"valores": <valores>,
"codigo": <filtro>
}
],
"generales": [
{
"campo": <campo>,
"valores": <valores>,
"codigo": <filtro>
}
]
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | <campo> | Campo por el que se va a aplicar el filtro, dentro del bloque al que corresponde. En este caso, sobre expedientes o titulares de los expedientes | Sí | Cadena de caracteres | <valores> | Lista de valores | Sí | Lista de valores | <filtro> | | Sí | Cadena de caracteres |
| Note |
|---|
¡Importante! Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json. No olvidar el token |
Ejemplo de request URL| Code Block |
|---|
http://192.168.293.365:8071/expedientes/search' |
Ejemplo de request URL con opciones de paginación| Code Block |
|---|
http://192.168.293.365:8071/expedientes/search?PageSize=10&PageNumber=2' |
Ejemplo de body| Code Block |
|---|
{
"titulares": [
{
"campo": "apellidos",
"valores": [
"S.A."
],
"codigo": "EQ"
}
],
"generales": [
{
"campo": "modalidad",
"valores": [
"M",
"P"
],
"codigo": "EQ"
},
{
"campo": "numero",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "bis",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "referencia",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "pais",
"valores": [
"CL",
"BR",
"DO"
],
"codigo": "EQ"
}
]
} |
Campo | Descripción | Obligatorio | Tipo parámetro | “modalidad” | Filtro sobre la modalidad del expediente | No | Cadena de caracteres | “numero” | Filtro sobre el número del expediente | No | Cadena de caracteres | “bis” | Filtro sobre bis del expediente | No | Cadena de caracteres | “referencia” | Filtro sobre la referencia del expediente | No | Cadena de caracteres | “pais” | Filtro sobre el país del expediente | No | Cadena de caracteres |
Ejemplo de cURL| Code Block |
|---|
| curl --location --request POST 'http://192.168.293.365:8071/expedientes/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"titulares": [
{
"campo": "apellidos",
"valores": [
"S.A."
],
"codigo": "EQ"
}
],
"generales": [
{
"campo": "modalidad",
"valores": [
"M",
"P"
],
"codigo": "EQ"
},
{
"campo": "numero",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "bis",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "referencia",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "pais",
"valores": [
"CL",
"BR",
"DO"
],
"codigo": "EQ"
}
]
}' |
Ejemplo de cURL con opciones de paginación| Code Block |
|---|
| curl --location --request POST 'http://192.168.293.365:8071/expedientes/search?PageSize=10&PageNumber=2' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"titulares": [
{
"campo": "apellidos",
"valores": [
"S.A."
],
"codigo": "EQ"
}
],
"generales": [
{
"campo": "modalidad",
"valores": [
"M",
"P"
],
"codigo": "EQ"
},
{
"campo": "numero",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "bis",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "referencia",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "pais",
"valores": [
"CL",
"BR",
"DO"
],
"codigo": "EQ"
}
]
}' |
Responses validaciones de campos Valor no válido para el campo ‘codigo’| Code Block |
|---|
{
"statusCode": 400,
"message": "Filtro 'X' no contemplado. [GET] /filtros para más información",
"data": null
} |
Valor no válido para el campo ‘campo’| Code Block |
|---|
{
"statusCode": 400,
"message": "Campo 'X' no contemplado",
"data": null
} |
Lista de valores vacía| Code Block |
|---|
{
"statusCode": 400,
"message": "Se deben informar valores para el tipo de filtro 'EQ'",
"data": null
} |
Lista de ‘valores’ con valor vacío| Code Block |
|---|
{
"statusCode": 400,
"message": "El valor no puede ser nulo",
"data": null
} |
Filtro ‘Between’ con más de dos valores| Code Block |
|---|
{
"statusCode": 400,
"message": "El filtro 'BT' tiene que tener únicamente dos valores",
"data": null
} |
En esta petición, además de devolver un listado con los contactos que cumplen los filtros de búsqueda, en la cabecera de la respuesta se devuelve el parámetro X-Pagination con la siguiente información: | Code Block |
|---|
{"TotalCount":<total>,"PageSize":<size>,"CurrentPage":<current_page>,"TotalPages":<total_pages>,"HasNextPage":<has_next_page>,"HasPreviousPage":<has_previous_page>,"NextPageUrl":<next_url>,"PreviousPageUrl":<previous_url>} |
Parámetro | Descripción | <total> | Número total de expedientes encontrados en la búsqueda | <size> | Número de elementos por página | <current_page> | Página actual | <total_pages> | Número total de páginas | <has_next_page> | Indica si hay página siguiente | <has_previous_page> | Indica si hay página anterior | <next_url> | URL de la siguiente página | <previous_url> | URL de la página anterior |
| Code Block |
|---|
{"TotalCount":2432,"PageSize":10,"CurrentPage":1,"TotalPages":244,"HasNextPage":true,"HasPreviousPage":false,"NextPageUrl":"","PreviousPageUrl":""} |
Responses Ha ido correctamente| Code Block |
|---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"id": 1,
"estado": {
"codigo": "A",
"descripcion": "Alta"
},
"modalidad": {
"codigo": "M",
"descripcion": "Marca Nacional"
},
"numero": "4123111",
"pais": {
"codigo": "ES",
"descripcion": "España"
},
"bis": null,
"fecha_vencimiento": "20/06/2025",
"referencia": null,
"descripciones": [
{
"id": 1,
"tipo": {
"codigo": "DT",
"descripcion": "Denominación"
},
"descripcion": "Culture",
"idioma": {
"codigo": "es",
"descripcion": "Español"
}
}
],
"titulares": [
{
"id": 1,
"nombre": null,
"apellidos": "Empresa S.A."
},
{
"id": 2,
"nombre": "Juan",
"apellidos": "Gómez"
}
]
},
{
"id": 2,
"estado": {
"codigo": "B",
"descripcion": "Baja"
},
"modalidad": {
"codigo": "H",
"descripcion": "Marca Internacional"
},
"numero": "345645",
"pais": {
"codigo": "CL",
"descripcion": "Chile"
},
"bis": null,
"fecha_vencimiento": "24/12/2024",
"referencia": "TM870EU01",
"descripciones": [
{
"id": 1,
"tipo": {
"codigo": "DE",
"descripcion": "Descripción"
},
"descripcion": "Culture",
"idioma": {
"codigo": "es",
"descripcion": "Español"
}
}
],
"titulares": []
}
]
} |
Ha ocurrido un error| Code Block |
|---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|