Agenda

Documentação

Índice

• Guia de Desenvolvimento
  • Autorizações Disponíveis
• Referência da API REST
  • Códigos de status HTTP
• Campos
• Inserir Item
  • Not Allowed
• Listar Items
  • Success
• Detalhar Item
  • Success
  • Not Found
• Atualizar Item
  • Not Allowed
• Deletar Item
  • Not Allowed

Guia de Desenvolvimento

Autorizações Disponíveis

AUTHORIZATION	Bearer	URL
Token	auth	/api-token-auth/

Referência da API REST

Códigos de status HTTP

• 200 Successful request
• 401 Unauthorized
• 404 Not Found
• 405 Not Allowed

---

Campos

Nome	Tipo	Tamanho máximo	Em branco/Nulo	Descrição
day	String	-	False/False	Dia da agenda.
schedule	Array	-	/	Lista de horários disponíveis do médico.
doctor	String	-	/	Médico a quem a agenda pertence.

Inserir Item

POST /agendas/

Insere um item e retorna os valores inseridos.

Not Allowed

• Status Code: 405

Resposta de exemplo:

Listar Items

GET /agendas/

Retorna uma lista com todos os itens cadastrados.

Success

• Status Code: 200

Resposta de exemplo:

[
  {
    "id": "Integer",
    "day": "String",
    "schedule": "String",
    "doctor": "String",
  },
  {
    "id": "Integer",
    "day": "String",
    "schedule": "String",
    "doctor": "String",
  },
  // ...
]

Detalhar Item

GET /agendas/:id

Retorna o detalhe de um item.

Success

• Status Code: 200

Resposta de exemplo:

{
  "id": "Integer",
  "day": "String",
  "schedule": "String",
  "doctor": "String",
}

Not Found

• Status Code: 404

Resposta de exemplo:

{
  "detail": "Não encontrado."
}

Atualizar Item

PUT /agendas/:id

Atualiza um item e retorna os valores alterados.

Not Allowed

• Status Code: 405

Resposta de exemplo:

Deletar Item

DELETE /agendas/:id

Deletar um item cadastrado.

Not Allowed

• Status Code: 405

Resposta de exemplo: