Code Block
http://<dominio>:<puerto>

Parámetro	Descripción	Obligatorio	Ejemplo
<dominio>	Dominio API	Sí	192.168.293.365
<puerto>	Puerto API	Sí	8080

Estándar cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/estados' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Header	Descripción	Obligatorio	Ejemplo
<idioma>	Idioma para las descripciones	No	es
<token>	Token de acceso	Sí	`eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH`

Note
Importante: El tipo de autenticación que se utiliza en la API es JWT, y su nomenclatura es: `Bearer <token>`

...

Expand

title	Más información...

Petición

Info
`GET /filtros`

Request URL

Code Block
http://<dominio>:<puerto>/filtros

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/filtros' \
--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/filtros

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/filtros' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "EQ",
            "descripcion": "Igual que el/los valor(es)"
        },
        {
            "codigo": "BT",
            "descripcion": "Between - Resultados entre dos valores"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /

...

empresas 🆕

Descripción

Devuelve un listado con los estados las empresas disponibles.

Expand

title	Más información...

Petición

Info
`GET /estadosempresas`

Request URL

Code Block
http://<dominio>:<puerto>/estadosempresas'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/estadosempresas' \
--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/estadosempresas'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/estadosempresas' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": [ { "codigo": "AE1", "descripcion": "AltaEmpresa 1", }, "pais": { { "codigo": "BES", "descripcion": "BajaEspaña" }, ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "moneda": { "statusCodecodigo": 500"EUR", "message": <mensaje_error>, "data": null }

[GET] /idiomas/descripciones

Descripción

Devuelve un listado con los idiomas disponibles.

Expand

title	Más información...

Petición

Info
`GET /idiomas/descripciones`

Request URL

Code Block
http://<dominio>:<puerto>/idiomas/descripciones'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/idiomas/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/descripciones'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/idiomas/descripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {                "descripcion": "Moneda de los estados miembros de EMU"
            },
            "CIF": "R2788776B"
        },
        {
            "codigo": "E2",
            "descripcion": "Empresa 2",
            "pais": {
                  "codigo": "bgES",
                  "descripcion": "BúlgaroEspaña"
            },
            "moneda": {
                  "codigo": "enEUR",
                  "descripcion": "Inglés"Moneda de los estados miembros de EMU"
   },         {},
            "codigoCIF": "E0413308"es",
        },
   "descripcion": "Español"    {
    },         {"codigo": "E3",
            "codigodescripcion": "etEmpresa 3",
            "descripcionpais": {
"Estonio"         }     ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCodecodigo": 500,"ES", "messagedescripcion": <mensaje_error> "España" }, "data "moneda": null }

[GET] /modalidades

Descripción

Devuelve un listado con las modalidades disponibles.

Expand

title	Más información...

Petición

Info
`GET /modalidades`

Request URL

Code Block
http://<dominio>:<puerto>/modalidades'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/modalidades' \
--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/modalidades'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/modalidades' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,{
                  "codigo": "EUR",
                  "messagedescripcion": "PeticiónMoneda finalizadade correctamente",los estados miembros de  "data": [EMU"
        {             "codigo": "A"},
            "descripcionCIF": "Marca de la Unión EuropeaR2777776B"
        },
        {
            "codigo": "HE4",
            "descripcion": "MarcaEmpresa Internacional4",
          },  "pais": {
     {             "codigo": "PES",
                  "descripcion": "PatenteEspaña"
            },
            "moneda": {
                  "codigo": "UEUR",
                  "descripcion": "Modelo de UtilidadMoneda de los estados miembros de EMU"
            },
            "CIF": "V04182408"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /

...

estados

Descripción

Devuelve un listado con las monedas los estados disponibles.

Expand

title	Más información...

Petición

Info
`GET /monedasestados`

Request URL

Code Block
http://<dominio>:<puerto>/monedas'estados

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/monedasestados' \
--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/monedas'estados

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/monedasestados' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

json

Code Block

language

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "EURA",
            "descripcion": "Moneda de los estados miembros de EMUAlta"
        },
        {
            "codigo": "GBPB",
            "descripcion": "Libra BritánicaBaja"
        },
        ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "codigo": "USD", "descripcion": "Dólar Americano" }, ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": "message": <mensaje_error>, "data": null }

[GET] /idiomas/

...

descripciones

Descripción

Devuelve un listado con los países idiomas disponibles.

Expand

title	Más información...

Petición

Info
`GET /idiomas/paisesdescripciones`

Request URL

Code Block
http://<dominio>:<puerto>/idiomas/paisesdescripciones'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/paisesidiomas/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/paisesidiomas/descripciones'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/idiomas/paisesdescripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "ALbg",
            "descripcion": "AlbaniaBúlgaro"
        },
        {
            "codigo": "AMen",
            "descripcion": "ArmeniaInglés"
        },
        {
            "codigo": "ARes",
            "descripcion": "ArgentinaEspañol"
        },
        {
            "codigo": "ASet",
            "descripcion": "Samoa Americana (American Samoa)Estonio"
        },
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ { "statusCode": 500, "message": "codigo": "AT", "descripcion": "Austria" } ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, <mensaje_error>, "data": null }

[GET] /

...

modalidades

Descripción

Devuelve un listado con los tipos las modalidades disponibles para contactos.

Expand

title	Más información...

Petición

Info
`GET /tipos/contactosmodalidades`

Request URL

Code Block
http://<dominio>:<puerto>/tipos/contactosmodalidades'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/tipos/contactosmodalidades' \
--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/contactosmodalidades'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/contactosmodalidades' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "A",
            "descripcion": "AgenteMarca de la Unión Europea"
        },
        {
            "codigo": "BH",
            "descripcion": "AbogadoMarca Internacional"
        },
        {
            "codigo": "CP",
            "descripcion": "ClientePatente"
        },
       ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{{ "statusCode": 500, "message "codigo": "U", "descripcion": "Modelo de Utilidad" } ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /

...

monedas 🆕

Descripción

Devuelve un listado con los tipos disponibles para las descripcioneslas monedas disponibles.

Expand

title	Más información...

Petición

Info
`GET /tipos/descripcionesmonedas`

Request URL

Code Block
http://<dominio>:<puerto>/tipos/descripcionesmonedas'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/tipos/descripcionesmonedas' \
--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/descripcionesmonedas'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/descripcionesmonedas' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

language	json

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "codigo": "DTEUR",
            "descripcion": "DenominaciónMoneda de los estados miembros de EMU"
        },
        {
            "codigo": "DEGBP",
            "descripcion": "DescripciónLibra Británica"
        },
        {
            "codigo": "INUSD",
            "descripcion": "IndicaciónDólar Americano"
        },
        {
            "codigo": "RE",
            "descripcion": "Renuncia"
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "] }

Status

colour	Yellow
title	500

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 los domicilios.

Expand

title	Más información...

Petición

Info
`GET /tipos/domiciliospaises`

Request URL

Code Block
http://<dominio>:<puerto>/tipos/domiciliospaises'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/tipos/domiciliospaises' \
--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/domiciliospaises'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/domiciliospaises' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
         {
            "codigo": "AAL",
            "descripcion": "Etiqueta AlternativaAlbania"
        },
        {
            "codigo": "CAM",
            "descripcion": "Solo CorrespondenciaArmenia"
        },
        {
            "codigo": "FAR",
            "descripcion": "Solo FacturaciónArgentina"
        },
        {
            "codigo": "GAS",
            "descripcion": "GenéricoSamoa Americana (American Samoa)"
        },
       ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{{ "statusCode": 500, "messagecodigo": <mensaje"AT", "descripcion": "Austria" } ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

...

[GET] /tipos/contactos

...

Descripción

Obtiene la información de un contacto, a partir de su identificadorDevuelve un listado con los tipos disponibles para contactos.

Request URL

Expand

title	Más información...

Petición

Info
`GET /tipos/contactos/<id>`

Parámetro

Descripción

Obligatorio

Ejemplo

<id>

Identificador del contacto

Sí

6450

Code Block
http://<dominio>:<puerto>/tipos/contactos/<id>'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/tipos/contactos/<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/tipos/contactos/3992'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/contactos/3992' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": {[
        {
  "id": 1,         "codigo": "4879A",
            "tipodescripcion": {"Agente"
        },
   "codigo": "C",             "descripcion": "Cliente"
        },
        "referencia": "RF39438948",
        "estado": {
            "codigo": "AB",
            "descripcion": "AltaAbogado"
        },
        "domicilios": [
            {
                "idcodigo": 442,
   "C",
            "nombredescripcion": "JoseCliente",
        }
    ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "apellidosstatusCode": "García", 500, "domiciliomessage": "Wayna Aero"<mensaje_error>, "poblacion"data": "Valencia", "tipo": { null }

[GET] /tipos/descripciones

Descripción

Devuelve un listado con los tipos disponibles para las descripciones.

Expand

title	Más información...

Petición

Info
`GET /tipos/descripciones`

Request URL

Code Block
http://<dominio>:<puerto>/tipos/descripciones'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/tipos/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/tipos/descripciones'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/descripciones' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "codigomessage": "GPetición finalizada correctamente",
    "data": [
        {
            "descripcioncodigo": "GenéricoDT",
            "descripcion": "Denominación"
  }      },
      }  {
      ],         "titularescodigo": ["DE",
            {
"descripcion": "Descripción"
        },
      "id": 1,    {
            "nombrecodigo": null"IN",
                "apellidosdescripcion": "Empresa S.A.Indicación"
            },
            {
   
            "idcodigo": 2"RE",
                "nombre": "Juan","descripcion": "Renuncia"
                "apellidos": "Gómez"
            }        
   
    ]      
    }
}

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[

...

GET] /tipos/

...

domicilios

Descripción

Creación de un nuevo contacto. Devuelve el identificador del contacto creado o existenteDevuelve un listado con los tipos disponibles para los domicilios.

Body (request)

Expand

title	Más información...

Petición

Info
`POST GET /tipos/contactosdomicilios`

Request URL

Code Block
http://<dominio>:<puerto>/tipos/contactosdomicilios'

cURL

Code Block

language	json

curl --location --request POSTGET 'http://<dominio>:<puerto>/contactostipos/domicilios' \
--header 'Authorization: Bearer <token>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/domicilios'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/tipos/domicilios' \
--header 'Contentaccept-Typelanguage: application/jsones' \
--data-rawheader '<body>Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Header

Responses

Descripción

Status

Obligatorio

colour

<body>

Información del contacto que queremos crear

Sí

Green
title	200

Ha ido correctamente

Code Block
{ "codigostatusCode": <codigo>200, "tipomessage": <tipo>"Petición finalizada correctamente", "estadodata": <estado> }

Parámetro

Descripción

Obligatorio

Tipo parámetro

Longitud máxima parámetro

Ejemplo

<codigo>

Código del contacto

Sí

Cadena de caracteres

10 caracteres

58634

<tipo>

Tipo del contacto. Consultar petición [GET] /tipos/contactos para más información

Sí

Cadena de caracteres

Único carácter

C

<estado>

Estado del contacto. Consultar petición [GET] /estados para más información

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": "58634A", "tipo": "C", "estado": "B" }

Ejemplo de cURL

Code Block

language	json

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

Status

colour	Purple
title	400

Valor no válido para el campo ‘tipo’

Code Block

{
    "statusCode": 400,    "descripcion": "Etiqueta Alternativa"
        },
        {
            "codigo": "C",
            "messagedescripcion": "Valor 'X' no válido para el campo 'tipo'. [GET]  /tipos/contactos para más información",Solo Correspondencia"
        },
       "data": null
}

Status

colour	Purple
title	400

Valor no válido para el campo ‘estado’

Code Block
{ { "statusCodecodigo": 400,"F", "messagedescripcion": "Valor 'X' no válido para el campo 'estado'. [GET] /estados para más información",Solo Facturación" }, "data": null }

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "messagecodigo": "Petición finalizada correctamenteG", "data": 3992 }

Status

colour	Purple
title	409

Ya existe el contacto que está intentando crear

Code Block
{ "statusCodedescripcion": 409, "messageGenérico": "Ya existe el contacto que está intentando crear", } "data": 3992] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

Contactos

[

...

GET] /contactos/

...

{id}

Descripción

Búsqueda de contactos con filtros. Devuelve un listado con los contactos que cumplen los filtros de búsquedaObtiene la información de un contacto, a partir de su identificador.

Expand

title	Más información...

Petición

Info
`POST GET /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

<id>

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto	Sí	6450

Request URL

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

<id>'

cURL

Code Block

language	json

curl --location --request POSTGET 'http://<dominio>:<puerto>/contactos/search<id>' \
--header 'Authorizationaccept-language: Bearer <token><idioma>' \
--header 'Content-TypeAuthorization: application/json' \
--data-raw '<body>'

cURL con opciones de paginación

Code Block

language	json

curlBearer <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

language	json

curl --location --request POSTGET 'http://<dominio>:<puerto>192.168.293.365:8071/contactos/search?PageSize=<size>&PageNumber=<number>3992' \
--header 'Authorizationaccept-language: Bearer <token>es' \
--header 'Content-TypeAuthorization: application/json' \
--data-raw '<body>'

Header

Descripción

Obligatorio

<body>

Conjunto de filtros a aplicar sobre la búsqueda

No

Body (request)

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "domiciliosstatusCode": [200,
    {
  "message": "Petición finalizada correctamente",
    "campodata": {
<campo>,        "valoresid": <valores>1,
        "codigo": <filtro>
 "4879",
  }   ],   "titularestipo": [{
     {       "campocodigo": <campo>"C",,
      "valores": <valores>,     "descripcion":  "codigoCliente":
<filtro>     }   ]},
  "generales": [     {"referencia": "RF39438948",
        "campoestado": <campo>, {
            "valorescodigo": <valores>,"A",
            "codigodescripcion": <filtro>"Alta"
    }   ] }

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 titulares

Sí

Cadena de caracteres

<valores>

Lista de valores

Sí

Lista de valores

<filtro>

Tipo de filtro a aplicar. Consultar petición [GET] /filtros para más información

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": [
    {
      "campo": "apellidos",,
        "domicilios": [
            {
                "id": 442,
                "nombre": "Jose",
       "valores": [        "apellidos": "García",
        ],        "codigodomicilio": "EQWayna Aero",
    }   ],   "titulares": [     {
      "campo"poblacion": "apellidosValencia",
      "valores": [         "S.A.tipo": {
             ],       "codigo": "EQG",
      }           ],   "generalesdescripcion": "Genérico"
 [     {       "campo": "codigo",  }
    "valores": [       }
 "424"       ],
        "codigotitulares": "EQ" [
       },     {
      "campo": "tipo",          "valoresid": [1,
        "C",         "A"nombre": null,
         ],       "codigoapellidos": "EQEmpresa S.A."
            },
            {
                "campoid": "referencia"2,
      "valores": [         "RF239348""nombre": "Juan",
      ],          "codigoapellidos": "EQ"Gómez"
            }      ] }

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”

Filtro sobre el código de contacto

No

Cadena de caracteres

“tipo”

Filtro sobre el tipo de contacto

No

Cadena de caracteres

“referencia”

Filtro sobre la referencia del contacto

No

Cadena de caracteres

Ejemplo de cURL

Code Block

language	json

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": [     }
}

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "campostatusCode": "apellidos"404, "valoresmessage": ["No se ha encontrado el contacto", "Garcíadata": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ ], "statusCode": 500, "codigomessage": "EQ" } ]<mensaje_error>, "titularesdata": null }

[POST] /contactos

Descripción

Creación de un nuevo contacto. Devuelve el identificador del contacto creado o existente

Ejemplo headers responses

Expand

title	Más información...

Petición

Info
`POST /contactos`

Request URL

Code Block
http://<dominio>:<puerto>/contactos'

cURL

Code Block

language	json

curl --location --request POST  {
      "campo": "apellidos",
      "valores": [
        "S.A."
      ],
      "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "codigo",
      "valores": [
        "424"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "tipo",
      "valores": [
        "C",
        "A"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referencia",
      "valores": [
        "RF239348"
      ],
      "codigo": "EQ"
    }
  ]
}'

Ejemplo de cURL con opciones de paginación

'http://<dominio>:<puerto>/contactos' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del contacto que queremos crear	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>	Código del contacto	Sí	Cadena de caracteres	10 caracteres	58634
<tipo>	Tipo del contacto. Consultar petición [GET] /tipos/contactos para más información	Sí	Cadena de caracteres	Único carácter	C
<estado>	Estado del contacto. Consultar petición [GET] /estados para más información	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

language	json

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 '{
  "domicilioscodigo": [
    {
   "58634",
  "campotipo": "apellidosC",
      "valoresestado": [
   "B"
}'

Responses validaciones de campos

Status

colour	Purple
title	400

Valor no válido para el campo ‘tipo’

Code Block
{ "GarcíastatusCode" ], : 400, "codigomessage": "EQ"Valor 'X' no válido para }el campo 'tipo'. ], "titulares": [[GET] /tipos/contactos para más información", "data": null }

Status

colour	Purple
title	400

Valor no válido para el campo ‘estado’

Code Block
{ "campostatusCode": "apellidos"400, "valoresmessage": ["Valor 'X' no válido para el "S.A." ]campo 'estado'. [GET] /estados para más información", "codigodata": "EQ" } ], "generales": [ { null }

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "campostatusCode": "codigo"200, "valoresmessage": ["Petición "424" ], finalizada correctamente", "codigodata": "EQ" }, 3992 }

Status

colour	Purple
title	409

Ya existe el contacto que está intentando crear

Code Block
{ "campostatusCode": "tipo"409, "valoresmessage": ["Ya existe el contacto que está intentando "Ccrear", "Adata": 3992 }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ ]"statusCode": 500, "message": <mensaje_error>, "codigodata": "EQ" }, { "campo": "referencia", "valores": [ "RF239348" ], "codigo": "EQ" } ] }'

Responses validaciones de campos

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

Valor no válido para el campo ‘campo’

Code Block
{ "statusCode": 400, "message": "Campo 'X' no contemplado", "data": null }

Status

colour	Purple
title	400

Lista de valores vacía

Code Block
{ "statusCode": 400, "message": "Se deben informar valores para el tipo de filtro 'EQ'", "data": null }

Status

colour	Purple
title	400

Lista de ‘valores’ con valor vacío

Code Block
{ "statusCode": 400, "message": "El valor no puede ser nulo", "data": null }

Status

colour	Purple
title	400

Filtro ‘Between’ con más de dos valores

Code Block
{ "statusCode": 400, "message": "El filtro 'BT' tiene que tener únicamente dos valores", "data": null }

Headers responses

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 contactos 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

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": [ { "id": 1, "codigo": "4879", "tipo": { "codigo": "C", "descripcion": "Cliente" }, "referencia": "RF39438948null }

[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

title	Más información...

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

language	json

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

language	json

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>'

Header	Descripción	Obligatorio
<body>	Conjunto de filtros a aplicar sobre la búsqueda	No

Body (request)

Code Block

{
  "domicilios": [
    {
      "campo": <campo>,
      "valores": <valores>,
      "codigo": <filtro>
    }
  ],
  "titulares": [
    {
      "campo": <campo>,,
      "valores": <valores>,
      "codigo": <filtro>
    }
  ],
  "generales": [
    {
      "campo": <campo>,
      "valores": <valores>,
      "codigo": <filtro>
    }
  ]
}

Parámetro	Descripción	Obligatorio	Tipo parámetro
<campo>	Campo por el que se va a aplicar el filtro dentro del bloque al que corresponde. En este caso, sobre contactos, domicilios o titulares	Sí	Cadena de caracteres
<valores>	Lista de valores	Sí	Lista de valores
<filtro>	Tipo de filtro a aplicar. Consultar petición [GET] /filtros para más información	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": [
    {
      "campo": "apellidos",
      "valores": [
        "García"
      ],
      "codigo": "EQ"
    }
  ],
  "titulares": [
    {
      "campo": "apellidos",
      "estadovalores": {[
        "codigo": "B",
 S.A."
      ],
      "descripcioncodigo": "BajaEQ"
      },
   ],
  "domiciliosgenerales": [
    {
   {   "campo": "codigo",
      "idvalores": 4,[
        "424"
 "nombre": "María",    ],
      "apellidoscodigo": "García"EQ"
    },
    {
      "domiciliocampo": "Calle Los Arenales",
  "tipo",
      "valores": [
       "poblacion": "ValenciaC",
 
        "tipoA":
{      ],
      "codigo": "G"EQ"
    },
    {
       "descripcioncampo": "Genéricoreferencia",
      "valores": [
  }      "RF239348"
  }       ],
      "titularescodigo": ["EQ"
    }
   {
           "id": 1,
           "nombre": null,
    ]
}

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”	Filtro sobre el código de contacto	No	Cadena de caracteres
“tipo”	Filtro sobre el tipo de contacto	No	Cadena de caracteres
“referencia”	Filtro sobre la referencia del contacto	No	Cadena de caracteres

Ejemplo de cURL

Code Block

language	json

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": [
    {
      "apellidoscampo": "Empresa S.A."apellidos",
      "valores": [
 },       "García"
 {     ],
      "idcodigo": 2,"EQ"
    }
   ],
  "nombretitulares": "Juan",[
    {
       "apellidoscampo": "Gómezapellidos",
      "valores": [
}        "S.A."
      ],
      "codigo": "EQ"
    },
  ],
 { "generales": [
    "id": 2,{
       "codigocampo": "68798codigo",
      "tipovalores": {[
        "codigo": "A",
 424"
      ],
      "descripcioncodigo": "AgenteEQ"
    },
 },   {
      "referenciacampo": "DG29849348tipo",
      "estadovalores": {[
        "codigoC": "A",
        "descripcionA":
"Alta"       }],
      "domicilioscodigo": [],"EQ"
    },
 "titulares": []  {
  }   ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "campo": "referencia", "statusCodevalores": 500, [ "message": <mensaje_error>RF239348" ], "datacodigo": null"EQ" }

[GET] /contactos/{id}/domicilios

Descripción

Obtiene los domicilios de un contacto.

Request URL

Expand

title	Más información...

Petición

Info
`GET /contactos/<id>/domicilios`

Parámetro

Descripción

Obligatorio

Ejemplo

<id>

Identificador del contacto

Sí

6450

Code Block
http://<dominio>:<puerto>/contactos/<id>/domicilios'

cURL


  ]
}'

Ejemplo de cURL con opciones de paginación

Code Block

language	json

curl --location --request GETPOST 'http://<dominio>:<puerto>/contactos/<id>/domicilios' \
--header 'accept-language: <idioma>'192.168.293.365:8071/contactos/search?PageSize=10&PageNumber=2' \
--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

language	json

curl --location --request GET 'http://192.168.293.365:8071/contactos/3992/domicilioseyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{data-raw '{
  "domicilios": [
    {
"statusCode": 200,     "messagecampo": "Peticiónapellidos",
finalizada correctamente",     "datavalores": [
        {"García"
      ],
      "idcodigo": 1,"EQ"
    }
  ],
    "nombre"titulares": "Natalia",[
    {
       "apellidoscampo": "Garcíaapellidos",
      "valores": [
    "domicilio": "Wayna Aero",    "S.A."
      ],
      "poblacioncodigo": "ValenciaEQ",
    }
    ],
  "tipogenerales": {[
     {
          "codigocampo": "Acodigo",
      "valores": [
        "descripcion424":
"Etiqueta Alternativa"     ],
       }"codigo": "EQ"
        },
    {
   {     "campo": "tipo",
       "idvalores": 2,[
            "nombreC": "María",
            "apellidosA":
"Fernandez",      ],
      "domiciliocodigo": "Yedra Centro"EQ"
    },
     {
      "poblacioncampo": "Madridreferencia",
      "valores": [
    "tipo": {   "RF239348"
      ],
      "codigo": "GEQ",
    }
           "descripcion": "Genérico"]
}'

Responses validaciones de campos

Status

colour	Purple
title	400

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 } ] }

Status

colour	Purple
title	404

No se ha encontrado el contacto

400

Valor no válido para el campo ‘campo’

Code Block
{ "statusCode": 404400, "message": "NoCampo se'X' ha encontrado el contactono contemplado", "data": null }

Status

colour	YellowPurple
title	500

Ha ocurrido un error

400

Lista de valores vacía

Code Block
{ "statusCode": 500400, "message": <mensaje_error>, "Se deben informar valores para el tipo de filtro 'EQ'", "data": null }

[POST] /contactos/{id}/domicilios

Descripción

Creación de un nuevo domicilio asociado a un contacto. Devuelve el identificador del domicilio creado o existente.

...

title	Más información...

Petición

Info
`POST /contactos/<id>/domicilios`

...

Parámetro

...

Descripción

...

Obligatorio

...

Ejemplo

...

<id>

...

Identificador del contacto

...

Sí

...

6450

Request URL

Code Block
http://<dominio>:<puerto>/contactos/<id>/domicilios'

cURL

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/contactos/<id>/domicilios' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

...

Header

...

Descripción

...

Obligatorio

...

<body>

...

Información del domicilio que queremos crear

...

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>

...

Tipo del domicilio. Consultar petición [GET] /tipos/domicilios para más información

...

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

language	json

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

Status

colour	Purple
title	400

Valor no válido para el campo ‘tipo’

Code Block
{ "statusCode": 400, "message": "Valor 'X' no válido para el campo 'tipo'. [GET] /tipos/domicilios para más información", "data": null }

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": 3992 }

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Purple
title	409

Ya existe el domicilio que está intentando crear

Code Block
{ "statusCode": 409, "message": "Ya existe el domicilio que está intentando crear", "data": 3992 }

Status

colour	Yellow
title	500

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.

Request URL

Expand

title	Más información...

Petición

Info
`PUT /contactos/<id>/domicilios/<idDomicilio>`

Parámetro

Descripción

Obligatorio

Ejemplo

<id>

Identificador del contacto

Sí

6450

<idDomicilio>

Identificador del domicilio a modificar

Sí

450

Code Block
http://<dominio>:<puerto>/contactos/<id>/domicilios/<idDomicilio>'

cURL

Code Block

language	json

curl --location --request PUT 'http://<dominio>:<puerto>/contactos/<id>/domicilios/<idDomicilio>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header

Descripción

Obligatorio

<body>

Información del domicilio que queremos actualizar

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

language	json

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

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": null }

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Purple
title	404

No se ha encontrado el domicilio

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el domicilio", "data": null }

Status

colour	Purple
title	409

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 }

Status

colour	Purple
title	409

Ya existe un domicilio con esas características para ese contacto

Code Block
{ "statusCode": 409, "message": "Ya existe un domicilio con esas características para ese contacto", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block{ "statusCode": 500, "message": <mensaje_error>, "data":

Status

colour	Purple
title	400

Lista de ‘valores’ con valor vacío

Code Block
{ "statusCode": 400, "message": "El valor no puede ser nulo", "data": null }

Status

colour	Purple
title	400

Filtro ‘Between’ con más de dos valores

Code Block
{ "statusCode": 400, "message": "El filtro 'BT' tiene que tener únicamente dos valores", "data": null }

Headers responses

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 contactos 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

Ejemplo headers responses

Code Block
{"TotalCount":2432,"PageSize":10,"CurrentPage":1,"TotalPages":244,"HasNextPage":true,"HasPreviousPage":false,"NextPageUrl":"","PreviousPageUrl":""}

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "codigo": "4879",
      "tipo": {
        "codigo": "C",
        "descripcion": "Cliente"
      },
      "referencia": "RF39438948",
      "estado": {
        "codigo": "B",
        "descripcion": "Baja"
      },
      "domicilios": [
        {
          "id": 4,
          "nombre": "María",
          "apellidos": "García",
          "domicilio": "Calle Los Arenales",
          "poblacion": "Valencia",
          "tipo": {
            "codigo": "G",
            "descripcion": "Genérico"
          }
        }
      ],
      "titulares": [
        {
           "id": 1,
           "nombre": null,
           "apellidos": "Empresa S.A."
        },
        {
           "id": 2,
           "nombre": "Juan",
            "apellidos": "Gómez"
        }        
      ]      
    },
    {
      "id": 2,
      "codigo": "68798",
      "tipo": {
        "codigo": "A",
        "descripcion": "Agente"
      },
      "referencia": "DG29849348",
      "estado": {
        "codigo": "A",
        "descripcion": "Alta"
      },
      "domicilios": [],
      "titulares": []
    }
  ]
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /contactos/{id}/

...

domicilios

Descripción

Obtiene los titulares domicilios de un clientecontacto.

Expand

title	Más información...

Petición

Info
`GET /contactos/<id>/titularesdomicilios`

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto

de tipo cliente

Sí

6450

Request URL

Code Block
http://<dominio>:<puerto>/contactos/<id>/titularesdomicilios'

cURL

Code Block

language	json

curl --location --request GET 'http://<dominio>:<puerto>/contactos/<id>/titularesdomicilios' \
--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/titularesdomicilios'

Ejemplo de cURL

Code Block

language	json

curl --location --request GET 'http://192.168.293.365:8071/contactos/3992/titularesdomicilios' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
            "id": 1,
            "nombre": "Natalia",
            "apellidos": "García",
        },    "domicilio": "Wayna Aero",
  {          "poblacion": "Valencia",
    "id        "tipo": 2,{
                "nombrecodigo": null,"A",
                "apellidosdescripcion": "LU S.A."Etiqueta Alternativa"
            }
      ]
}

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ }, { "statusCodeid": 4042, "messagenombre": "No se ha encontrado el contacto",María", "dataapellidos": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "Fernandez", "statusCodedomicilio": 500,"Yedra Centro", "message": <mensaje_error>, "datapoblacion": null }

[POST] /contactos/{id}/titulares

Descripción

Creación de un titular a un cliente en concreto. Devuelve el identificador del titular creado o existente.

Request URL

Expand

title	Más información...

Petición

Info
`POST /contactos/<id>/titulares`

Parámetro

Descripción

Obligatorio

Ejemplo

<id>

Identificador del contacto de tipo cliente

Sí

6450

Code Block
http://<dominio>:<puerto>/contactos/<id>/titulares'

cURL

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/contactos/<id>/titulares' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header

Descripción

Obligatorio

<body>

Información del titular que queremos crear

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

"Madrid",
            "tipo": {
                "codigo": "G",
                "descripcion": "Genérico"
            }
        }
    ]
}

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[POST] /contactos/{id}/domicilios

Descripción

Creación de un nuevo domicilio asociado a un contacto. Devuelve el identificador del domicilio creado o existente.

Expand

title	Más información...

Petición

Info
`POST /contactos/<id>/domicilios`

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto	Sí	6450

Request URL

Code Block
http://192.168.293.365:8071<dominio>:<puerto>/contactos/<id>/titularesdomicilios'

Ejemplo de body

cURL

Code Block

language	json

{curl --location  "nombre": "Juan",
  "apellidos": "García Fernández"
}

Ejemplo de cURL

Code Block

language	json

curl --location --request POST 'http://192.168.293.365:8071/contactos/6450/titulares--request POST 'http://<dominio>:<puerto>/contactos/<id>/domicilios' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH<token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "nombre": "Juan",
  "apellidos": "García Fernández"
}'

Responses validaciones de campos

Status

colour	Purple
title	400

El contacto no es un cliente

<body>'

Header	Descripción	Obligatorio
<body>	Información del domicilio que queremos crear	Sí

Body (request)

Code Block
{ "statusCodeapellidos": 400<apellidos>, "messagetipo": "El contacto 'X' no es un cliente", "data": null }

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": 3992 }

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }<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>	Tipo del domicilio. Consultar petición [GET] /tipos/domicilios para más información	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

language	json

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

Status

colour	Purple
title	409

Ya existe la relación que está intentando crear

400

Valor no válido para el campo ‘tipo’

Code Block
{ "statusCode": 409400, "message": "YaValor existe'X' elno titularválido para el contactocampo 'X'tipo'. [GET] /tipos/domicilios para más información", "data": 3992null }

Responses

Status

colour	YellowGreen
title	500200

Ha ocurrido un errorido correctamente

Code Block
{ "statusCode": 500200, "message": <mensaje_error>"Petición finalizada correctamente", "data": null3992 }

Expedientes

[GET] /expedientes/{id}

Descripción

Obtiene la información de un expediente a partir de su identificador.

Request URL

Expand

title	Más información...

Petición

Info
`GET /expedientes/<id>`

Parámetro

Descripción

Obligatorio

Ejemplo

<id>

Identificador del expediente

Sí

6450

Code Block
http://<dominio>:<puerto>/expedientes/<id>'

cURL

Code Block

language	json

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

language	json

curl --location --request GET 'http://192.168.293.365:8071/expedientes/3992' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block{ "statusCode": 200, "message": "Petición finalizada correctamente",

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Purple
title	409

Ya existe el domicilio que está intentando crear

Code Block
{ "statusCode": 409, "message": "Ya existe el domicilio que está intentando crear", "data": 3992 }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block

{
  "statusCode": 500,
  "message": <mensaje_error>,
  "data": null
{
        "id": 1,
        "estado": {
            "codigo": "B",
            "descripcion": "Baja"
        },
        "modalidad": {
            "codigo": "M",
            "descripcion": "Marca Nacional"
        },      
        "numero": "4123111",
        "pais": {
            "codigo": "ES",
            "descripcion": "España"
        },
        "bis": "4",    
        "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}

[PUT] /contactos/{id}/domicilios/{idDomicilio}

Descripción

Modificación de un domicilio asociado a un contacto.

Expand

title	Más información...

Petición

Info
`PUT /contactos/<id>/domicilios/<idDomicilio>`

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto	Sí	6450
<idDomicilio>	Identificador del domicilio a modificar	Sí	450

Request URL

Code Block
http://<dominio>:<puerto>/contactos/<id>/domicilios/<idDomicilio>'

cURL

Code Block

language	json

curl --location --request PUT 'http://<dominio>:<puerto>/contactos/<id>/domicilios/<idDomicilio>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del domicilio que queremos actualizar	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

language	json

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

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": null }

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Purple
title	404

No se ha encontrado el domicilio

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el domicilio", "data": null }

Status

colour	Purple
title	409

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 }

Status

colour	Purple
title	409

Ya existe un domicilio con esas características para ese contacto

Code Block
{ "statusCode": 409, "message": "Ya existe un domicilio con esas características para ese contacto", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[GET] /contactos/{id}/titulares

Descripción

Obtiene los titulares de un cliente.

Expand

title	Más información...

Petición

Info
`GET /contactos/<id>/titulares`

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del contacto de tipo cliente	Sí	6450

Request URL

Code Block
http://<dominio>:<puerto>/contactos/<id>/titulares'

cURL

Code Block

language	json

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

language	json

curl --location --request GET 'http://192.168.293.365:8071/contactos/3992/titulares' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

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ómez"
   LU S.A."
        }
       
        ]
    }
}

Status

colour

]
}

Status

colour	Purple
title	404

No se ha encontrado el expedientecontacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el expedientecontacto", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[

...

POST] /

...

contactos/{id}/titulares

Descripción

Modificación Creación de un expedienteun titular a un cliente en concreto. Devuelve el identificador del titular creado o existente.

Expand

title	Más información...

Petición

Info
`PUT POST /expedientescontactos/<id>/titulares`

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del

expediente

contacto de tipo cliente

Sí

6450

Request URL

Code Block
http://<dominio>:<puerto>/expedientescontactos/<id>/titulares'

cURL

Code Block

language	json

curl --location --request PUTPOST 'http://<dominio>:<puerto>/expedientescontactos/<id>/titulares' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del

expediente

titular que queremos

modificar

crear

Sí

Body (request)

Code Block
{ "estadonombre": <estado><nombre>, "descripcionesapellidos": [ { "tipo": <tipo_descripcion>, "descripcion": <descripcion>, "idioma": <idioma_descripcion> } ]<apellidos> }

Parámetro

Descripción

Obligatorio

Tipo parámetro

Longitud máxima parámetro

Ejemplo

<nombre>

Estado del expediente. Consultar petición [GET] /estados para más información

Nombre del titular

No

Cadena de caracteres

Único carácter

50 caracteres

B

Juan

“descripciones”

Bloque opcional para las denominaciones

No

<tipo_descripcion>

Tipo de descripción. Consultar petición [GET] /tipos/descripciones para más información

Sí

Cadena de caracteres

2 caracteres

DE

<descripcion>

Descripción

No

Cadena de caracteres. Si se informa a vacío (““), se eliminará la descripción.

Culture

<idioma_descripcion>

Idioma de la descripción. Consultar petición [GET] /idiomas/descripciones para más información

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

<apellidos>

Apellidos del titular

Sí

Cadena de caracteres

250 caracteres

García Fernández

Note

¡Importante!

Al ser una petición PUTPOST, 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/expedientes<id>/6450titulares'

Ejemplo de body

Code Block
{ "estadonombre": "BJuan", "descripcionesapellidos": ["García Fernández" }

Ejemplo de cURL

Code Block

language	json

curl --location --request {
      "tipo": "DE",
      "descripcion": "Culture",
      "idioma": "es"
    }
  ]
}

Ejemplo de cURL

Code Block

language	json

curl --location --request PUT 'http:POST 'http://192.168.293.365:8071/expedientescontactos/6450/titulares' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "estadonombre": "BJuan",
  "descripcionesapellidos": [
    {
      "tipo": "DE",
      "descripcion": "Culture",
      "idioma": "es"
    }
  ]
}"García Fernández"
}'

Responses validaciones de campos

Status

colour	Purple
title	400

Valor no válido para el campo ‘estado’ El contacto no es un cliente

Code Block
{ "statusCode": 400, "message": "ValorEl contacto 'X' no es válidoun paracliente", el campo 'estado'. [GET] /estados para más información", "data": null }

Responses

control descripciones

Status

colour	PurpleGreen
title	400

Valor no válido para el campo ‘idioma’

200

Ha ido correctamente

Code Block
{ "statusCode": 400200, "message": "ValorPetición 'X' no válido para el campo 'idioma'. [GET] /idiomas/descripciones para más informaciónfinalizada correctamente", "data": null3992 }

Status

colour	Purple
title	400

Valor no válido para el campo ‘tipo’

404

No se ha encontrado el contacto

Code Block
{ "statusCode": 400404, "message": "ValorNo 'X'se noha válidoencontrado para el campo 'tipo'. [GET] /tipos/descripciones para más informacióncontacto", "data": null }

Status

colour	Purple
title	400

Claves duplicadas en la lista de descripciones

409

Ya existe la relación que está intentando crear

Code Block
{ "statusCode": 400409, "message": "DescripcionesYa duplicadas.existe Claveel duplicadatitular {para Elementoel = { Tipo = DE, Idioma = es }, Ocurrencias = 2 }", "data": null }

Status

colour	Purple
title	400

Incluir varias denominaciones para modalidades distintas de patentes

contacto 'X'",
    "data": 3992
}

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 400500, "message": "Este tipo de modalidad no permite guardar varias denominaciones", <mensaje_error>, "data": null }

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": null }

Status

colour	Purple
title	404

No se ha encontrado el expediente

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el expediente", "data": null }

Status

colour	Yellow
title	500

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

title	Más información...

Petición

Info
`POST /expedientes`

Request URL

Code Block
http:/

Expedientes

[GET] /expedientes/{id}

Descripción

Obtiene la información de un expediente a partir de su identificador.

Body (request)

Expand

title	Más información...

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

language	json

curl --location --request POSTGET 'http://<dominio>:<puerto>/expedientes/<id>' \
--header 'Authorizationaccept-language: Bearer <token><idioma>' \
--header 'Content-TypeAuthorization: application/json' \
--data-raw '<body>'

Header

Descripción

Obligatorio

<body>

Información del expediente que queremos crear

Sí

Code Block
{ "id_contacto": <id_contacto>, "estado": <estado>, "modalidad": <modalidad>, "numero": <numero>, "pais": <pais>, "bis": <bis>, "referencia": <referencia>, "descripciones": [ {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

language	json

curl --location --request GET 'http://192.168.293.365:8071/expedientes/3992' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": {
        "tipoid": <tipo_descripcion>1,
        "estado": {
            "codigo": "B",
            "descripcion": "Baja"
        },
        "modalidad": {
            "codigo": <descripcion>,"M",
            "idiomadescripcion": <idioma_descripcion>"Marca Nacional"
        },      
        ],"numero": "4123111",
        "titularespais": {
[     {       "idcodigo": <titular>"ES",
            "descripcion": "España"
}    ]   ]
}

Parámetro

Descripción

Obligatorio

Tipo parámetro

Longitud máxima parámetro

Ejemplo

<id_contacto>

Identificador del contacto al que pertenece el expediente

Sí

Numérico

6450

<estado>

Estado del expediente. Consultar petición [GET] /estados para más información

No

Cadena de caracteres

Único carácter

B

<modalidad>

Modalidad del expediente. Consultar petición [GET] /modalidades para más información

No

Cadena de caracteres

10 caracteres

M

<numero>

Número del expediente

Sí

Cadena de caracteres

30 caracteres

578549

<pais>

País del expediente. Consultar petición [GET] /países para más información

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>

Tipo de descripción. Consultar petición [GET] /tipos/descripciones para más información

Sí

Cadena de caracteres

2 caracteres

DE

<descripcion>

Descripción

No

Cadena de caracteres

Culture

<idioma_descripcion>

Idioma de la descripción. Consultar petición [GET] /idiomas/descripciones para más información

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

language	json

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

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

Valor no válido para el campo ‘pais’

Code Block
{ "statusCode": 400, "message": "Valor 'X' no válido para el campo 'pais'. [GET] /paises para más información", "data": null }

Status

colour	Purple
title	400

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

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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

Status

colour	Purple
title	400

Titular no existente

Code Block
{ "statusCode": 400, "message": "No existe el titular 'X'", "data": null }

Status

colour	Purple
title	400

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

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": 3992 }

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Purple
title	409

Ya existe el expediente que está intentando crear

Code Block
{ "statusCode": 409, "message": "Ya existe el expediente que está intentando crear", "data": 3992 }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "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.

cURL

Expand

title	Más información...

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

Code Block

language	json

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

 },
        "bis": "4",    
        "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"
            }        
        ]
    }
}

Status

colour	Purple
title	404

No se ha encontrado el expediente

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el expediente", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": null }

[PUT] /expedientes/{id}

Descripción

Modificación de un expediente.

Expand

title	Más información...

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

language	json

curl --location --request PUT 'http://<dominio>:<puerto>/expedientes/<id>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del expediente que queremos modificar	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>	Estado del expediente. Consultar petición [GET] /estados para más información	No	Cadena de caracteres	Único carácter	B
“descripciones”	Bloque opcional para las denominaciones	No
<tipo_descripcion>	Tipo de descripción. Consultar petición [GET] /tipos/descripciones para más información	Sí	Cadena de caracteres	2 caracteres	DE
<descripcion>	Descripción	No	Cadena de caracteres. Si se informa a vacío (““), se eliminará la descripción.		Culture
<idioma_descripcion>	Idioma de la descripción. Consultar petición [GET] /idiomas/descripciones para más información	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

language	json

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

Status

colour	Purple
title	400

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

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": null }

Status

colour	Purple
title	404

No se ha encontrado el expediente

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el expediente", "data": null }

Status

colour	Yellow
title	500

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

title	Más información...

Petición

Info
`POST /expedientes`

Request URL

Code Block
http://<dominio>:<puerto>/expedientes'

cURL

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/expedientes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del expediente que queremos crear	Sí

Body (request)

Code Block

{
  "id_contacto": <id_contacto>,
  "estado": <estado>,
  "modalidad": <modalidad>,
  "numero": <numero>,
  "pais": <pais>,
  "bis": <bis>,
  "referencia": <referencia>,
  "descripciones": [
    {
      "tipo": <tipo_descripcion>,
      "descripcion": <descripcion>,
      "idioma": <idioma_descripcion>
    }
  ],
  "titulares": [
    {
      "id": <titular>
    }
   ]
  ]
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<id_contacto>	Identificador del contacto al que pertenece el expediente	Sí	Numérico		6450
<estado>	Estado del expediente. Consultar petición [GET] /estados para más información	No	Cadena de caracteres	Único carácter	B
<modalidad>	Modalidad del expediente. Consultar petición [GET] /modalidades para más información	No	Cadena de caracteres	10 caracteres	M
<numero>	Número del expediente	Sí	Cadena de caracteres	30 caracteres	578549
<pais>	País del expediente. Consultar petición [GET] /países para más información	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>	Tipo de descripción. Consultar petición [GET] /tipos/descripciones para más información	Sí	Cadena de caracteres	2 caracteres	DE
<descripcion>	Descripción	No	Cadena de caracteres		Culture
<idioma_descripcion>	Idioma de la descripción. Consultar petición [GET] /idiomas/descripciones para más información	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

language	json

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

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

Valor no válido para el campo ‘pais’

Code Block
{ "statusCode": 400, "message": "Valor 'X' no válido para el campo 'pais'. [GET] /paises para más información", "data": null }

Status

colour	Purple
title	400

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

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

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

Status

colour	Purple
title	400

Titular no existente

Code Block
{ "statusCode": 400, "message": "No existe el titular 'X'", "data": null }

Status

colour	Purple
title	400

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

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "statusCode": 200, "message": "Petición finalizada correctamente", "data": 3992 }

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": 404, "message": "No se ha encontrado el contacto", "data": null }

Status

colour	Purple
title	409

Ya existe el expediente que está intentando crear

Code Block
{ "statusCode": 409, "message": "Ya existe el expediente que está intentando crear", "data": 3992 }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "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.

Body (request)

Expand

title	Más información...

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

language	json

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

language	json

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>'

Header	Descripción	Obligatorio
<body>	Conjunto de filtros a aplicar sobre la búsqueda	No

Body (request)

Code Block
{ "titulares": [ { "campo": <campo>, "valores": <valores>, "codigo": <filtro> } ], "generales": [ { "campo": <campo>, "valores": <valores>, "codigo": <filtro> } ] }

Parámetro	Descripción	Obligatorio	Tipo parámetro
<campo>	Campo por el que se va a aplicar el filtro, dentro del bloque al que corresponde. En este caso, sobre expedientes o titulares de los expedientes	Sí	Cadena de caracteres
<valores>	Lista de valores	Sí	Lista de valores
<filtro>	Tipo de filtro a aplicar. Consultar petición [GET] /filtros para más información	Sí	Cadena de caracteres

Note

¡Importante!

Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json.

No olvidar el token

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/expedientes/search'

Ejemplo de request URL con opciones de paginación

Code Block
http://192.168.293.365:8071/expedientes/search?PageSize=10&PageNumber=2'

Ejemplo de body

Code Block

{
  "titulares": [
    {
      "campo": "apellidos",
      "valores": [
        "S.A."
      ],
      "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "modalidad",
      "valores": [
        "M",
        "P"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "numero",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "bis",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referencia",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "pais",
      "valores": [
        "CL",
        "BR",
        "DO"
      ],
      "codigo": "EQ"
    }
  ]
}

Campo	Descripción	Obligatorio	Tipo parámetro
“modalidad”	Filtro sobre la modalidad del expediente	No	Cadena de caracteres
“numero”	Filtro sobre el número del expediente	No	Cadena de caracteres
“bis”	Filtro sobre bis del expediente	No	Cadena de caracteres
“referencia”	Filtro sobre la referencia del expediente	No	Cadena de caracteres
“pais”	Filtro sobre el país del expediente	No	Cadena de caracteres

Ejemplo de cURL

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>192.168.293.365:8071/expedientes/search?PageSize=<size>&PageNumber=<number>' \
--header 'Authorization: Bearer <token>eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header

Descripción

Obligatorio

<body>

Conjunto de filtros a aplicar sobre la búsqueda

No

Code Block

{
  "titulares": [
    {
      "campo": "apellidos",
      "valores": [
        "S.A."
      ],
      "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "modalidad",
      "valores": [
  
 {       "campoM":,
 <campo>,       "valores": <valores>P"
      ],
      "codigo": <filtro>"EQ"
    },
  ],  {
 "generales": [     {"campo": "numero",
      "campovalores": [
<campo>,        "valores": <valores>12345"
      ],
      "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 expedientes o titulares de los expedientes

Sí

Cadena de caracteres

<valores>

Lista de valores

Sí

Lista de valores

<filtro>

Tipo de filtro a aplicar. Consultar petición [GET] /filtros para más información

Sí

Cadena de caracteres

Note

¡Importante!

Al ser una petición POST, tenemos que incluir un header adicional (Content-Type) para indicar el formato del body. Para esta petición es application/json.

No olvidar el token

Ejemplo de request URL

Code Block
http://192.168.293.365:8071/expedientes/search'

Ejemplo de request URL con opciones de paginación

Code Block
http://192.168.293.365:8071/expedientes/search?PageSize=10&PageNumber=2'

Ejemplo de body

Code Block

{
  "titulares": [  {
      "campo": "bis",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referencia",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "apellidospais",
      "valores": [
        "S.A."CL",
        "BR",
        "DO"
      ],
      "codigo": "EQ"
    }
  ],
}'

Ejemplo de cURL con opciones de paginación

Code Block

language	json

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 '{
  "generalestitulares": [
    {
      "campo": "modalidadapellidos",
      "valores": [
        "MS.A.",
        "P"
      ],
      "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "numeromodalidad",
      "valores": [
        "M",
        "12345P"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "bisnumero",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referenciabis",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "paisreferencia",
      "valores": [
        "CL12345",
        "BR",
        "DO"
      ],
      "codigo": "EQ"
    }
  ]
}

Campo

Descripción

Obligatorio

Tipo parámetro

“modalidad”

Filtro sobre la modalidad del expediente

No

Cadena de caracteres

“numero”

Filtro sobre el número del expediente

No

Cadena de caracteres

“bis”

Filtro sobre bis del expediente

No

Cadena de caracteres

“referencia”

Filtro sobre la referencia del expediente

No

Cadena de caracteres

“pais”

Filtro sobre el país del expediente

No

Cadena de caracteres

Ejemplo de cURL

Code Block

language	json

curl --location --request POST 'http://192.168.293.365:8071/expedientes/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "titulares": [
    {
      "campo": "apellidos",
      "valores": [
        "S.A."
      ],
      "codigo": "EQ"
    }
  ],
  "generales": [
    {
      "campo": "modalidad",
      "valores": [
        "M",
        "P"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "numero",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "bis",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "referencia",
      "valores": [
        "12345"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "pais",
      "valores": [
        "CL",
        "BR",
        "DO"
      ],
      "codigo": "EQ"
    }
  ]
}'

Ejemplo de cURL con opciones de paginación

Code Block

language	json

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": "pais",
      "valores": [
        "CL",
        "BR",
        "DO"
      ],
      "codigo": "EQ"
    }
  ]
}'

Responses validaciones de campos

Status

colour	Purple
title	400

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 }

Status

colour	Purple
title	400

Valor no válido para el campo ‘campo’

Code Block
{ "statusCode": 400, "message": "Campo 'X' no contemplado", "data": null }

Status

colour	Purple
title	400

Lista de valores vacía

Code Block
{ "statusCode": 400, "message": "Se deben informar valores para el tipo de filtro 'EQ'", "data": null }

Status

colour	Purple
title	400

Lista de ‘valores’ con valor vacío

Code Block
{ "statusCode": 400, "message": "El valor no puede ser nulo", "data": null }

Status

colour	Purple
title	400

Filtro ‘Between’ con más de dos valores

Code Block
{ "statusCode": 400, "message": "El filtro 'BT' tiene que tener únicamente dos valores", "data": null }

Headers responses

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

Ejemplo headers responses

Code Block
{"TotalCount":2432,"PageSize":10,"CurrentPage":1,"TotalPages":244,"HasNextPage":true,"HasPreviousPage":false,"NextPageUrl":"","PreviousPageUrl":""}

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "campoid": "apellidos"1,
      "valoresestado": [{
        "S.A."
      ],codigo": "A",
        "codigodescripcion": "EQAlta"
      },
  ],    "generalesmodalidad": [
  {
 {       "campocodigo": "modalidadM",
        "valoresdescripcion": [
        "M",
        "PMarca Nacional"
      ]},
      "codigonumero": "EQ4123111",
    },  "pais": {
 {       "campocodigo": "numero",
      "valores": [ES",
        "descripcion": "12345España"
      ]},
      "codigobis": "EQ"
    }null,     {
      "campofecha_vencimiento": "bis20/06/2025",
      "valoresreferencia": [null,
      "descripciones": [
"12345"       ], {
     "codigo": "EQ"    "id": }1,
    {       "campotipo": "referencia",{
      "valores": [         "12345codigo": "DT",
     ],       "codigodescripcion": "EQDenominación"
          },
    {       "campodescripcion": "paisCulture",
          "valoresidioma": [{
        "CL",    "codigo": "es",
   "BR",         "DOdescripcion": "Español"
     ],    }
  "codigo": "EQ"     }
      ]
}'

Responses validaciones de campos

Status

colour	Purple
title	400

Valor no válido para el campo ‘codigo’

Code Block
{, "statusCodetitulares": [ 400, "message": "Filtro 'X' no{ contemplado. [GET] /filtros para más información", "dataid": null }

Status

colour	Purple
title	400

Valor no válido para el campo ‘campo’

Code Block
{ 1, "statusCodenombre": 400null, "messageapellidos": "Empresa "Campo 'X' no contemplado",S.A." }, "data": null }

Status

colour	Purple
title	400

Lista de valores vacía

Code Block
{ "statusCode": 400, "messageid": "Se2, deben informar valores para el tipo de filtro 'EQ'", "datanombre": null }

Status

colour	Purple
title	400

Lista de ‘valores’ con valor vacío

Code Block
{"Juan", "statusCode": 400, "messageapellidos": "El valor no puede ser nulo", "data": null }

Status

colour	Purple
title	400

Filtro ‘Between’ con más de dos valores

Code Block
Gómez" } ] }, { "statusCodeid": 4002, "messageestado": "El{ filtro 'BT' tiene que tener únicamente dos valores"codigo": "B", "data": null }

Headers responses

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

Ejemplo headers responses

Code Block
{"TotalCount":2432,"PageSize":10,"CurrentPage":1,"TotalPages":244,"HasNextPage":true,"HasPreviousPage":false,"NextPageUrl":"","PreviousPageUrl":""}

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
       "descripcion": "Baja"
      },
      "modalidad": {
        "codigo": "H",
        "descripcion": "Marca Internacional"
      },
      "numero": "345645",
      "pais": {
        "codigo": "CL",
        "descripcion": "Chile"
      },
      "bis": null,
      "fecha_vencimiento": "24/12/2024",
      "referencia": "TM870EU01",
      "descripciones": [
        {
          "id": 1,
          "estadotipo": {
            "codigo": "ADE",
            "descripcion": "AltaDescripción"
          },
          "modalidaddescripcion": {"Culture",
          "codigoidioma": "M", {
            "descripcioncodigo": "Marca Nacionales"
,
     },       "numerodescripcion": "4123111",Español"
         }
 "pais":  {     }
   "codigo": "ES",  ],
      "descripciontitulares": "España"[]
    }
  ]
},

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block

{
  "statusCode": 500,
  "bismessage": null<mensaje_error>,
  "data": 
      "fecha_vencimiento": "20/06/2025",
      "referencia": null,
      "descripciones": [
        {
          "id": 1,
          "tipo": {
            "codigo": "DT",
            "descripcion": "Denominación"null
}

[GET] /expedientes/{id}/titulares

Descripción

Obtiene los titulares de un expediente.

Expand

title	Más información...

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

language	json

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

language	json

curl --location --request GET 'http://192.168.293.365:8071/expedientes/3992/titulares' \
--header 'accept-language: es' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH'

Responses

Status

colour	Green
title	200

Ha ido correctamente

Code Block

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": [
        {
 },           "descripcionid": "Culture",
       1,
  "idioma": {             "codigonombre": "esNatalia",
            "descripcionapellidos": "EspañolGarcía"
         },
        }{
      ],       "titularesid": [2,
        {           "id"nombre": 1null,
            "nombreapellidos": null,
"LU S.A."
        }
"apellidos": "Empresa S.A."  ]
}

Status

colour	Purple
title	404

No se ha encontrado el contacto

Code Block
{ "statusCode": }404, "message": "No se ha encontrado {el expediente", "data": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "idstatusCode": 2, 500, "nombremessage": "Juan"<mensaje_error>, "data": null }

[POST] /expedientes/{id}/titulares

Descripción

Asignación de un titular a un expediente.

Expand

title	Más información...

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

language	json

curl --location --request    "apellidos": "Gómez"
        }
      ]
    },
    {
   POST 'http://<dominio>:<puerto>/expedientes/<id>/titulares' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Información del titular que queremos asignar	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

Code Block
{ "id": 2, "estado": { "codigo": "B", "descripcion": "Baja" }, 735 }

Ejemplo de cURL

Code Block

language	json

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

Status

colour	Green
title	200

Ha ido correctamente

Code Block
{ "modalidadstatusCode": { 200, "codigomessage": "HPetición finalizada correctamente", "descripciondata": "Marca Internacional"null }

Status

colour	Purple
title	404

No se ha encontrado el titular

Code Block
{ }, "statusCode": 404, "numeromessage": "345645No se ha encontrado el titular", "paisdata": null }

Status

colour	Purple
title	404

No se ha encontrado el expediente

Code Block
{ "codigostatusCode": "CL"404, "descripcionmessage": "Chile"No se ha encontrado el }expediente", "bisdata": null, }

Status

colour	Purple
title	409

El titular existe pero no pertenece al cliente del expediente

Code Block
{ "fecha_vencimientostatusCode": "24/12/2024"409, "referenciamessage": "TM870EU01", "descripciones": [El titular existe pero no pertenece al cliente del expediente", "data": null }

Status

colour	Purple
title	409

Ya existe la relación que está intentando crear

Code Block
{ "statusCode": 409, "idmessage": 1,"Ya existe el titular para el expediente 'X'", "tipodata": null }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode": 500, "message": <mensaje_error>, "data": "codigo": "DE", "descripcion": "Descripción" }, "descripcion": "Culture", "idioma": { "codigo": "es", "descripcion": "Español" } } ],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

title	Más información...

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

language	json

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ón

Code Block

language	json

curl --location --request POST 'http://<dominio>:<puerto>/expedientes/actos/search?PageSize=<size>&PageNumber=<number>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '<body>'

Header	Descripción	Obligatorio
<body>	Conjunto de filtros a aplicar sobre la búsqueda	No

Body (request)

Code Block
{ "generales": [ { "titularescampo": []<campo>, } ] }

Status

colour	Yellow
title	500

Ha ocurrido un error

Code Block
{ "statusCode"valores": 500<valores>, "messagecodigo": <mensaje_error>,<filtro> "data": null }

[GET] /expedientes/{id}/titulares

Descripción

Obtiene los titulares de un expediente.

Importante: no olvidar headers

Expand

title	Más información...

Petición

Info
`GET /expedientes/<id>/titulares`

]
}

Note

Parámetro

Descripción

Obligatorio

Ejemplo

Tipo parámetro

<id>

Identificador del expediente

Campo	Descripción	Obligatorio	Tipo parámetro
“fecha_acto”	Filtro sobre la fecha del acto	No	Cadena de caracteres. Formato: día/mes/año
“fecha_publicacion”	Filtro sobre la fecha de publicación del acto	No	Cadena de caracteres. Formato: día/mes/año
“fecha_alta”	Filtro sobre la fecha de alta del boletín	No	Cadena de caracteres. Formato: día/mes/año
“id_boletin”	Filtro sobre el identificador del boletín	No	Cadena de caracteres

Page Comparison

Versions Compared

Old Version 32

New Version Current

Key

Parámetro

Descripción

<dominio>

Dominio API

Sí

192.168.293.365

<puerto>

Puerto API

Sí

8080

Estándar cURL

Header

Descripción

<idioma>

Idioma para las descripciones

No

es

<token>

Token de acceso

Sí

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /

empresas 🆕

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /idiomas/descripciones

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /modalidades

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /

estados

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /idiomas/

descripciones

Descripción

Petición

Request URL

cURL

Ejemplo de request URL

Ejemplo de cURL

Responses

[GET] /

modalidades

Descripción

Petición

Request URL

`eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OH`