...
Expand |
---|
|
PeticiónRequest URL Code Block |
---|
http://<dominio>:<puerto>/empresas' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/empresas' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/empresas' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/empresas' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"codigo": "E1",
"descripcion": "Empresa 1",
"codPaispais": "null", {
"codMonedacodigo": "nullES",
"CIFdescripcion": "R2788776BEspaña"
}, },
{ "moneda": {
"codigo": "E2", "descripcioncodigo": "Empresa 2EUR",
"codPaisdescripcion": "null",Moneda de los estados miembros de EMU"
"codMoneda": "null"},
"CIF": "E0413308R2788776B""
},
{
"codigo": "E3E2",
"descripcion": "Empresa 32",
"pais": {
"codigo": "ES",
"descripcion": "España"
},
"moneda": {
"codigo": "EUR",
"descripcion": "Moneda de los estados miembros de EMU"
},
"CIF": "E0413308"R2777776B"
},
{
"codigo": "E4E3",
"descripcion": "Empresa 43",
"pais": {
"codigo": "ES",
"descripcion": "España"
},
"moneda": {
"codigo": "EUR",
"descripcion": "Moneda de los estados miembros de EMU"
},
"CIF": "V04182408R2777776B"
},
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode "codigo": 500,"E4",
"messagedescripcion": <mensaje_error>"Empresa 4",
"data "pais": {
null
} |
|
[GET] /estados
Descripción
Devuelve un listado con los estados disponibles.
Expand |
---|
|
PeticiónRequest URL Code Block |
---|
http://<dominio>:<puerto>/estados |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/estados' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/estados |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/estados' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{ "codigo": "ES",
"statusCodedescripcion": 200,
"message": "Petición finalizada correctamente","España"
"data": [ },
{ "moneda": {
"codigo": "A", "descripcioncodigo": "Alta"EUR",
}, "descripcion": "Moneda de los estados miembros {de EMU"
"codigo": "B" },
"descripcionCIF": "BajaV04182408"
}
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[GET] /
...
estados
Descripción
Devuelve un listado con los idiomas estados disponibles.
Expand |
---|
|
Petición Info |
---|
GET /idiomas/descripcionesestados
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/idiomas/descripciones'estados |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/idiomas/descripcionesestados' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/idiomas/descripciones'estados |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/idiomas/descripcionesestados' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"codigo": "bgA",
"descripcion": "BúlgaroAlta"
},
{
"codigo": "enB",
"descripcion": "InglésBaja"
},
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": "codigo": "es",
"descripcion": "Español"
},
{
"codigo": "et",
"descripcion": "Estonio"
}
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": 500,
"message": <mensaje_error>,
"data": null
} |
|
[GET] /idiomas/
...
descripciones
Descripción
Devuelve un listado con las modalidades los idiomas disponibles.
Expand |
---|
|
Petición Info |
---|
GET /modalidadesidiomas/descripciones
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/idiomas/modalidadesdescripciones' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/modalidadesidiomas/descripciones' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/idiomas/modalidadesdescripciones' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/modalidadesidiomas/descripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"codigo": "Abg",
"descripcion": "Marca de la Unión EuropeaBúlgaro"
},
{
"codigo": "Hen",
"descripcion": "Marca InternacionalInglés"
},
{
"codigo": "Pes",
"descripcion": "PatenteEspañol"
},
{
"codigo": "Uet",
"descripcion": "Modelo de UtilidadEstonio"
}
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[GET] /
...
modalidades
Descripción
Devuelve un listado con las monedas modalidades disponibles.
Expand |
---|
|
Petición Info |
---|
GET /monedasmodalidades
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/monedasmodalidades' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/monedasmodalidades' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/monedasmodalidades' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/monedasmodalidades' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
| {
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"codigo": "EURA",
"descripcion": "Moneda de los estados miembros de EMUMarca de la Unión Europea"
},
{
"codigo": "H",
"descripcion": "Marca Internacional"
},
{
"codigo": "GBPP",
"descripcion": "Libra BritánicaPatente"
},
{
"codigo": "USDU",
"descripcion": "DólarModelo de AmericanoUtilidad"
}
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[GET] /
...
monedas 🏗️ (In progress)
Descripción
Devuelve un listado con los países las monedas disponibles.
Expand |
---|
|
PeticiónRequest URL Code Block |
---|
http://<dominio>:<puerto>/paisesmonedas' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/paisesmonedas' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/paisesmonedas' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/paisesmonedas' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
| {
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"codigo": "ALEUR",
"descripcion": "AlbaniaMoneda de los estados miembros de EMU"
},
{
"codigo": "AMGBP",
"descripcion": "Armenia"
},
{
"codigo": "AR",Libra Británica"
"descripcion": "Argentina"
},
{
"codigo": "ASUSD",
"descripcion": "Samoa Americana (American Samoa)"
},
{
"codigo": "AT",
Dólar Americano"
"descripcion": "Austria"
}
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[GET] /
...
paises
Descripción
Devuelve un listado con los tipos países disponibles para contactos.
Expand |
---|
|
Petición Info |
---|
GET /tipos/contactospaises
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/tipos/contactospaises' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/tipos/contactospaises' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/tipos/contactospaises' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/tipos/contactospaises' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"codigo": "AAL",
"descripcion": "AgenteAlbania"
},
{
"codigo": "BAM",
"descripcion": "AbogadoArmenia"
},
{
"codigo": "CAR",
"descripcion": "ClienteArgentina"
},
{
"codigo": "AS",
"descripcion": "Samoa Americana (American Samoa)"
},
{
"codigo": "AT",
"descripcion": "Austria"
}
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[GET] /tipos/
...
contactos
Descripción
Devuelve un listado con los tipos disponibles para las descripcionescontactos.
Expand |
---|
|
Petición Info |
---|
GET /tipos/descripcionescontactos
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/tipos/descripcionescontactos' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/tipos/descripcionescontactos' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/tipos/descripcionescontactos' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/tipos/descripcionescontactos' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"codigo": "DTA",
"descripcion": "DenominaciónAgente"
},
{
"codigo": "DEB",
"descripcion": "DescripciónAbogado"
},
{
"codigo": "INC",
"descripcion": "IndicaciónCliente"
},
{
"codigo": "RE",
"descripcion": "Renuncia"
}
]
} |
Status |
---|
|
colour | Yellow |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
[GET] /tipos/
...
descripciones
Descripción
Devuelve un listado con los tipos disponibles para los domicilioslas descripciones.
Expand |
---|
|
Petición Info |
---|
GET /tipos/domiciliosdescripciones
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/tipos/domiciliosdescripciones' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/tipos/domiciliosdescripciones' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/tipos/domiciliosdescripciones' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/tipos/domiciliosdescripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"codigo": "ADT",
"descripcion": "Etiqueta AlternativaDenominación"
},
{
"codigo": "CDE",
"descripcion": "Solo CorrespondenciaDescripción"
},
{
"codigo": "FIN",
"descripcion": "Solo FacturaciónIndicación"
},
{
"codigo": "GRE",
"descripcion": "GenéricoRenuncia"
}
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
Contactos
[GET] /
...
tipos/
...
domicilios
Descripción
Obtiene la información de un contacto, a partir de su identificadorDevuelve un listado con los tipos disponibles para los domicilios.
Expand |
---|
|
Petición Info |
---|
GET /contactostipos/<id>
|
|
Parámetro | Descripción | Obligatorio | Ejemplo |
<id> | | Sí | 6450 |
Request URL
Code Block |
---|
http://<dominio>:<puerto>/contactostipos/<id>domicilios' |
cURL
Code Block |
---|
|
curl --location --request GET 'http://<dominio>:<puerto>/contactostipos/<id>domicilios' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL
Code Block |
---|
http://192.168.293.365:8071/contactostipos/3992domicilios' |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request GET 'http://192.168.293.365:8071/contactostipos/3992domicilios' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses
Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{ {
"id": 1, "codigo": "4879A",
"tipo": { "codigodescripcion": "C",
"descripcion": "Cliente"Etiqueta Alternativa"
},
"referencia": "RF39438948",
"estado": {
"codigo": "AC",
"descripcion": "AltaSolo Correspondencia"
},
"domicilios": [
{
"idcodigo": 442"F",
"nombredescripcion": "JoseSolo Facturación",
},
"apellidos": "García",
{
"domiciliocodigo": "Wayna AeroG",
"poblaciondescripcion": "ValenciaGenérico",
}
]
} |
Ha ocurrido un error Code Block |
---|
{
"tipostatusCode": {500,
"message": <mensaje_error>,
"data": null
} |
Contactos
[GET] /contactos/{id}
Descripción
Obtiene la información de un contacto, a partir de su identificador.
Expand |
---|
|
PeticiónParámetro | Descripción | Obligatorio | Ejemplo | <id> | | Sí | 6450 |
Request URL Code Block |
---|
http://<dominio>:<puerto>/contactos/<id>' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/contactos/<id>' \
--header 'accept-language: <idioma>' \
"codigo": "G",
"descripcion": "Genérico"
}
}
],--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/contactos/3992' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/contactos/3992' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": {
"titularesid": [1,
"codigo": "4879",
{ "tipo": {
"idcodigo": 1"C",
"nombre": null,"descripcion": "Cliente"
},
"apellidosreferencia": "Empresa S.A."RF39438948",
"estado": {
"codigo": "A",
"descripcion": "Alta"
},
"domicilios": [
{
"id": 2442,
"nombre": "JuanJose",
"apellidos": "GómezGarcía",
} "domicilio": "Wayna Aero",
] "poblacion": "Valencia",
} } | No se ha encontrado el contacto Code Block |
---|
{ "statusCode": 404, "messagetipo": {
"No se ha encontrado el contacto", "data": null } | Ha ocurrido un error Code Block |
---|
{ "statusCode": 500, "messagecodigo": <mensaje_error>"G",
"data": null
} |
|
[POST] /contactos
Descripción
Creación de un nuevo contacto. Devuelve el identificador del contacto creado o existente
Expand |
---|
|
PeticiónRequest URL Code Block |
---|
http://<dominio>:<puerto>/contactos' |
cURL Code Block |
---|
| curl --location --request POST 'http://<dominio>:<puerto>/contactos' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
|
| Descripción | Obligatorio |
<body> | | Sí |
Body (request)
Code Block |
---|
{
"codigo": <codigo>,
"tipo": <tipo>,
"estado": <estado>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo |
<codigo> | | Sí | Cadena de caracteres | 10 caracteres | 58634 |
<tipo> | | Sí | Cadena de caracteres | Único carácter | C |
<estado> | | No | Cadena de caracteres | Único carácter | B |
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/contactos' |
Ejemplo de body
Code Block |
---|
{
"codigo": "58634",
"tipo": "C",
"estado": "B"
} |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request POST 'http://192.168.293.365:8071/contactos' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"codigo": "58634",
"tipo": "C",
"estado": "B"
}' |
Responses validaciones de campos
Valor no válido para el campo ‘tipo’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'tipo'. [GET] /tipos/contactos para más información",
"data": null
} |
Valor no válido para el campo ‘estado’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'estado'. [GET] /estados para más información",
"data": null
} |
Responses
Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": 3992
} |
Ya existe el contacto que está intentando crear Code Block |
---|
{
"statusCode": 409,
"message": "Ya existe el contacto que está intentando crear",
"data": 3992
} "descripcion": "Genérico"
}
}
],
"titulares": [
{
"id": 1,
"nombre": null,
"apellidos": "Empresa S.A."
},
{
"id": 2,
"nombre": "Juan",
"apellidos": "Gómez"
}
]
}
} |
No se ha encontrado el contacto Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el contacto",
"data": null
} |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
[POST] /contactos
...
Descripción
Búsqueda de contactos con filtros. Devuelve un listado con los contactos que cumplen los filtros de búsqueda.Creación de un nuevo contacto. Devuelve el identificador del contacto creado o existente
Expand |
---|
|
Petición Info |
---|
POST /contactos/search
|
Petición con opciones de paginación Info |
---|
POST /contactos/search?PageSize=<size>&PageNumber=<number>
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/contactos/search' | Request URL con opciones de paginacióncURL Code Block |
---|
| curl --location --request POST 'http://<dominio>:<puerto>/contactos/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>/contactos/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>/contactos/search?PageSize=<size>&PageNumber=<number>' \
--' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
No | Descripción | Obligatorio |
<body> |
Conjunto de filtros a aplicar sobre la búsqueda | Body (request)
Code Block |
---|
{
"domicilioscodigo": [
{
"campo": <campo>,
<codigo>,
"valorestipo": <valores><tipo>,
"codigoestado": <filtro>
}
],
"titulares": [
{
"campo": <campo>,,
"valores": <valores>,
"codigo": <filtro>
}
],
"generales": [
{
"campo": <campo>,
"valores": <valores>,
"codigo": <filtro>
}
]
}<estado>
} |
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 contactos, domicilios o titularesLongitud máxima parámetro | Ejemplo |
<codigo> | | Sí | Cadena de caracteres | 10 caracteres |
<valores> | Lista de valores<filtro> | Tipo de filtro a aplicarLista de valores | Cadena de caracteres | Único carácter | C |
<estado> | |
filtros SíNo | Cadena de caracteres | Único carácter | B |
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/contactos/search' |
Ejemplo de request URL
con opciones de paginación Code Block |
---|
http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2' |
Ejemplo de body
Code Block |
---|
{
"domicilioscodigo": ["58634",
{
"campo"tipo": "apellidosC",
"valoresestado": [
"García"
],
"B"
} |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request POST 'http://192.168.293.365:8071/contactos' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"codigo": "EQ58634",
}
]"tipo": "C",
"titularesestado": [
"B"
}' |
Responses validaciones de campos
Valor no válido para el campo ‘tipo’ Code Block |
---|
{
"campostatusCode": "apellidos"400,
"valoresmessage": ["Valor 'X' no válido para el "S.A."
]campo 'tipo'. [GET] /tipos/contactos para más información",
"codigodata": "EQ"
}
],
"generales": [
{
null
} |
Valor no válido para el campo ‘estado’ Code Block |
---|
{
"campostatusCode": "codigo"400,
"valoresmessage": ["Valor 'X' no válido para el campo 'estado'. "424"
],
[GET] /estados para más información",
"codigodata": "EQ"
},null
} |
Responses
Ha ido correctamente Code Block |
---|
{
{
"statusCode": 200,
"campomessage": "tipoPetición finalizada correctamente",
"valoresdata": [
3992
} |
Ya existe el contacto que está intentando crear Code Block |
---|
{
"CstatusCode": 409,
"A"
]"message": "Ya existe el contacto que está intentando crear",
"codigodata": "EQ"
},
{
"campo": "referencia"3992
} |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"valoresmessage": [
"RF239348"
],
<mensaje_error>,
"codigodata": "EQ"
}
]
} |
Campo | Descripción | Obligatorio | Tipo parámetro |
“apellidos” | Filtro sobre el campo apellidos de titulares o domicilios (dependiendo del bloque en el que se encuentre) | No | Cadena de caracteres |
“codigo” | | No | Cadena de caracteres |
“tipo” | | No | Cadena de caracteres |
“referencia” | | No | Cadena de caracteres |
Ejemplo de
[POST] /contactos/search
Descripción
Búsqueda de contactos con filtros. Devuelve un listado con los contactos que cumplen los filtros de búsqueda.
Expand |
---|
|
Petición Info |
---|
POST /contactos/search
|
Petición con opciones de paginación Info |
---|
POST /contactos/search?PageSize=<size>&PageNumber=<number>
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/contactos/search' |
Request URL con opciones de paginación Code Block |
---|
http://<dominio>:<puerto>/contactos/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://192.168.293.365:8071<dominio>:<puerto>/contactos/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH<token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"domicilios": [
{
"campo": "apellidos",
"valores": [
"García"
<body>' |
cURL con opciones de paginación Code Block |
---|
| curl --location --request POST 'http://<dominio>:<puerto>/contactos/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 |
---|
{
"domicilios": [
{
"campo": <campo>,
] "valores": <valores>,
"codigo": "EQ"<filtro>
}
],
"titulares": [
{
"campo": "apellidos"<campo>,,
"valores": [
"S.A."
]<valores>,
"codigo": "EQ"<filtro>
}
],
"generales": [
{
"campo": "codigo"<campo>,
"valores": [
"424"
]<valores>,
"codigo": "EQ"<filtro>
},
{
"campo": "tipo",
"valores]
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | <campo> | | 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/contactos/search' |
Ejemplo de request URL con opciones de paginación Code Block |
---|
http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2' |
Ejemplo de body Code Block |
---|
{
"domicilios": [
{
"C", "campo": "apellidos",
"valores": [
"AGarcía"
],
"codigo": "EQ"
}
],
"titulares": [
{
"campo": "referenciaapellidos",
"valores": [
"RF239348S.A."
],
"codigo": "EQ"
}
]
}' |
Ejemplo de cURL con opciones de paginación Code Block |
---|
| curl --location --request POST 'http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"domicilios,
"generales": [
{
"campo": "apellidoscodigo",
"valores": [
"García424"
],
"codigo": "EQ"
}
],
"titulares": [ {
"campo": "apellidostipo",
"valores": [
"S.A.C",
], "A"
"codigo": "EQ"
}
],
"generales": [
{
"campo": "codigo",
"valores": [
"424"
],
"codigo": "EQ"
},
{
"campo": "tipo",
"valores": [
"C",
"A"
],
"codigo": "EQ"
},
{
"campo": "referencia",
"valores": [
"RF239348"
],
"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 | {Campo | Descripción | Obligatorio | Tipo parámetro | “apellidos” | Filtro sobre el campo apellidos de titulares o domicilios (dependiendo del bloque en el que se encuentre) | No | Cadena de caracteres | “codigo” | | No | Cadena de caracteres | “tipo” | | No | Cadena de caracteres | “referencia” | | No | Cadena de caracteres |
Ejemplo de cURL Code Block |
---|
| curl --location --request POST 'http://192.168.293.365:8071/contactos/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"domicilios": [
{
"statusCodecampo": 400"apellidos",
"messagevalores": "Campo 'X' no contemplado",[
"dataGarcía":
null } | Lista de valores vacía Code Block |
---|
{ ],
"statusCode": 400, "messagecodigo": "EQ"Se
deben informar valores para el tipo}
de filtro 'EQ'",
],
"datatitulares": null
} | Lista de ‘valores’ con valor vacío Code Block |
---|
{[
{
"statusCodecampo": 400"apellidos",
"messagevalores": [
"El valor no puede ser nulo" "S.A."
],
"datacodigo": null
} | Filtro ‘Between’ con más de dos valores Code Block |
---|
{ "EQ"
}
],
"generales": [
{
"statusCodecampo": 400"codigo",
"messagevalores": [
"El filtro 'BT' tiene que tener únicamente dos valores","424"
],
"datacodigo": "EQ"
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> | |
<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,
{
"campo": "tipo",
"valores": [
"C",
"A"
],
"codigo": "EQ"
},
{
"campo": "referencia",
"valores": [
"RF239348"
],
"codigo": "EQ"
}
]
}' |
Ejemplo de cURL con opciones de paginación
Code Block |
---|
|
curl --location --request POST 'http://192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"domicilios": [
{
"campo": "apellidos",
"valores": [
"García"
],
"codigo": "EQ"
}
],
"titulares": [
{
"idcampo": 1"apellidos",
"codigovalores": "4879",[
"tipo": {S.A."
],
"codigo": "CEQ",
}
],
"descripciongenerales": "Cliente"[
{
},
"referenciacampo": "RF39438948codigo",
"estadovalores": {[
"codigo424": "B",
],
"descripcioncodigo": "BajaEQ"
},
}, {
"domicilioscampo": ["tipo",
{"valores": [
"idC": 4,
"A"
"nombre": "María", ],
"apellidoscodigo": "GarcíaEQ",
},
"domicilio": "Calle Los Arenales",{
"poblacion"campo": "Valenciareferencia",
"tipovalores": {
[
"codigoRF239348":
"G", ],
"descripcioncodigo": "Genérico"
EQ"
}
]
}}' |
Responses validaciones de campos
Valor no válido para el campo ‘codigo’ Code Block |
---|
{
],
"statusCode": 400,
"titularesmessage": ["Filtro 'X' no contemplado. [GET] /filtros para más información",
{ "data": null
} |
Valor no válido para el campo ‘campo’ Code Block |
---|
{
"idstatusCode": 1400,
"nombremessage": null,
"Campo 'X' no contemplado",
"apellidosdata": "Empresa S.A."null
} |
Lista de valores vacía Code Block |
---|
{
}"statusCode": 400,
"message": "Se deben informar {valores para el tipo de filtro 'EQ'",
"iddata": 2,
null
} |
Lista de ‘valores’ con valor vacío Code Block |
---|
{
"statusCode": 400,
"nombremessage": "Juan",El valor no puede ser nulo",
"apellidosdata": "Gómez"
}null
} |
Filtro ‘Between’ con más de dos valores Code Block |
---|
{
"statusCode": 400,
"message": "El filtro 'BT' ]tiene que tener únicamente
},
{dos valores",
"iddata": 2,
"codigo": "68798",
"tipo": {
"codigo": "A",
"descripcion": "Agente"
},
"referencia": "DG29849348",
"estado": {
"codigo": "A",
"descripcion": "Alta"
},
"domicilios": [],
"titulares": []
}
]
} |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
[GET] /contactos/{id}/domicilios
Descripción
Obtiene los domicilios de un contacto.
Expand |
---|
|
Petición Info |
---|
GET /contactos/<id>/domicilios
|
|
Parámetro | Descripción | Obligatorio | Ejemplo |
<id> | | Sí | 6450 |
Request URL
Code Block |
---|
http://<dominio>:<puerto>/contactos/<id>/domicilios' |
cURL
Code Block |
---|
|
curl --location --request GET 'http://<dominio>:<puerto>/contactos/<id>/domicilios' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL
Code Block |
---|
http://192.168.293.365:8071/contactos/3992/domicilios' |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request GET 'http://192.168.293.365:8071/contactos/3992/domicilios' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses
Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"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> | |
<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,
"codigo": "4879",
"tipo": {
"codigo": "C",
"descripcion": "Cliente"
},
"referencia": "RF39438948",
"idestado": 1,
{
"nombrecodigo": "NataliaB",
"apellidos"descripcion": "GarcíaBaja",
},
"domiciliodomicilios": "Wayna Aero", [
{
"poblacionid": "Valencia"4,
"tiponombre": {"María",
"codigo"apellidos": "AGarcía",
"descripciondomicilio": "EtiquetaCalle Los AlternativaArenales",
"poblacion": "Valencia",
} },
"tipo": {
"idcodigo": 2"G",
"nombredescripcion": "María",Genérico"
}
"apellidos": "Fernandez", }
],
"domiciliotitulares": "Yedra Centro",
[
{
"poblacionid": "Madrid"1,
"tiponombre": {null,
"codigoapellidos": "G",Empresa S.A."
},
"descripcion": "Genérico" {
}"id": 2,
} "nombre": "Juan",
"apellidos": "Gómez"
}
] } |
No se ha encontrado el contacto Code Block |
---|
},
{
"statusCodeid": 4042,
"messagecodigo": "68798"No,
se ha encontrado el contacto"tipo",: {
"data": null } |
Ha ocurrido un error Code Block |
---|
{ "statusCodecodigo": 500"A",
"messagedescripcion": <mensaje_error>,"Agente"
},
"datareferencia": null
} |
...
"DG29849348",
"estado": {
"codigo": "A",
"descripcion": "Alta"
},
"domicilios": [],
"titulares": []
}
]
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[GET] /contactos/{id}/domicilios
Descripción
Creación Obtiene los domicilios de un nuevo domicilio asociado a un contacto. Devuelve el identificador del domicilio creado o existente.
Expand |
---|
|
Petición Info |
---|
POST GET /contactos/<id>/domicilios
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | | Sí | 6450 |
Request URL Code Block |
---|
http://<dominio>:<puerto>/contactos/<id>/domicilios' |
cURL Code Block |
---|
| curl --location --request POSTGET 'http://<dominio>:<puerto>/contactos/<id>/domicilios' \
--header 'Authorizationaccept-language: Bearer <token><idioma>' \
--header 'Content-TypeAuthorization: application/json' \
--data-raw '<body>' |
|
| Descripción | Obligatorio |
<body> | | Sí |
Body (request)
Code Block |
---|
{
"apellidos": <apellidos>,
"tipo": <tipo>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo |
<apellidos> | Apellidos | Sí | Cadena de caracteres | 100 caracteres | García Fernández |
<tipo> | | Sí | Cadena de caracteres | Único carácter | A |
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 tokenBearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL
Code Block |
---|
http://192.168.293.365:8071/contactos/<id>3992/domicilios' |
Ejemplo de
bodycURL
Code Block |
---|
|
{curl "apellidos": "García Fernández",
"tipo": "A"
} |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request POST--location --request GET 'http://192.168.293.365:8071/contactos/64503992/domicilios' \
--header 'Authorizationaccept-language: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHHes' \
--header 'Content-TypeAuthorization: application/json' \
--data-raw '{
"apellidos": "García Fernández",
"tipo": "A"
}' |
Responses validaciones de camposBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses
Status |
---|
colour | PurpleGreen |
---|
title | 400 |
---|
|
Valor no válido para el campo ‘tipo’ Ha ido correctamente Code Block |
---|
{
"statusCode": 400200,
"message": "ValorPetición 'X' no válido para el campo 'tipo'. [GET] /tipos/domicilios para más información",finalizada correctamente",
"data": [
{
"dataid": 1,
null
} |
Responses
Ha ido correctamente Code Block |
---|
{ "statusCodenombre": 200"Natalia",
"message": "Petición finalizada correctamente", "dataapellidos": 3992
} |
No se ha encontrado el contacto Code Block |
---|
{"García",
"statusCode": 404, "messagedomicilio": "No se ha encontrado el contacto","Wayna Aero",
"datapoblacion": "Valencia",
null } |
Ya existe el domicilio que está intentando crear Code Block |
---|
{ "statusCode": 409, "messagetipo": "Ya{
existe el domicilio que está intentando crear", "data": 3992 } |
Ha ocurrido un error Code Block |
---|
{ "statusCodecodigo": 500"A",
"message": <mensaje_error>, "datadescripcion": null
} |
[PUT] /contactos/{id}/domicilios/{idDomicilio}
Descripción
Modificación de un domicilio asociado a un contacto.
Expand |
---|
|
Petición Info |
---|
PUT /contactos/<id>/domicilios/<idDomicilio>
|
|
Parámetro | Descripción | Obligatorio | Ejemplo |
<id> | | Sí | 6450 |
<idDomicilio> | Identificador del domicilio a modificar | Sí | 450 |
Request URL
Code Block |
---|
http://<dominio>:<puerto>/contactos/<id>/domicilios/<idDomicilio>' |
cURL
Code Block |
---|
|
curl --location --request PUT 'http://<dominio>:<puerto>/contactos/<id>/domicilios/<idDomicilio>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio |
<body> | | Sí |
Body (request)
Code Block |
---|
{
"apellidos": <apellidos>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo |
<apellidos> | Apellidos | Sí | Cadena de caracteres | 100 caracteres | García Fernández |
Note |
---|
¡Importante! Al ser una petición PUT, 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/contactos/<id>/domicilios/<idDomicilio>' |
Ejemplo de body
Code Block |
---|
{
"apellidos": "García Fernández"
} |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request PUT 'http://192.168.293.365:8071/contactos/6450/domicilios/450' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{"Etiqueta Alternativa"
}
},
{
"id": 2,
"nombre": "María",
"apellidos": "Fernandez"García,
Fernández" }' |
Responses
Ha ido correctamente Code Block |
---|
{ "statusCode": 200, "messagedomicilio": "PeticiónYedra finalizada correctamenteCentro",
"data": null } |
No se ha encontrado el contacto Code Block |
---|
{ "statusCodepoblacion": 404"Madrid",
"message "tipo": "No{
se ha encontrado el contacto", "data": null } |
No se ha encontrado el domicilio Code Block |
---|
{ "statusCodecodigo": 404"G",
"message": "No se ha encontrado el domicilio", "datadescripcion": null
} |
El domicilio existe pero no pertenece a ese contacto Code Block |
---|
{"Genérico"
"statusCode": 409, "message": "El domicilio existe pero no pertenece a ese contacto",
}
}
"data": null]
} |
Ya existe un domicilio con esas características para ese No se ha encontrado el contacto Code Block |
---|
{
"statusCode": 409404,
"message": "YaNo existese unha domicilioencontrado con esas características para ese el contacto",
"data": null
} |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
[
...
POST] /contactos/{id}/
...
domicilios
Descripción
Obtiene los titulares de un clienteCreación de un nuevo domicilio asociado a un contacto. Devuelve el identificador del domicilio creado o existente.
Expand |
---|
|
Petición Info |
---|
GET POST /contactos/<id>/titularesdomicilios
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | | de tipo clienteRequest URL Code Block |
---|
http://<dominio>:<puerto>/contactos/<id>/titularesdomicilios' |
cURL Code Block |
---|
| curl --location --request GETPOST 'http://<dominio>:<puerto>/contactos/<id>/titularesdomicilios' \
--header 'accept-languageAuthorization: <idioma>Bearer <token>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/contactos/3992/titulares' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/contactos/3992/titulares'Content-Type: application/json' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente | Descripción | Obligatorio | <body> | | Sí |
Body (request) Code Block |
---|
{
"statusCodeapellidos": 200<apellidos>,
"messagetipo": "Petición finalizada correctamente",
"data": [
{
"id": 1,
"nombre": "Natalia",
"apellidos": "García"
},
{
"id": 2,
"nombre": null,
"apellidos": "LU S.A."
}
]
}<tipo>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo | <apellidos> | Apellidos | Sí | Cadena de caracteres | 100 caracteres | García Fernández | <tipo> | | Sí | Cadena de caracteres | Único carácter | A |
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/contactos/<id>/domicilios' |
Ejemplo de body Code Block |
---|
{
"apellidos": "García Fernández",
"tipo": "A"
} |
Ejemplo de cURL Code Block |
---|
| curl --location --request POST 'http://192.168.293.365:8071/contactos/6450/domicilios' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"apellidos": "García Fernández",
"tipo": "A"
}' |
Responses validaciones de campos No se ha encontrado el contacto Valor no válido para el campo ‘tipo’ Code Block |
---|
{
"statusCode": 404400,
"message": "No se ha encontradoValor 'X' no válido para el contacto",
"campo 'tipo'. [GET] /tipos/domicilios para más información",
"data": null
} |
Responses Status |
---|
colour | YellowGreen |
---|
title | 500200 |
---|
| Ha ocurrido un errorido correctamente Code Block |
---|
{
"statusCode": 500200,
"message": <mensaje_error> "Petición finalizada correctamente",
"data": null3992
} |
|
[POST] /contactos/{id}/titulares
Descripción
Creación de un titular a un cliente en concreto. Devuelve el identificador del titular creado o existente.
Expand |
---|
|
Petición Info |
---|
POST /contactos/<id>/titulares
|
|
Parámetro | Descripción | Obligatorio | Ejemplo |
<id> | | Sí | 6450 |
Request URL
Code Block |
---|
http://<dominio>:<puerto>/contactos/<id>/titulares' |
cURL
Code Block |
---|
|
curl --location --request POST 'http://<dominio>:<puerto>/contactos/<id>/titulares' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio |
<body> | | Sí |
Body (request)
Code Block |
---|
{
"nombre": <nombre>,
"apellidos": <apellidos>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo |
<nombre> | Nombre del titular | No | Cadena de caracteres | 50 caracteres | Juan |
<apellidos> | Apellidos del titular | Sí | Cadena de caracteres | 250 caracteres | García Fernández |
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 No se ha encontrado el contacto Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el contacto",
"data": null
} |
Ya existe el domicilio que está intentando crear Code Block |
---|
{
"statusCode": 409,
"message": "Ya existe el domicilio que está intentando crear",
"data": 3992
} |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
[PUT] /contactos/{id}/domicilios/{idDomicilio}
Descripción
Modificación de un domicilio asociado a un contacto.
Expand |
---|
|
Petición Info |
---|
PUT /contactos/<id>/domicilios/<idDomicilio>
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | | Sí | 6450 | <idDomicilio> | Identificador del domicilio a modificar | Sí | 450 |
Request URL Code Block |
---|
http://192.168.293.365:8071<dominio>:<puerto>/contactos/<id>/titulares' |
Ejemplo de body Code Block |
---|
{
"nombre": "Juan",
"apellidos": "García Fernández"
} | Ejemplo de domicilios/<idDomicilio>' |
cURL Code Block |
---|
| curl --location --request POSTPUT 'http://192.168.293.365:8071<dominio>:<puerto>/contactos/<id>/6450domicilios/titulares<idDomicilio>' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH<token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"nombre": "Juan",
"apellidos": "García Fernández"
}' |
Responses validaciones de campos El contacto no es un cliente | Descripción | Obligatorio | <body> | | Sí |
Body (request) Code Block |
---|
{
"statusCodeapellidos": 400,
"message": "El contacto 'X' no es un cliente",
"data": null
} |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": 3992
} | No se ha encontrado el contacto Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el contacto<apellidos>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo | <apellidos> | Apellidos | Sí | Cadena de caracteres | 100 caracteres | García Fernández |
Note |
---|
¡Importante! Al ser una petición PUT, 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/contactos/<id>/domicilios/<idDomicilio>' |
Ejemplo de body Code Block |
---|
{
"apellidos": "García Fernández"
} |
Ejemplo de cURL Code Block |
---|
| curl --location --request PUT 'http://192.168.293.365:8071/contactos/6450/domicilios/450' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"apellidos": "García Fernández"
}' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": null
} | Ya existe la relación que está intentando crear No se ha encontrado el contacto Code Block |
---|
{
"statusCode": 409404,
"message": "YaNo existese elha titular paraencontrado el contacto 'X'",
"data": 3992null
} |
Status |
---|
colour | YellowPurple |
---|
title | 500 |
---|
| Ha ocurrido un error No se ha encontrado el domicilio Code Block |
---|
{
"statusCode": 500404,
"message": <mensaje_error>,"No se ha encontrado el domicilio",
"data": null
} |
|
Expedientes
[GET] /expedientes/{id}
Descripción
Obtiene la información de un expediente a partir de su identificador.
Expand |
---|
|
Petición Info |
---|
GET /expedientes/<id>
|
|
Parámetro | Descripción | Obligatorio | Ejemplo |
<id> | Identificador del expediente | Sí | 6450 |
Request URL
Code Block |
---|
http://<dominio>:<puerto>/expedientes/<id>' |
cURL
Code Block |
---|
|
curl --location --request GET 'http://<dominio>:<puerto>/expedientes/<id>' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL
Code Block |
---|
http://192.168.293.365:8071/expedientes/3992' |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request GET 'http://192.168.293.365:8071/expedientes/3992' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses
Ha ido correctamente Code Block |
{
"statusCode": 200 El domicilio existe pero no pertenece a ese contacto Code Block |
---|
{
"statusCode": 409,
"message": "El domicilio existe pero no pertenece a ese contacto",
"data": null
} |
Ya existe un domicilio con esas características para ese contacto Code Block |
---|
{
"statusCode": 409,
"message": "PeticiónYa finalizadaexiste correctamente",un domicilio con esas características "data": {
para ese contacto",
"iddata": 1,
null
} |
Ha ocurrido un error Code Block |
---|
{
"estadostatusCode": {500,
"codigo"message": "B",
<mensaje_error>,
"descripciondata": "Baja"
},
"modalidad": {
"codigo": "M",
null
} |
[GET] /contactos/{id}/titulares
Descripción
Obtiene los titulares de un cliente.
Expand |
---|
|
Petición Info |
---|
GET /contactos/<id>/titulares
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | | Sí | 6450 |
Request URL Code Block |
---|
http://<dominio>:<puerto>/contactos/<id>/titulares' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/contactos/<id>/titulares' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/contactos/3992/titulares' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/contactos/3992/titulares' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"descripcionstatusCode": "Marca200,
Nacional" "message": "Petición finalizada correctamente",
}, "data": [
{
"numero": "4123111", "paisid": {1,
"codigonombre": "ESNatalia",
"descripcionapellidos": "EspañaGarcía"
},
"bis": "4",{
"fecha_vencimientoid": "20/06/2025",2,
"referencianombre": null,
"descripciones": [ "apellidos": "LU S.A."
{ }
]
} | No se ha encontrado el contacto Code Block |
---|
{
"idstatusCode": 27297404,
"message": "No se ha encontrado el contacto",
"tipodata": null
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"codigomessage": "DT",
<mensaje_error>,
"descripcion"data": "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"
}
]
}
} | No se ha encontrado el expediente |
[POST] /contactos/{id}/titulares
Descripción
Creación de un titular a un cliente en concreto. Devuelve el identificador del titular creado o existente.
Expand |
---|
|
Petición Info |
---|
POST /contactos/<id>/titulares
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | | Sí | 6450 |
Request URL Code Block |
---|
http://<dominio>:<puerto>/contactos/<id>/titulares' |
cURL Code Block |
---|
| curl --location --request POST 'http://<dominio>:<puerto>/contactos/<id>/titulares' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio | <body> | | Sí |
Body (request) Code Block |
---|
{
"nombre": <nombre>,
"apellidos": <apellidos>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo | <nombre> | Nombre del titular | No | Cadena de caracteres | 50 caracteres | Juan | <apellidos> | Apellidos del titular | Sí | Cadena de caracteres | 250 caracteres | García Fernández |
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/contactos/<id>/titulares' |
Ejemplo de body Code Block |
---|
{
"nombre": "Juan",
"apellidos": "García Fernández"
} |
Ejemplo de cURL Code Block |
---|
| curl --location --request POST 'http://192.168.293.365:8071/contactos/6450/titulares' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"nombre": "Juan",
"apellidos": "García Fernández"
}' |
Responses validaciones de campos El contacto no es un cliente Code Block |
---|
{
"statusCode": 400,
"message": "El contacto 'X' no es un cliente",
"data": null
} |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": 3992
} | No se ha encontrado el contacto Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el contacto",
"data": null
} | Ya existe la relación que está intentando crear Code Block |
---|
{
"statusCode": 409,
"message": "Ya existe el titular para el contacto 'X'",
"data": 3992
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
Expedientes
[GET] /expedientes/{id}
Descripción
Obtiene la información de un expediente a partir de su identificador.
Expand |
---|
|
Petición Info |
---|
GET /expedientes/<id>
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | Identificador del expediente | Sí | 6450 |
Request URL Code Block |
---|
http://<dominio>:<puerto>/expedientes/<id>' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/expedientes/<id>' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/expedientes/3992' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/expedientes/3992' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 404200,
"message": "NoPetición se ha encontrado el expedientefinalizada correctamente",
"data": null
} | Ha ocurrido un error Code Block |
---|
{ {
"statusCodeid": 5001,
"message "estado": <mensaje_error>, {
"datacodigo": null
} |
|
[PUT] /expedientes/{id}
Descripción
Modificación de un expediente.
Expand |
---|
|
Petición Info |
---|
PUT /expedientes/<id>
|
|
Parámetro | Descripción | Obligatorio | Ejemplo |
<id> | Identificador del expediente | Sí | 6450 |
Request URL
Code Block |
---|
http://<dominio>:<puerto>/expedientes/<id>' |
cURL
Code Block |
---|
|
curl --location --request PUT 'http://<dominio>:<puerto>/expedientes/<id>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio |
<body> | | Sí |
Body (request)
Code Block |
---|
{
"estado": <estado>,
"descripciones": [
{ "B",
"descripcion": "Baja"
},
"modalidad": {
"codigo": "M",
"descripcion": "Marca Nacional"
},
"numero": "4123111",
"pais": {
"tipocodigo": <tipo_descripcion>,"ES",
"descripcion": <descripcion>"España"
},
"idiomabis": <idioma_descripcion>"4",
} ]
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo |
<estado> | | No | Cadena de caracteres | Único carácter | B |
“descripciones” | Bloque opcional para las denominaciones | No | <tipo_descripcion> | | Sí | Cadena de caracteres | 2 caracteres | DE |
<descripcion> | Descripción | No | | Culture | <idioma_descripcion> | | Sí | Cadena de caracteres | 2 caracteres | es |
Note |
---|
¡Importante! Si se hace referencia a un descripción existente con valor ““ en el campo <descripcion> se realizará un borrado de dicha descripción. En caso contrario, se actualizará. Si no existe, se creará como nueva descripción |
Note |
---|
¡Importante! Al ser una petición PUT, 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/6450' |
Ejemplo de body
Code Block |
---|
{
"estado": "B",
"descripciones": [
{
"tipo": "DE",
"descripcion": "Culture",
"idioma": "es"
}
]
} |
Ejemplo de "fecha_vencimiento": "20/06/2025",
"referencia": null,
"descripciones": [
{
"id": 27297,
"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"
}
]
}
} |
No se ha encontrado el expediente Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el expediente",
"data": null
} |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
[PUT] /expedientes/{id}
Descripción
Modificación de un expediente.
Expand |
---|
|
Petición Info |
---|
PUT /expedientes/<id>
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | Identificador del expediente | Sí | 6450 |
Request URL Code Block |
---|
http://<dominio>:<puerto>/expedientes/<id>' |
cURL Code Block |
---|
| curl --location --request PUT 'http://<dominio>:<puerto>/expedientes/<id>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio | <body> | | Sí |
Body (request) Code Block |
---|
{
"estado": <estado>,
"descripciones": [
{
"tipo": <tipo_descripcion>,
"descripcion": <descripcion>,
"idioma": <idioma_descripcion>
}
]
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo | <estado> | | No | Cadena de caracteres | Único carácter | B | “descripciones” | Bloque opcional para las denominaciones | No | | <tipo_descripcion> | | Sí | Cadena de caracteres | 2 caracteres | DE | <descripcion> | Descripción | No | | | Culture | <idioma_descripcion> | | Sí | Cadena de caracteres | 2 caracteres | es |
Note |
---|
¡Importante! Si se hace referencia a un descripción existente con valor ““ en el campo <descripcion> se realizará un borrado de dicha descripción. En caso contrario, se actualizará. Si no existe, se creará como nueva descripción |
Note |
---|
¡Importante! Al ser una petición PUT, 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/6450' |
Ejemplo de body Code Block |
---|
{
"estado": "B",
"descripciones": [
{
"tipo": "DE",
"descripcion": "Culture",
"idioma": "es"
}
]
} |
Ejemplo de cURL Code Block |
---|
| curl --location --request PUT 'http://192.168.293.365:8071/expedientes/6450' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"estado": "B",
"descripciones": [
{
"tipo": "DE",
"descripcion": "Culture",
"idioma": "es"
}
]
}' |
Responses validaciones de campos Valor no válido para el campo ‘estado’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'estado'. [GET] /estados para más información",
"data": null
} |
Responses control descripciones Valor no válido para el campo ‘idioma’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'idioma'. [GET] /idiomas/descripciones para más información",
"data": null
} | Valor no válido para el campo ‘tipo’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'tipo'. [GET] /tipos/descripciones para más información",
"data": null
} | Claves duplicadas en la lista de descripciones Code Block |
---|
{
"statusCode": 400,
"message": "Descripciones duplicadas. Clave duplicada { Elemento = { Tipo = DE, Idioma = es }, Ocurrencias = 2 }",
"data": null
} | Incluir varias denominaciones para modalidades distintas de patentes Code Block |
---|
{
"statusCode": 400,
"message": "Este tipo de modalidad no permite guardar varias denominaciones",
"data": null
} |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": null
} | No se ha encontrado el expediente Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el expediente",
"data": null
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[POST] /expedientes
Descripción
Creación de un nuevo expediente. Devuelve el identificador del expediente creado o existente.
Expand |
---|
|
PeticiónRequest URL Code Block |
---|
http://<dominio>:<puerto>/expedientes' |
cURL Code Block |
---|
| curl --location --request PUTPOST 'http://192.168.293.365:8071<dominio>:<puerto>/expedientes/6450' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH<token>' \
--header 'Content-Type: application/json' \
--data-raw '{'<body>' |
| Descripción | Obligatorio | <body> | | Sí |
Body (request) Code Block |
---|
{
"id_contacto": <id_contacto>,
"estado": <estado>,
"modalidad": <modalidad>,
"numero": <numero>,
"pais": <pais>,
"bis": <bis>,
"estadoreferencia": "B"<referencia>,
"descripciones": [
{
"tipo": "DE"<tipo_descripcion>,
"descripcion": <descripcion>,
"descripcionidioma": <idioma_descripcion>
"Culture", }
],
"titulares": [
{
"idioma": "es"
}
]
}' |
Responses validaciones de campos Valor no válido para el campo ‘estado’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'estado'. [GET] /estados para más información",
"data": null
} |
Responses control descripciones Valor no válido para el campo ‘idioma’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'idioma'. [GET] /idiomas/descripciones para más información",
"data": null
} | Valor no válido para el campo ‘tipo’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'tipo'. [GET] /tipos/descripciones para más información",
"data": null
} | Claves duplicadas en la lista de descripciones Code Block |
---|
{
"statusCode": 400,
"message": "Descripciones duplicadas. Clave duplicada { Elemento = { Tipo = DE, Idioma = es }, Ocurrencias = 2 }",
"data": null
} | Incluir varias denominaciones para modalidades distintas de patentes Code Block |
---|
{
"statusCode": 400,
"message": "Este tipo de modalidad no permite guardar varias denominaciones",
"data": null
} |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": null
} | No se ha encontrado el expediente Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el expediente",
"data": null
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[POST] /expedientes
Descripción
Creación de un nuevo expediente. Devuelve el identificador del expediente creado o existente.
Expand |
---|
|
PeticiónRequest URL Code Block |
---|
http://<dominio>:<puerto>/expedientes' |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo | | | Sí | Numérico | | 6450 | <estado> | | No | Cadena de caracteres | Único carácter | B | <modalidad> | | No | Cadena de caracteres | 10 caracteres | M | <numero> | Número del expediente | Sí | Cadena de caracteres | 30 caracteres | 578549 | <pais> | | No | Cadena de caracteres | 2 caracteres | ES | <bis> | Bis del expediente | No | Cadena de caracteres | 3 caracteres | 4 | <referencia> | Referencia del expediente | No | Cadena de caracteres | 100 caracteres | RF938439845 | “descripciones” | Bloque opcional para las denominaciones | No | | <tipo_descripcion> | | Sí | Cadena de caracteres | 2 caracteres | DE | <descripcion> | Descripción | No | Cadena de caracteres | | Culture | <idioma_descripcion> | | Sí | Cadena de caracteres | 2 caracteres | es | “titulares” | Bloque opcional para introducir un listado de los titulares del expediente | No | | | | <titular> | Identificador del titular | No | Numérico | | 735 |
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' |
Ejemplo de body Code Block |
---|
{
"id_contacto": 735,
"numero": "578549",
"modalidad": "M",
"pais": "ES",
"bis": "4",
"referencia": "RF938439845",
"estado": "B",
"descripciones": [
{
"tipo": "DE",
"descripcion": "Culture",
"idioma": "es"
}
],
"titulares": [
{
"id": 735
},
{
"id": 789
},
{
"id": 898
}
]
} |
Ejemplo de cURL Code Block |
---|
| curl --location --request POST 'http://<dominio>:<puerto>192.168.293.365:8071/expedientes' \
--header 'Authorization: Bearer <token>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
|
| Descripción | Obligatorio |
<body> | | Sí |
Body (request)
Code Block |
---|
{
"id_contacto": <id_contacto>735,
"estadonumero": <estado>"578549",
"modalidad": <modalidad>"M",
"numeropais": <numero>"ES",
"paisbis": <pais>"4",
"bisreferencia": <bis>"RF938439845",
"referenciaestado": <referencia>"B",
"descripciones": [
{
"tipo": <tipo_descripcion>"DE",
"descripcion": <descripcion>"Culture",
"idioma": <idioma_descripcion>"es"
}
],
"titulares": [
{
"id": <titular>735
},
{
"id": 789
] ]
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo |
| | Sí | Numérico | 6450 | <estado> | | No | Cadena de caracteres | Único carácter | B |
<modalidad> | | No | Cadena de caracteres | 10 caracteres | M |
<numero> | Número del expediente | Sí | Cadena de caracteres | 30 caracteres | 578549 |
<pais> | | No | Cadena de caracteres | 2 caracteres | ES |
<bis> | Bis del expediente | No | Cadena de caracteres | 3 caracteres | 4 |
<referencia> | Referencia del expediente | No | Cadena de caracteres | 100 caracteres | RF938439845 |
“descripciones” | Bloque opcional para las denominaciones | No | <tipo_descripcion> | | Sí | Cadena de caracteres | 2 caracteres | DE |
<descripcion> | Descripción | No | Cadena de caracteres | Culture | <idioma_descripcion> | | Sí | Cadena de caracteres | 2 caracteres | es |
“titulares” | Bloque opcional para introducir un listado de los titulares del expediente | No | <titular> | Identificador del titular | No | Numérico | 735 | 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' |
Ejemplo de bodyResponses validaciones de campos
Valor no válido para el campo ‘modalidad’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'modalidad'. [GET] /modalidades para más información",
"data": null
} |
Valor no válido para el campo ‘pais’ Code Block |
---|
{
"id_contactostatusCode": 735400,
"numeromessage": "578549Valor 'X' no válido para el campo 'pais'. [GET] /paises para más información",
"modalidaddata": "M", null
} |
Valor no válido para el campo ‘estado’ Code Block |
---|
{
"paisstatusCode": "ES"400,
"bis": "4",
"referenciamessage": "RF938439845",
"estado": "B",
"descripciones": [
{Valor 'X' no válido para el campo 'estado'. [GET] /estados para más información",
"tipodata": "DE",
null
} |
Responses control descripciones
Valor no válido para el campo ‘idioma’ Code Block |
---|
{
"descripcionstatusCode": "Culture"400,
"idiomamessage": "es"Valor 'X' no válido para }el campo 'idioma'. ],
"titulares": [[GET] /idiomas/descripciones para más información",
{
"id"data": 735
null
},
{
} |
Valor no válido para el campo ‘tipo’ Code Block |
---|
{
"idstatusCode": 789
}400,
{
"id"message": 898"Valor 'X' no válido para }el campo 'tipo'. [GET] } |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request POST 'http://192.168.293.365:8071/expedientes' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"id_contacto": 735,
"numero": "578549",
"modalidad": "M",
"pais": "ES",
"bis": "4",
"referencia": "RF938439845",
"estado": "B",
"descripciones": [
{
"tipo": "DE",
"descripcion": "Culture",
"idioma": "es"
}
],
"titulares": [
{
"id": 735
},
{
"id": 789
},
{
"id": 898
}
]
}' |
Responses validaciones de campos
/tipos/descripciones para más información",
"data": null
} |
Claves duplicadas en la lista de descripciones Code Block |
---|
{
"statusCode": 400,
"message": "Descripciones duplicadas. Clave duplicada { Elemento = { Tipo = DE, Idioma = es }, Ocurrencias = 2 }",
"data": null
} |
Incluir varias denominaciones para modalidades distintas de patentes Code Block |
---|
{
"statusCode": 400,
"message": "Este tipo de modalidad no permite guardar varias denominaciones",
"data": null
} |
Responses control titulares
Titular no existente Code Block |
---|
{
"statusCode": 400,
"message": "No existe el titular 'X'",
"data": null
} |
Asociar un titular de un cliente diferente al del expediente Code Block |
---|
{
"statusCode": 400,
"message": "No se puede asociar un titular de un cliente diferente al del expediente",
"data": null
} |
Responses
Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": 3992
} |
Valor no válido para el campo ‘modalidad’ No se ha encontrado el contacto Code Block |
---|
{
"statusCode": 400404,
"message": "ValorNo 'X'se noha válido paraencontrado el campo 'modalidad'. [GET] /modalidades para más informacióncontacto",
"data": null
} |
Valor no válido para el campo ‘pais’ Ya existe el expediente que está intentando crear Code Block |
---|
{
"statusCode": 400409,
"message": "Valor 'X' no válido paraYa existe el campo 'pais'. [GET] /paises para más informaciónexpediente que está intentando crear",
"data": null3992
} |
Status |
---|
colour | PurpleYellow |
---|
title | 400 |
---|
|
Valor no válido para el campo ‘estado’ Ha ocurrido un error Code Block |
---|
{
"statusCode": 400500,
"message": "Valor 'X' no válido para el campo 'estado'. [GET] /estados para más información"<mensaje_error>,
"data": null
} |
Responses control descripciones
Valor no válido para el campo ‘idioma’ Code Block |
---|
{
"statusCode": 400,
"message": "Valor 'X' no válido para el campo 'idioma'. [GET] /idiomas/descripciones para más información",
"data": null
} |
Valor no válido para el campo ‘tipo’
[POST] /expedientes/search
Descripción
Búsqueda de expedientes con filtros. Devuelve un listado con los expedientes que cumplen los filtros de búsqueda.
Expand |
---|
|
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 |
---|
{
"statusCodetitulares": 400,[
"message": "Valor 'X' no válido para el campo 'tipo'. [GET] /tipos/descripciones para más información",{
"campo": <campo>,
"datavalores": null
} | Claves duplicadas en la lista de descripciones Code Block |
---|
{
"statusCode": 400,<valores>,
"messagecodigo": "Descripciones<filtro>
duplicadas. Clave duplicada { Elemento = { Tipo = DE, Idioma = es },
Ocurrencias = 2 }"],
"data": null
} | Incluir varias denominaciones para modalidades distintas de patentes Code Block |
---|
{generales": [
{
"statusCodecampo": 400<campo>,
"messagevalores": "Este tipo de modalidad no permite guardar varias denominaciones"<valores>,
"datacodigo": null
} |
Responses control titulares Titular no existente Code Block |
---|
{
"statusCode": 400,
"message": "No existe el titular 'X'",
"data": null
} | Asociar un titular de un cliente diferente al del expedientePará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 |
---|
{
"statusCodetitulares": 400,
[
"message": "No se puede asociar un titular de un cliente diferente al del expediente",
"data": null
} |
Responses Ha ido correctamente Code Block |
---|
{ {
"statusCodecampo": 200"apellidos",
"messagevalores": [
"Petición finalizada correctamente", "data": 3992
} | No se ha encontrado el contacto Code Block |
---|
{S.A."
],
"statusCode": 404, "messagecodigo": "NoEQ"
se ha encontrado el}
contacto", ],
"datagenerales": [
null } | Ya existe el expediente que está intentando crear Code Block |
---|
{
"statusCodecampo": 409"modalidad",
"messagevalores": [
"Ya existe el expediente que está intentando crear" "M",
"P"
],
"datacodigo": 3992
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,"EQ"
},
{
"data": null
} |
|
[POST] /expedientes/search
Descripción
Búsqueda de expedientes con filtros. Devuelve un listado con los expedientes que cumplen los filtros de búsqueda.
Expand |
---|
|
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": "numero",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "bis",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": <campo>"referencia",
"valores": <valores> [
"12345"
],
"codigo": <filtro>"EQ"
},
],{
"campo": "pais",
"generalesvalores": [
{ "CL",
"campoBR":,
<campo>, "valores": <valores>DO"
],
"codigo": <filtro>"EQ"
}
]
} |
ParámetroSíCampo | 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 | “modalidad” | Filtro sobre la modalidad del expediente | No | Cadena de caracteres |
“numero” | Filtro sobre el número del expediente | No | Cadena de caracteres |
<valores> | Lista de valores | Sí | Lista de valores |
<filtro> | | Sí“bis” | Filtro sobre bis del expediente | No | Cadena de caracteres |
“referencia” | Filtro sobre la referencia del expediente | No | 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 |
---|
“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' |
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 |
---|
\
--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",
"Mvalores",: [
"P12345"
],
"codigo": "EQ"
},
{
"campo": "numeroreferencia",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "bispais",
"valores": [
"CL",
"12345"BR",
"DO"
],
"codigo": "EQ"
},
]
}' |
Ejemplo de cURL con opciones de paginación
Code Block |
---|
|
curl {
"campo": "referencia",
"valores": [
--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": [
{
"12345campo": "apellidos",
], "valores": [
"codigo": "EQ" "S.A."
}, {],
"campocodigo": "pais",
EQ"
}
],
"valoresgenerales": [
{
"CL", "BR",
"campo": "modalidad",
"DOvalores": [
], "codigoM":,
"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": [ "P"
],
"codigo": "EQ"
},
{
"campo": "apellidosnumero",
"valores": [
"S.A.12345"
],
"codigo": "EQ"
}
],
"generales": [ {
"campo": "modalidadbis",
"valores": [
"M",
"P12345"
],
"codigo": "EQ"
},
{
"campo": "numeroreferencia",
"valores": [
"12345"
],
"codigo": "EQ"
},
{
"campo": "bispais",
"valores": [
"CL",
"BR",
"12345DO"
],
"codigo": "EQ"
},
]
{}' |
Responses validaciones de campos
Valor no válido para el campo ‘codigo’ Code Block |
---|
{
"statusCode": 400,
"campo": "referencia",
"message": "Filtro 'X' no contemplado. [GET] /filtros para más información",
"valoresdata": [
null
} |
Valor no válido para el campo ‘campo’ Code Block |
---|
{
"12345statusCode"
],
: 400,
"codigomessage": "EQ"Campo 'X' no contemplado",
}, "data": null
{
} |
Lista de valores vacía Code Block |
---|
{
"campostatusCode": "pais"400,
"valoresmessage": ["Se deben informar valores para el tipo de filtro "CL'EQ'",
"data": null
"BR",} |
Lista de ‘valores’ con valor vacío Code Block |
---|
{
"statusCode": 400,
"DOmessage": "El valor no puede ser ]nulo",
"codigodata": "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 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": [
{
"12345" ]"id": 1,
"codigoestado": "EQ"{
},
{
"campocodigo": "referenciaA",
"valoresdescripcion": [
"12345"Alta"
]},
"codigomodalidad": "EQ"
},
{
{ "campocodigo": "paisM",
"valoresdescripcion": ["Marca Nacional"
"CL"},
"numero": "BR4123111",
"DOpais": {
],
"codigo": "EQES"
}
]
}' |
Responses validaciones de campos
Valor no válido para el campo ‘codigo’ Code Block |
---|
{
"statusCode": 400,,
"messagedescripcion": "España"Filtro
'X' no contemplado. [GET] /filtros para},
más información", "databis": null
} |
Valor no válido para el campo ‘campo’ Code Block |
---|
{,
"statusCodefecha_vencimiento": 400,"20/06/2025",
"messagereferencia": "Campo 'X' no contemplado",null,
"datadescripciones": null
} |
Lista de valores vacía Code Block |
---|
{ [
{
"statusCodeid": 4001,
"messagetipo": "Se{
deben informar valores para el tipo de filtro 'EQ'", "datacodigo": null
} |
Lista de ‘valores’ con valor vacío Code Block |
---|
{"DT",
"statusCode": 400, "messagedescripcion": "El valor no puede ser nulo"Denominación"
},
"data": null } |
Filtro ‘Between’ con más de dos valores Code Block |
---|
{
"statusCodedescripcion": 400"Culture",
"messageidioma": "El{
filtro 'BT' tiene que tener únicamente dos valores", "datacodigo": 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": [
{"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"
},
"idnumero": 1"345645",
"estadopais": {
"codigo": "ACL",
"descripcion": "AltaChile"
},
"modalidadbis": null,
{ "fecha_vencimiento": "24/12/2024",
"codigoreferencia": "MTM870EU01",
"descripciondescripciones": [
"Marca Nacional" {
}, "numeroid": "4123111"1,
"paistipo": {
"codigo": "ESDE",
"descripcion": "EspañaDescripción"
},
"bis": null, "descripcion": "Culture",
"idioma": {
"fecha_vencimientocodigo": "20/06/2025es",
"referencia": null, "descripcion": "descripcionesEspañol":
[ {}
}
"id": 1, ],
"tipotitulares": {[]
}
]
} |
Ha ocurrido un error Code Block |
---|
{
"codigostatusCode": 500,
"DTmessage": <mensaje_error>,
"data": "descripcion": "Denominación"
},
"descripcion": "Culture",
"idioma": {
"codigo": "es",
"descripcion": "Español"
}
}
],
"titularesnull
} |
[GET] /expedientes/{id}/titulares
Descripción
Obtiene los titulares de un expediente.
Expand |
---|
|
Petición Info |
---|
GET /expedientes/<id>/titulares
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | Identificador del expediente | Sí | 6450 |
Request URL Code Block |
---|
http://<dominio>:<puerto>/expedientes/<id>/titulares' |
cURL Code Block |
---|
| curl --location --request GET 'http://<dominio>:<puerto>/expedientes/<id>/titulares' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/expedientes/3992/titulares' |
Ejemplo de cURL Code Block |
---|
| curl --location --request GET 'http://192.168.293.365:8071/expedientes/3992/titulares' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": [
{
"id": 1,
"nombre": null"Natalia",
"apellidos": "Empresa S.A.García"
},
{
"id": 2,
"nombre": "Juan"null,
"apellidos": "GómezLU S.A."
}
]
},
{
} | No se ha encontrado el contacto Code Block |
---|
{
"id": 2,
"estado": {
"codigo": "B",
statusCode": 404,
"descripcionmessage": "Baja"No se ha encontrado el }expediente",
"modalidaddata": null
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"codigomessage": "H"<mensaje_error>,
"data": null
} |
|
[POST] /expedientes/{id}/titulares
Descripción
Asignación de un titular a un expediente.
Expand |
---|
|
Petición Info |
---|
POST /expedientes/<id>/titulares
|
Parámetro | Descripción | Obligatorio | Ejemplo | <id> | Identificador del expediente | Sí | 6450 |
Request URL Code Block |
---|
http://<dominio>:<puerto>/expedientes/<id>/titulares' |
cURL Code Block |
---|
| curl --location --request "descripcion": "Marca Internacional"
},
"numero": "345645",
"pais": {
"codigo": "CL",
"descripcion": "Chile"
},
"bis": null,
"fecha_vencimiento": "24/12/2024",
"referencia": "TM870EU01POST 'http://<dominio>:<puerto>/expedientes/<id>/titulares' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio | <body> | | Sí |
Body (request) Code Block |
---|
{
"id": <titular>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo | <titular> | Identificador del titular | Sí | Numérico | | 735 |
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/<id>/titulares' |
Ejemplo de bodyEjemplo de cURL Code Block |
---|
| curl --location --request POST 'http://192.168.293.365:8071/expedientes/6450/titulares' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 735
}' |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"descripcionesdata": [
null
} | No se ha encontrado el titular Code Block |
---|
{
"statusCode": 404,
"idmessage": 1,"No se ha encontrado el titular",
"tipodata": null
} | No se ha encontrado el expediente Code Block |
---|
{
"statusCode": 404,
"codigomessage": "DE",No se ha encontrado el expediente",
"descripciondata": "Descripción"
},
null
} | El titular existe pero no pertenece al cliente del expediente Code Block |
---|
{
"descripcionstatusCode": "Culture"409,
"idiomamessage": {"El titular existe pero no pertenece al cliente del expediente",
"codigodata": "es",null
} | Ya existe la relación que está intentando crear Code Block |
---|
{
"statusCode": 409,
"descripcionmessage": "Español"Ya existe el titular para el }
}
],
expediente 'X'",
"titularesdata": []
}
]
}null
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[
...
POST] /expedientes/
...
actos/
...
search
Descripción
Obtiene los titulares de un expedienteBúsqueda de actos con filtros. Devuelve un listado con los actos que cumplen los filtros de búsqueda.
Expand |
---|
|
Petición Info | GET |
---|
POST /expedientes/actos/search
|
Petición con opciones de paginación Info |
---|
POST /expedientes/actos/search?PageSize=<size>&PageNumber=<number>
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/expedientes/actos/search' |
Request URL con opciones de paginación Code Block |
---|
http://<dominio>:<puerto>/expedientes/ <id>/titularesactos/search?PageSize=<size>&PageNumber=<number>' |
Code Block | http://<dominio>:<puerto>/expedientes/<id>/titulares'Parámetro | Descripción | Obligatorio | Ejemplo |
<id> | Identificador del expediente | Sí | 6450 | Request URL | <size> | Número de elementos por página | No | 10 | <number> | Número de página | No | 2 |
cURL Code Block |
---|
| curl --location --request GETPOST 'http://<dominio>:<puerto>/expedientes/<id>actos/titularessearch' \
--header 'accept-languageAuthorization: <idioma>Bearer <token>' \
--header 'Authorization: Bearer <token>' |
Note |
---|
Importante: no olvidar headers |
Ejemplo de request URL Code Block |
---|
http://192.168.293.365:8071/expedientes/3992/titulares' | Ejemplo de cURLContent-Type: application/json' \
--data-raw '<body>' |
cURL con opciones de paginación Code Block |
---|
| curl --location --request GETPOST 'http://192.168.293.365:8071<dominio>:<puerto>/expedientes/3992/titularesactos/search?PageSize=<size>&PageNumber=<number>' \
--header 'accept-languageAuthorization: esBearer <token>' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' |
Responses Ha ido correctamenteContent-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio | <body> | Conjunto de filtros a aplicar sobre la búsqueda | No |
Body (request) Code Block |
---|
{
"statusCodegenerales": 200,[
"message": "Petición finalizada correctamente",{
"datacampo": [<campo>,
{"valores": <valores>,
"id"codigo": 1,<filtro>
"nombre": "Natalia",
"apellidos": "García"
},
{
"id": 2,
"nombre": null,
"apellidos": "LU S.A."
}
]
} | No se ha encontrado el contacto Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el expediente",
"data": null
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|
[POST] /expedientes/{id}/titulares
Descripción
Asignación de un titular a un expediente.
...
Petición
Info |
---|
POST /expedientes/<id>/titulares
|
...
Parámetro
...
Descripción
...
Obligatorio
...
Ejemplo
...
<id>
...
Identificador del expediente
...
Sí
...
6450
Request URL
Code Block |
---|
http://<dominio>:<puerto>/expedientes/<id>/titulares' |
cURL
Code Block |
---|
|
curl --location --request POST 'http://<dominio>:<puerto>/expedientes/<id>/titulares' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
...
...
Descripción
...
Obligatorio
...
<body>
...
...
Sí
Body (request)
Code Block |
---|
{
"id": <titular>
} |
...
Parámetro
...
Descripción
...
Obligatorio
...
Tipo parámetro
...
Longitud máxima parámetro
...
Ejemplo
...
<titular>
...
Identificador del titular
...
Sí
...
Numérico
...
735
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/<id>/titulares' |
Ejemplo de body
Ejemplo de cURL
Code Block |
---|
|
curl --location --request POST 'http://192.168.293.365:8071/expedientes/6450/titulares' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 735
}' |
Responses
Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": null
} |
No se ha encontrado el titular Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el titular",
"data": null
} |
No se ha encontrado el expediente Code Block |
---|
{
"statusCode": 404,
"message": "No se ha encontrado el expediente",
"data": null
} |
El titular existe pero no pertenece al cliente del expediente Code Block |
---|
{
"statusCode": 409,
"message": "El titular existe pero no pertenece al cliente del expediente",
"data": null
} |
Ya existe la relación que está intentando crear Code Block |
---|
{
"statusCode": 409,
"message": "Ya existe el titular para el expediente 'X'",
"data": null
} |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
[POST] /expedientes/actos/search
Descripción
Búsqueda de actos con filtros. Devuelve un listado con los actos que cumplen los filtros de búsqueda.
Expand |
---|
|
Petición Info |
---|
POST /expedientes/actos/search
|
Petición con opciones de paginación Info |
---|
POST /expedientes/actos/search?PageSize=<size>&PageNumber=<number>
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/expedientes/actos/search' |
Request URL con opciones de paginación Code Block |
---|
http://<dominio>:<puerto>/expedientes/actos/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/actos/search' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
cURL con opciones de paginaciónPará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 actos | 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/actos/search' |
Ejemplo de request URL con opciones de paginación
Code Block |
---|
http://192.168.293.365:8071/expedientes/actos/search?PageSize=10&PageNumber=2' |
Ejemplo de body
Code Block |
---|
{
"generales": [
{
"campo": "fecha_acto",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_acto",
"valores": [
"01/01/2022"
],
"codigo": "EQ"
},
{
"campo": "fecha_publicacion",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_publicacion",
"valores": [
"01/01/2022"
],
"codigo": "EQ"
},
{
"campo": "fecha_alta",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_alta",
"valores": [
"01/01/2022"
],
"codigo": "EQ"
},
{
"campo": "id_boletin",
"valores": [
"345"
],
"codigo": "EQ"
}
]
} |
Campo | Descripción | Obligatorio | Tipo parámetro |
“fecha_acto” | Filtro sobre la fecha del acto | No | |
“fecha_publicacion” | Filtro sobre la fecha de publicación del acto | No | |
“fecha_alta” | Filtro sobre la fecha de alta del boletín | No | |
“id_boletin” | Filtro sobre el identificador del boletín | No | Cadena de caracteres |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request POST 'http://<dominio>:<puerto>192.168.293.365:8071/expedientes/actos/search?PageSize=<size>&PageNumber=<number>' \
--header 'Authorization: Bearer <token>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--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 |
---|
{
"generales": [": [
{
"campo": "fecha_acto",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": <campo>"fecha_acto",
"valores": <valores> [
"01/01/2022"
],
"codigo": <filtro>"EQ"
},
]
} |
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 actos | 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/actos/search' |
Ejemplo de request URL con opciones de paginación
Code Block |
---|
http://192.168.293.365:8071/expedientes/actos/search?PageSize=10&PageNumber=2' |
Ejemplo de body
Code Block |
---|
{
"generales": [ {
"campo": "fecha_publicacion",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_publicacion",
"valores": [
"01/01/2022"
],
"codigo": "EQ"
},
{
"campo": "fecha_actoalta",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_acto_alta",
"valores": [
"01/01/2022"
],
"codigo": "EQ"
},
{
"campo": "id_boletin",
"valores": [
"345"
],
"codigo": "EQ"
}
]
}' |
Ejemplo de cURL con opciones de paginación
Code Block |
---|
|
curl --location --request "01/01/2022"
],
"codigo": "EQ"
},POST 'http://192.168.293.365:8071/expedientes/actos/search?PageSize=10&PageNumber=2' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"generales": [
{
"campo": "fecha_publicacionacto",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_publicacionacto",
"valores": [
"01/01/2022"
],
"codigo": "EQ"
},
{
"campo": "fecha_altapublicacion",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_alta",
"valores": [01/01/2022",
"0131/01/2022"
],
"codigo": "EQBT"
},
{
"campo": "idfecha_boletinpublicacion",
"valores": [
"345"
], "codigo": "EQ"
}
]
} |
Campo | Descripción | Obligatorio | Tipo parámetro |
“fecha_acto” | Filtro sobre la fecha del acto | No | |
“fecha_publicacion” | Filtro sobre la fecha de publicación del acto | No | |
“fecha_alta” | Filtro sobre la fecha de alta del boletín | No | |
“id_boletin” | Filtro sobre el identificador del boletín | No | Cadena de caracteres |
Ejemplo de cURL
Code Block |
---|
|
curl --location --request POST 'http:"01//192.168.293.365:8071/expedientes/actos/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"generales": [01/2022"
],
"codigo": "EQ"
},
{
"campo": "fecha_actoalta",
"valores": [
"01/01/2022",
"31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_actoalta",
"valores": [
"01/01/2022"
],
"codigo": "EQ"
},
{
"campo": "fechaid_publicacionboletin",
"valores": [
"345"
],
"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"01/01/2022",
"31/01/2022data": null
} |
Valor no válido para el campo ‘campo’ Code Block |
---|
{
]"statusCode": 400,
"codigomessage": "BT"Campo 'X' no contemplado",
}, "data": null
} |
Lista de valores vacía Code Block |
---|
{
"campostatusCode": "fecha_publicacion",400,
"message": "Se deben informar "valores": para [el tipo de filtro 'EQ'",
"01/01/2022data": null
} |
Lista de ‘valores’ con valor vacío Code Block |
---|
{
"statusCode": ]400,
"codigomessage": "EQ"El valor no puede ser }nulo",
{"data": null
} |
Filtro ‘Between’ con más de dos valores Code Block |
---|
{
"campostatusCode": "fecha_alta"400,
"valoresmessage": ["El filtro 'BT' tiene que tener únicamente dos "01/01/2022"valores",
"data": "31/01/2022"
],
"codigo": "BT"
},
{
"campo": "fecha_alta",
"valores": [
"01/01/2022"
],
"codigo": "EQ"
},
{
"campo": "id_boletin",
"valores": [
"345"
],
"codigo": "EQ"
}
]
}' |
Ejemplo de cURL con opciones de paginación
Code Block |
---|
|
curl --location --request POST 'http://192.168.293.365:8071/expedientes/actos/search?PageSize=10&PageNumber=2' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"generales": [
{
"campo": "fecha_acto",
"valoresnull
} |
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 actos 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": [
{
"01/01/2022",
"31/01/2022"
]"id": 1,
"codigoid_expediente": "BT"6420,
}, "acto": {
{ "campocodigo": "fecha_acto520",
"valoresdescripcion": [ "01/01/2022"Anotación"
]},
"codigofecha_acto": "EQ"
}01/12/2021",
{ "campo": "fecha_publicacion": null,
"valoresreferencia": [
"01/01/2022",
"31/01/2022"null,
]"numero_acto": null,
"codigofecha_anulacion": "BT"null
},
{
"campoid": "fecha_publicacion"2,
"valoresid_expediente": [5487,
"01/01/2022"
"acto": {
], "codigo": "EQ050",
}, {
"descripcion": "Solicitud de registro"
"campo": "fecha_alta" },
"valoresid_boletin": [345,
"fecha_alta": "0103/0104/20222020",
"fecha_acto": "3110/0112/20222021",
] "fecha_publicacion": null,
"codigoreferencia": "BT"null,
}, "numero_acto": null,
{ "campo": "fecha_altaanulacion",: null
}
"valores": [ ]
} |
Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"01/01/2022message": <mensaje_error>,
"data": ],
"codigo": "EQ"
},
{
"campo": "id_boletin",
"valores": [
"345"
],
"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 actos 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,
"id_expediente": 6420,
"acto": {
"codigo": "520",
"descripcion": "Anotación"
},
"fecha_acto": "01/12/2021",
"fecha_publicacion": null,
"referencia": null,
"numero_acto": null,
"fecha_anulacion": null
},
{
"id": 2,
"id_expediente": 5487,
"acto": {
"codigo": "050",
"descripcion": "Solicitud de registro"
},
"id_boletin": 345,
"fecha_alta": "03/04/2020",
"fecha_acto": "10/12/2021",
"fecha_publicacion": null,
"referencia": null,
"numero_acto": null,
"fecha_anulacion": null
}
]null
} |
Facturas Recibidas
[POST] /facturas/recibidas 🏗️ (In progress)
Creación de una nueva factura recibida. Devuelve el identificador de la factura creada.
Expand |
---|
|
Petición Info |
---|
POST /facturas/recibidas
|
Request URL Code Block |
---|
http://<dominio>:<puerto>/facturas/recibidas' |
cURL Code Block |
---|
| curl --location --request POST 'http://<dominio>:<puerto>/facturas/recibidas' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>' |
| Descripción | Obligatorio | <body> | | Sí |
Body (request) Code Block |
---|
{
"empresa": <empresa>,
"numeroFactura": <numero_factura>,
"id_contacto": <id_contacto>,
"fechaFactura": <fecha_factura>,
"fechaContabilizacion": <fecha_contabilizacion>,
"pais": <pais>,
"moneda": <moneda>,
"importeHonorarios": <importe_honorarios>,
"importeTasas": <importe_tasas>
"observaciones": <observaciones>
} |
Parámetro | Descripción | Obligatorio | Tipo parámetro | Longitud máxima parámetro | Ejemplo | <empresa> | | Sí | Cadena de caracteres | 10 caracteres | 22D | <numero_factura> | Número de la factura | No | Cadena de caracteres | 30 caracteres | 578549 | | | Sí | Numérico | - | 6450 | <fecha_factura> | Fecha de la factura | No | Cadena de caracteres. | - | 30/04/2022 | <fecha_contabilizacion> | Fecha de contabilización de la factura | No | Cadena de caracteres. | - | 31/12/2022 18:00:00 | <pais> | | Sí | Cadena de caracteres | 2 caracteres | ES | <moneda> | | Sí | Cadena de caracteres | 3 caracteres | EUR | <importe_honorarios> | Importe de los honorarios | No | Numérico con decimales | Máximo 4 decimales | 100.50 | <importe_tasas> | Importe de las tasas | No | Numérico con decimales | Máximo 4 decimales | 504.22 | <observaciones> | Observaciones de la factura | No | Cadena de caracteres | - | Factura de ejemplo |
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/facturas/recibidas' |
Ejemplo de body Code Block |
---|
{
"empresa": "E1",
"numeroFactura": "12345",
"id_contacto": 17,
"fechaFactura": "03/02/2023 0:00:00",
"fechaContabilizacion": "03/02/2023 18:30:00",
"pais": "ES",
"moneda": "EUR",
"importeHonorarios": 100.10,
"importeTasas": 150.40,
"observaciones": "Factura de ejemplo"
} |
Ejemplo de cURL Code Block |
---|
| curl --location --request POST 'http://192.168.293.365:8071/facturas/recibidas' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
"empresa": "E1",
"numeroFactura": "12345",
"id_contacto": 17,
"fechaFactura": "03/02/2023 0:00:00",
"fechaContabilizacion": "03/02/2023 18:30:00",
"pais": "ES",
"moneda": "EUR",
"importeHonorarios": 100.10,
"importeTasas": 150.40,
"observaciones": "Factura de ejemplo"
}' |
Responses validaciones de campos Valor no válido para el campo ‘empresa’ Code Block |
---|
{
"statusCode": 404,
"message": "Valor 'X' no encontrado para el campo 'empresa'. [GET] /empresas para más información",
"data": null
} | Valor no válido para el campo ‘pais’ Code Block |
---|
{
"statusCode": 404,
"message": "Valor 'X' no encontrado para el campo 'pais'. [GET] /paises para más información",
"data": null
} | Valor no válido para el campo ‘moneda’ Code Block |
---|
{
"statusCode": 404,
"message": "Valor 'X' no encontrado para el campo 'moneda'. [GET] /monedas para más información",
"data": null
} | Valor no válido para el campo ‘id_contacto’ Code Block |
---|
{
"statusCode": 404,
"message": "Valor 'X' no encontrado para el campo 'Id_contacto'. [GET] /contactos/search para más información",
"data": null
} | Valor fecha no válido Code Block |
---|
{
"statusCode": 400,
"message": "Valor '30/23/2022' no tiene un formato de fecha válido para el campo 'FechaFactura'",
"data": null
} |
Responses Ha ido correctamente Code Block |
---|
{
"statusCode": 200,
"message": "Petición finalizada correctamente",
"data": 3992
} | Ha ocurrido un error Code Block |
---|
{
"statusCode": 500,
"message": <mensaje_error>,
"data": null
} |
|