Por toroalbert
Publicado el 13 de Marzo del 2023
Esta consulta permite conocer los campos que tiene agregados un menú, así como sus tipos de datos y si son requeridos o no. Para realizar esta consulta se requiere hacer previamente la autenticación y el inicio de sesión para obtener el access_token
y el token
correspondiente.
https://shortae.com/api/camp/{alias_de_menu}
Donde {alias_de_menu}
es el alias asignado al menú que se quiere consultar.
GET
Parámetro | Descripción | Tipo | Requerido |
---|---|---|---|
access_token | Token de acceso obtenido con la autenticación | string | Sí |
Cabecera | Descripción | Tipo | Requerido |
---|---|---|---|
Authorization | Token de sesión del usuario | string | Sí |
En caso de éxito, se devuelve un objeto JSON con la siguiente estructura:
{
"success": true,
"answer": [
{
"alias_campo_1": {
"tipo": "tipo_de_dato",
"requerido": true/false
}
},
{
"alias_campo_2": {
"tipo": "tipo_de_dato",
"requerido": true/false
}
}
]
}
Donde cada objeto dentro del array answer
corresponde a un campo del menú, y su contenido muestra el tipo de dato y si es requerido o no. Los valores de tipo_de_dato
pueden ser:
texto
entero
decimal
booleano
fecha
hora
fecha_hora
opción
archivo
GET https://shortae.com/api/camp/menu_ejemplo
Authorization: Bearer {token_de_sesion}
{
"success": true,
"answer": [
{
"campo_texto": {
"tipo": "texto",
"requerido": true
}
},
{
"campo_numero": {
"tipo": "entero",
"requerido": false
}
},
{
"campo_fecha": {
"tipo": "fecha",
"requerido": true
}
}
]
}