{ "info": { "_postman_id": "58b21965-efa5-4a39-914e-cf910c4af1af", "name": "Docplanner Integrations API", "description": "Welcome to Docplanner Integrations [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) API!\n\nThis API gives You the ability to build Your own application and integrate it with Docplanner services.\n", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "item": [ { "name": "facilities", "item": [ { "name": "{facility id}", "item": [ { "name": "doctors", "item": [ { "name": "{doctor id}", "item": [ { "name": "addresses", "item": [ { "name": "{address id}", "item": [ { "name": "services", "item": [ { "name": "{address service id}", "item": [ { "name": "get Address Service", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "address_service_id", "value": "", "type": "string", "description": "(Required) ID of an address service" } ] }, "description": "Service returned in this endpoint is an address service.\n\nService returned here is from a specified address (address_services).\n" }, "response": [ { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Address service", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 101,\n \"name\": \"USG\",\n \"is_default\": true,\n \"is_price_from\": false,\n \"price\": 100,\n \"description\": \"Description of service\",\n \"service_id\": 1\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" } ] }, { "name": "update Address Service", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"is_price_from\": \"\",\n \"price\": \"\",\n \"description\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "address_service_id", "value": "", "type": "string", "description": "(Required) ID of an address service" } ] }, "description": "Service updated in this endpoint is an address service from this specified address (address_services).\n" }, "response": [ { "name": "You are not authorized to see this resource", "originalRequest": { "method": "PATCH", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"price\": 200,\n \"is_price_from\": true,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "PATCH", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"price\": 200,\n \"is_price_from\": true,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"Validation error message, e.g.: Invalid price value for service. Price should be either null or integer greater or equal 0.\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "PATCH", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"price\": 200,\n \"is_price_from\": true,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "Address service", "originalRequest": { "method": "PATCH", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"price\": 200,\n \"is_price_from\": true,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 101,\n \"name\": \"USG\",\n \"is_default\": true,\n \"is_price_from\": true,\n \"price\": 200,\n \"description\": \"Address service description\",\n \"service_id\": 1\n}" } ] }, { "name": "delete Address Service", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "address_service_id", "value": "", "type": "string", "description": "(Required) ID of an address service" } ] }, "description": "Service deleted in this endpoint is an address service from this specified address (address_services).\n" }, "response": [ { "name": "You are not authorized to see this resource", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "Successfully deleted address service", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services/:address_service_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services", ":address_service_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "address_service_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "get Address Services", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services?start=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "query": [ { "key": "start", "value": "", "description": "Slot start date (parameter must be urlencoded before sending request)" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Services returned in this endpoint are address services.\n\nServices returned here are from specified address (address_services).\n" }, "response": [ { "name": "List of services", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services?start=2021-05-16T14:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "query": [ { "key": "start", "value": "2021-05-16T14:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"id\": 101,\n \"name\": \"USG\",\n \"is_default\": true,\n \"is_price_from\": false,\n \"price\": 100,\n \"description\": \"Description of service\",\n \"service_id\": 1\n },\n {\n \"id\": 103,\n \"name\": \"EEG\",\n \"is_default\": true,\n \"is_price_from\": false,\n \"price\": null,\n \"description\": \"Description of service\",\n \"service_id\": 3\n }\n ]\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services?start=2021-05-16T14:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "query": [ { "key": "start", "value": "2021-05-16T14:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services?start=2021-05-16T14:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "query": [ { "key": "start", "value": "2021-05-16T14:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" } ] }, { "name": "add Address Service", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": \"\",\n \"is_price_from\": \"\",\n \"price\": \"\",\n \"description\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Adds new service to an address of the doctor\n\nServices added here are specific to this address (address_services).\n" }, "response": [ { "name": "Service added to address", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": 2,\n \"is_price_from\": true,\n \"price\": 200,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Location", "value": "officia est incididunt proident sed", "description": "Resource URL for the new booking" }, { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": 2,\n \"is_price_from\": true,\n \"price\": 200,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": 2,\n \"is_price_from\": true,\n \"price\": 200,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": 2,\n \"is_price_from\": true,\n \"price\": 200,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"Validation error message, e.g.: Invalid price value for service. Price should be either null or integer greater or equal 0.\"\n}" }, { "name": "Request would result in creating conflicted or duplicated resources", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"service_id\": 2,\n \"is_price_from\": true,\n \"price\": 200,\n \"description\": \"Address service description\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/services", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "services" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"The address service you are trying to add already exists in the system\"\n}" } ] } ] }, { "name": "insurance-providers", "item": [ { "name": "get Address Insurance Providers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Get a list of insurance providers for a specific address" }, "response": [ { "name": "List of insurance providers", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"insurance_provider_id\": 1,\n \"name\": \"Insurance provider 1\"\n },\n {\n \"insurance_provider_id\": 2,\n \"name\": \"Insurance provider 2\"\n }\n ]\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" } ] }, { "name": "add Address Insurance Provider", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"insurance_provider_id\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Adds new insurance provider to an address of the doctor" }, "response": [ { "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"insurance_provider_id\": 3\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Provided insurance provider ID not found in dictionary\"\n}" }, { "name": "Successfully added insurance provider to address", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"insurance_provider_id\": 3\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"insurance_provider_id\": 3\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"insurance_provider_id\": 3\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"Validation error message, e.g.: Insurance provider with given ID is already assigned to this address.\"\n}" } ] }, { "name": "delete Address Insurance Provider", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers/:insurance_provider", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers", ":insurance_provider" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "insurance_provider", "value": "", "type": "string", "description": "(Required) ID of an insurance provider from DP dictionary" } ] }, "description": "Delete an insurance provider from doctor’s address" }, "response": [ { "name": "Successfully added insurance provider to address", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers/:insurance_provider", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers", ":insurance_provider" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "insurance_provider" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers/:insurance_provider", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers", ":insurance_provider" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "insurance_provider" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers/:insurance_provider", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers", ":insurance_provider" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "insurance_provider" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"Validation error message, e.g.: Insurance provider with given ID is not assigned to this address.\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/insurance-providers/:insurance_provider", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "insurance-providers", ":insurance_provider" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "insurance_provider" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Provided insurance provider ID not found in dictionary\"\n}" } ] } ] }, { "name": "breaks", "item": [ { "name": "{break id}", "item": [ { "name": "get Calendar Break", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "break_id", "value": "", "type": "string", "description": "(Required) ID of the Calendar Break" } ] }, "description": "View a specific calendar break" }, "response": [ { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "break_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Invalid break ID\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "break_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Calendar break", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "break_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 567,\n \"since\": \"2020-12-16T14:00:00+01:00\",\n \"till\": \"2020-12-16T14:30:00+01:00\"\n}" } ] }, { "name": "delete Calendar Break", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "break_id", "value": "", "type": "string", "description": "(Required) ID of the Calendar Break" } ] }, "description": "Delete the calendar break" }, "response": [ { "name": "You are not authorized to see this resource", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "break_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Request would result in creating conflicted or duplicated resources", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "break_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Break for given address and date range exists\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "break_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"No slots found on given address\"\n}" }, { "name": "Succesfully removed calendar break", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "break_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Request cannot be processed", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks/:break_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks", ":break_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "break_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Invalid date range\"\n}" } ] } ] }, { "name": "get Calendar Breaks", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks?since=&till=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "query": [ { "key": "since", "value": "", "description": "(Required) " }, { "key": "till", "value": "", "description": "(Required) " } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Get the list of calendar breaks" }, "response": [ { "name": "List of calendar breaks", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks?since=2021-05-16T14:00:00+01:00&till=2021-05-16T15:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "query": [ { "key": "since", "value": "2021-05-16T14:00:00+01:00" }, { "key": "till", "value": "2021-05-16T15:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 567,\n \"since\": \"2020-12-16T14:00:00+01:00\",\n \"till\": \"2020-12-16T14:30:00+01:00\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks?since=2021-05-16T14:00:00+01:00&till=2021-05-16T15:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "query": [ { "key": "since", "value": "2021-05-16T14:00:00+01:00" }, { "key": "till", "value": "2021-05-16T15:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks?since=2021-05-16T14:00:00+01:00&till=2021-05-16T15:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "query": [ { "key": "since", "value": "2021-05-16T14:00:00+01:00" }, { "key": "till", "value": "2021-05-16T15:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"No slots found on given address\"\n}" } ] }, { "name": "add Calendar Break", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"since\": \"\",\n \"till\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Add a new break to the calendar" }, "response": [ { "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"since\": \"2021-05-16T14:00:00+01:00\",\n \"till\": \"2021-05-16T15:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"No slots found on given address\"\n}" }, { "name": "Request would result in creating conflicted or duplicated resources", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"since\": \"2021-05-16T14:00:00+01:00\",\n \"till\": \"2021-05-16T15:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Break for given address and date range exists\"\n}" }, { "name": "Break added to the calendar", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"since\": \"2021-05-16T14:00:00+01:00\",\n \"till\": \"2021-05-16T15:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Location", "value": "officia est incididunt proident sed", "description": "Resource URL for the new calendar break" }, { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Request cannot be processed", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"since\": \"2021-05-16T14:00:00+01:00\",\n \"till\": \"2021-05-16T15:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Invalid date range\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"since\": \"2021-05-16T14:00:00+01:00\",\n \"till\": \"2021-05-16T15:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/breaks", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "breaks" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" } ] } ] }, { "name": "slots", "item": [ { "name": "get Slots", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots?start=&end=&with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "query": [ { "key": "start", "value": "", "description": "(Required) Slot start date (parameter must be urlencoded before sending request)" }, { "key": "end", "value": "", "description": "(Required) Slot start date (parameter must be urlencoded before sending request)" }, { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "List of free slots for the address within specified date range\n\nExtensions:\n* `slot.services` - with this parameter in url, query results will return address services attached to given slots\n" }, "response": [ { "name": "List of slots", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots?start=2021-05-16T14:00:00+01:00&end=2021-05-16T15:00:00+01:00&with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "query": [ { "key": "start", "value": "2021-05-16T14:00:00+01:00" }, { "key": "end", "value": "2021-05-16T15:00:00+01:00" }, { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"start\": \"2020-12-16T14:00:00+01:00\"\n },\n {\n \"start\": \"2020-12-16T14:30:00+01:00\"\n }\n ]\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots?start=2021-05-16T14:00:00+01:00&end=2021-05-16T15:00:00+01:00&with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "query": [ { "key": "start", "value": "2021-05-16T14:00:00+01:00" }, { "key": "end", "value": "2021-05-16T15:00:00+01:00" }, { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots?start=2021-05-16T14:00:00+01:00&end=2021-05-16T15:00:00+01:00&with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "query": [ { "key": "start", "value": "2021-05-16T14:00:00+01:00" }, { "key": "end", "value": "2021-05-16T15:00:00+01:00" }, { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"No slots found on given address\"\n}" } ] }, { "name": "replace Slots", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"slots\": [\n {\n \"address_services\": [\n {\n \"address_service_id\": \"\",\n \"duration\": \"\"\n },\n {\n \"address_service_id\": \"\",\n \"duration\": \"\"\n }\n ],\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"address_services\": [\n {\n \"address_service_id\": \"\",\n \"duration\": \"\"\n },\n {\n \"address_service_id\": \"\",\n \"duration\": \"\"\n }\n ],\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Adds or replaces the slots. This will override all existing slots for given date ranges" }, "response": [ { "name": "Successfully replaced slots", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"slots\": [\n {\n \"address_services\": [\n {\n \"address_service_id\": 111,\n \"duration\": 30\n },\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T14:00:00+01:00\",\n \"end\": \"2021-05-16T15:00:00+01:00\"\n },\n {\n \"address_services\": [\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T15:00:00+01:00\",\n \"end\": \"2021-05-16T16:00:00+01:00\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"slots\": [\n {\n \"address_services\": [\n {\n \"address_service_id\": 111,\n \"duration\": 30\n },\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T14:00:00+01:00\",\n \"end\": \"2021-05-16T15:00:00+01:00\"\n },\n {\n \"address_services\": [\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T15:00:00+01:00\",\n \"end\": \"2021-05-16T16:00:00+01:00\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Request cannot be processed", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"slots\": [\n {\n \"address_services\": [\n {\n \"address_service_id\": 111,\n \"duration\": 30\n },\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T14:00:00+01:00\",\n \"end\": \"2021-05-16T15:00:00+01:00\"\n },\n {\n \"address_services\": [\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T15:00:00+01:00\",\n \"end\": \"2021-05-16T16:00:00+01:00\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Cannot activate calendar on address 123, profile/address is not commercial\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"slots\": [\n {\n \"address_services\": [\n {\n \"address_service_id\": 111,\n \"duration\": 30\n },\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T14:00:00+01:00\",\n \"end\": \"2021-05-16T15:00:00+01:00\"\n },\n {\n \"address_services\": [\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T15:00:00+01:00\",\n \"end\": \"2021-05-16T16:00:00+01:00\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"slots\": [\n {\n \"address_services\": [\n {\n \"address_service_id\": 111,\n \"duration\": 30\n },\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T14:00:00+01:00\",\n \"end\": \"2021-05-16T15:00:00+01:00\"\n },\n {\n \"address_services\": [\n {\n \"address_service_id\": 112,\n \"duration\": 15\n }\n ],\n \"start\": \"2021-05-16T15:00:00+01:00\",\n \"end\": \"2021-05-16T16:00:00+01:00\"\n }\n ]\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Validation error message, e.g.: Slots comes from different days\"\n}" } ] }, { "name": "book Slot", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address_service_id\": \"\",\n \"is_returning\": \"\",\n \"patient\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"birth_date\": \"\",\n \"nin\": \"\",\n \"gender\": \"\"\n },\n \"duration\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:start/book", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":start", "book" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "start", "value": "", "type": "string", "description": "(Required) Slot start date (parameter must be urlencoded before sending request)" } ] }, "description": "Book a slot" }, "response": [ { "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_service_id\": 113,\n \"is_returning\": false,\n \"patient\": {\n \"name\": \"Abraham\",\n \"surname\": \"Lincoln\",\n \"email\": \"example@example.com\",\n \"phone\": 48123123123,\n \"birth_date\": \"1985-01-01\",\n \"nin\": 894237492,\n \"gender\": \"m\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:start/book", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":start", "book" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "start" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Unable to book a visit for this address\"\n}" }, { "name": "Booking", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_service_id\": 113,\n \"is_returning\": false,\n \"patient\": {\n \"name\": \"Abraham\",\n \"surname\": \"Lincoln\",\n \"email\": \"example@example.com\",\n \"phone\": 48123123123,\n \"birth_date\": \"1985-01-01\",\n \"nin\": 894237492,\n \"gender\": \"m\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:start/book", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":start", "book" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "start" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 2134124,\n \"status\": \"booked\",\n \"start_at\": \"2021-05-16T14:00:00+01:00\",\n \"end_at\": \"2021-05-16T14:30:00+01:00\",\n \"duration\": 30,\n \"booked_by\": \"user\",\n \"canceled_by\": \"\",\n \"booked_at\": \"2021-05-12T12:00:00+01:00\",\n \"canceled_at\": \"2021-05-16T14:30:00+01:00\",\n \"patient\": {\n \"name\": \"Abraham\",\n \"surname\": \"Lincoln\",\n \"email\": \"example@example.com\",\n \"phone\": 48123123123,\n \"birth_date\": \"1985-01-01\",\n \"nin\": 894237492,\n \"gender\": \"m\"\n },\n \"presence\": \"present\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_service_id\": 113,\n \"is_returning\": false,\n \"patient\": {\n \"name\": \"Abraham\",\n \"surname\": \"Lincoln\",\n \"email\": \"example@example.com\",\n \"phone\": 48123123123,\n \"birth_date\": \"1985-01-01\",\n \"nin\": 894237492,\n \"gender\": \"m\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:start/book", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":start", "book" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "start" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_service_id\": 113,\n \"is_returning\": false,\n \"patient\": {\n \"name\": \"Abraham\",\n \"surname\": \"Lincoln\",\n \"email\": \"example@example.com\",\n \"phone\": 48123123123,\n \"birth_date\": \"1985-01-01\",\n \"nin\": 894237492,\n \"gender\": \"m\"\n }\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:start/book", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":start", "book" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "start" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Validation error message\"\n}" } ] }, { "name": "delete Slots", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:date", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":date" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "date", "value": "", "type": "string", "description": "(Required) " } ] }, "description": "Delete slots for the given date" }, "response": [ { "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:date", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":date" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "date" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "Successfully deleted slots for the given date", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:date", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":date" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "date" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/slots/:date", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "slots", ":date" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "date" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" } ] } ] }, { "name": "bookings", "item": [ { "name": "{booking id}", "item": [ { "name": "presence/patient", "item": [ { "name": "mark Patient Presence", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "booking_id", "value": "", "type": "string", "description": "(Required) ID of the Booking" } ] }, "description": "Mark the presence of the patient on the visit" }, "response": [ { "name": "Successfuly marked the presence", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Validation error message, e.g.: Visit is in the future\"\n}" } ] }, { "name": "mark Patient Absence", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "booking_id", "value": "", "type": "string", "description": "(Required) ID of the Booking" } ] }, "description": "Mark the absence of the patient on the visit" }, "response": [ { "name": "Successfuly marked the absence", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Validation error message, e.g.: Visit is in the future\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/presence/patient", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "presence", "patient" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" } ] } ] }, { "name": "get Booking", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "booking_id", "value": "", "type": "string", "description": "(Required) ID of the Booking" } ] }, "description": "View specific booking\n\nExtensions:\n* `booking.patient` - with this parameter in url, query results will return patient data for specified booking\n* `booking.address_service` - with this parameter in url, query results will return address service for specified booking\n* `booking.presence` - with this parameter in url, query results will return additional information weather patient was present for specified booking\n" }, "response": [ { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Succesfully retrieved booking", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 2134124,\n \"status\": \"booked\",\n \"start_at\": \"2021-05-16T14:00:00+01:00\",\n \"end_at\": \"2021-05-16T14:30:00+01:00\",\n \"duration\": 30,\n \"booked_by\": \"user\",\n \"canceled_by\": \"\",\n \"booked_at\": \"2021-05-12T12:00:00+01:00\",\n \"canceled_at\": null,\n \"patient\": {\n \"name\": \"Abraham\",\n \"surname\": \"Lincoln\",\n \"email\": \"example@example.com\",\n \"phone\": 48123123123,\n \"birth_date\": \"1985-01-01\",\n \"nin\": 894237492,\n \"gender\": \"m\"\n },\n \"presence\": \"present\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" } ] }, { "name": "cancel Booking", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "booking_id", "value": "", "type": "string", "description": "(Required) ID of the Booking" } ] }, "description": "Cancel the booking" }, "response": [ { "name": "Resource not found", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Validation error message, e.g.: Visit 12345 cannot be canceled because it is not booked\"\n}" }, { "name": "Succesfully canceled the booking", "originalRequest": { "method": "DELETE", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "move Booking", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"address_service_id\": \"\",\n \"start\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/move", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "move" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" }, { "key": "booking_id", "value": "", "type": "string", "description": "(Required) ID of the Booking" } ] }, "description": "Move booking for a doctor" }, "response": [ { "name": "Request would result in creating conflicted or duplicated resources", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_serrvice_id\": 112,\n \"start\": \"2021-05-26T16:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/move", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "move" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"The visit has already been canceled or moved\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_serrvice_id\": 112,\n \"start\": \"2021-05-26T16:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/move", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "move" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_serrvice_id\": 112,\n \"start\": \"2021-05-26T16:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/move", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "move" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Validation error message\"\n}" }, { "name": "Succesfully moved the booking", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_serrvice_id\": 112,\n \"start\": \"2021-05-26T16:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/move", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "move" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Location", "value": "officia est incididunt proident sed", "description": "Resource URL for the new booking" }, { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"address_serrvice_id\": 112,\n \"start\": \"2021-05-26T16:00:00+01:00\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings/:booking_id/move", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings", ":booking_id", "move" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" }, { "key": "booking_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" } ] } ] }, { "name": "get Bookings", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings?with=&start=&end=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings" ], "query": [ { "key": "with", "value": "" }, { "key": "start", "value": "", "description": "(Required) Slot start date (parameter must be urlencoded before sending request)" }, { "key": "end", "value": "", "description": "(Required) Slot start date (parameter must be urlencoded before sending request)" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Get bookings list of a doctor in the facility\n\nExtensions:\n* `booking.patient` - with this parameter in url, query results will return patient data for every booking\n* `booking.address_service` - with this parameter in url, query results will return address service for every booking\n* `booking.presence` - with this parameter in url, query results will return additional information weather patient was present for every booking\n" }, "response": [ { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings?with=&start=2021-05-16T14:00:00+01:00&end=2021-05-16T15:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings" ], "query": [ { "key": "with", "value": "" }, { "key": "start", "value": "2021-05-16T14:00:00+01:00" }, { "key": "end", "value": "2021-05-16T15:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "Succesfully retrieved bookings list", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings?with=&start=2021-05-16T14:00:00+01:00&end=2021-05-16T15:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings" ], "query": [ { "key": "with", "value": "" }, { "key": "start", "value": "2021-05-16T14:00:00+01:00" }, { "key": "end", "value": "2021-05-16T15:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"id\": 2134124,\n \"status\": \"booked\",\n \"start_at\": \"2021-05-16T14:00:00+01:00\",\n \"end_at\": \"2021-05-16T14:30:00+01:00\",\n \"duration\": 30,\n \"booked_by\": \"user\",\n \"canceled_by\": \"\",\n \"booked_at\": \"2021-05-12T12:00:00+01:00\",\n \"canceled_at\": null,\n \"patient\": {\n \"name\": \"Abraham\",\n \"surname\": \"Lincoln\",\n \"email\": \"example@example.com\",\n \"phone\": 48123123123,\n \"birth_date\": \"1985-01-01\",\n \"nin\": 894237492,\n \"gender\": \"m\"\n },\n \"presence\": \"present\"\n },\n {\n \"id\": 2134125,\n \"status\": \"booked\",\n \"start_at\": \"2021-05-16T17:00:00+01:00\",\n \"end_at\": \"2021-05-16T17:30:00+01:00\",\n \"duration\": 15,\n \"booked_by\": \"doctor\",\n \"canceled_by\": \"doctor\",\n \"booked_at\": \"2021-05-12T13:00:00+01:00\",\n \"canceled_at\": \"2021-05-16T14:30:00+01:00\",\n \"patient\": {\n \"name\": \"Abraham\",\n \"surname\": \"Lincoln\",\n \"email\": \"example@example.com\",\n \"phone\": 48123123123,\n \"birth_date\": \"1985-01-01\",\n \"nin\": 894237492,\n \"gender\": \"m\"\n },\n \"presence\": null\n }\n ]\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id/bookings?with=&start=2021-05-16T14:00:00+01:00&end=2021-05-16T15:00:00+01:00", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id", "bookings" ], "query": [ { "key": "with", "value": "" }, { "key": "start", "value": "2021-05-16T14:00:00+01:00" }, { "key": "end", "value": "2021-05-16T15:00:00+01:00" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" } ] } ] }, { "name": "get Address", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" }, { "key": "address_id", "value": "", "type": "string", "description": "(Required) ID of a doctor`s address in a facility" } ] }, "description": "Get a single address of a doctor\n\nExtensions:\n* `address.online_only` - with this parameter in url, query results will return additional parameter indicating if an address is dedicated to video consultations\n* `address.visit_payment` - with this parameter in url, query results will return additional parameter indicating if visit payment isr enabled\n" }, "response": [ { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "List of addresses", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses/:address_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses", ":address_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" }, { "key": "address_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 111,\n \"name\": \"Example hospital\",\n \"post_code\": \"xx-xxx\",\n \"street\": \"Some street\",\n \"booking_extra_fields\": {\n \"birth_date\": false,\n \"gender\": false,\n \"nin\": false\n }\n}" } ] } ] }, { "name": "get Addresses", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" } ] }, "description": "Get a list of addresses of a doctor\n\nExtensions:\n* `address.online_only` - with this parameter in url, query results will return additional parameter indicating if returned addresses are dedicated to video consultations\n* `address.visit_payment` - with this parameter in url, query results will return additional parameter indicating if visit payments are enabled\n" }, "response": [ { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "List of addresses", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"id\": 111,\n \"name\": \"Example hospital\",\n \"post_code\": \"xx-xxx\",\n \"street\": \"Some street\"\n }\n ]\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/addresses?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "addresses" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" } ] } ] }, { "name": "get Doctor", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" } ] }, "description": "Get a single doctor in a facility\n\nExtensions:\n* `doctor.addresses` - with this parameter in url, query results will return a list of all the doctor addresses in a given facility\n* `address.booking_extra_fields` - with this parameter in url, query results will return required parameters requested from patient in the booking flow\n* `address.online_only` - with this parameter in url, query results will return additional parameter indicating if an address is dedicated to video consultations\n* `address.visit_payment` - with this parameter in url, query results will return additional parameter indicating when visit payments are enabled\n" }, "response": [ { "name": "Doctor data", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 123,\n \"name\": \"Sample\",\n \"surname\": \"Doctor 123\",\n \"specializations\": {\n \"_items\": [\n {\n \"id\": 12,\n \"name\": \"Specialization example 12\"\n }\n ]\n }\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" } ] }, { "name": "request Opinion", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": \"\"\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/opinion-request", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "opinion-request" ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" }, { "key": "doctor_id", "value": "", "type": "string", "description": "(Required) ID of a doctor in a facility" } ] }, "description": "After the visit was booked via clinics software, by calling this endpoint you can request SMS asking patient to leave an opinion. We do not store patient and visit information" }, "response": [ { "name": "Request cannot be processed", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": 123456789\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/opinion-request", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "opinion-request" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Cannot send request\"\n}" }, { "name": "Request would result in creating conflicted or duplicated resources", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": 123456789\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/opinion-request", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "opinion-request" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Opinion already exists\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": 123456789\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/opinion-request", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "opinion-request" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "Validation of the submitted values wasn't successful", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": 123456789\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/opinion-request", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "opinion-request" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Validation error message, e.g.: Phone number is invalid.\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": 123456789\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/opinion-request", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "opinion-request" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Succesfully put opinion request", "originalRequest": { "method": "PUT", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phone\": 123456789\n}" }, "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors/:doctor_id/opinion-request", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors", ":doctor_id", "opinion-request" ], "variable": [ { "key": "facility_id" }, { "key": "doctor_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "get Doctors", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" } ] }, "description": "Get a list of doctors in a facility\n\nExtensions:\n* `doctor.specializations` - with this parameter in url, query results will contain specialization of doctors\n" }, "response": [ { "name": "List of doctors", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"id\": 123,\n \"name\": \"Sample\",\n \"surname\": \"Doctor 123\"\n },\n {\n \"id\": 234,\n \"name\": \"Sample\",\n \"surname\": \"Doctor 234\"\n }\n ]\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" }, { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id/doctors?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id", "doctors" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" } ] } ] }, { "name": "get Facility", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities/:facility_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id", "value": "", "type": "string", "description": "(Required) ID of the Facility" } ] }, "description": "Get a single facility\n\nExtensions:\n* `facility.doctors` - with this parameter in url, query results will return a list of all the doctors in a given facility\n" }, "response": [ { "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"Object not found\"\n}" }, { "name": "Facility data", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"id\": 1,\n \"name\": \"Sample hospital\"\n}" }, { "name": "You are not authorized to see this resource", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities/:facility_id?with=", "host": [ "{{baseUrl}}" ], "path": [ "facilities", ":facility_id" ], "query": [ { "key": "with", "value": "" } ], "variable": [ { "key": "facility_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"errors\": [],\n \"message\": \"You are not authorized to see this facility\"\n}" } ] } ] }, { "name": "get Facilities", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/facilities", "host": [ "{{baseUrl}}" ], "path": [ "facilities" ] }, "description": "Get a list of facilities" }, "response": [ { "name": "List of facilities", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/facilities", "host": [ "{{baseUrl}}" ], "path": [ "facilities" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"id\": 1,\n \"name\": \"Sample hospital\"\n },\n {\n \"id\": 2,\n \"name\": \"Another sample hospital\"\n }\n ]\n}" } ] } ] }, { "name": "get Services", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/services?with=", "host": [ "{{baseUrl}}" ], "path": [ "services" ], "query": [ { "key": "with", "value": "" } ] }, "description": "Services returned in this endpoint are dictionary services.\n\nServices returned here are from a dictionary (item_services).\n\nScopes:\n\n* `services.only_diagnostics` - with this parameter in url, query results will return only dictionary of services dedicated to integration with diagnostics marketplace\n" }, "response": [ { "name": "List of services", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/services?with=", "host": [ "{{baseUrl}}" ], "path": [ "services" ], "query": [ { "key": "with", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"id\": 1,\n \"name\": \"USG\"\n },\n {\n \"id\": 2,\n \"name\": \"EKG\"\n },\n {\n \"id\": 3,\n \"name\": \"EEG\"\n }\n ]\n}" } ] }, { "name": "get Insurance Providers", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "insurance-providers" ] }, "description": "Get a list of available insurance providers" }, "response": [ { "name": "List of insurance providers", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/insurance-providers", "host": [ "{{baseUrl}}" ], "path": [ "insurance-providers" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"_items\": [\n {\n \"insurance_provider_id\": 1,\n \"name\": \"Insurance provider 1\"\n },\n {\n \"insurance_provider_id\": 2,\n \"name\": \"Insurance provider 2\"\n },\n {\n \"insurance_provider_id\": 3,\n \"naame\": \"Insurance provider 3\"\n }\n ]\n}" } ] }, { "name": "Push Notifications", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/:client-endpoint-url", "host": [ "{{baseUrl}}" ], "path": [ ":client-endpoint-url" ], "variable": [ { "key": "client-endpoint-url" } ] }, "description": "Pushing Notifications - To be able to use this method, client should give us an endpoint url, and we will be pushing notifications to this endpoint in real time. HTTP POST method will be used to push event data to endpoint. Note: Regardless of the response status (500, 200, 400) from the client endpoint, the events will be pushed only once. You can find every possible event notification requests below." }, "response": [ { "name": "Your server returns this code if it accepts the callback", "originalRequest": { "method": "POST", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/:client-endpoint-url", "host": [ "{{baseUrl}}" ], "path": [ ":client-endpoint-url" ], "variable": [ { "key": "client-endpoint-url" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Pull Notification", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ] }, "description": "Pulling Notifications - You can pull notifications via this endpoint. This page will respond to you with the earliest notification you haven’t been pulled yet. First In First Out (FIFO) principle applied here. This endpoint will respond with one notification per request until there aren’t any notifications left in the notification stack. Important: Notifications that are not pulled in 72 hours are marked as expired and deleted from the system." }, "response": [ { "name": "Notification from the bottom of the notification stack.", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.docplanner+json; charset=UTF-8" } ], "cookie": [], "body": "{\n \"name\": \"slot-changed\",\n \"data\": {\n \"facility\": {\n \"id\": 1,\n \"name\": \"Sample hospital\"\n },\n \"doctor\": {\n \"id\": 123,\n \"name\": \"Sample\",\n \"surname\": \"Doctor 123\"\n },\n \"address\": {\n \"id\": 111,\n \"name\": \"Example hospital\",\n \"street\": \"Some street\"\n }\n },\n \"created_at\": \"2021-05-12T10:18:34+01:00\"\n}" }, { "name": "Notification stack is empty.", "originalRequest": { "method": "GET", "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/notifications", "host": [ "{{baseUrl}}" ], "path": [ "notifications" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/vnd.error+docplanner+json" } ], "cookie": [], "body": "{\n \"error\": [],\n \"message\": \"No notifications found\"\n}" } ] } ], "auth": { "type": "oauth2" }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://www.{{domain}}/api/v3/integration" }, { "key": "facilityId", "value": "231206" }, { "key": "doctorId", "value": "336390" }, { "key": "addressId", "value": "950178" } ] }