diff --git a/apigee/medicamentos-afiliado.json b/apigee/medicamentos-afiliado.json index 33b02f8..cfa7adb 100644 --- a/apigee/medicamentos-afiliado.json +++ b/apigee/medicamentos-afiliado.json @@ -27,6 +27,10 @@ { "name": "cols-medicamentos-validacion", "description": "Validacion de pacientes" + }, + { + "name": "quick-medicamentos-domicilios", + "description": "Servicio de gestión de domicilio de medicamentos" } ], "paths": { @@ -39,7 +43,7 @@ "description": "Obtener informacion de los pacientes", "operationId": "validadorDerechoMedicamentos", "parameters": [ - { + { "name": "eps", "in": "path", "description": "Nombre EPSs.
neps - Nueva EPS", @@ -54,69 +58,7 @@ { "name": "tipoId", "in": "query", - "description": " - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Nueva EPS
Tipo de identificación - Descripción -
1 CE - Cédula de extranjería
2 TI - Tarjeta de identidad
3 CC - Cédula de ciudadanía
4 NIT - NIT
5 RC - Registro civil de nacimiento
6 PS - Pasaporte
7 ME - Menor de edad
8 NU - NUIP
9 AS - Adulto sin identificación
10 CD - Carné diplomático
11 CN - Recién nacido vivo
12 SC - Salvoconducto
13 PE - Permiso especial
", + "description": "
Nueva EPS
Tipo de identificación Descripción
1 CE - Cédula de extranjería
2 TI - Tarjeta de identidad
3 CC - Cédula de ciudadanía
4 NIT - NIT
5 RC - Registro civil de nacimiento
6 PS - Pasaporte
7 ME - Menor de edad
8 NU - NUIP
9 AS - Adulto sin identificación
10 CD - Carné diplomático
11 CN - Recién nacido vivo
12 SC - Salvoconducto
13 PE - Permiso especial
", "required": true, "schema": { "type": "string" @@ -156,6 +98,131 @@ } ] } + }, + "/v1/medicamentos/domicilio/cobertura": { + "post": { + "tags": [ + "quick-medicamentos-domicilios" + ], + "summary": "Solicitud de cobertura", + "description": "Permite validar si Quick tiene cobertura en una dirección y ciudad.", + "operationId": "solicitudCobertuta", + "requestBody": { + "$ref": "#/components/requestBodies/direccionRequestBody" + }, + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/generalQuick" + } + } + } + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } + }, + "/v1/medicamentos/domicilio": { + "post": { + "tags": [ + "quick-medicamentos-domicilios" + ], + "summary": "Crear guia", + "description": "Se crea servicio en la plataforma SmarQuick para el control y gestion del domicilio.", + "operationId": "crearGuia", + "requestBody": { + "$ref": "#/components/requestBodies/crearGuiaRequestBody" + }, + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/generalQuick" + } + } + } + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + }, + "get": { + "tags": [ + "quick-medicamentos-domicilios" + ], + "summary": "Consultar guia", + "description": "Permite consultar guia a partir del numero de guia. Consulta contra SmartQuick.", + "operationId": "consultarGuia", + "parameters": [ + { + "name": "numeroGuia", + "in": "query", + "description": "Numero de guia.", + "required": true, + "schema": { + "type": "number" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultadoQuick" + } + }, + "consultarGuia": { + "type": "array", + "items": { + "$ref": "#/components/schemas/consultarGuia" + } + } + } + } + } + } + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } } }, "externalDocs": { @@ -164,6 +231,269 @@ }, "components": { "schemas": { + "resultadoQuick": { + "description": "Objeto de resultado específico para la plataforma SmarQuick", + "type": "object", + "properties": { + "codigo": { + "type": "string", + "description": "Código del resultado" + }, + "descripcion": { + "type": "string", + "description": "Descripción del resultado" + }, + "valorTotal": { + "type": "number", + "description": "Valor total" + }, + "direccion": { + "type": "string", + "description": "Dirección no encontrada" + } + }, + "required": [ + "valorTotal codigo descripcion" + ] + }, + "generalQuick": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultadoQuick" + } + } + } + }, + "crearGuiaRequest": { + "type": "object", + "properties": { + "informacionPersonal": { + "type": "object", + "description": "Código del resultado", + "properties": { + "nombre": { + "$ref": "#/components/schemas/nombreRequestQuick" + }, + "documento": { + "$ref": "#/components/schemas/documentoRequestQuick" + }, + "residencia": { + "$ref": "#/components/schemas/residenciaRequestQuick" + } + } + }, + "envio": { + "type": "object", + "properties": { + "guia": { + "$ref": "#/components/schemas/guia" + }, + "entrega": { + "$ref": "#/components/schemas/entrega" + }, + "pago": { + "$ref": "#/components/schemas/pago" + }, + "observacion": { + "type": "string" + }, + "negocio": { + "type": "string" + }, + "usuario": { + "type": "string" + } + } + } + } + }, + "nombreRequestQuick": { + "type": "object", + "description": "Informacion del nombre del receptor", + "properties": { + "completo": { + "type": "string", + "description": "Nombre completo de recptor" + } + } + }, + "documentoRequestQuick": { + "type": "object", + "description": "Informacion del documento del receptor", + "properties": { + "numero": { + "type": "number", + "description": "Numero de identificacion del receptor" + } + } + }, + "direccionRequestQuick": { + "type": "object", + "description": "Informacion de la direccion de envio", + "properties": { + "ciudad": { + "type": "object", + "description": "Informacion de la ciudad", + "properties": { + "nombre": { + "type": "string", + "description": "Nombre de la ciudad" + } + } + }, + "direccionPrincipal": { + "type": "string", + "description": "Direccion de envio" + } + } + }, + "residenciaRequestQuick": { + "type": "object", + "description": "Informacion de residencia del receptor", + "properties": { + "ciudad": { + "type": "object", + "description": "Informacion de la ciudad del recptor", + "properties": { + "nombre": { + "type": "string", + "description": "Nombre de la ciudad de envio" + } + } + }, + "direccion": { + "type": "object", + "description": "Informacion de la direccion", + "properties": { + "direccionPrincipal": { + "type": "string", + "description": "Direccion del receptor" + } + } + }, + "telefono": { + "type": "number", + "description": "Telefono del receptor" + } + } + }, + "consultarGuia": { + "type": "object", + "properties": { + "direccion": { + "$ref": "#/components/schemas/direccion" + }, + "envio": { + "type": "object", + "description": "Informacion del envio", + "properties": { + "guia": { + "type": "object", + "description": "Informacion de guia", + "properties": { + "numero": { + "type": "string", + "description": "Numero de guia del envio" + }, + "imei": { + "type": "string", + "description": "Numero identificacion del envio" + }, + "fechaCreacion": { + "type": "string", + "description": "Fecha de creacion de la guia" + } + } + }, + "fechaRecibido": { + "type": "string", + "description": "Fecha de recibido del envio" + }, + "fechaLlegada": { + "type": "string", + "description": "Fecha de llegada del transporte" + }, + "fechaCierre": { + "type": "string", + "description": "Fecha de cierre del envio" + }, + "estado": { + "type": "string", + "description": "Estado del envio" + }, + "novedad": { + "type": "string", + "description": "Novedad del envio" + } + } + }, + "informacionPersonal": { + "type": "object", + "description": "Informacion del conductor", + "properties": { + "nombre": { + "type": "string", + "description": "Nombre del transportista" + }, + "foto": { + "type": "string", + "description": "Foto del transportista" + } + } + } + } + }, + "guia": { + "type": "object", + "description": "Informacion de la guia", + "properties": { + "numero": { + "type": "number", + "description": "Numero de guia del envio" + } + } + }, + "entrega": { + "type": "object", + "description": "Informacion de la entrega", + "properties": { + "fecha": { + "type": "string", + "description": "Fecha de entrega del envio" + }, + "hora": { + "type": "string", + "description": "Hora de entrega del envio" + } + } + }, + "pago": { + "type": "object", + "description": "Informacion del pago", + "properties": { + "forma": { + "type": "string", + "description": "Forma de pago del receptor" + }, + "valor": { + "type": "string", + "description": "Valor a pagar por el receptor" + }, + "cuentaVenta": { + "type": "string", + "description": "Por cual plataforma compro el recptor" + } + } + }, "resultado": { "type": "object", "properties": { @@ -746,7 +1076,30 @@ } } }, - "requestBodies": {}, + "requestBodies": { + "direccionRequestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/direccionRequestQuick" + } + } + }, + "description": "Información de la cita a actualizar", + "required": true + }, + "crearGuiaRequestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/crearGuiaRequest" + } + } + }, + "description": "Crear cita sin orden", + "required": true + } + }, "securitySchemes": { "apigee_auth": { "type": "oauth2", @@ -762,4 +1115,4 @@ } } } -} \ No newline at end of file +}