DocumentType

Índice

criar

Cria um novo tipo de documento e o adiciona ao banco de dados.

Parâmetros

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.
  • fk_doc_group número A chave estrangeira do grupo de documentos que esse tipo de documento pertence.
  • type_name string O nome do novo tipo de documento.
  • Sort_Number número A ordem de classificação do novo tipo de documento.
  • obrigatório booleano se o novo tipo de documento é obrigatório ou não.

Retorna objeto O objeto de resposta COntinging the o tipo de documento recém -criado e uma mensagem de sucesso, ou uma mensagem de erro se a solicitação falhar.

atualizar

Atualiza um tipo de documento no banco de dados com o ID fornecido.

Parâmetros ###

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.
  • fk_doc_group número A chave estrangeira do grupo de documentos que esse tipo de documento pertence.
  • type_name string O nome do novo tipo de documento.
  • Sort_number numBER A ordem de classificação do novo tipo de documento.
  • obrigatório booleano se o novo tipo de documento é obrigatório ou não.

*Lança Erro Se houver um erro ao atualizar o tipo de documento.

Retorna objeto O objeto de resposta com um JSON contendo o tipo de documento atualizado ou uma mensagem de erro.

remover

Remove um tipo de documento do banco de dados.

Parâmetros ###

  • req objeto O objeto de solicitação.
  • res objeto O objeto de resposta.
  • id objeto Parametro /{id}.

*Lança Erro Se houver um erro ao remover o tipo de documento.

Retorna objeto O objeto de resposta com um código de status e um objeto JSON contendo uma mensagem de erro ou uma mensagem de sucesso.

getbygroup

Recupera todos os documentos que pertencem a um grupo de documentos específicos.

Parâmetros ###

  • req objeto O objeto de solicitação.
  • res objeto O REobjeto de sponse.
  • fk_doc_group object parametro /{fk_doc_group}.

*Lança objeto lança um erro se houver um problema recuperando os documentos.

Retorna Objeto Retorna um objeto que contém os documentos que pertencem ao grupo especificado.

getall

Recupera todos os tipos de documentos do banco de dados e os retorna como um objeto JSON.

Parâmetros ###

  • req objeto O objeto de solicitação.
  • res objeto A respostaobjeto.

*Lança Erro Se houver um erro recuperando os tipos de documentos do banco de dados.

Retorna Objeto Um objeto JSON contendo todos os tipos de documentos.

getDocumentType

Recupera um tipo de documento do banco de dados com o ID fornecido e o retorna como um objeto JSON.

Parâmetros ###

  • req objeto O objeto de solicitação que contém o ID do tipo de documento a recuperar.
  • res objeto O objeto de resposta para enviar a recuperaçãoED Tipo de documento como um objeto JSON.
  • id objeto Parametro /{id}.

*Lança Erro Se houver um erro recuperando o tipo de documento do banco de dados.

Retorna qualquer nenhum

This work is licensed under a Creative Commons Attribution 4.0 ShareAlike License, including custom images & stylesheets. Permissions beyond the scope of this license may be available at @jr0cket
Creative Commons License