­Home‎ > ‎

Getting Started



Base URL

https://a.aeegle.com

Request Headers


Header Value
Host https://app.aeegle.com
Content-type application/json;charset=UTF-8

WS API Requests Catalog


Operation

URI

HTTP

Protocolo

Description

User forms

/app/api/v1/user/forms

POST

Get the user's forms

User form metadata

/app/api/v1/form/metadata

POST

Get the a specific user's form metadata

Search Records

/app/api/v1/search

POST

Para la búsqueda de uno o varios registros del formulario, permite especificar ocultar uno o varios campos, filtrar y ordenar los registros a conveniencia.

Create a Record

/app/api/v1/create

POST

Se utiliza para crear registros al formulario.

Get Record

/app/api/v1/get

POST

Obtiene un único registro de un formulario, se debe especificar el identificador del registro.

Update a Record

/app/api/v1/update

POST

Para modificar uno o todos los campos de un registro, se debe conocer el identificador del registro

Delete a Record

/app/api/v1/delete

POST

Se usa para eliminar un registro de un formulario, se debe saber el identificador del registro y del formulario.

API request format

{

"authToken": "(valueAutToken)",

"formId": "(valueFormId)",

"model": {

"(param1)": "(value1)",

"(param2)": "(value2)",

...

"(paramN)": "(valueN)",

}

}

Request parameters

Parameter

Description

authToken

Valid token

formId

Id of the form

model

Object JSON whit list of fields to save

API response format

{

   "message": "(message result)",

   "nodeResponse": {

       "count": (total records),

       "filterFields": [],

       "pageSize": (number of records per page),

       "current": (current page),

       "records": [

           {

"_id": "(id the record)",

"(field1)" : "(value1)",

"(field2)" : "(value2)",

...

"(fieldN)" : "(valueN)"

               

           }

       ],

       "totalPages": (total pages)

   },

   "action": "(execute action)",

   "code": (code the result from request)

}


Response parameters


HTTP Status Code 200 demuestra que la petición fue recibida exitosamente.

 

Parameter

Description

message

Message shown when the data was successfully processed

nodeResponse

Shows the data requested or the status of the action

action

Shows the action executed

code

200


In case that an error occurs when executing the request, the following data is shown:

Parametro

Description

message

Message that describes the error

error

Error code on the database

name

Name of the error found

code

Error code on the application


Important notes

  • Audit fields such as createdBy and createdDate are non editable, these are automatically added when a new record is created.
  • For all operations is mandatory to include the formID that the records belong to
  • For the operations Get, Update and Delete is mandatory to include the recordID in the request
  • For the operation Search, maxResults is higher priority than page.
  • The maximum time for a request doesn’t have to exceed 60 seconds.