Estado

Índice

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

criar

Cria um Novo Estado No Banco de Dadas.

Parâmetros ###

• req objeto o objeto de requisição.
• res Object O objeto de resposta.
• state_name string O nome do estado.
• state_code string O código do estado.

• Throws Error Se houver um erro ao criar o estado ou ao obter o usuário logado.

Returns Object O objeto de resposta contendo o estado recém-criado e uma mensagem de sucesso ou uma mensagem de erro.

update

Updates a state in the database with the given ID.

Parameters

• req Object Tele solicita objeto.
• res objeto O objeto de resposta.
• state_name string o nome do estado.
• state_code string o código do estado.

*Lança Erro Se houver um erro ao atualizar o estado.

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.

remover

Remove um estado 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 estado.

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 todos os dados da tabela de estado e os retorna como um objeto JSON.

Parâmetros ###

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

*Lança Erro Se houver um erro recuperando os dados, um erro do servidor será retornado.

Retorna objeto Um objeto JSON contendo todos os dados da tabela de estado.

getState

Recupera um objeto de estado do banco de dados com o ID fornecido e o retorna como uma resposta JSON.

Parâmetros ###

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

*Lança objeto Um objeto de erro que contém informações sobre o erro que ocorreu.

Retorna objeto Uma resposta JSON contendo o objeto de estado recuperado.

---

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