Agendamientos

Creada por Wenderson Cotta Sansão, Modificado el Jue., 11 Jun. a las 5:03 P. M. por Wenderson Cotta Sansão

Campos del agendamiento

El agendamiento posee los siguientes campos:

calendar_id: Id del calendario
patient_id: Id del paciente
dentist_datum_id: Id del dentista
title: Título del agendamiento
description: Descripción del agendamiento
start_date: Fecha y hora de inicio del agendamiento
end_date: Fecha y hora de fin del agendamiento
comment: Comentario sobre el agendamiento
color: Color del agendamiento
status: Estado del agendamiento
phone: Teléfono del agendamiento

El agendamiento posee los siguientes estados:

0 : Abierto
1 : Atendido
2 : En espera
3 : Ausente
4 : Anotación
5 : Observación
6 : Confirmado
7 : Cancelado
8 : Horario bloqueado, usado para bloqueo de horarios en la agenda

Listar los agendamientos

El controller de agendamientos permite listar los agendamientos a través de la action "index". Esto puede utilizarse para encontrar un agendamiento que se desea actualizar.

Ejemplo con CURL:

curl -X GET 'https://max.cfaz.net/api/v1/events' \
  -d 'access_token=0cd675768fev8dab81fe1c1297d56b09' \
  -d 'title_eq=João das Couves' \
  -d 'status=1'

Ejemplo con la Gem RestClient:

RestClient.get 'https://max.cfaz.net/api/v1/events',
    {
        'access_token'=> '0cd675768fev8dab81fe1c1297d56b09',
        'title_eq' => 'João das Couves',
        'status' => '1'
    }

Este listado cuenta con una paginación de 8 agendamientos por página. Al no especificar la página, se retorna la primera por defecto; sin embargo, es posible especificarla agregando el parámetro "page" con un valor entero mayor que 0. Ejemplo con el parámetro:

Ejemplo con CURL:

curl -X GET 'https://max.cfaz.net/api/v1/events' \
  -d 'access_token=0cd675768fev8dab81fe1c1297d56b09' \
  -d 'title_eq=João das Couves"' \
  -d 'status=1' \
  -d 'page=2'

Ejemplo con la Gem RestClient:

RestClient.get 'https://max.cfaz.net/api/v1/events',
    {
        'access_token'=> '0cd675768fev8dab81fe1c1297d56b09',
        'title_eq' => 'João das Couves',
        'status' => '1',
        'page' => 2
    }

Crear un agendamiento

El controller de agendamientos permite crear agendamientos accediendo a la action "create".

Ejemplo con CURL:

curl -X POST 'https://max.cfaz.net/api/v1/events' \
    -d 'access_token=0cd675768fev8dab81fe1c1297d56b09' \
    -d 'event[calendar_id]=158' \
    -d 'event[patient_id]=317358' \
    -d 'event[title]=Agendamento pela API' \
    -d 'event[description]=Descrição de teste' \
    -d 'event[start_date]=Thu, 16 Jun 2025 14:00:00.000000000 UTC +00:00' \
    -d 'event[end_date]=Thu, 16 Jun 2025 14:30:00.000000000 UTC +00:00' \
    -d 'event[status]=2' \
    -d 'event[phone]=31 9 1234 5678' \
    -d 'event[dentist_datum_id]=56022'

Ejemplo con la Gem RestClient:

RestClient.post 'https://max.cfaz.net/api/v1/events',
    {
        event: {
            calendar_id: 158,
            patient_id: 317358,
            title: "Agendamento pela API",
            description: "Descrição de teste",
            start_date: "Thu, 16 Jun 2025 14:00:00.000000000 UTC +00:00",
            end_date: "Thu, 16 Jun 2025 14:30:00.000000000 UTC +00:00",
            status: 2,
            phone: "31 9 1234 5678",
            dentist_datum_id: 56022,
        },
        access_token: "0cd675768fev8dab81fe1c1297d56b09",
    }

Actualizar un agendamiento

El controller de agendamientos permite actualizar un agendamiento accediendo a la action "update". Para actualizar un agendamiento es necesario conocer el ID del agendamiento que se desea actualizar.

Ejemplo con CURL:

curl -X PUT 'https://max.cfaz.net/api/v1/events/{event_id}' \
    -d 'access_token=0cd675768fev8dab81fe1c1297d56b09' \
    -d 'event[title]=Agendamento pela API/Update'

Ejemplo con la Gem RestClient:

RestClient.put "https://max.cfaz.net/api/v1/events/{event_id}",
            { event:
                {
                    title: "Agendamento pela API/Update"
                },
                access_token: "0cd675768fev8dab81fe1c1297d56b09",
            }

Eliminar un agendamiento

El controller de agendamientos permite eliminar un agendamiento accediendo a la action "destroy". Para eliminar un agendamiento es necesario conocer el ID del agendamiento que se desea eliminar.

Ejemplo con CURL:

curl -X DELETE 'https://max.cfaz.net/api/v1/events/{event_id}' \
  -d 'access_token=9b6309a4fe550142d34cba2af195ef07'

Ejemplo con la Gem RestClient:

RestClient.delete "https://max.cfaz.net/api/v1/event/{patient_id}",
           "authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"

Crear un bloqueo

El controller de eventos permite crear un bloqueo de horario. El funcionamiento del bloqueo de horarios es igual al de la creación de un evento, con la diferencia de que el status debe ser igual a 8.

El bloqueo posee los siguientes campos:

calendar_id: Id del calendario
title: Motivo del bloqueo
start_date: Fecha y hora de inicio del bloqueo
end_date: Fecha y hora de fin del bloqueo
status: Estado del bloqueo, debe ser siempre igual a 8

Ejemplo con CURL:

curl -X POST 'https://max.cfaz.net/api/v1/events' \
        -d 'access_token=0cd675768fev8dab81fe1c1297d56b09' \
        -d 'event[calendar_id]=158' \
        -d 'event[title]=Bloqueio pela API' \
        -d 'event[start_date]=Thu, 16 Jun 2025 14:00:00.000000000 UTC +00:00' \
        -d 'event[end_date]=Thu, 16 Jun 2025 14:30:00.000000000 UTC +00:00' \
        -d 'event[status]=8'

Ejemplo con la Gem RestClient:

RestClient.post 'https://max.cfaz.net/api/v1/events',
    {
        event: {
            calendar_id: 158,
            title: "Bloqueio pela API",
            start_date: "Thu, 16 Jun 2025 14:00:00.000000000 UTC +00:00",
            end_date: "Thu, 16 Jun 2025 14:30:00.000000000 UTC +00:00",
            status: 8,
        },
        access_token: "0cd675768fev8dab81fe1c1297d56b09"
    }