Medical Appointment

Documentação

Índice

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

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
• 204 No Content
• 401 Unauthorized
• 404 Not Found
• 405 Not Allowed

---

Campos

Nome	Tipo	Tamanho máximo	Em branco/Nulo	Descrição
day	String	-	/	Dia da consulta referente a agenda.
hourly	String	-	False/False	Hora da consulta.
doctor	String	-	/	Médico que realizará a consulta.
scheduling_date	String	-	/	Data de criação da consulta.

Inserir Item

POST /consultas/

Insere um item e retorna os valores inseridos.

Success

• Status Code: 201

Dados de exemplo:

{
  "agenda_id": "Integer",
  "horario": "String",
}

POST /consultas/ { "agenda_id": 1, "horario": "14:15" }

Resposta de exemplo:

{
  "id": "Integer",
  "dia": "String",
  "horario": "String",
  "data_agendamento": "String",
  "medico": {
    "id": "Integer",
    "crm": "Integer",
    "nome": "String",
    "especialidade": {
      "id": "Integer",
      "nome": "String"
    }
  }
}

Listar Items

GET /consultas/

Retorna uma lista com todos os itens cadastrados.

Success

• Status Code: 200

Resposta de exemplo:

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

Unauthorized

• Status Code: 401

Resposta de exemplo:

{}

Detalhar Item

GET /consultas/:id

Retorna o detalhe de um item.

Not Allowed

• Status Code: 405

Resposta de exemplo:

Not Found

• Status Code: 404

Resposta de exemplo:

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

Atualizar Item

PUT /consultas/:id

Atualiza um item e retorna os valores alterados.

Not Allowed

• Status Code: 405

Resposta de exemplo:

Deletar Item

DELETE /consultas/:id

Deletar um item cadastrado.

Success

• Status Code: 204

Resposta de exemplo:

Not Found

• Status Code: 404

Resposta de exemplo:

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