En este artículo mostraremos cómo utilizar la API en los agendamientos
Campos del agendamiento
El agendamiento posee los siguientes campos:
- calendar_id: Id del calendario
- patient_id: Id del paciente
- dentist_datum_id: id del odontólogo
- title: Título del agendamiento
- description: Descripción del agendamiento
- start_date: Fecha y hora de inicio del agendamiento
- end_date: Fecha y hora final del agendamiento
- comment: Comentario sobre el agendamiento
- color: Color del agendamiento
- status: Status del agendamiento
- phone: Teléfono del agendamiento
Listar los agendamientos
El controller de agendamientos permite listar los agendamientos a través de la action "index". Esto se puede utilizar para encontrar un agendamiento que será actualizado.
Ejemplo 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'
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'
}En este listado hay una paginación con 8 agendamientos en cada página. Si no se especifica la página, por defecto, se devuelve la primera; sin embargo, esta se puede especificar agregando el parámetro "page" con un valor entero mayor que 0, devolviendo entonces la página en cuestión. Ejemplo con el 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'
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' \
--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'Ejemplo con 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,
}Actualizar un agendamiento
El controller de agendamientos permite actualizar un agendamiento accediendo a la action "update". Para actualizar un agendamiento, es necesario saber el id del agendamiento que desea actualizar.
Ejemplo con 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'Ejemplo con Gem RestClient:
RestClient.put "https://max.cfaz.net/api/v1/events/{event_id}",
{ "event[title]": "Agendamento pela API/Update" },
"authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"Eliminar un agendamiento
El controller de agendamientos permite eliminar un agendamiento accediendo a la action "destroy". Para eliminar un agendamiento, es necesario saber el id del agendamiento que desea eliminar.
Ejemplo con CURL:
curl -X DELETE 'https://max.cfaz.net/api/v1/events/{event_id}' \
--url-query 'access_token=9b6309a4fe550142d34cba2af195ef07'Ejemplo con la Gem RestClient
RestClient.delete "https://max.cfaz.net/api/v1/event/{patient_id}",
"authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"¿Le fue útil este artículo?
¡Qué bueno!
Gracias por sus comentarios
¡Sentimos mucho no haber sido de ayuda!
Gracias por sus comentarios
Comentarios enviados
Agradecemos su iniciativa, e intentaremos corregir el artículo