diff --git a/apigee/medicamentos-afiliado.json b/apigee/medicamentos-afiliado.json index eba8ef8..ef70b88 100644 --- a/apigee/medicamentos-afiliado.json +++ b/apigee/medicamentos-afiliado.json @@ -46,7 +46,7 @@ }, { "name": "cols-medicamentos-pedidos", - "description": "Servicio encargado de gestionar cada uno de los departamentos y ciudades que participan en el proyecto de Medicamentos. Estos servicios permiten ver un listado de cada uno de los departamentos y a su vez las ciudades que tienen asociadas." + "description": "Servicios de gestion de pedidos de proyecto de medicamentos." } ], "paths": { @@ -737,7 +737,274 @@ ] } }, - + "/v1/medicamentos/pedidos/usuarios": { + "get": { + "tags": [ + "cols-medicamentos-pedidos" + ], + "summary": "Consulta de pedidos por usuario.", + "description": "Permite consultar los pedidos por usuario.", + "operationId": "obtenerPedidoPorUsuario", + "parameters": [ + { + "name": "id", + "in": "query", + "description": "Número de identificación del usuario.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "pedidoId", + "in": "query", + "description": "Número de identificación del pedido.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "estado", + "in": "query", + "description": "Estado del pedido.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "ciudadId", + "in": "query", + "description": "Numero de identificacion de la ciudad del usuario.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "epsId", + "in": "query", + "description": "Numero de identificacion de la EPS del usuario.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "fechaIni", + "in": "query", + "description": "Fecha inicial.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "fechaFin", + "in": "query", + "description": "Fecha final.", + "required": true, + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/obtenerPedidoPorUsuarioResponse" + } + } + } + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v1/medicamentos/pedidos/id": { + "get": { + "tags": [ + "cols-medicamentos-pedidos" + ], + "summary": "Consulta de pedidos por id del pedido.", + "description": "Permite consultar los pedidos por el numero de identificacion del pedido.", + "operationId": "obtenerPedidoPorId", + "parameters": [ + { + "name": "pedidoId", + "in": "query", + "description": "Número de identificación del pedido.", + "required": true, + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/obtenerPedidoPorIdResponse" + } + } + } + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v1/medicamentos/pedidos/pacientes": { + "get": { + "tags": [ + "cols-medicamentos-pedidos" + ], + "summary": "Consulta de pedidos por pacientes.", + "description": "Permite consultar los pedidos por pacientes.", + "operationId": "obtenerPedidoPorPaciente", + "parameters": [ + { + "name": "tipoId", + "in": "query", + "description": "Tipo de identificacion del paciente.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "numId", + "in": "query", + "description": "Número de identificación del paciente.", + "required": true, + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/obtenerPedidoPorPacienteResponse" + } + } + } + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v1/medicamentos/pedidos/valor/ciudades": { + "get": { + "tags": [ + "cols-medicamentos-pedidos" + ], + "summary": "Consulta de valor pedido por ciudad.", + "description": "Permite consultar los valores de los pedidos por ciudad.", + "operationId": "obtenerValorPedidoCiudad", + "parameters": [ + { + "name": "ciudadId", + "in": "query", + "description": "Numero de identificacion de la ciudad.", + "required": true, + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/obtenerPedidoValorCiudadResponse" + } + } + } + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v1/medicamentos/pedidos/archivos": { + "get": { + "tags": [ + "cols-medicamentos-pedidos" + ], + "summary": "Consulta archivos por pedidos.", + "description": "Permite consultar los archivos por los pedidos.", + "operationId": "obtenerArchivoPedido", + "parameters": [ + { + "name": "pedidoId", + "in": "query", + "description": "Numero de identificacion del pedido.", + "required": true, + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/obtenerArchivoPedidoResponse" + } + } + } + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + } }, @@ -1980,6 +2247,412 @@ } } }, + "direccionPedido": { + "type": "object", + "properties": { + "ciudad": { + "$ref": "#/components/schemas/ciudad" + }, + "direccionPrincipal": { + "type": "string", + "description": "Dirección principal" + }, + "id": { + "type": "number", + "description": "Numero de identificacion de la direccion." + } + }, + "xml": { + "name": "direccionPedido" + } + }, + "pacientePedido": { + "type": "object", + "properties": { + "nombre": { + "$ref": "#/components/schemas/nombre" + }, + "documento": { + "$ref": "#/components/schemas/documento" + }, + "eps": { + "$ref": "#/components/schemas/eps" + }, + "direccion": { + "$ref": "#/components/schemas/direccionPedido" + }, + "correoElectronico": { + "type": "string", + "description": "Correo electronico del paciente." + }, + "telefono": { + "type": "string", + "description": "Telefono del paciente." + } + } + }, + "pedido": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Numero de identificacion del pedido." + }, + "estado": { + "type": "string", + "description": "Estado del pedido." + }, + "paciente": { + "$ref": "#/components/schemas/pacientePedido" + }, + "horario": { + "$ref": "#/components/schemas/horario" + }, + "calificacion": { + "type": "string", + "description": "Calificacion del pedido." + }, + "valor": { + "type": "string", + "description": "Valor del pedido." + }, + "comentario": { + "type": "string", + "description": "Comentario del pedido." + }, + "usuarioCreacion": { + "type": "string", + "description": "Usuario de creacion del pedido." + }, + "usuarioActual": { + "type": "string", + "description": "Usuario actual." + }, + "fechaCreacion": { + "type": "string", + "description": "Fecha de creacion del pedido.", + "format": "date-time" + }, + "fechaActualizacion": { + "type": "string", + "description": "Fecha de actualizacion del pedido.", + "format": "date-time" + } + } + }, + "obtenerPedidoUsuario": { + "type": "object", + "properties": { + "pedido": { + "$ref": "#/components/schemas/pedido" + } + } + }, + "producto": { + "type": "object", + "properties": { + "codigo": { + "type": "string", + "description": "Codigo del producto." + }, + "descripcion": { + "type": "string", + "description": "Descripcion del producto." + } + }, + "xml": { + "name": "formula" + } + }, + "tratamiento": { + "type": "object", + "properties": { + "producto": { + "$ref": "#/components/schemas/producto" + }, + "cantidad": { + "type": "string", + "description": "Cantidad del tratamiento." + } + }, + "xml": { + "name": "formula" + } + }, + "formula": { + "type": "object", + "properties": { + "numero": { + "type": "string", + "description": "Numero de formula." + }, + "tratamiento": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tratamiento" + } + } + }, + "xml": { + "name": "formula" + } + }, + "horario": { + "type": "object", + "properties": { + "rango": { + "type": "string", + "description": "Rango horario." + } + }, + "xml": { + "name": "horario" + } + }, + "archivo": { + "type": "object", + "properties": { + "ruta": { + "type": "string", + "description": "Ruta de archivo." + }, + "url": { + "type": "string", + "description": "URL de archivo." + }, + "id": { + "type": "string", + "description": "Id de archivo." + } + }, + "xml": { + "name": "archivo" + } + }, + "pedidoId": { + "type": "object", + "properties": { + "paciente": { + "$ref": "#/components/schemas/pacientePedido" + }, + "formula": { + "type": "array", + "items": { + "$ref": "#/components/schemas/formula" + } + }, + "horario": { + "$ref": "#/components/schemas/horario" + }, + "calificacion": { + "type": "string", + "description": "Calificacion del pedido." + }, + "valor": { + "type": "string", + "description": "Valor del pedido." + }, + "comentario": { + "type": "string", + "description": "Comentario del pedido." + }, + "usuarioCreacion": { + "type": "string", + "description": "Usuario de creacion del pedido." + }, + "usuarioActual": { + "type": "string", + "description": "Usuario actual." + }, + "fechaCreacion": { + "type": "string", + "description": "Fecha de creacion del pedido.", + "format": "date-time" + }, + "fechaActualizacion": { + "type": "string", + "description": "Fecha de actualizacion del pedido.", + "format": "date-time" + }, + "archivo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/archivo" + } + } + } + }, + "obtenerPedido": { + "type": "object", + "properties": { + "pedido": { + "$ref": "#/components/schemas/pedidoId" + } + } + }, + "obtenerPedidoPaciente": { + "type": "object", + "properties": { + "pedido": { + "$ref": "#/components/schemas/pedido" + } + } + }, + "ciudadValor": { + "type": "object", + "properties": { + "valor": { + "type": "string", + "description": "Valor del pedido por la ciudad." + } + } + }, + "obtenerValorCiudad": { + "type": "object", + "properties": { + "ciudad": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ciudadValor" + } + } + } + }, + "pedidoArchivo": { + "type": "object", + "properties": { + "archivo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/archivo" + } + } + } + }, + "obtenerArchivo": { + "type": "object", + "properties": { + "pedido": { + "$ref": "#/components/schemas/pedidoArchivo" + } + } + }, + "obtenerArchivoPedidoResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "obtenerArchivo": { + "type": "array", + "items": { + "$ref": "#/components/schemas/obtenerArchivo" + } + } + } + }, + "obtenerPedidoValorCiudadResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "obtenerValorCiudad": { + "type": "array", + "items": { + "$ref": "#/components/schemas/obtenerValorCiudad" + } + } + } + }, + + "obtenerPedidoPorPacienteResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "obtenerPedidoPaciente": { + "type": "array", + "items": { + "$ref": "#/components/schemas/obtenerPedidoPaciente" + } + } + } + }, + "obtenerPedidoPorIdResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "obtenerPedido": { + "type": "array", + "items": { + "$ref": "#/components/schemas/obtenerPedido" + } + } + } + }, + "obtenerPedidoPorUsuarioResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "obtenerPedidoUsuario": { + "type": "array", + "items": { + "$ref": "#/components/schemas/obtenerPedidoUsuario" + } + } + } + }, "obtenerPaciente": { "type": "object", "properties": {