Organização

Índice

• Create
  • Parâmetros
• atualização
  • Parâmetros
• Remover
  • Parâmetros
• getall
  • Parâmetros
• Getorganization
  • Parâmetros

criar

Cria uma Organização Nova e Registra A Criação.

Parâmetros ###

• req objeto o objeto de requisição.
• res Object O objeto de resposta.
• oficial_name String O nome oficial da organização.
• personal_name String O nome pessoal da organização.
• fk_genery_org_type String A chave estrangeira para o tipo genérico de organização.

• Throws Error Se houver um erro ao criar a organização ou registrar a criação.

Returns Object O objeto de resposta com a organização criada e uma mensagem de sucesso.

update

Update uma organização.

Parameters

• req Object O objeto de requisição.
• res Object O objeto de resposta.
• oficial_name String O nome oficial da organização.
• personal_name String O nome pessoal da organização.
• fk_genery_org_type String A chave estrangeira para o tipo genérico de organização.

• Throws Error Se houver um erro ao criar a organização ou registraruma crianda.

Retorna objeto o objeto de resposta com uma organização Criada e uma mensageira de sucessão.

remover

Remove uma organização 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 lança um erro se houver um problema na conexão do banco de dados ou se o usuário não estiver conectado.

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.

getall

Recupera todas as organizações do banco de dados e as devolve como um objeto JSON.

Parâmetros ###

• req objeto O objeto de solicitação.
• res objeto O objeto de resposta.

*Lança objeto Se houver um erro na recuperação das organizações, um erro do servidor será lançado.

Retorna objeto Um objeto JSON Contereing todas as organizações.

Getorganization

Recupera uma organização do banco de dados com o ID fornecido e o retorna como um objeto JSON.

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 recuperando os dados da organização do banco de dados.

Retorna Object Um objeto JSON contendo os dados da organização.

---

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