Ordenes

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

Campos del pedido

El pedido posee los siguientes campos:

date: Fecha en que se creó el pedido.
clinic_id: ID de la clínica en la que se creó el pedido.
request_status_id: ID del estado en que se encuentra el pedido.
comment: Comentario del pedido.
dentist_datum: Solicitante que indicó al paciente.
- name: Nombre del solicitante que realizó el pedido.
- email: Correo electrónico del solicitante que realizó el pedido.
- commercial_phone: Teléfono comercial del solicitante que realizó el pedido.
- mobile_phone: Teléfono celular del solicitante que realizó el pedido.
patient_datum: Paciente indicado.
- name: Nombre del paciente.
- birthdate: Fecha de nacimiento.
- gender: Sexo del paciente ("true" para masculino y "false" para femenino).
- email: Correo electrónico del paciente.

Listar estados de pedido

Ejemplo con CURL:

curl https://max.cfaz.net/api/v1/requests?access_token=0cd675768fev8dab81fe1c1297d56b09

Ejemplo con la Gem RestClient:

RestClient.get "https://max.cfaz.net/api/v1/requests",
               "authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"

Usando filtro por la fecha de creación del registro

Ejemplo con CURL:

curl --globoff -X GET -G "https://max.cfaz.net/api/v1/requests" \
     -d "access_token=token" \
     --data-urlencode "q[created_at_gteq]=2024-08-14T01:01:01.000-03:00"

Usando filtro por el ID del pedido

Ejemplo con CURL:

curl -X GET \
     -G "https://max.cfaz.net/api/v1/requests" \
     -d "access_token=0cd675768fev8dab81fe1c1297d56b09" \
     -d "q[id_eq]=15988959"

Se observa que los parámetros utilizados para filtrar la consulta deben pasarse dentro de la notación "q[]" conforme a los dos ejemplos anteriores.

Crear pedido

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

Para crear un pedido es necesario conocer el ID de la clínica y el ID del estado del pedido. El sistema no aceptará los parámetros sin estos IDs o si los IDs no corresponden, respectivamente, a una clínica y a un estado de pedido del usuario.

Ejemplo con CURL:

curl -X POST https://max.cfaz.net/api/v1/requests \
     -d "access_token=0cd675768fev8dab81fe1c1297d56b09" \
     -d "request[clinic_id]=4" \
     -d "request[request_status_id]=7" \
     -d "request[date]=2020-12-15T16:30" \
     -d "request[dentist_datum][name]=João das Couves" \
     -d "request[patient_datum][name]=Maria das Couves" \
     -d "request[patient_datum][gender]=true" \
     -d "request[patient_datum][birthdate]=1995-01-01" \

Ejemplo con la Gem RestClient:

RestClient.post "https://max.cfaz.net/api/v1/requests",
               { request:
                 { clinic_id: 4,
                   request_status_id: 7,
                   date: "2020-12-15T16:30",
                   dentist_datum: { name: "João das Couves" },
                   patient_datum: { name: "Maria das Couves", gender: true, birthdate: "1995-01-01"}
                 }
               },
               "authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"

Mostrar pedido

El controller de pedidos permite detallar un pedido accediendo a la action "show". Para mostrar los detalles del pedido es necesario conocer el ID del pedido.

ps: En el retorno del pedido está presente el campo financial_information que presenta los datos financieros del pedido. El campo financial_postings corresponde a las cuotas/pagos realizados, mientras que financial_class_financial_postings detalla la composición de cada cuota, incluyendo procedimientos, valor y descuento.

Ejemplo con CURL:

curl -X GET "https://max.cfaz.net/api/v1/requests/{request_id}" \
      -d "access_token=0cd675768fev8dab81fe1c1297d56b09"

Ejemplo con la Gem RestClient:

RestClient.get "https://max.cfaz.net/api/v1/requests/{request_id}",
               "authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"

Actualizar pedido

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

Ejemplo con CURL:

curl -X PUT "https://max.cfaz.net/api/v1/requests/{request_id}" \
     -d "access_token=0cd675768fev8dab81fe1c1297d56b09" \
     -d "request[request_status_id]=7"

Ejemplo con la Gem RestClient:

RestClient.put "https://max.cfaz.net/api/v1/requests/{request_id}",
               { request: { request_status_id: 7 } },
               "authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"

Eliminar pedido

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

Ejemplo con CURL:

curl -X DELETE https://max.cfaz.net/api/v1/requests/{request_id} \
    -d "access_token=0cd675768fev8dab81fe1c1297d56b09"

Ejemplo con la Gem RestClient:

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