- Print
- DarkLight
Campos do pedido
O pedido possui os campos:
- date: Data em que o pedido foi criado.
- clinic_id: Id da clínica na qual o pedido foi criado.
- request_status_id: Id do status em que o pedido se encontra.
- dentist_datum: Dentista que indicou o paciente.
- name: Nome do dentista que requisitou o pedido.
- email: Email do dentista que requisitou o pedido.
- commercial_phone: Telefone comercial do dentista que requisitou o pedido.
- mobile_phone: Celular do dentista que requisitou o pedido.
- patient_datum: Paciente indicado.
- name: Nome do paciente.
- birthdate: Data de nascimento.
- gender: Sexo do paciente ("true" para masculino e "false" para feminino).
- email: Email do paciente.
Listar Pedidos
Exemplo com CURL:
curl https://max.cfaz.net/api/v1/requests?access_token=0cd675768fev8dab81fe1c1297d56b09
Exemplo com a Gem RestClient:
RestClient.get "https://max.cfaz.net/api/v1/requests",
"authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"
Exemplo com CURL usando filtro pela data de criação do registro:
curl -X GET \
-G "https://max.cfaz.net/api/v1/requests" \
-d "access_token=0cd675768fev8dab81fe1c1297d56b09" \
-d "q[created_at_gteq]=2024-08-14T01:01:01.000-03:00"
Exemplo com CURL usando filtro pelo id do pedido:
curl -X GET \
-G "https://max.cfaz.net/api/v1/requests" \
-d "access_token=0cd675768fev8dab81fe1c1297d56b09" \
-d "q[id_eq]=15988959"
Nota-se que os parâmetros usados para filtrar a consulta devem ser passados dentro da notação "q[]" conforme os dois exemplos acima.
Criar pedido
O controller de pedidos permite criar pedidos acessando a action "create".
Para criar um pedido é necessário saber o id da clínica e o id do status do pedido. O sistema não irá aceitar os parâmetros sem esses ids ou se os ids não corresponderem, respectivamente, a uma clínica e a um status de pedido do usuário.
Exemplo com CURL:
curl -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" \
https://max.cfaz.net/api/v1/requests?access_token=0cd675768fev8dab81fe1c1297d56b09
Exemplo com 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
O controller de pedidos permite detalhar um pedido acessando a action "show".
Para mostrar os detalhes do pedido é necessário saber o id do pedido.
Exemplo com CURL:
curl "https://max.cfaz.net/api/v1/requests/{request_id}?access_token=0cd675768fev8dab81fe1c1297d56b09"
Exemplo com Gem RestClient:
RestClient.get "https://max.cfaz.net/api/v1/requests/{request_id}",
"authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"
Atualizar pedido
O controller de pedidos permite atualizar um pedido acessando a action "update".
Para atualizar um pedido é necessário saber o id do pedido que deseja atualizar.
Exemplo com CURL:
curl -X PUT \
-d "request[request_status_id]=7" \
https://max.cfaz.net/api/v1/requests/{request_id}?access_token=0cd675768fev8dab81fe1c1297d56b09
Exemplo com Gem RestClient:
RestClient.put "https://max.cfaz.net/api/v1/requests/{request_id}",
{ request: { request_status_id: 7 } },
"authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"
Excluir pedido
O controller de pedidos permite excluir um pedido acessando a action "destroy".
Para excluir um pedido é necessário saber o id do pedido que deseja excluir.
Exemplo com CURL:
curl -X DELETE https://max.cfaz.net/api/v1/requests/{request_id}?access_token=0cd675768fev8dab81fe1c1297d56b09
Exemplo com Gem RestClient:
RestClient.delete "https://max.cfaz.net/api/v1/requests/{request_id}",
"authorization" => "Token token=0cd675768fev8dab81fe1c1297d56b09"