openapi: 3.0.

0 #Definirá la versión de nuestra especificación de openapi utilizada

info: #Contendrá un objeto con información de utilidad sobre nuestro api.

version: 1.0.0 #version de nuestra api esta cambia con el tiempo
title: API Administrador Correspondales Encuestas #Titulo de nuestrapi
description: API Administrador Corresponsales encuestas Para Conocer Mas Acerca
de las caracteristicas de los comercios y prospectos comisonistas #Breve
descripcion sobre nuestra api

servers: #Array con las urls de los diferentes entornos donde está alojada nuestra
API, pueden ser mas de uno.
- url: www.example-encuestas.com #url del servidor
description: pagina de las encuestas #pequeña descripcion del servidor

# Basic authentication se utilizan para describir los métodos de autenticación

utilizados en la API.
components:
securitySchemes:
BasicAuth:
type: http
scheme: basic
security:
- BasicAuth: []

paths: #puntos finales (rutas) y metodos (verbos) http /Punto final

#cuando un punto final tenga corchetes significa que nesecita un parametro
/{idEncuesta}/temas:
get:
description: Consulta temas que se realiza en la encuesta selecionada
#atributo
summary: 'Consulta temas que se realiza en la encuesta selecionada'
parameters:
- name: idEncuesta # ( - ) se utiliza para referir que es una matriz, el
nombre debe ser el mismo que el parametro
in: path #ubicacion
required: true #atributos
schema:
type: integer #tipo de dato
default: 1

## Esto no va, para que sea un parametro en "path" debe estar entre
corchetes --> {Esto es un parametro}
##de aqui
## - name: idTema # ( - ) se utiliza para referir que es una matriz, el
nombre debe ser el mismo que el parametro
## in: path #ubicacion
##required: true #atributos
##schema:
## type: integer #tipo de dato
##default: 9

#aca es incorrecto - eliminar

responses: # Para cada operación, podemos definir posibles códigos de estado,

como 200 OK o 404 Not Found, Cada operación debe tener definida al menos una
respuesta, generalmente una respuesta exitosa.
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: operacion exitosa
description: Mensaje de la operacion
folio:
type: string
example: 88801613000000474
description: Folio de la operacion
resultado:
type: object
properties:
id:
type: integer
example: 9
description: identificador de la encuesta
descripcion:
type: string
example: conocimiento y capacidad del negocio
description: Descripcion del tema
paso:
type: integer
example: 0
description: numero del paso a seguir en el tema
puntajeRequerido:
type: string
example: '0.00'
description: puntaje requerido del tema
preguntas:
type: array
items:
type: object
properties:
id:
type: integer
example: 21
description: identificador de la pregunta
idTipoControl:
type: integer
example: 1
description: Identificador del tipo control
idPrincipal:
type: integer
example: 0
description: Identificador de la pregunta
principal
descripcion:
type: string
example: 4. Acreditacion de giro de negocio propio
description: Descripcion de la pregunta
orden:
type: integer
 example: 1
description: identificador del orden de la pregunta
puntajeRequerido:
type: string
example: 0.00 x|
description: Puntaje requerido de la pregunta
urlImagen:
type: string
example:
https://CorresponsaLias-Encuestas/imagen.png
description: La imagen se mostrara en ciertos casos
como ejemplo de la pregunta
respuestas:
type: array
items:
type: object
description: Si la pregunta tiene subpreguntas se
oculta el arreglo de respuestas y se activa el objeto de subpreguntas
properties:
id:
type: integer
example: 1
description: identificador de la respuesta
descripcion:
type: string
example: si
description: Descripcion de la respuesta
puntajeRequerido:
type: string
example: 0.01
description: Puntaje requerido
descartado:
type: boolean
example: false
description: Descartar automaticamente el comercio
subpreguntas:
type: array
items:
type: object
description: si las preguntas no contienen subpreguntas
se oculta el objeto
properties:
id:
type: integer
example: 22
description: Identificador de la pregunta
idPadre:
type: integer
example: 9
description: Identificador de la encuesta padre
idControl:
type: integer
example: 1
description: Identificador del tipo control
idPrincipal:
type: integer
example: 21
description: Identificador de la pregunta principal
descripcion:
 type: string
example: 4.1 El propietario cuenta con cedula de
identificacion fiscal
description: Descripcion de la pregunta
orden:
type: integer
example: 1
description: Identificador del orden de la pregunta
puntajeRequerido:
type: string
example: 0.00
description: Puntaje requerido de la pregunta

'400':
description: Solicitud incorrecta
content:
application/json:
schema:
type: object
properties:
codigo:
type: string
example: 400.Corresponsalidas-Encuestas.10400
description: Codigo del error
mensaje:
type: string
example: Peticion no valida, favor de validar su informacion
description: Mensaje de la operacion
folio:
type: string
example: 840996000000000210
description: Folio de la operacion
info:
type: string
example:
https://baz-developer.bancoazteca.com.mx/info#400.corresponsaLias-Encuestas.10400
description: Rutas de ayuda para atender el error
detalles:
type: string
example: Favor de llenar el campo IDencuesta
description: Lista de errores
'404':
description: Recurso no encontrado
content:
application/json:
schema:
type: object
properties:
codigo:
type: string
example: 404.CorresponsaLias-Encuestas.10404
description: Codigo del error
mensaje:
type: string
example: No se encontro informacion
description: Descripcion del error
folio:
type: string
 example: 22920190128134317232
description: Numero de folio de la operacion
info:
type: string
example:
https://baz-developer.bancoazteca.com.mx/info#404.CorresponsaLias-Encuestas.10404
description: Rutas de ayuda para atender el error
detalles:
type: string
example: No se encontro informacion
description: Lista de errores
'500':
description: Error interno del servidor
content:
application/json:
schema:
type: object
properties:
codigo:
type: string
example: 500.CorresponsaLias-Encuestas.10500
description: Codigo del error
mensaje:
type: string
example: Problemas al procesar su solicitud favor de
contactar a su administrador
description: Descripcion del error
folio:
type: string
example: 22920181120162829642
description: Numero de folio de la operacion
info:
type: string
example:
https://baz-developer.bancoazteca.com.mx/info#500.CorresponsaLias-Encuestas.10500
description: Rutas de ayuda para atender el error
detalles:
type: string
example: Problemas al procesar su solicitud favor de
contactar a su administrador
description: Lista de errores

/{idEncuesta}/respuestas:
post: ##Aqui marca error por que faltan las respuestas (abajo)
description: Regitra las respuestas de la encuesta elegida
summary: Regitra las respuestas de la encuesta elegida
parameters:
- name: idEncuesta
in: path
required: true
schema:
type: integer
default: 1
- name: x.idAcceso
in: header
required: true
schema:
type: string
##format: uuid
 default: 20081113318051247

requestBody:
description: Objeto para el registro de comisionista
required: true
content:
application/json:
schema:
type: object
required:
##DUDAAAS
- Body
properties:
idDispositivo:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
description: identificador del dispositivo movil
idUsuario:
type: string
example: N24232121
description: Identificador de usuario
idProspecto:
type: string
example: 22
description: Identificador del prospecto comisionista
idEncuesta:
type: string
example: 4
description: Identificador de la encuesta realizada
idTema:
type: integer
example: 9
description: Identificador del tema realizado
respuestas:
type: array
items:
type: object
description: si las preguntas no contienen subpreguntas se
oculta el objeto
properties:
idPregunta:
type: integer
example: 23
description: Identificador de la pregunta
idRespuesta:
type: integer
example:
description: Identificador de la respuesta
horario: #horario es de tipo objeto horario { }
type: object
##items: al ser objeto no lleva items
##: object ya definimos enteriormente que es ovjeto
description: si la pregunta requiere un horario se debe
llenar el objeto en caso contrario puede omitirse
#Faltaba properties
properties:
apertura: #estaba mal identado
type: string
example: 9:00
 description: Horario de apertura
cierre:
type: string
example: 20:00
description: Horario de cierre
responses: ##estaba mal intentado toda la parte de responses
'201':
description: OK
content:
application/json:
schema:
type: object
properties:
mensaje:
type: string
example: Operacion exitosa
description: Lista de errores