Endpoints CRUD

Utilícese los siguientes endpoint para invocar los métodos del CRUD: create, one, update y delete.

Entidad Métodos

Utilícese estos endpoint para gestionar los datos de los modelos de la base de datos.

Nota

Ejemplo de uso: En este primer ejemplo nos basamos en la entidad Profile, para utilizar sus endpoint ( URLs de las Entidades ) remplasamos cada <Entity.route> por la ruta de la entidad correspondiente en la table Rutas por entidad para este caso tendriamos profile: ( Default URL Profile: POST /profile/ ). Para las Request Entity.FIELDS ver capítulo Entidades, para Profile, por tanto, tendremos que enviar en la request los campos: nombre, last_name, ci, nit y address.

URLs de las Entidades

Default URL: POST /<Entity.route>/

Default URL: GET /<Entity.route>s/

Default URL: GET /<Entity.route>/:id

Default URL: PUT /<Entity.route>/

Default URL: PATCH /<Entity.route>/

Rutas por entidad

Default URL/Entity

Entity route

Profile

  • profile

HiredPerson

  • hired/person

ProfileHiredPerson

  • profile/hired/persons

License

  • license

LicenseUser

  • license/user

FiscalYear

  • fiscal/year

Element

  • element

SupportDocument

  • support/document

Voucher

  • voucher

VoucherDetail

  • voucher/detail

Account

  • account

Method

Request

Response

POST GET PUT PATCH

Entity.FIELDS Entity.FIELD

  • Bearer

  • token

HTTP_201_CREATED HTTP_200_OK HTTP_204_NO_CONTENT

  • status: "success"

  • error: null

  • data:

    User.FIELDS, confirUrl, token

HTTP_409_CONFLICT HTTP_500_INTERNAL_SERVER_ERROR

  • status: "fail"

  • error: { message }

  • data: null

Eliminar

Utilice este endpoint para eliminar la entidad deceada. Se enviará la información del usuario loguedo en un token mediante la cabecera HTTP Authorization utilizando un Authentication schemes.

Default URL: /profile/<:uid>/ Default URL: /support/document/<:uid>/

Default URL: /hired/person/<:uid>/ Default URL: /voucher/<:uid>/

Default URL: /profile/hired/person/<:uid>/ Default URL: /voucher/detail/<:uid>/

Default URL: /license/<:uid>/ Default URL: /account/<:uid>/

Default URL: /license/user/<:uid>/

Default URL: /fiscal/year/<:uid>/

Default URL: /element/<:uid>/

Method

Request

Response

DELETE

  • Bearer

  • token

HTTP_204_NO_CONTENT

HTTP_400_BAD_REQUEST

  • status: "fail"

  • error: { message }

  • data: null