Home

Expedientes

21 16 abril, 2025

Índice

[GET] /expedientes/{id}
[GET]/expedientes/{id}/actos
[GET]/expedientes/{id}/actos/{idActo}
[GET]/expedientes/{id}/anotaciones
[GET]/expedientes/{id}/especificos
[GET]/expedientes/{id}/graficos
[GET]/expedientes/{id}/prioridades
[GET]/expedientes/{id}/situaciones
[GET]/expedientes/{id}/tareas
[GET]/expedientes/{id}/tareas/{idTarea}
[GET]/expedientes/{id}/tareas/{idTarea}/importes
[GET] /expedientes/{id}/titulares
[POST] /expedientes
[POST] /expedientes/search
[POST] /expedientes/actos/search
[POST] /expedientes/tareas/search
[POST] /expedientes/{id}/actos
[POST] /expedientes/{id}/tareas
[POST] /expedientes/{id}/tareas/{idTarea}/importes
[POST] /expedientes/{id}/titulares [PUT] /expedientes/{id}
[PUT] /expedientes/{id}/tareas/{idTarea}
[PUT] /expedientes/{id}/tareas/{idTarea}/importes/{idImporte}

Ir arriba

[GET] /expedientes/{id}

Ir arriba

Descripción

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

Ir arriba

Petición

GET /expedientes/<id>

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

Ir arriba

Request URL

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

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/3992'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": {
    "id": 1,
    "empresa": {
      "codigo": "EMP",
      "descripcion": "Empresa"
    },
    "delegacion": {
      "codigo": "DEL1",
      "descripcion": "Delegación"
    },
    "departamento": {
      "codigo": "DEP1",
      "descripcion": "Departamento"
    },
    "division": {
      "codigo": "DIV",
      "descripcion": "Division"
    },
    "clave": null,
    "referencia2": "ref2",
    "referencia3": "ref3",
    "referencia4": "ref4",
    "observacion": "observacion",
    "idIntermediario": 1234,
    "idAgente": 456,
    "aplicacionExterna": "123456",
    "situacion": [],
    "idCliente": 3455,
    "estado": {
      "codigo": "B",
      "descripcion": "Baja"
    },
    "modalidad": {
      "codigo": "M",
      "descripcion": "Marca Nacional"
    },
    "numero": "4123111",
    "pais": {
      "codigo": "ES",
      "descripcion": "España"
    },
    "bis": null,
    "fechaVencimiento": "20/06/2025",
    "referencia": "referencia",
    "descripciones": [
      {
        "id": 1,
        "tipo": {
          "codigo": "DT",
          "descripcion": "Denominación"
        },
        "descripcion": "Culture",
        "idioma": {
          "codigo": "es",
          "descripcion": "Español"
        }
      }
    ]
  }
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/actos

Ir arriba

Descripción

Obtiene los actos de un expediente.

Ir arriba

Petición

GET /expedientes/<id>/actos

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

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/actos'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/3992/actos'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{ "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "fechaOrdenContacto": "01/01/2020",
      "fechaComunicadoContacto": "12/12/2021",
      "fechaEnvioDocumentacionOrganismo": "05/11/2022",
      "fechaRecepcionDocumentacionOrganismo": "31/12/2019",
      "fechaComunicadoContacto2": "03/03/2021",
      "idContacto": 1234,
      "personaAnterior": "Persona contacto",
      "personaSiguiente": "Persona contacto",
      "fechaAnulacion": "02/12/2023",
      "idExpediente": 6420,
      "idBoletin": 435,
      "acto": {
        "codigo": "520",
        "descripcion": "Anotación"
      },
      "fechaAlta": "03/04/2021",
      "fechaActo": "01/12/2021",
      "fechaPublicacion": "14/12/2021",
      "referencia": "Referencia acto",
      "referencia2": null,
      "numeroActo": "N2345",
      "numeroPublicacion": "NP23433434",
      "observaciones": "Observaciones del acto"
    },
    {
      "id": 2,
      "fechaOrdenContacto": "01/01/2020",
      "fechaComunicadoContacto": "12/12/2021",
      "fechaEnvioDocumentacionOrganismo": "05/11/2022",
      "fechaRecepcionDocumentacionOrganismo": "31/12/2019",
      "fechaComunicadoContacto2": "03/03/2021",
      "idContacto": 45343,
      "personaAnterior": "Persona contacto",
      "personaSiguiente": "Persona contacto",
      "fechaAnulacion": "02/12/2023",
      "idExpediente": 5487,
      "idBoletin": 987,
      "acto": {
        "codigo": "050",
        "descripcion": "Solicitud de registro"
      },
      "fechaAlta": "14/05/2021",
      "fechaActo": "10/12/2021",
      "fechaPublicacion": "10/12/2021",
      "referencia": "Referencia 1",
      "referencia2": "Referencia 2",
      "numeroActo": "RF34343",
      "numeroPublicacion": "N234453",
      "observaciones": "Observaciones del acto"
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/actos/{idActo}

Ir arriba

Descripción

Obtiene un acto asociado a un expediente.

Ir arriba

Petición

GET /expedientes/<id>/actos/<idActo>

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	6420
<idActo>	Identificador del acto	Sí	1

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/actos/<idActo>'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/6420/actos/1'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{ 
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "fechaOrdenContacto": "01/01/2020",
      "fechaComunicadoContacto": "12/12/2021",
      "fechaEnvioDocumentacionOrganismo": "05/11/2022",
      "fechaRecepcionDocumentacionOrganismo": "31/12/2019",
      "fechaComunicadoContacto2": "03/03/2021",
      "idContacto": 1234,
      "personaAnterior": "Persona contacto",
      "personaSiguiente": "Persona contacto",
      "fechaAnulacion": "02/12/2023",
      "idExpediente": 6420,
      "idBoletin": 435,
      "acto": {
        "codigo": "520",
        "descripcion": "Anotación"
      },
      "fechaAlta": "03/04/2021",
      "fechaActo": "01/12/2021",
      "fechaPublicacion": "14/12/2021",
      "referencia": "Referencia acto",
      "referencia2": null,
      "numeroActo": "N2345",
      "numeroPublicacion": "NP23433434",
      "observaciones": "Observaciones del acto"
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/anotaciones

Ir arriba

Descripción

Obtiene las anotaciones de un expediente.

Ir arriba

Petición

GET /expedientes/<id>/anotaciones

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	73

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/anotaciones'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/73/anotaciones'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "fechaAlta": "03/04/2021",
      "tipo": {
        "codigo": "B",
        "descripcion": "Baja"
      },
      "usuario": null,
      "idExpediente": 73,
      "rutaFichero": "C:\\Grupo10\\ApigesPro\\Documentos\\Expedientes\\Anotaciones\\EJEMPLO DE CARTA PENDIENTE DE PAGO.eml",
      "texto": {
        "codigo": "EJEMPLO004",
        "descripcion": "EJEMPLO DE CARTA DE PAGO"
      }
    },
    {
      "id": 2,
      "fechaAlta": "21/05/2020",
      "tipo": {
        "codigo": "A",
        "descripcion": "Alta"
      },
      "usuario": null,
      "idExpediente": 73,
      "rutaFichero": "C:\\Grupo10\\ApigesPro\\Documentos\\Expedientes\\Anotaciones\\EJEMPLO DE CARTA PENDIENTE DE PAGO2.eml",
      "texto": {
        "codigo": "EJEMPLO005",
        "descripcion": "EJEMPLO DE CARTA DE PAGO2"
      }
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/especificos

Ir arriba

Descripción

Obtiene los datos específicos de un expediente.

Ir arriba

Petición

GET /expedientes/<id>/especificos

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	73

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/especificos'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/73/especificos'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "naturaleza": {
        "codigo": "4",
        "descripcion": "Derivada"
      },
      "organo": null,
      "procedimiento": null,
      "jurisdiccion": null,
      "obra": null,
      "familia": null,
      "primeraLengua": {
        "codigo": "es",
        "descripcion": "Español"
      },
      "segundaLengua": null,
      "idLicenciatario": null,
      "idTraductor": null,
      "idCopista": null,
      "idAdministrativo": null,
      "idTecnico": null,
      "idFacturacion": null,
      "idRegistrador": null,
      "años": 10,
      "seguimiento": "Seguimiento",
      "caracterDistintivo": false,
      "observacionesComplementarias": "Observaciones",
      "color": false,
      "recibido2006": false,
      "recibidoFolletoB1": false,
      "recibidoPoder": false,
      "recibidoDibujos": false,
      "recibidoTexto": false,
      "recibidoTraduccion": false,
      "recibidoCopia": false,
      "oficinaReceptora": null,
      "oficinaBusqueda": null,
      "oficinaExamen": null,
      "dnsipprimaria": null,
      "dnsipsecundaria": null,
      "poblacion": null,
      "sala": null,
      "numeroAutos": null,
      "dns1": null,
      "dns2": null,
      "dns3": null,
      "dns4": null,
      "fechaFinVidaLegal": null,
      "refBilling": null,
      "matterName": null,
      "uriNegocio": null,
      "divisional": false,
      "referenciaObtentor": null,
      "nombreComercial": null,
      "señal": false,
      "extranet": false,
      "login": null,
      "password": null,
      "caracter": null,
      "observacionSolicitud": null,
      "poderEsNic": false,
      "registroMercantil": false,
      "viaPct": true,
      "renovadoPor": null
    },
    {
      "naturaleza": {
        "codigo": "5",
        "descripcion": "Transformación"
      },
      "organo": null,
      "procedimiento": null,
      "jurisdiccion": null,
      "obra": null,
      "familia": null,
      "primeraLengua": {
        "codigo": "es",
        "descripcion": "Español"
      },
      "segundaLengua": null,
      "idLicenciatario": null,
      "idTraductor": null,
      "idCopista": null,
      "idAdministrativo": null,
      "idTecnico": null,
      "idFacturacion": null,
      "idRegistrador": null,
      "años": 5,
      "seguimiento": "Seguimiento",
      "caracterDistintivo": false,
      "observacionesComplementarias": "Observaciones complementarias",
      "color": false,
      "recibido2006": false,
      "recibidoFolletoB1": false,
      "recibidoPoder": false,
      "recibidoDibujos": false,
      "recibidoTexto": false,
      "recibidoTraduccion": false,
      "recibidoCopia": false,
      "oficinaReceptora": null,
      "oficinaBusqueda": null,
      "oficinaExamen": null,
      "dnsipprimaria": null,
      "dnsipsecundaria": null,
      "poblacion": null,
      "sala": null,
      "numeroAutos": null,
      "dns1": null,
      "dns2": null,
      "dns3": null,
      "dns4": null,
      "fechaFinVidaLegal": null,
      "refBilling": null,
      "matterName": null,
      "uriNegocio": null,
      "divisional": false,
      "referenciaObtentor": null,
      "nombreComercial": null,
      "señal": false,
      "extranet": false,
      "login": null,
      "password": null,
      "caracter": null,
      "observacionSolicitud": null,
      "poderEsNic": false,
      "registroMercantil": false,
      "viaPct": false,
      "renovadoPor": null
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/graficos

Ir arriba

Descripción

Obtiene los gráficos de un expediente.

Ir arriba

Petición

GET /expedientes/<id>/graficos

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	12345

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/graficos'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/12345/graficos'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "idExpediente": 12345,
      "orden": 1,
      "grafico": "/9j/5QMDr3+Pn6/8QAHzEGEkFRA="
    },
    {
      "idExpediente": 12345,
      "orden": 2,
      "grafico": "VqI/cegMm9QuX4dgGk0zkg=="
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/prioridades

Ir arriba

Descripción

Obtiene las prioridades de un expediente.

Ir arriba

Petición

GET /expedientes/<id>/prioridades

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	1

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/prioridades'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/1/prioridades'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "expedientesId": 1,
      "expedientesIdApiges": 43,
      "expedienteExterno": "NUM 232430",
      "fecha": "03/04/2021",
      "observacion": "Observaciones"
    },
    {
      "id": 2,
      "expedientesId": 1,
      "expedientesIdApiges": 56,
      "expedienteExterno": "NUM 34556",
      "fecha": "23/12/2022",
      "observacion": "Observaciones"
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/situaciones

Ir arriba

Descripción

Obtiene las situaciones de un expediente.

Ir arriba

Petición

GET /expedientes/<id>/situaciones

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	12345

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/situaciones'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/12345/situaciones'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "idExpediente": 12345,
      "situacion": {
        "global": true,
        "codigo": "03",
        "descripcion": "Anulado"
      },
      "observacion": "Observaciones"
    },
    {
      "idExpediente": 243325,
      "situacion": {
        "global": false,
        "codigo": "04",
        "descripcion": "Caducado"
      },
      "observacion": "Observaciones"
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/tareas

Ir arriba

Descripción

Obtiene las tareas de un expediente.

Ir arriba

Petición

GET /expedientes/<id>/tareas

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	5487

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/tareas'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/5487/tareas'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "idExpediente": 5487,
      "tarea": {
        "codigo": "BREXIT",
        "descripcion": "Brexit"
      },
      "estado": {
        "codigo": "A",
        "descripcion": "Aplazada"
      },
      "fechaVencimiento": "15/04/2021",
      "fechaInicio": "04/03/2021",
      "fechaFin": null,
      "descripcionAlternativa": "Descripcion",
      "observaciones": "Observaciones de la tarea",
      "supervisor": {
        "codigo": "ANI",
        "nombre": "Ana",
        "apellidos": "Lopez"
      },
      "responsable": {
        "codigo": "LAU",
        "nombre": "Laura",
        "apellidos": "Rodriguez"
      },
      "responsableFin": null
    },
    {
      "id": 2,
      "idExpediente": 6420,
      "tarea": {
        "codigo": "ARMEDIM",
        "descripcion": "Mediación - M"
      },
      "estado": {
        "codigo": "C",
        "descripcion": "Completada"
      },
      "fechaVencimiento": "03/04/2021",
      "fechaInicio": "01/12/2021",
      "fechaFin": "31/12/2021",
      "descripcionAlternativa": null,
      "observaciones": null,
      "supervisor": null,
      "responsable": null,
      "responsableFin": {
        "codigo": "ANI",
        "nombre": "Ana",
        "apellidos": "Lopez"
      }
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/tareas/{idTarea}

Ir arriba

Descripción

Obtiene una tarea asociada a un expediente.

Ir arriba

Petición

GET /expedientes/<id>/tareas/<idTarea>

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	5487
<idTarea>	Identificador de la tarea	Sí	1

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/tareas/<idTarea>'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/5487/tareas/1'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "idExpediente": 5487,
      "tarea": {
        "codigo": "BREXIT",
        "descripcion": "Brexit"
      },
      "estado": {
        "codigo": "A",
        "descripcion": "Aplazada"
      },
      "fechaVencimiento": "15/04/2021",
      "fechaInicio": "04/03/2021",
      "fechaFin": null,
      "descripcionAlternativa": "Descripcion",
      "observaciones": "Observaciones de la tarea",
      "supervisor": {
        "codigo": "ANI",
        "nombre": "Ana",
        "apellidos": "Lopez"
      },
      "responsable": {
        "codigo": "LAU",
        "nombre": "Laura",
        "apellidos": "Rodriguez"
      },
      "responsableFin": null
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/tareas/{idTarea}/importes

Ir arriba

Descripción

Obtiene los importes de una tarea asociada a un expediente.

Ir arriba

Petición

GET /expedientes/<id>/tareas/<idTarea>/importes

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	5487
<idTarea>	Identificador de la tarea	Sí	1

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/tareas/<idTarea>/importes'

Ir arriba

cURL

curl --location --request GET 'http://<dominio>:<puerto>/expedientes/<id>/tareas/<idTarea>/importes' \
--header 'accept-language: <idioma>' \
--header 'Authorization: Bearer <token>'

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/5487/tareas/1/importes'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "articulo": {
        "codigo": "A1",
        "descripcion": "Descripción del artículo"
      },
      "importe": 100,
      "cantidad": 2,
      "descuento": 10,
      "importeTasa": 25,
      "numeroClasesAdicionales": 3,
      "importeMulticlase": 50,
      "importeTasaClaseAdicional": 8,
      "importeMulticlase2": 75,
      "importeTasaClaseAdicionales2": 12,
      "numeroClasesAdicionales2": 2,
      "totalGastosEstimados": 200
    },
    {
      "id": 2,
      "articulo": {
        "codigo": "A2",
        "descripcion": "Descripción del artículo"
      },
      "importe": 300,
      "cantidad": 1,
      "descuento": 0,
      "importeTasa": 15,
      "numeroClasesAdicionales": 3,
      "importeMulticlase": 150,
      "importeTasaClaseAdicional": 8,
      "importeMulticlase2": 45,
      "importeTasaClaseAdicionales2": 12,
      "numeroClasesAdicionales2": 2,
      "totalGastosEstimados": 200
    }
  ]
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[GET] /expedientes/{id}/titulares

Ir arriba

Descripción

Obtiene los titulares de un expediente.

Ir arriba

Petición

GET /expedientes/<id>/titulares

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

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/titulares'

Ir arriba

cURL

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

Importante: no olvidar headers

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/3992/titulares'

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[POST] /expedientes

Ir arriba

Descripción

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

Ir arriba

Petición

POST /expedientes

Ir arriba

Request URL

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

Ir arriba

cURL

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í

Ir arriba

Body (request)

{
  "idContacto": <idContacto>,
  "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
<idContacto>	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

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes'

Ir arriba

Ejemplo de body

{
  "idContacto": 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
    }
  ]
}

Ir arriba

Ejemplo de cURL

curl --location --request POST 'http://192.168.293.365:8071/expedientes' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "idContacto": 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
    }
  ]
}'

Ir arriba

Responses validaciones de campos

400 Valor no válido para el campo ‘modalidad’

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

400 Valor no válido para el campo ‘pais’

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

400 Valor no válido para el campo ‘estado’

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

Ir arriba

Responses control descripciones

400 Valor no válido para el campo ‘idioma’

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

400 Valor no válido para el campo ‘tipo’

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

400 Claves duplicadas en la lista de descripciones

{
    "statusCode": 400,
    "message": "Descripciones duplicadas. Clave duplicada { Elemento = { Tipo = DE, Idioma = es }, Ocurrencias = 2 }",
    "data": null
}

400 Incluir varias denominaciones para modalidades distintas de patentes

{
    "statusCode": 400,
    "message": "Este tipo de modalidad no permite guardar varias denominaciones",
    "data": null
}

Ir arriba

Responses control titulares

400 Titular no existente

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

400 Asociar un titular de un cliente diferente al del expediente

{
    "statusCode": 400,
    "message": "No se puede asociar un titular de un cliente diferente al del expediente",
    "data": null
}

Ir arriba

Responses

200 Ha ido correctamente

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

404 No se ha encontrado el contacto

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

409 Ya existe el expediente que está intentando crear

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

500 Ha ocurrido un error

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

Ir arriba

[POST] /expedientes/search

Ir arriba

Descripción

Búsqueda de expedientes con filtros. Devuelve un listado con los expedientes que cumplen los filtros de búsqueda.

Ir arriba

Petición

POST /expedientes/search

Ir arriba

Petición con opciones de paginación

POST /expedientes/search?PageSize=<size>&PageNumber=<number>

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/search'

Ir arriba

Request URL con opciones de paginación

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

Ir arriba

cURL

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

Ir arriba

cURL con opciones de paginación

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

Ir arriba

Body (request)

{
  "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

¡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

Ir arriba

Ejemplo de request URL

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

Ir arriba

Ejemplo de request URL con opciones de paginación

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

Ir arriba

Ejemplo de body

{
  "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

Ir arriba

Ejemplo de cURL

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

Ir arriba

Ejemplo de cURL con opciones de paginación

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

Ir arriba

Responses validaciones de campos

400 Valor no válido para el campo ‘codigo’

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

400 Valor no válido para el campo ‘campo’

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

400 Lista de valores vacía

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

400 Lista de ‘valores’ con valor vacío

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

400 Filtro ‘Between’ con más de dos valores

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

Ir arriba

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:

{"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

Ir arriba

Ejemplo headers responses

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "domicilioPrincipalCliente": {
        "id": 1,
        "idContacto": 1234,
        "nombre": null,
        "apellidos": "Empresa S.L",
        "domicilio": "Avenida Laurel, 5",
        "principal": true,
        "personaContacto": "Juan Ramón Pérez",
        "pais": {
          "codigo": "ES",
          "descripcion": "España"
        },
        "tipo": {
          "codigo": "GE",
          "descripcion": "Genérico"
        },
        "email": null,
        "dni": null,
        "codPostal": null
      },
      "logo": null,
      "idCliente": 1234,
      "estado": {
        "codigo": "A",
        "descripcion": "Alta"
      },
      "modalidad": {
        "codigo": "M",
        "descripcion": "Marca Nacional"
      },
      "numero": "4123111",
      "pais": {
        "codigo": "ES",
        "descripcion": "España"
      },
      "bis": null,
      "fechaVencimiento": "20/06/2025",
      "referencia": null,
      "descripciones": [
        {
          "id": 1,
          "tipo": {
            "codigo": "DT",
            "descripcion": "Denominación"
          },
          "descripcion": "Culture",
          "idioma": {
            "codigo": "es",
            "descripcion": "Español"
          }
        }
      ]
    },
    {
      "id": 2,
      "domicilioPrincipalCliente": {
        "id": 1,
        "idContacto": 1234,
        "nombre": null,
        "apellidos": "Empresa S.L",
        "domicilio": "Avenida Laurel, 5",
        "principal": true,
        "personaContacto": "Juan Ramón Pérez",
        "pais": {
          "codigo": "ES",
          "descripcion": "España"
        },
        "tipo": {
          "codigo": "GE",
          "descripcion": "Genérico"
        },
        "email": null,
        "dni": null,
        "codPostal": null
      },
      "logo": null,
      "idCliente": 1234,
      "estado": {
        "codigo": "B",
        "descripcion": "Baja"
      },
      "modalidad": {
        "codigo": "H",
        "descripcion": "Marca Internacional"
      },
      "numero": "345645",
      "pais": {
        "codigo": "CL",
        "descripcion": "Chile"
      },
      "bis": null,
      "fechaVencimiento": "24/12/2024",
      "referencia": "TM870EU01",
      "descripciones": [
        {
          "id": 1,
          "tipo": {
            "codigo": "DE",
            "descripcion": "Descripción"
          },
          "descripcion": "Culture",
          "idioma": {
            "codigo": "es",
            "descripcion": "Español"
          }
        }
      ]
    }
  ]
}

500 Ha ocurrido un error

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

Ir arriba

[POST] /expedientes/{id}/actos

Ir arriba

Descripción

Asignación de un acto a un expediente.

Ir arriba

Petición

POST /expedientes/<id>/actos

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

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/actos'

Ir arriba

cURL

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

Header	Descripción	Obligatorio
<body>	Información del acto que queremos asignar	Sí

Ir arriba

Body (request)

{
  "codigo": <codigo>,
  "fechaActo": <fechaActo>,
  "numeroPublicacion": <numeroPublicacion>,
  "fechaPublicacion": <fechaPublicacion>,
  "numeroActo": <numeroActo>,
  "observaciones": <observaciones>,
  "crearPago": <crearPago>,
  "añosRenovacion": <añosRenovacion>
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<codigo>	Identificador del acto. Consultar petición [GET] /actos para más información	Sí	Cadena de caracteres	10 caracteres	VENC G1
<fechaActo>	Fecha del acto	No	Cadena de caracteres. Formato: día/mes/año		07/10/2024
<numeroPublicacion>	Número de publicación	No	Cadena de caracteres	10 caracteres	1233
<fechaPublicacion>	Fecha de publicación	No	Cadena de caracteres. Formato: día/mes/año		07/10/2024
<numeroActo>	Número de acto	No	Cadena de caracteres	10 caracteres	343454
<observaciones>	Observaciones	No	Cadena de caracteres		Observaciones del acto
<crearPago>	Crear pago	No	Booleano		False
<añosRenovacion>	Años de renovación	No	Numérico		1

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/<id>/actos'

Ir arriba

Ejemplo de body

{
  "codigo": "VENC G1",
  "fechaActo": "07/10/2024",
  "numeroPublicacion": "1233",
  "fechaPublicacion": "07/10/2024",
  "numeroActo": "343454",
  "observaciones": "Observaciones del acto",
  "crearPago": "False",
  "añosRenovacion": "1"
}

Ir arriba

Ejemplo de cURL

curl --location --request POST 'http://192.168.293.365:8071/expedientes/6450/actos' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{ 
  "codigo": "VENC G1", 
  "fechaActo": "07/10/2024", 
  "numeroPublicacion": "1233", 
  "fechaPublicacion": "07/10/2024", 
  "numeroActo": "343454", 
  "observaciones": "Observaciones del acto",
  "crearPago": "False",
  "añosRenovacion": "1"
}'

Ir arriba

Responses

200 Ha ido correctamente

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

404 No se ha encontrado el acto

{
    "statusCode": 404,
    "message": "No se ha encontrado el acto",
    "data": null
}

404 No se ha encontrado el expediente

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

409 Ya existe la relación que está intentando crear

{
    "statusCode": 409,
    "message": "Ya existe el acto para el expediente 'X'",
    "data": null
}

500 Ha ocurrido un error

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

Ir arriba

[POST] /expedientes/{id}/tareas

Ir arriba

Descripción

Asignación de una tarea a un expediente.

Ir arriba

Petición

POST /expedientes/<id>/tareas

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

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/tareas'

Ir arriba

cURL

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

Header	Descripción	Obligatorio
<body>	Información de la tarea que queremos asignar	Sí

Ir arriba

Body (request)

{
  "codigo": <codigo>,
  "fechaVencimiento": <fechaVencimiento>
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<codigo>	Identificador de la tarea. Consultar petición [GET] /tareas para más información	Sí	Cadena de caracteres	10 caracteres	VENC G1
<fechaVencimiento>	Fecha de vencimiento	Sí	Cadena de caracteres. Formato: día/mes/año		07/10/2024

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/<id>/tareas'

Ir arriba

Ejemplo de body

{
  "codigo": "VENC G1",
  "fechaVencimiento": "07/10/2024"
}

Ir arriba

Ejemplo de cURL

curl --location --request POST 'http://192.168.293.365:8071/expedientes/6450/tareas' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{ 
   "codigo": "VENC G1", 
   "fechaVencimiento": "07/10/2024" 
}'

Ir arriba

Responses

200 Ha ido correctamente

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

404 No se ha encontrado la tarea

{
    "statusCode": 404,
    "message": "No se ha encontrado la tarea",
    "data": null
}

404 No se ha encontrado el expediente

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

409 Ya existe la relación que está intentando crear

{
    "statusCode": 409,
    "message": "Ya existe la tarea para el expediente 'X'",
    "data": null
}

500 Ha ocurrido un error

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

Ir arriba

[POST] /expedientes/{id}/tareas/{idTarea}/importes

Ir arriba

Descripción

Creación de un importe de una tarea asociada a un expediente. Devuelve el identificador del importe creado.

Ir arriba

Petición

POST /expedientes/<id>/tareas/<idTarea>/importes

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	6450
<idTarea>	Identificador de la tarea	Sí	145

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/tareas/<idTarea>/importes'

Ir arriba

cURL

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

Header	Descripción	Obligatorio
<body>	Información del importe que queremos asignar	Sí

Ir arriba

Body (request)

{
  "idArticulo": <idArticulo>,
  "importe": <importe>,
  "cantidad": <cantidad>,
  "descuento": <descuento>,
  "importeTasa": <importeTasa>,
  "numeroClasesAdicionales": <numeroClasesAdicionales>,
  "importeMulticlase": <importeMulticlase>,
  "importeTasaClaseAdicional": <importeTasaClaseAdicional>,
  "importeMulticlase2": <importeMulticlase2>,
  "importeTasaClaseAdicionales2": <importeTasaClaseAdicionales2>,
  "numeroClasesAdicionales2": <numeroClasesAdicionales2>,
  "totalGastosEstimados": <totalGastosEstimados>
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<idArticulo>	Identificador del artículo. Consultar petición [GET] /articulos para más información	Sí	Cadena de caracteres		1234
<importe>	Importe	No	Numérico con decimales	Máximo 4 decimales	1000
<cantidad>	Cantidad	No	Numérico		1
<descuento>	Descuento	No	Numérico con decimales	Máximo 4 decimales	10
<importeTasa>	Importe de tasa	No	Numérico con decimales	Máximo 4 decimales	345
<numeroClasesAdicionales>	Número de clases adicionales	No	Numérico		2
<importeMulticlase>	Importe multiclase	No	Numérico con decimales	Máximo 4 decimales	900
<importeTasaClaseAdicional>	Importe de tasa por clase adicional	No	Numérico con decimales	Máximo 4 decimales	100
<importeMulticlase2>	Importe multiclase 2	No	Numérico con decimales	Máximo 4 decimales	400
<importeTasaClaseAdicionales2>	Importe de tasa por clase adicional	No	Numérico con decimales	Máximo 4 decimales	120
<numeroClasesAdicionales2>	Número de clases adicionales 2	No	Numérico		2
<totalGastosEstimados>	Total gastos estimados	No	Numérico con decimales	Máximo 4 decimales	200

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/<id>/tareas/<idTarea>/importes'

Ir arriba

Ejemplo de body

{
  "idArticulo": 1234,
  "importe": 1000,
  "cantidad": 1,
  "descuento": 10,
  "importeTasa": 345,
  "numeroClasesAdicionales": 2,
  "importeMulticlase": 900,
  "importeTasaClaseAdicional": 100,
  "importeMulticlase2": 400,
  "importeTasaClaseAdicionales2": 120,
  "numeroClasesAdicionales2": 2,
  "totalGastosEstimados": 200
}

Ir arriba

Ejemplo de cURL

curl --location --request POST 'http://192.168.293.365:8071/expedientes/6450/tareas/145/importes' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "idArticulo": 1234,
  "importe": 1000,
  "cantidad": 1,
  "descuento": 10,
  "importeTasa": 345,
  "numeroClasesAdicionales": 2,
  "importeMulticlase": 900,
  "importeTasaClaseAdicional": 100,
  "importeMulticlase2": 400,
  "importeTasaClaseAdicionales2": 120,
  "numeroClasesAdicionales2": 2,
  "totalGastosEstimados": 200
}'

Ir arriba

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": 16
}

404 No se ha encontrado la tarea

{
    "statusCode": 404,
    "message": "No se ha encontrado la tarea",
    "data": null
}

404 No se ha encontrado el expediente

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

404 No se ha encontrado el artículo

{
    "statusCode": 404,
    "message": "No se ha encontrado el artículo",
    "data": null
}

500 Ha ocurrido un error

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

Ir arriba

[POST] /expedientes/{id}/titulares

Ir arriba

Descripción

Asignación de un titular a un expediente.

Ir arriba

Petición

POST /expedientes/<id>/titulares

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

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/titulares'

Ir arriba

cURL

curl --location --request 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í

Ir arriba

Body (request)

{
  "id": <titular>
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<titular>	Identificador del titular	Sí	Numérico		735

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/<id>/titulares'

Ir arriba

Ejemplo de body

{
  "id": 735
}

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses

200 Ha ido correctamente

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

404 No se ha encontrado el titular

{
    "statusCode": 404,
    "message": "No se ha encontrado el titular",
    "data": null
}

404 No se ha encontrado el expediente

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

409 El titular existe pero no pertenece al cliente del expediente

{
    "statusCode": 409,
    "message": "El titular existe pero no pertenece al cliente del expediente",
    "data": null
}

409 Ya existe la relación que está intentando crear

{
    "statusCode": 409,
    "message": "Ya existe el titular para el expediente 'X'",
    "data": null
}

500 Ha ocurrido un error

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

Ir arriba

[POST] /expedientes/actos/search

Ir arriba

Descripción

Búsqueda de actos con filtros. Devuelve un listado con los actos que cumplen los filtros de búsqueda.

Ir arriba

Petición

POST /expedientes/actos/search

Ir arriba

Petición con opciones de paginación

POST /expedientes/actos/search?PageSize=<size>&PageNumber=<number>

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/actos/search'

Ir arriba

Request URL con opciones de paginación

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

Ir arriba

cURL

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

Ir arriba

cURL con opciones de paginación

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

Ir arriba

Body (request)

{
  "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 actos	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

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/actos/search'

Ir arriba

Ejemplo de request URL con opciones de paginación

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

Ir arriba

Ejemplo de body

{
  "generales": [
    {
      "campo": "fechaActo",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaActo",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "fechaPublicacion",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaPublicacion",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "fechaAlta",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaAlta",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "idBoletin",
      "valores": [
        "345"
      ],
      "codigo": "EQ"
    }
  ]
}

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

Ir arriba

Ejemplo de cURL

curl --location --request POST 'http://192.168.293.365:8071/expedientes/actos/search' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "generales": [
    {
      "campo": "fechaActo",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaActo",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "fechaPublicacion",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaPublicacion",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "fechaAlta",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaAlta",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "idBoletin",
      "valores": [
        "345"
      ],
      "codigo": "EQ"
    }
  ]
}'

Ir arriba

Ejemplo de cURL con opciones de paginación

curl --location --request POST 'http://192.168.293.365:8071/expedientes/actos/search?PageSize=10&PageNumber=2' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "generales": [
    {
      "campo": "fechaActo",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaActo",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "fechaPublicacion",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaPublicacion",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "fechaAlta",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "fechaAlta",
      "valores": [
        "01/01/2022"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "idBoletin",
      "valores": [
        "345"
      ],
      "codigo": "EQ"
    }
  ]
}'

Ir arriba

Responses validaciones de campos

400 Valor no válido para el campo ‘codigo’

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

400 Valor no válido para el campo ‘campo’

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

400 Lista de valores vacía

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

400 Lista de ‘valores’ con valor vacío

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

400 Filtro ‘Between’ con más de dos valores

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

Ir arriba

Headers responses

{"TotalCount":<total>,"PageSize":<size>,"CurrentPage":<current_page>,"TotalPages":<total_pages>,"HasNextPage":<has_next_page>,"HasPreviousPage":<has_previous_page>,"NextPageUrl":<next_url>,"PreviousPageUrl":<previous_url>}

Parámetro	Descripción
<total>	Número total de actos encontrados en la búsqueda
<size>	Número de elementos por página
<current_page>	Página actual
<total_pages>	Número total de páginas
<has_next_page>	Indica si hay página siguiente
<has_previous_page>	Indica si hay página anterior
<next_url>	URL de la siguiente página
<previous_url>	URL de la página anterior

Ir arriba

Ejemplo headers responses

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "idExpediente": 6420,
      "acto": {
        "codigo": "520",
        "descripcion": "Anotación"
      },
      "fechaActo": "01/12/2021",
      "fechaPublicacion": null,
      "referencia": null,
      "numero_acto": null,
      "fechaAnulacion": null
    },
    {
      "id": 2,
      "idExpediente": 5487,
      "acto": {
        "codigo": "050",
        "descripcion": "Solicitud de registro"
      },
      "idBoletin": 345,
      "fechaAlta": "03/04/2020",
      "fechaActo": "10/12/2021",
      "fechaPublicacion": null,
      "referencia": null,
      "numero_acto": null,
      "fechaAnulacion": null
    }
  ]
}

500 Ha ocurrido un error

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

Ir arriba

[POST] /expedientes/tareas/search

Ir arriba

Descripción

Búsqueda de tareas sobre los expedientes con filtros. Devuelve un listado con las tareas que cumplan los filtros de búsqueda.

Ir arriba

Petición

POST /expedientes/tareas/search

Ir arriba

Petición con opciones de paginación

POST /expedientes/tareas/search?PageSize=<size>&PageNumber=<number>

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/tareas/search'

Ir arriba

Request URL con opciones de paginación

http://<dominio>:<puerto>/expedientes/tareas/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

Ir arriba

cURL

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

Ir arriba

cURL con opciones de paginación

curl --location --request POST 'http://<dominio>:<puerto>/expedientes/tareas/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

Ir arriba

Body (request)

{
  "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 tareas 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

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/tareas/search'

Ir arriba

Ejemplo de request URL con opciones de paginación

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

Ir arriba

Ejemplo de body

{
  "generales": [
    {
      "campo": "codigo",
      "valores": [
        "VENCF1"
      ],
      "codigo": "EQ"
    },
    {
      "campo": "fechaVencimiento",
      "valores": [
        "01/01/2022",
        "31/01/2022"
      ],
      "codigo": "BT"
    },
    {
      "campo": "estado",
      "valores": [
        "P"
      ],
      "codigo": "EQ"
    }
  ]
}

Campo	Descripción	Obligatorio	Tipo parámetro
“fechaVencimiento”	Filtro sobre la fecha de vencimiento de la tarea	No	Cadena de caracteres. Formato: día/mes/año
“estado”	Filtro sobre el estado de la tarea	No	Un carácter
“codigo”	Filtro sobre el código de la tarea	No	Cadena de caracteres

Ir arriba

Ejemplo de cURL

curl –location –request POST ‘http://192.168.293.365:8071/expedientes/tareas/search’ \

–header ‘Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH’ \

–header ‘Content-Type: application/json’ \

–data-raw ‘{

“generales”: [

{

“campo”: “codigo”,

“valores”: [

“VENCF1”

“codigo”: “EQ”

{

“campo”: “fechaVencimiento”,

“valores”: [

“01/01/2022”,

“31/01/2022”

“codigo”: “BT”

{

“campo”: “estado”,

“valores”: [

“P”

“codigo”: “EQ”

}

]

}’

Ir arriba

Ejemplo de cURL con opciones de paginación

curl –location –request POST ‘http://192.168.293.365:8071/expedientes/tareas/search?PageSize=10&PageNumber=2’ \

–header ‘Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH’ \

–header ‘Content-Type: application/json’ \

–data-raw ‘{

“generales”: [

{

“campo”: “codigo”,

“valores”: [

“VENCF1”

“codigo”: “EQ”

{

“campo”: “fechaVencimiento”,

“valores”: [

“01/01/2022”,

“31/01/2022”

“codigo”: “BT”

{

“campo”: “estado”,

“valores”: [

“P”

“codigo”: “EQ”

}

]

}’

Ir arriba

Responses validaciones de campos

400 Valor no válido para el campo ‘codigo’

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

400 Valor no válido para el campo ‘campo’

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

400 Lista de valores vacía

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

400 Lista de ‘valores’ con valor vacío

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

400 Filtro ‘Between’ con más de dos valores

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

Ir arriba

Headers responses

{"TotalCount":<total>,"PageSize":<size>,"CurrentPage":<current_page>,"TotalPages":<total_pages>,"HasNextPage":<has_next_page>,"HasPreviousPage":<has_previous_page>,"NextPageUrl":<next_url>,"PreviousPageUrl":<previous_url>}

Parámetro	Descripción
<total>	Número total de actos encontrados en la búsqueda
<size>	Número de elementos por página
<current_page>	Página actual
<total_pages>	Número total de páginas
<has_next_page>	Indica si hay página siguiente
<has_previous_page>	Indica si hay página anterior
<next_url>	URL de la siguiente página
<previous_url>	URL de la página anterior

Ir arriba

Ejemplo headers responses

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

Ir arriba

Responses

200 Ha ido correctamente

{
  "statusCode": 200,
  "message": "Petición finalizada correctamente",
  "data": [
    {
      "id": 1,
      "idExpediente": 5487,
      "tarea": {
        "codigo": "BREXIT",
        "descripcion": "Brexit"
      },
      "estado": {
        "codigo": "A",
        "descripcion": "Aplazada"
      },
      "fechaVencimiento": "15/04/2021",
      "fechaInicio": "04/03/2021",
      "fechaFin": null,
      "descripcionAlternativa": "Descripcion",
      "observaciones": "Observaciones de la tarea",
      "supervisor": {
        "codigo": "ANI",
        "nombre": "Ana",
        "apellidos": "Lopez"
      },
      "responsable": {
        "codigo": "LAU",
        "nombre": "Laura",
        "apellidos": "Rodriguez"
      },
      "responsableFin": null
    },
    {
      "id": 2,
      "idExpediente": 6420,
      "tarea": {
        "codigo": "ARMEDIM",
        "descripcion": "Mediación - M"
      },
      "estado": {
        "codigo": "C",
        "descripcion": "Completada"
      },
      "fechaVencimiento": "03/04/2021",
      "fechaInicio": "01/12/2021",
      "fechaFin": "31/12/2021",
      "descripcionAlternativa": null,
      "observaciones": null,
      "supervisor": null,
      "responsable": null,
      "responsableFin": {
        "codigo": "ANI",
        "nombre": "Ana",
        "apellidos": "Lopez"
      }
    }
  ]
}

500 Ha ocurrido un error

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

Ir arriba

[PUT] /expedientes/{id}

Ir arriba

Descripción

Modificación de un expediente.

Ir arriba

Petición

PUT /expedientes/<id>

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

Ir arriba

Request URL

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

Ir arriba

cURL

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í

Ir arriba

Body (request)

{
  "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

¡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

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/6450'

Ir arriba

Ejemplo de body

{
  "estado": "B",
  "descripciones": [
    {
      "tipo": "DE",
      "descripcion": "Culture",
      "idioma": "es"
    }
  ]
}

Ir arriba

Ejemplo de cURL

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

Ir arriba

Responses validaciones de campos

400 Valor no válido para el campo ‘estado’

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

Ir arriba

Responses control descripciones

400 Valor no válido para el campo ‘idioma’

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

400 Valor no válido para el campo ‘tipo’

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

400 Claves duplicadas en la lista de descripciones

{
    "statusCode": 400,
    "message": "Descripciones duplicadas. Clave duplicada { Elemento = { Tipo = DE, Idioma = es }, Ocurrencias = 2 }",
    "data": null
}

400 Incluir varias denominaciones para modalidades distintas de patentes

{
    "statusCode": 400,
    "message": "Este tipo de modalidad no permite guardar varias denominaciones",
    "data": null
}

Ir arriba

Responses

200 Ha ido correctamente

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

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[PUT] /expedientes/{id}/tareas/{idTarea}

Ir arriba

Descripción

Modificación de una tarea de un expediente.

Ir arriba

Petición

PUT /expedientes/<id>/tareas/<idTarea>

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	6450
<idTarea>	Identificador de la tarea	Sí	245

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/tareas/<idTarea>'

Ir arriba

cURL

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

Header	Descripción	Obligatorio
<body>	Información de la tarea que queremos modificar	Sí

Ir arriba

Body (request)

{
  "fechaVencimiento": <fechaVencimiento>,
  "fechaInicio": <fechaInicio>,
  "fechaFin": <fechaFin>,
  "estado": <estado>,
  "respuesta": <respuesta>,
  "multiopcion": <multiopcion>
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<fechaVencimiento>	Fecha de vencimiento	No	Cadena de caracteres. Formato: día/mes/año		07/10/2024
“fechaInicio”	Fecha de inicio	No	Cadena de caracteres. Formato: día/mes/año		07/10/2024
<fechaFin>	Fecha de fin	No	Cadena de caracteres. Formato: día/mes/año		07/10/2024
<estado>	Estado del expediente. Consultar petición [GET] /estados para más información	No	Cadena de caracteres.	Único carácter	B
<respuesta>	Respuesta a la pregunta de Workflow. Consultar petición [GET] /tareas/{codTarea}/preguntas para más información	No	Booleano		true
<multiopcion>	Multiopción del Workflow. Consultar petición [GET] /tareas/{codTarea}/multiopciones para más información	No	Array numérico		1

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/6450/tareas/245'

Ir arriba

Ejemplo de body

{
  "fechaVencimiento": "09/10/2024",
  "fechaInicio": "09/10/2024",
  "fechaFin": "09/10/2024",
  "estado": "B",
  "respuesta": false,
  "multiopcion": []
}

Ir arriba

Ejemplo de cURL

curl --location --request PUT 'http://192.168.293.365:8071/expedientes/6450' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "fechaVencimiento": "09/10/2024",
  "fechaInicio": "09/10/2024",
  "fechaFin": "09/10/2024",
  "estado": "B",
  "respuesta": false,
  "multiopcion": []
}'

Ir arriba

Responses validaciones de campos

400 Valor no válido para el campo ‘estado’

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

Ir arriba

Responses control descripciones

400 Valor no válido para el campo ‘idioma’

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

Ir arriba

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": 4
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

[PUT] /expedientes/{id}/tareas/{idTarea}/importes/{idImporte}

Ir arriba

Descripción

Modificación de un importe de una tarea de un expediente.

Ir arriba

Petición

PUT /expedientes/<id>/tareas/<idTarea>/importes/<idImporte>

Parámetro	Descripción	Obligatorio	Ejemplo
<id>	Identificador del expediente	Sí	6450
<idTarea>	Identificador de la tarea	Sí	245
<idImporte>	Identificador del importe	Sí	10

Ir arriba

Request URL

http://<dominio>:<puerto>/expedientes/<id>/tareas/<idTarea>/importes/<idImporte>'

Ir arriba

cURL

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

Header	Descripción	Obligatorio
<body>	Información del importe que queremos modificar	Sí

Ir arriba

Body (request)

{
  "idArticulo": <idArticulo>,
  "importe": <importe>,
  "cantidad": <cantidad>,
  "descuento": <descuento>,
  "importeTasa": <importeTasa>,
  "numeroClasesAdicionales": <numeroClasesAdicionales>,
  "importeMulticlase": <importeMulticlase>,
  "importeTasaClaseAdicional": <importeTasaClaseAdicional>,
  "importeMulticlase2": <importeMulticlase2>,
  "importeTasaClaseAdicional2": <importeTasaClaseAdicional2>,
  "numeroClasesAdicionales2": <numeroClasesAdicionales2>,
  "totalGastosEstimados": <totalGastosEstimados>
}

Parámetro	Descripción	Obligatorio	Tipo parámetro	Longitud máxima parámetro	Ejemplo
<idArticulo>	Id del artículo. Consultar petición [GET] /articulos para más información	No	Numérico		1
“importe”	Importe del artículo	No	Numérico con decimales	Máximo 4 decimales	100
<cantidad>	Cantidad de artículos	No	Numérico		2
<descuento>	Descuento del artículo	No	Numérico con decimales	Máximo 4 decimales	10
<importeTasa>	Importe de tasa	No	Numérico con decimales	Máximo 4 decimales	25
<numeroClasesAdicionales>	Número de clases adicionales	No	Numérico		3
<importeMulticlase>	Importe multiclase	No	Numérico con decimales	Máximo 4 decimales	50
“importeTasaClaseAdicional”	Importe de tasa de clase adicional	No	Numérico con decimales	Máximo 4 decimales	8
<importeMulticlase2>	Importe multiclase 2	No	Numérico con decimales	Máximo 4 decimales	75
<importeTasaClaseAdicional2>	Importe de tasa de clase adicional 2	No	Numérico con decimales	Máximo 4 decimales	12
<numeroClasesAdicionales2>	Número de clases adicionales 2	No	Numérico		2
<totalGastosEstimados>	Total gastos estimados	No	Numérico con decimales	Máximo 4 decimales	200

¡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

Ir arriba

Ejemplo de request URL

http://192.168.293.365:8071/expedientes/6450/tareas/245/importes/10'

Ir arriba

Ejemplo de body

{
  "idArticulo": 1,
  "importe": 100,
  "cantidad": 2,
  "descuento": 10,
  "importeTasa": 25,
  "numeroClasesAdicionales": 3,
  "importeMulticlase": 50,
  "importeTasaClaseAdicional": 8,
  "importeMulticlase2": 75,
  "importeTasaClaseAdicional2": 12,
  "numeroClasesAdicionales2": 2,
  "totalGastosEstimados": 200
}

Ir arriba

Ejemplo de cURL

curl --location --request PUT 'http://192.168.293.365:8071/expedientes/6450/tareas/245/importes/10' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiI5ZTI5ZDA1Yi0zMTNjLTQ2MjNzUyNzg2OHH' \
--header 'Content-Type: application/json' \
--data-raw '{
  "idArticulo": 1,
  "importe": 100,
  "cantidad": 2,
  "descuento": 10,
  "importeTasa": 25,
  "numeroClasesAdicionales": 3,
  "importeMulticlase": 50,
  "importeTasaClaseAdicional": 8,
  "importeMulticlase2": 75,
  "importeTasaClaseAdicional2": 12,
  "numeroClasesAdicionales2": 2,
  "totalGastosEstimados": 200
}'

Ir arriba

Responses

200 Ha ido correctamente

{
    "statusCode": 200,
    "message": "Petición finalizada correctamente",
    "data": 4
}

404 No se ha encontrado el expediente

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

500 Ha ocurrido un error

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

Ir arriba

Artículo siguiente