Create practitioner role
curl --request POST \
--url https://api.clinikapi.com/v1/practitioner-roles \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"practitionerId": "<string>",
"role": "<string>",
"organizationName": "<string>",
"specialty": [
"<string>"
],
"locationName": "<string>",
"phone": "<string>",
"email": "[email protected]",
"period": {
"start": "<string>",
"end": "<string>"
},
"availableTime": [
{
"daysOfWeek": [],
"allDay": true,
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
],
"notAvailable": [
{
"description": "<string>",
"during": {
"start": "<string>",
"end": "<string>"
}
}
],
"availabilityExceptions": "<string>",
"availableDays": [],
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/practitioner-roles"
payload = {
"practitionerId": "<string>",
"role": "<string>",
"organizationName": "<string>",
"specialty": ["<string>"],
"locationName": "<string>",
"phone": "<string>",
"email": "[email protected]",
"period": {
"start": "<string>",
"end": "<string>"
},
"availableTime": [
{
"daysOfWeek": [],
"allDay": True,
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
],
"notAvailable": [
{
"description": "<string>",
"during": {
"start": "<string>",
"end": "<string>"
}
}
],
"availabilityExceptions": "<string>",
"availableDays": [],
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
practitionerId: '<string>',
role: '<string>',
organizationName: '<string>',
specialty: ['<string>'],
locationName: '<string>',
phone: '<string>',
email: '[email protected]',
period: {start: '<string>', end: '<string>'},
availableTime: [
{
daysOfWeek: [],
allDay: true,
availableStartTime: '<string>',
availableEndTime: '<string>'
}
],
notAvailable: [{description: '<string>', during: {start: '<string>', end: '<string>'}}],
availabilityExceptions: '<string>',
availableDays: [],
availableStartTime: '<string>',
availableEndTime: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/practitioner-roles', 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.clinikapi.com/v1/practitioner-roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'practitionerId' => '<string>',
'role' => '<string>',
'organizationName' => '<string>',
'specialty' => [
'<string>'
],
'locationName' => '<string>',
'phone' => '<string>',
'email' => '[email protected]',
'period' => [
'start' => '<string>',
'end' => '<string>'
],
'availableTime' => [
[
'daysOfWeek' => [
],
'allDay' => true,
'availableStartTime' => '<string>',
'availableEndTime' => '<string>'
]
],
'notAvailable' => [
[
'description' => '<string>',
'during' => [
'start' => '<string>',
'end' => '<string>'
]
]
],
'availabilityExceptions' => '<string>',
'availableDays' => [
],
'availableStartTime' => '<string>',
'availableEndTime' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.clinikapi.com/v1/practitioner-roles"
payload := strings.NewReader("{\n \"practitionerId\": \"<string>\",\n \"role\": \"<string>\",\n \"organizationName\": \"<string>\",\n \"specialty\": [\n \"<string>\"\n ],\n \"locationName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"availableDays\": [],\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("https://api.clinikapi.com/v1/practitioner-roles")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"practitionerId\": \"<string>\",\n \"role\": \"<string>\",\n \"organizationName\": \"<string>\",\n \"specialty\": [\n \"<string>\"\n ],\n \"locationName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"availableDays\": [],\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/practitioner-roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"practitionerId\": \"<string>\",\n \"role\": \"<string>\",\n \"organizationName\": \"<string>\",\n \"specialty\": [\n \"<string>\"\n ],\n \"locationName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"availableDays\": [],\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyPractitioner Roles
Create Practitioner Role
POST
/
v1
/
practitioner-roles
Create practitioner role
curl --request POST \
--url https://api.clinikapi.com/v1/practitioner-roles \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"practitionerId": "<string>",
"role": "<string>",
"organizationName": "<string>",
"specialty": [
"<string>"
],
"locationName": "<string>",
"phone": "<string>",
"email": "[email protected]",
"period": {
"start": "<string>",
"end": "<string>"
},
"availableTime": [
{
"daysOfWeek": [],
"allDay": true,
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
],
"notAvailable": [
{
"description": "<string>",
"during": {
"start": "<string>",
"end": "<string>"
}
}
],
"availabilityExceptions": "<string>",
"availableDays": [],
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
'import requests
url = "https://api.clinikapi.com/v1/practitioner-roles"
payload = {
"practitionerId": "<string>",
"role": "<string>",
"organizationName": "<string>",
"specialty": ["<string>"],
"locationName": "<string>",
"phone": "<string>",
"email": "[email protected]",
"period": {
"start": "<string>",
"end": "<string>"
},
"availableTime": [
{
"daysOfWeek": [],
"allDay": True,
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
],
"notAvailable": [
{
"description": "<string>",
"during": {
"start": "<string>",
"end": "<string>"
}
}
],
"availabilityExceptions": "<string>",
"availableDays": [],
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
practitionerId: '<string>',
role: '<string>',
organizationName: '<string>',
specialty: ['<string>'],
locationName: '<string>',
phone: '<string>',
email: '[email protected]',
period: {start: '<string>', end: '<string>'},
availableTime: [
{
daysOfWeek: [],
allDay: true,
availableStartTime: '<string>',
availableEndTime: '<string>'
}
],
notAvailable: [{description: '<string>', during: {start: '<string>', end: '<string>'}}],
availabilityExceptions: '<string>',
availableDays: [],
availableStartTime: '<string>',
availableEndTime: '<string>'
})
};
fetch('https://api.clinikapi.com/v1/practitioner-roles', 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.clinikapi.com/v1/practitioner-roles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'practitionerId' => '<string>',
'role' => '<string>',
'organizationName' => '<string>',
'specialty' => [
'<string>'
],
'locationName' => '<string>',
'phone' => '<string>',
'email' => '[email protected]',
'period' => [
'start' => '<string>',
'end' => '<string>'
],
'availableTime' => [
[
'daysOfWeek' => [
],
'allDay' => true,
'availableStartTime' => '<string>',
'availableEndTime' => '<string>'
]
],
'notAvailable' => [
[
'description' => '<string>',
'during' => [
'start' => '<string>',
'end' => '<string>'
]
]
],
'availabilityExceptions' => '<string>',
'availableDays' => [
],
'availableStartTime' => '<string>',
'availableEndTime' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.clinikapi.com/v1/practitioner-roles"
payload := strings.NewReader("{\n \"practitionerId\": \"<string>\",\n \"role\": \"<string>\",\n \"organizationName\": \"<string>\",\n \"specialty\": [\n \"<string>\"\n ],\n \"locationName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"availableDays\": [],\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("https://api.clinikapi.com/v1/practitioner-roles")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"practitionerId\": \"<string>\",\n \"role\": \"<string>\",\n \"organizationName\": \"<string>\",\n \"specialty\": [\n \"<string>\"\n ],\n \"locationName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"availableDays\": [],\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/practitioner-roles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"practitionerId\": \"<string>\",\n \"role\": \"<string>\",\n \"organizationName\": \"<string>\",\n \"specialty\": [\n \"<string>\"\n ],\n \"locationName\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"[email protected]\",\n \"period\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n },\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"availableDays\": [],\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Role code (doctor, nurse, pharmacist, admin, consultant)
Maximum string length:
100Maximum string length:
200Maximum string length:
200Period during which the role is valid
Show child attributes
Show child attributes
Multiple availability schedules
Show child attributes
Show child attributes
Periods when the practitioner is not available
Show child attributes
Show child attributes
Free-text description of availability exceptions
Maximum string length:
1000Legacy: use availableTime instead
Available options:
mon, tue, wed, thu, fri, sat, sun Legacy: use availableTime instead
Legacy: use availableTime instead
Response
201
Practitioner role created
⌘I