Agendamentos

Criada por Wenderson Cotta Sansão, Modificado em Seg, 15 Jun na (o) 12:28 PM por Wenderson Cotta Sansão

Neste mostraremos como fazer uso da API nos agendamentos

Campos do agendamento

O agendamento possui os seguintes campos:

calendar_id: Id do calendário
patient_id: Id do paciente
dentist_datum_id: id do dentista
title: Título do agendamento
description: Descrição do agendamento
start_date: Data e hora de início do agendamento
end_date: Data e hora final do agendamento
comment: Comentário sobre o agendamento
color: Cor do agendamento
status: Status do agendamento
phone: Telefone do agendamento

Listar os agendamentos

O controller de agendamentos permite listar os agendamentos atravez da action "index". Isso pode ser usado para encontrar um agendamento que vai ser atualizado.

Exemplo curl:

curl -X GET 'https://max.cfaz.net/api/v1/events' \

  --url-query 'access_token=0cd675768fev8dab81fe1c1297d56b09' \

  --url-query 'title_eq=João das Couves"' \

  --url-query 'status=1'

Exemplo com a Gem RestClient:

RestClient.get'https://max.cfaz.net/api/v1/events',

    {

        'access_token'=> '0cd675768fev8dab81fe1c1297d56b09',

        'title_eq' => 'João das Couves"',

        'status' => '1'

    }

Nessa listagem há uma paginação com 8 agendamentos em cada página, ao não especificar a página, por padrão, é retornada a primeira, entretanto essa pode ser especificada adicionando o parâmetro "page" com um valor inteiro maior que 0, retornando então a página em questão. Exemplo com o parâmetro:

curl -X GET 'https://max.cfaz.net/api/v1/events' \

  --url-query 'access_token=0cd675768fev8dab81fe1c1297d56b09' \

  --url-query 'title_eq=João das Couves"' \

  --url-query 'status=1' \

  --url-query 'page=2'

Criar um agendamento

O controller de agendamentos permite criar agendamentos acessando a action "create".

Exemplo com curl:

    curl -X POST 'https://max.cfaz.net/api/v1/events' \

        --url-query 'access_token=0cd675768fev8dab81fe1c1297d56b09' \

        --url-query 'event[calendar_id]=158' \

        --url-query 'event[patient_id]=317358' \

        --url-query 'event[title]=Agendamento pela API' \

        --url-query 'event[description]=Descrição de teste' \

        --url-query 'event[start_date]=Thu, 16 Jun 2025 14:00:00.000000000 UTC +00:00' \

        --url-query 'event[end_date]=Thu, 16 Jun 2025 14:30:00.000000000 UTC +00:00' \

        --url-query 'event[comment]=Comentario de teste' \

        --url-query 'event[color]=1' \

        --url-query 'event[status]=2' \

        --url-query 'event[phone]=31 9 1234 5678' \

        --url-query 'event[dentist_datum_id]=56022'

Exemplo com Gem RestClient

RestClient.post 'https://max.cfaz.net/api/v1/events',

    {

        "access_token"=> "0cd675768fev8dab81fe1c1297d56b09",

        "event[calendar_id]": 158,

        "event[patient_id]": 317358,

        "event[title]": "Agendamento pela API",

        "event[description]": "Descrição de teste",

        "event[start_date]": "Thu, 16 Jun 2025 14:00:00.000000000 UTC +00:00",

        "event[end_date]": "Thu, 16 Jun 2025 14:30:00.000000000 UTC +00:00",

        "event[comment]": "Comentario de teste",

        "event[color]": 1,

        "event[status]": 2,

        "event[phone]": "31 9 1234 5678",

        "event[dentist_datum_id]": 56022,

    }

Atualizar um agendamento

O controller de agendamentos permite atualizar um agendamento acessando a action "update". Para atualizar um agendamento é necessário saber o id do agendamento que deseja atualizar.

Exemplo com CURL:

    curl -X PUT 'https://max.cfaz.net/api/v1/events/{event_id}' \

        --url-query 'access_token=0cd675768fev8dab81fe1c1297d56b09' \

        --url-query 'event[title]=Agendamento pela API/Update'

Exemplo com Gem RestClient:

    RestClient.put "https://max.cfaz.net/api/v1/events/{event_id}",

                { "event[title]": "Agendamento pela API/Update" },

                "authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"

Excluir um agendamento

O controller de agendamentos permite exlcuir um agendamento acessando a action "destroy". Para deletar um agendamento é necessário saber o id do agendamento que deseja excluir.

Exemplo com CURL:

curl -X DELETE 'https://max.cfaz.net/api/v1/events/{event_id}' \

  --url-query 'access_token=9b6309a4fe550142d34cba2af195ef07'

Exemplo com a Gem RestClient

    RestClient.delete "https://max.cfaz.net/api/v1/event/{patient_id}",

               "authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"