GET /consultation_schedules/{consultation_schedule_id}
curl --request GET \
--url https://api.example.test/consultation_schedules/{consultation_schedule_id} \
--header 'Content-Type: application/json' \
--data '
{
"consultation_schedule": {
"blocked_cause": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"reminder": true,
"sms_reminder": true,
"schedule_type": "<string>",
"overlaps_with": 123,
"price": 123,
"account_confirmed": true,
"account_id": "<string>"
}
}
'import requests
url = "https://api.example.test/consultation_schedules/{consultation_schedule_id}"
payload = { "consultation_schedule": {
"blocked_cause": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"reminder": True,
"sms_reminder": True,
"schedule_type": "<string>",
"overlaps_with": 123,
"price": 123,
"account_confirmed": True,
"account_id": "<string>"
} }
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
consultation_schedule: {
blocked_cause: '<string>',
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z',
reminder: true,
sms_reminder: true,
schedule_type: '<string>',
overlaps_with: 123,
price: 123,
account_confirmed: true,
account_id: '<string>'
}
})
};
fetch('https://api.example.test/consultation_schedules/{consultation_schedule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.test/consultation_schedules/{consultation_schedule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'consultation_schedule' => [
'blocked_cause' => '<string>',
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z',
'reminder' => true,
'sms_reminder' => true,
'schedule_type' => '<string>',
'overlaps_with' => 123,
'price' => 123,
'account_confirmed' => true,
'account_id' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.test/consultation_schedules/{consultation_schedule_id}"
payload := strings.NewReader("{\n \"consultation_schedule\": {\n \"blocked_cause\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"reminder\": true,\n \"sms_reminder\": true,\n \"schedule_type\": \"<string>\",\n \"overlaps_with\": 123,\n \"price\": 123,\n \"account_confirmed\": true,\n \"account_id\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.test/consultation_schedules/{consultation_schedule_id}")
.header("Content-Type", "application/json")
.body("{\n \"consultation_schedule\": {\n \"blocked_cause\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"reminder\": true,\n \"sms_reminder\": true,\n \"schedule_type\": \"<string>\",\n \"overlaps_with\": 123,\n \"price\": 123,\n \"account_confirmed\": true,\n \"account_id\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.test/consultation_schedules/{consultation_schedule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"consultation_schedule\": {\n \"blocked_cause\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"reminder\": true,\n \"sms_reminder\": true,\n \"schedule_type\": \"<string>\",\n \"overlaps_with\": 123,\n \"price\": 123,\n \"account_confirmed\": true,\n \"account_id\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"consultation_schedule": {
"cause": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"id": 123,
"links": {
"consultation": "<string>",
"encounter": "<string>",
"invoice": "<string>",
"person": "<string>"
},
"person_id": 123,
"starts_at": "2023-11-07T05:31:56Z",
"confirmed_at": null,
"schedule_type": "<string>",
"encounter_id": 123,
"blocked_cause": null,
"account_id": 123,
"telehealth_url": null,
"price": 123,
"arrival_at": null,
"account_confirmed": true,
"organization_schedule_id": null,
"account_username": "<string>",
"status": null,
"metadata": {
"share_payment_link": true,
"send_payment_link": true,
"showChargeOption": true,
"charge_product": true,
"sms_reminder": true
},
"subsequent_id": null,
"source": "<string>",
"source_slug": "<string>",
"reason_for_cancellation": null,
"comments_for_cancellation": null,
"reminder": true,
"deleted_at": null,
"account_patient_id": null,
"account_name": "<string>",
"location_name": "<string>",
"encounter_type_id": 123,
"extra": {
"person": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"telephone": null,
"email": "jsmith@example.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"born_at": "2023-12-25",
"gender": "<string>",
"avatar_file_name": null,
"avatar_content_type": null,
"avatar_file_size": null,
"avatar_updated_at": null,
"telephone2": "<string>",
"person_attributes": {},
"account_id": 123,
"address_state_id": 123,
"organization_id": 123,
"notes": null,
"deleted_at": null,
"phone_country_id": 123,
"creator_id": 123,
"updater_id": 123,
"is_migrated": true,
"without_cellphone": true,
"nimbochat_invitation_date": null,
"admission_form": true,
"cirrus_patient_id": null,
"person_token_id": null,
"medical_record": null,
"send_welcome_email": true,
"patient_group_id": null
},
"consultation": null
}
}
}Appointments
GET /consultation_schedules/{consultation_schedule_id}
GET
/
consultation_schedules
/
{consultation_schedule_id}
GET /consultation_schedules/{consultation_schedule_id}
curl --request GET \
--url https://api.example.test/consultation_schedules/{consultation_schedule_id} \
--header 'Content-Type: application/json' \
--data '
{
"consultation_schedule": {
"blocked_cause": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"reminder": true,
"sms_reminder": true,
"schedule_type": "<string>",
"overlaps_with": 123,
"price": 123,
"account_confirmed": true,
"account_id": "<string>"
}
}
'import requests
url = "https://api.example.test/consultation_schedules/{consultation_schedule_id}"
payload = { "consultation_schedule": {
"blocked_cause": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"reminder": True,
"sms_reminder": True,
"schedule_type": "<string>",
"overlaps_with": 123,
"price": 123,
"account_confirmed": True,
"account_id": "<string>"
} }
headers = {"Content-Type": "application/json"}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
consultation_schedule: {
blocked_cause: '<string>',
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z',
reminder: true,
sms_reminder: true,
schedule_type: '<string>',
overlaps_with: 123,
price: 123,
account_confirmed: true,
account_id: '<string>'
}
})
};
fetch('https://api.example.test/consultation_schedules/{consultation_schedule_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.test/consultation_schedules/{consultation_schedule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'consultation_schedule' => [
'blocked_cause' => '<string>',
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z',
'reminder' => true,
'sms_reminder' => true,
'schedule_type' => '<string>',
'overlaps_with' => 123,
'price' => 123,
'account_confirmed' => true,
'account_id' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.test/consultation_schedules/{consultation_schedule_id}"
payload := strings.NewReader("{\n \"consultation_schedule\": {\n \"blocked_cause\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"reminder\": true,\n \"sms_reminder\": true,\n \"schedule_type\": \"<string>\",\n \"overlaps_with\": 123,\n \"price\": 123,\n \"account_confirmed\": true,\n \"account_id\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("GET", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.test/consultation_schedules/{consultation_schedule_id}")
.header("Content-Type", "application/json")
.body("{\n \"consultation_schedule\": {\n \"blocked_cause\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"reminder\": true,\n \"sms_reminder\": true,\n \"schedule_type\": \"<string>\",\n \"overlaps_with\": 123,\n \"price\": 123,\n \"account_confirmed\": true,\n \"account_id\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.test/consultation_schedules/{consultation_schedule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"consultation_schedule\": {\n \"blocked_cause\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"reminder\": true,\n \"sms_reminder\": true,\n \"schedule_type\": \"<string>\",\n \"overlaps_with\": 123,\n \"price\": 123,\n \"account_confirmed\": true,\n \"account_id\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"consultation_schedule": {
"cause": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"id": 123,
"links": {
"consultation": "<string>",
"encounter": "<string>",
"invoice": "<string>",
"person": "<string>"
},
"person_id": 123,
"starts_at": "2023-11-07T05:31:56Z",
"confirmed_at": null,
"schedule_type": "<string>",
"encounter_id": 123,
"blocked_cause": null,
"account_id": 123,
"telehealth_url": null,
"price": 123,
"arrival_at": null,
"account_confirmed": true,
"organization_schedule_id": null,
"account_username": "<string>",
"status": null,
"metadata": {
"share_payment_link": true,
"send_payment_link": true,
"showChargeOption": true,
"charge_product": true,
"sms_reminder": true
},
"subsequent_id": null,
"source": "<string>",
"source_slug": "<string>",
"reason_for_cancellation": null,
"comments_for_cancellation": null,
"reminder": true,
"deleted_at": null,
"account_patient_id": null,
"account_name": "<string>",
"location_name": "<string>",
"encounter_type_id": 123,
"extra": {
"person": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"telephone": null,
"email": "jsmith@example.com",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"born_at": "2023-12-25",
"gender": "<string>",
"avatar_file_name": null,
"avatar_content_type": null,
"avatar_file_size": null,
"avatar_updated_at": null,
"telephone2": "<string>",
"person_attributes": {},
"account_id": 123,
"address_state_id": 123,
"organization_id": 123,
"notes": null,
"deleted_at": null,
"phone_country_id": 123,
"creator_id": 123,
"updater_id": 123,
"is_migrated": true,
"without_cellphone": true,
"nimbochat_invitation_date": null,
"admission_form": true,
"cirrus_patient_id": null,
"person_token_id": null,
"medical_record": null,
"send_welcome_email": true,
"patient_group_id": null
},
"consultation": null
}
}
}⌘I