Cidade

Índice

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

criar

Cria uma nova cidade no banco de dados.

Parâmetros ###

• req objeto O objeto de solicitação.
• res objeto O objeto de resposta.
• city_name objeto O objeto de parâmetro que contém a cidade_name.
• state_id objeto O objeto de parâmetro que contém estado _id.

*Lança Erro Se houver um erro na criação da cidade ou se o usuário não estiver conectado.

Retorna Objeto O objeto de resposta com a cidade recém -criada e uma mensagem de sucesso.

atualizar

Atualiza uma cidade no banco de dados com o ID fornecido.

Parâmetros ###

• req ObjeCT O objeto de solicitação.
• res objeto O objeto de resposta.
• city_name objeto O objeto de parâmetro que contém a cidade_name.
• state_id objeto O objeto de parâmetro que contém estado _id.

*Joga Erro Se houver um erro ao atualizar a cidade.

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 uma cidade deo 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 cidades deo banco de dados e os retorna como um objeto JSON.

Parâmetros ###

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

*Lança Erro Se houver um erro recuperando as cidades do banco de dados.

Retorna objeto Um objeto JSON contendo todas as cidades no banco de dados.

getcity

Recupera uma cidade 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 da cidade para recuperar.
• res objeto O objeto de resposta para enviar a cidade recuperada como um objeto JSON.
• id objeto Parametro /{id}.

*Joga Erro Se houver um erro na recuperação da cidade no banco de dados.

Retorna Object Um objeto JSON contendo uma cidade no banco de dados.

---

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