Skip to content

Instantly share code, notes, and snippets.

@jd-alexander

jd-alexander/api.json

Created October 31, 2022 23:14
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jd-alexander/ac278cccaf0347eb441ba2785521ae3e to your computer and use it in GitHub Desktop.
Save jd-alexander/ac278cccaf0347eb441ba2785521ae3e to your computer and use it in GitHub Desktop.
Download ZIP
Raw
api.json
{
"openapi": "3.0.0",
"info": {
"title": "API Documentation",
"description": "",
"version": "1.0"
},
"paths": {
"/api/v1/attachments": {
"post": {
"summary": "Upload file",
"tags": [
"Attachment"
],
"description": "",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"example": "multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjV9.y3eVj2pTaP-jblP2IFuJJy41VNMKzLhB-cegeG-0GPVim1Gv9GRR2eHEbbeODzkyRq1mfI5XvH_lJJfj-GeKsg"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": "{\n \"recipient_id\": \"12424\",\n \"file\": {\n \"filename\": \"test.jpg\",\n \"type\": \"text/plain\",\n \"name\": \"file\",\n \"tempfile\": \"#<File:0x00007f5af13cf638>\",\n \"head\": \"Content-Disposition: form-data; name=\\\"file\\\"; filename=\\\"test.jpg\\\"\\r\\nContent-Type: text/plain\\r\\nContent-Length: 107\\r\\n\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true,
"file": "http://localhost/uploads/attachment/file/3/test.jpg"
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": false,
"errors": [
{
"key": "recipient_id",
"messages": [
"Recipient not found"
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/uploads/attachments/file/{attachment_id}/test.jpg": {
"get": {
"summary": "Download file",
"tags": [
"Attachment"
],
"description": "",
"parameters": [
{
"name": "attachment_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "10"
},
{
"name": "basename",
"in": "path",
"schema": {
"type": "string"
},
"example": "test"
},
{
"name": "extension",
"in": "path",
"schema": {
"type": "string"
},
"example": "jpg"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjIyfQ.8DOKd8PiZPA6WNOBwSW-ON0CBN7XCm-b2Xt93G2TGWEyTiGKqvdSRKOpUOC0UUbnr5fsi4bujvqd1uBmpOliGw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"image/jpeg": {
"examples": {
"get send file": {
"summary": "get send file",
"value": "ASCII-8BIT stream"
}
}
}
},
"headers": {
"Content-Type": {
"description": "image/jpeg"
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": false,
"errors": [
{
"key": "user",
"messages": [
"User doesn't have access to file"
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors/{doctor_id}/approve": {
"put": {
"summary": "Approve doctor request for managing Patient's medical history",
"tags": [
"Doctor"
],
"description": "",
"parameters": [
{
"name": "doctor_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "80"
},
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjc5fQ.0ViFgs5AtkVU9pA5s0v02GypbL1l_o8PcUJ23nEYdh2uJ459JEfltKLRJMpftnb79u9fbxTA360kgYaM6F9ZUw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
}
},
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
}
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only patients have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors/approved": {
"get": {
"summary": "List of Approved Doctors",
"tags": [
"Doctor"
],
"description": "List of Doctors that have access to Patient's medical history",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjg4fQ.oBSsMCt8du2LDfugu9oAOAcrl0z_z8bvFv60Ukplw07jPDle798-wfA1F-CFjSWTaROD0-P9T_yPU4UwhvZEXw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns doctors": {
"summary": "returns doctors",
"value": {
"success": true,
"doctors": [
{
"id": 85,
"first_name": "Ursula",
"last_name": "Pagac",
"specialization": "Manufacturing Designer",
"work_experience": 26,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/85/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only patients have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors/in_chat": {
"get": {
"summary": "List of chat Doctors",
"tags": [
"Doctor"
],
"description": "List of Doctors that have successfully paid by current Patient. It has actual and expired Doctor's session for communication. Pay attention about the payment expiration field.",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjEwNn0.D2aZhYfrM_A1YoiLVEikHKqJ1hjOezAv6XSdWWnkmlZyYFuBpXZ_JA_cYlBxjZEr50t0JGQgF5SwBnNmJi3V4g"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns doctors": {
"summary": "returns doctors",
"value": {
"success": true,
"doctors": [
{
"id": 101,
"first_name": "Lyndon",
"last_name": "Lebsack",
"specialization": "Accounting Manager",
"payment_expires_at": "2021-05-19T09:27:27+00:00",
"photo": "http://localhost/uploads/user/photo/101/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"card_permitted": true
},
{
"id": 102,
"first_name": "Chang",
"last_name": "Dach",
"specialization": "Central Specialist",
"payment_expires_at": "2021-05-19T11:27:27+00:00",
"photo": "http://localhost/uploads/user/photo/102/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"card_permitted": false
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only patients have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors": {
"get": {
"summary": "List of Doctors",
"tags": [
"Doctor"
],
"description": "",
"parameters": [
{
"in": "query",
"name": "filter",
"required": false,
"schema": {
"type": "object",
"required": [
"speciality"
],
"example": {
"speciality": "therapist"
},
"properties": {
"speciality": {
"type": "string",
"title": "doctor's speciality"
}
}
}
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjEyOX0.wzOf28Bj1QpgYrNycXk0oM1nmd-qC6HaHpp5HLbWyR2SKIJmZnQFvWDYiNwrIbT74T53SWLq6rp5pHZOVabP7Q"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns doctors": {
"summary": "returns doctors",
"value": {
"success": true,
"doctors": [
{
"id": 119,
"first_name": "Blanca",
"last_name": "Bartoletti",
"specialization": "Future Orchestrator",
"work_experience": 28,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/119/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
},
{
"id": 120,
"first_name": "Zina",
"last_name": "Zemlak",
"specialization": "Human Manager",
"work_experience": 5,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/120/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
},
{
"id": 121,
"first_name": "Monika",
"last_name": "Marks",
"specialization": "District Manufacturing Planner",
"work_experience": 14,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/121/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
},
{
"id": 122,
"first_name": "Earnest",
"last_name": "Reinger",
"specialization": "Lead Retail Architect",
"work_experience": 28,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/122/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
},
{
"id": 123,
"first_name": "Cary",
"last_name": "Wyman",
"specialization": "Dynamic Community-Services Designer",
"work_experience": 47,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/123/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
]
}
},
"returns therapists": {
"summary": "returns therapists",
"value": {
"success": true,
"doctors": [
{
"id": 135,
"first_name": "Anderson",
"last_name": "Hoeger",
"specialization": "Legacy Education Administrator",
"work_experience": 35,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/135/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
},
{
"id": 136,
"first_name": "Jamey",
"last_name": "Wisozk",
"specialization": "Lead Accounting Developer",
"work_experience": 39,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/136/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
},
{
"id": 137,
"first_name": "Tim",
"last_name": "Hettinger",
"specialization": "Construction Officer",
"work_experience": 37,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/137/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only patients have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors/permissions_requests": {
"get": {
"summary": "List of doctors requested permissions",
"tags": [
"Doctor"
],
"description": "Show a Doctors permissions request to the Patient's medical history",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjE3M30.l4GI1T7sb9KPE_LFo9WMtBv3z69Mh68Z0tbCCnyA8DtxJm9FlhoIXKJV1U2evZYPCgluiOuZ1SIDSjm_kdkOcw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns permissive doctors": {
"summary": "returns permissive doctors",
"value": {
"success": true,
"doctors": [
{
"id": 169,
"first_name": "Rosana",
"last_name": "Bergnaum",
"specialization": "Banking Coordinator",
"work_experience": 23,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/169/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
},
{
"id": 170,
"first_name": "Kaleigh",
"last_name": "Conn",
"specialization": "Mining Consultant",
"work_experience": 3,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/170/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only patients have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors/{doctor_id}/reject": {
"put": {
"summary": "Disable the doctor's access to manage the patient's medical history ",
"tags": [
"Doctor"
],
"description": "",
"parameters": [
{
"name": "doctor_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "189"
},
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjE4OH0.XLGiiugMHNAW1SJKfr2H78zbPtpgTjJK2ibfJqP9O5pxdxppVwYh4uknHshp0ZVxB_epJR-B8FlZ8HDxYB1TQA"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
}
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors/{id}": {
"get": {
"summary": "Show a Doctor",
"tags": [
"Doctor"
],
"description": "",
"parameters": [
{
"name": "id",
"in": "path",
"schema": {
"type": "number"
},
"example": "190"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjE5MX0.IYwWrPG9gNVJWRd0vMoTG3Zfg0W3QnMFJppj6z7nmRIJKUShfaZuLX3KVqe9LhqY72rLLewzwddhFTPtbDa2rA"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns doctor": {
"summary": "returns doctor",
"value": {
"success": true,
"id": 190,
"first_name": "Kaycee",
"last_name": "Rath",
"specialization": "Education Officer",
"work_experience": 4,
"price": "$15.77",
"photo": "http://localhost/uploads/user/photo/190/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"about_me": "Et dolor maxime. Quas dignissimos nesciunt. Quidem molestiae autem.",
"educations": [
{
"location": "veniam",
"graduation_year": 1902
},
{
"location": "est",
"graduation_year": 1982
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only patients have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns not found error": {
"summary": "returns not found error",
"value": {
"success": false,
"errors": [
{
"key": "base",
"messages": [
"Doctor not found."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors/specialities": {
"get": {
"summary": "List of specialities",
"tags": [
"Doctor"
],
"description": "",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjE5NX0.yyUUvVNEP4TKr09xvKGHLEw8I7ihvWs-fAlboKeQFJ0P3o47B9f2Oifi9AdYc4Hgzp6-rIT9kPkkKDOHoe1dFQ"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns specialities": {
"summary": "returns specialities",
"value": {
"success": true,
"specialities": [
{
"key": "therapist",
"text": "I don't know which doctor do I need",
"image": "http://localhost/assets/specialities/therapist-d6427eb805fa59e394e496a69d8cd19c57d7de49ba301af28b800dd93f37af93.png"
},
{
"key": "preventive",
"text": "Preventive medicine",
"image": "http://localhost/assets/specialities/preventive-796f284b49ae0c85a4c88493e3fed00fdd97c0527f23c76a48fff857a5f75654.png"
},
{
"key": "family",
"text": "Family medicine",
"image": "http://localhost/assets/specialities/family-cae45da31aa4c466337c3c15b54e3ecdd312c84ff8c456b77d406417fd828e62.png"
},
{
"key": "mental",
"text": "Mental health",
"image": "http://localhost/assets/specialities/mental-1e048637c1102aa1b57af51de0b95d8c7b692842b99098dfe1ba1d1a285ac66e.png"
},
{
"key": "laboratory",
"text": "Laboratory services",
"image": "http://localhost/assets/specialities/laboratory-94339578a31bf528e9f9a7014dfc4a2b67cbc2a6797d64c346ee36138fe8b5c7.png"
},
{
"key": "imaging",
"text": "Imaging services",
"image": "http://localhost/assets/specialities/imaging-ef0e303c5a4f5ace82a5aa9e7fe3f76b9c3ba0a71524337e928e75358e3d2855.png"
},
{
"key": "ob_gyn",
"text": "OB/GYN",
"image": "http://localhost/assets/specialities/ob_gyn-60341f1ffcd08a4bc7231d28e9a42bf1eca05f869cc227177e49bfc997fb63b5.png"
},
{
"key": "cardiology",
"text": "Cardiology",
"image": "http://localhost/assets/specialities/cardiology-2fa1788338df9b60d6ad2d350f315b9fab7ffe00f2fef6a18f7202f92a3b0483.png"
},
{
"key": "urgent",
"text": "Urgent Care",
"image": "http://localhost/assets/specialities/urgent-c1604d2f738e966cc9677f0e906d416c7934221d60ad59db7255690dc4399562.png"
},
{
"key": "pediatrics",
"text": "Pediatrics",
"image": "http://localhost/assets/specialities/pediatrics-921df5dca875a95474873771cf8b6bbb63aee591402b2046b947b058ad95c177.png"
},
{
"key": "orthopedics",
"text": "Orthopedics",
"image": "http://localhost/assets/specialities/orthopedics-e1ad46986bc280a76d76f1080a0266a645b46b9d3b217a5b736618694ff39727.png"
},
{
"key": "geriatrics",
"text": "Geriatrics",
"image": "http://localhost/assets/specialities/geriatrics-5151056c94921cb89bfa963020124a0885882740ef9af5a074cddf27cb823061.png"
},
{
"key": "internal",
"text": "Internal medicine",
"image": "http://localhost/assets/specialities/internal-068e653a2408f33977ea27a03fc80075c40035dd08f7160b7655981af049fd44.png"
},
{
"key": "neurology",
"text": "Neurology",
"image": "http://localhost/assets/specialities/neurology-1a9714eb1094f3d7b9f24a7bc95a3575fb07b23b1693f98e996a51839aa887f0.png"
},
{
"key": "dermatology",
"text": "Dermatology",
"image": "http://localhost/assets/specialities/dermatology-7c5fc3009eb3bba96c1462841ea0c74bba522daefd55313e29b74a3c31ed6ea2.png"
},
{
"key": "infectious",
"text": "Infectious diseases",
"image": "http://localhost/assets/specialities/infectious-5edadb7e0a6b00dc2f0d0507cdc6bbfd50d63c920870c698247272096f96a51e.png"
},
{
"key": "occupational",
"text": "Occupational medicine",
"image": "http://localhost/assets/specialities/occupational-b4f97be1a335f3c10da1c48b6af5f614916449fb32c549f8470d0e871044ca08.png"
},
{
"key": "allergy_immunology",
"text": "Allergy immunology",
"image": "http://localhost/assets/specialities/allergy_immunology-905e5ee3c727c94942af4ce31b0d6c5136f7418e87a0e8f5b10580d538ffee57.png"
},
{
"key": "endocrinology",
"text": "Endocrinology",
"image": "http://localhost/assets/specialities/endocrinology-fe1e26cda9b6b075595c3e6fb8064a893a8e75b07e2a855f68d8386f849debf4.png"
},
{
"key": "dentistry",
"text": "Dentistry",
"image": "http://localhost/assets/specialities/dentistry-90e3d4a54930b8dfea8aeb24f534e535b07ae7e8e0e5ba18582ea12035ebc0fc.png"
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only patients have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/doctors/{doctor_id}/pay": {
"post": {
"summary": "Pay for a Doctor",
"tags": [
"Payment"
],
"description": "",
"parameters": [
{
"name": "doctor_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "162"
},
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjE2M30.Yo5Xg7xKYqE12XAsIP4dvlApK4h_iJ70jBC7nNoAyBG5MThAwsMUAzfkcQP9jmKKROeREeKGHoM7wyM1g2HRKA"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns stripe session id": {
"summary": "returns stripe session id",
"value": {
}
},
"returns doctor not found error": {
"summary": "returns doctor not found error",
"value": {
}
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns stripe session id": {
"summary": "returns stripe session id",
"value": {
"success": true,
"payment_session_id": "cs_test_sample"
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns doctor not found error": {
"summary": "returns doctor not found error",
"value": {
"success": false,
"errors": [
{
"key": "base",
"messages": [
"Doctor not found."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/patients/{patient_id}/medical_cards": {
"post": {
"summary": "Create patient's Medical Card",
"tags": [
"Doctor Medical Card"
],
"description": "",
"parameters": [
{
"name": "patient_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "30"
},
{
"in": "query",
"name": "assistance_date",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjMxfQ.fWGp348xojRMoLziAYpgPsTNGrDIivWyQq-J3pP8oKqbdZCMUX3hkLq2hWXJZh-vbAchaZrry3CUEWNPV3xODA"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"assistance_date": "2020-07-17T12:27:26.000+00:00",
"patient_complaint": "Totam consequatur consequatur. Dolore quis impedit. Magnam velit perspiciatis.",
"illness_history": "Recusandae et et. Ab dignissimos commodi. Ea aut aut.",
"ros": "Modi sint nam. Maiores sunt aut. Error consequatur atque.",
"pmh": "Maiores magni ex. Architecto fugiat eligendi. Ut quaerat omnis.",
"psh": "Qui voluptas ipsa. Praesentium aperiam id. Asperiores iste non.",
"allergies": "Totam consectetur porro. Velit praesentium ipsum. Voluptatem dolores odit.",
"fh": "Iusto impedit voluptas. Dolor consequatur qui. Et voluptas eum.",
"sh": "Autem quae sint. Eveniet rem velit. Necessitatibus est rerum.",
"vital_signs": "Et quasi vero. Qui itaque sunt. Et magnam quia.",
"gen": "Accusantium modi velit. Sed culpa eum. Ut molestiae eligendi.",
"heart": "Sint laborum nam. Magnam exercitationem dolorem. Facilis debitis in.",
"lungs": "Ad quam ut. Possimus sit ex. A voluptates voluptate.",
"abdomen": "Dolorem reprehenderit quam. Ipsum ut natus. Sed recusandae laboriosam.",
"other_systems": "Aut iure error. Quis molestias nostrum. Culpa rerum quasi.",
"ose": "Officia quibusdam accusamus. Eligendi non esse. Enim ad inventore.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Dolorem sunt laboriosam. Nisi hic similique. Alias autem qui.",
"somatic_dysfunction": "Est in temporibus. Qui quis quos. Vel quo sed.",
"miscellaneous": "Est aut rerum. Eum in exercitationem. Enim laborum quos.",
"treatment_plan": "Sit alias et. Ut non a. Quo illum omnis."
}
},
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"assistance_date": "2018-10-22T12:27:26.092+00:00",
"patient_complaint": "Voluptatum et ut. Rem aut sed. Ex odit placeat.",
"illness_history": "Minima et facere. Numquam quas fugiat. Doloremque id officiis.",
"ros": "Alias dolorem magni. Maxime quas quibusdam. Ipsam iusto aut.",
"pmh": "Optio ipsa accusamus. Autem rerum voluptatem. Ut eos et.",
"psh": "Incidunt sunt iste. Et vel perferendis. Voluptatem atque aut.",
"allergies": "Occaecati et minus. Esse perferendis architecto. Expedita sed nihil.",
"fh": "Quia vel beatae. Distinctio autem autem. Sit ut sunt.",
"sh": "Vero deserunt sint. Saepe fugit et. Omnis reiciendis quasi.",
"vital_signs": "Ullam sapiente aperiam. Hic suscipit sunt. Cumque ipsum quia.",
"gen": "Quia a quam. Voluptatem consequuntur esse. Dolorem distinctio ea.",
"heart": "Aperiam ab qui. Omnis nesciunt voluptatem. Ut in eum.",
"lungs": "Repellat ut ut. Commodi distinctio esse. Ipsum quis quidem.",
"abdomen": "Cum voluptatem molestiae. Temporibus sunt consequatur. Officia deserunt inventore.",
"other_systems": "Ducimus nisi quo. Quas quidem sint. Consequuntur fuga ad.",
"ose": "Mollitia voluptas vel. Libero illum facilis. Unde quod voluptas.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Non cum quia. Saepe numquam eaque. Deleniti ad quia.",
"somatic_dysfunction": "Earum molestias ut. Pariatur autem in. Itaque eius ea.",
"miscellaneous": "Facilis veniam perferendis. Rerum placeat voluptatem. Sunt dolore ipsum.",
"treatment_plan": "Beatae corrupti sed. Quasi ex eum. Quia impedit consectetur."
}
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only doctors have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
},
"get": {
"summary": "List of patient's Medical Cards",
"tags": [
"Doctor Medical Card"
],
"description": "",
"parameters": [
{
"name": "patient_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "34"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjM3fQ.0rQKLdBcQ4V7hgpYHMXDoUivr8jpqyyohzq1N6h47h5uumd2c2_5cwFhhZ-EjHW_7Rn9ixZTeACUcMxQ2mP57w"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns patient cards": {
"summary": "returns patient cards",
"value": {
"success": true,
"medical_cards": [
{
"id": 2,
"treatment_plan": "Dignissimos et recusandae. Beatae qui rem. Aperiam et aut.",
"assistance_date": "2020-09-18T12:27:26+00:00",
"patient_complaint": "Eveniet nemo distinctio. Aut odit nulla. Eaque doloremque delectus.",
"illness_history": "Consequatur in unde. Ut eveniet repudiandae. Eum aspernatur fuga.",
"ros": "Mollitia quas quasi. Et repellendus placeat. Et aperiam rerum.",
"pmh": "Est veritatis veniam. Voluptates deleniti soluta. Quasi qui quibusdam.",
"psh": "Sed quam voluptas. Consequatur eius cupiditate. Recusandae quis illo.",
"allergies": "Aut eaque autem. Ab quisquam explicabo. Non aut occaecati.",
"fh": "Eum distinctio sequi. Et quis et. Maiores ipsa et.",
"sh": "Minima eligendi recusandae. Doloremque eligendi et. Molestiae et doloribus.",
"vital_signs": "Nesciunt pariatur quia. Laudantium atque ea. Et qui in.",
"gen": "Omnis odio maxime. Aut porro et. Voluptate doloremque sequi.",
"heart": "Sit laborum quia. Aperiam cumque est. Ea ab sunt.",
"lungs": "Officiis qui necessitatibus. Accusamus praesentium quia. Ut aut delectus.",
"abdomen": "Dolore doloribus neque. Aut praesentium qui. Alias sed asperiores.",
"other_systems": "Expedita molestias recusandae. Rerum autem eveniet. Ut iure asperiores.",
"ose": "Temporibus placeat officiis. Ut fugit optio. Et facere aspernatur.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Et molestias adipisci. Esse tenetur facilis. Sapiente soluta aut.",
"somatic_dysfunction": "Laudantium molestias ipsam. Necessitatibus et dolor. Doloremque voluptatibus quam.",
"miscellaneous": "Ea qui qui. A ratione excepturi. Officiis molestiae voluptatem.",
"doctor_specialization": "Product Technology Specialist"
},
{
"id": 3,
"treatment_plan": "Ducimus aliquid temporibus. Non voluptas dignissimos. Nesciunt omnis libero.",
"assistance_date": "2019-09-02T12:27:26+00:00",
"patient_complaint": "Atque rerum suscipit. Voluptatem minima quibusdam. Et cumque fugiat.",
"illness_history": "Aut aut neque. Facere voluptatem error. Assumenda quis eos.",
"ros": "In quae tempora. Provident dolorem molestias. Eos distinctio dignissimos.",
"pmh": "Quo animi quisquam. Repudiandae voluptas quaerat. Voluptatem incidunt eos.",
"psh": "Blanditiis iste ducimus. Ut quisquam eius. Ullam quo nulla.",
"allergies": "Rerum facilis aut. Rerum distinctio ab. Nobis ea necessitatibus.",
"fh": "Et ut similique. Optio qui totam. Temporibus consequuntur recusandae.",
"sh": "Sunt labore qui. Et nobis aliquid. Omnis ut et.",
"vital_signs": "Recusandae ut animi. Ut sequi quidem. Et voluptate aperiam.",
"gen": "Eum sunt ullam. Voluptatem est qui. Enim asperiores omnis.",
"heart": "Laudantium ipsam dolore. Repellendus earum harum. Vel sit consequatur.",
"lungs": "Magni provident esse. Deleniti dolor voluptas. Ipsa nemo eligendi.",
"abdomen": "Ut voluptatibus rerum. Praesentium voluptatum distinctio. Dolore deleniti est.",
"other_systems": "Impedit animi nisi. Nisi provident velit. Occaecati et unde.",
"ose": "Tempore et necessitatibus. Vel autem quos. Cumque itaque maxime.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Cumque magni quod. Eum in dolor. Neque eveniet commodi.",
"somatic_dysfunction": "Aut nesciunt facere. Veniam quas commodi. Enim est occaecati.",
"miscellaneous": "In consequatur quia. Reiciendis qui dolor. Omnis ipsum sit.",
"doctor_specialization": "Investor Banking Analyst"
},
{
"id": 4,
"treatment_plan": "Ipsum quo et. A odit et. Odit autem nam.",
"assistance_date": "2020-07-19T12:27:26+00:00",
"patient_complaint": "Inventore ut consequatur. Commodi corporis suscipit. Et aut excepturi.",
"illness_history": "Quo exercitationem sequi. Error rerum eum. Optio natus omnis.",
"ros": "In eos aut. Totam quibusdam repudiandae. Consequatur sit quia.",
"pmh": "Labore dolores nam. Illo ea aut. Sed eum velit.",
"psh": "Blanditiis officia totam. Blanditiis repellendus debitis. Ut autem porro.",
"allergies": "Esse iusto autem. In debitis magnam. Nemo tenetur porro.",
"fh": "Mollitia porro et. Alias aspernatur esse. Dolorem quam quaerat.",
"sh": "Odio eveniet sint. Sed numquam labore. Excepturi qui neque.",
"vital_signs": "Quis sed praesentium. Nisi quae quia. In blanditiis et.",
"gen": "Ea sit explicabo. Necessitatibus distinctio impedit. Sed voluptas aut.",
"heart": "Fuga nemo quis. Quasi numquam vero. Consequatur dignissimos quo.",
"lungs": "Nemo deserunt et. Distinctio ratione dicta. Officia a culpa.",
"abdomen": "Dolore in et. Id ut molestias. Iusto molestias rerum.",
"other_systems": "Omnis voluptatibus occaecati. Enim recusandae voluptatem. Cupiditate ipsa temporibus.",
"ose": "Aut necessitatibus qui. Aut voluptatem in. Occaecati et maiores.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Tempora ipsum velit. Molestiae tenetur asperiores. Numquam doloribus illo.",
"somatic_dysfunction": "Qui veniam expedita. Quam ut dolore. Consequatur modi sed.",
"miscellaneous": "Quis rem reprehenderit. Ea fuga velit. Nisi porro natus.",
"doctor_specialization": "Central Accounting Representative"
},
{
"id": 5,
"treatment_plan": "Nemo id vero. Qui vel excepturi. Iusto saepe aperiam.",
"assistance_date": "2020-02-27T12:27:26+00:00",
"patient_complaint": "Debitis repellat atque. Qui quo et. Sapiente ratione commodi.",
"illness_history": "Delectus exercitationem ad. Cum magni expedita. Doloremque et inventore.",
"ros": "Eos nemo eaque. Repellendus maiores voluptas. Non consequatur omnis.",
"pmh": "Vero laborum temporibus. Voluptate suscipit harum. Sunt qui voluptatem.",
"psh": "Voluptatibus eaque repellat. Quo recusandae eligendi. Voluptas non officia.",
"allergies": "Accusantium fugit porro. Quam qui voluptatum. Odit ut voluptatum.",
"fh": "Beatae repudiandae est. Sit officia magnam. Officia eligendi consequatur.",
"sh": "Et et id. Commodi doloremque et. Mollitia quam aut.",
"vital_signs": "Temporibus aut ipsum. Recusandae dicta ea. Culpa non sunt.",
"gen": "Ipsum cum neque. Quia ut culpa. Quis eius animi.",
"heart": "Quidem nobis et. Quidem assumenda et. Delectus excepturi consequatur.",
"lungs": "Nihil debitis nobis. Sapiente ea nihil. Assumenda ut nobis.",
"abdomen": "Qui architecto ea. Accusantium asperiores dicta. Ex aut expedita.",
"other_systems": "Incidunt maxime at. Et quo in. Odio error quia.",
"ose": "Modi ut accusamus. Nemo eum explicabo. Quia consequuntur quis.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Ut rerum illum. Consequatur rerum aut. Occaecati dolorem molestiae.",
"somatic_dysfunction": "Omnis voluptatibus laudantium. Et saepe optio. Fuga labore ea.",
"miscellaneous": "Est autem quisquam. Iusto optio ullam. Alias doloribus expedita.",
"doctor_specialization": "Central Accounting Representative"
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only doctors have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/patients/{patient_id}/medical_cards/permissions": {
"post": {
"summary": "Request permissions to patient's medical history",
"tags": [
"Doctor Medical Card"
],
"description": "",
"parameters": [
{
"name": "patient_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "46"
},
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjUwfQ.dy8rPfZaIMYU7Jbq1bNmhIIhkNN3q9MYg-Lxa9PeX5wBjLGjLsezV_nZ4DZ585TGR_4sLg4x8MGa8R2RU9lV4A"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
}
},
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
}
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only doctors have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/patients/{patient_id}/medical_cards/{id}": {
"get": {
"summary": "Show patient's Medical Card",
"tags": [
"Doctor Medical Card"
],
"description": "",
"parameters": [
{
"name": "patient_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "60"
},
{
"name": "id",
"in": "path",
"schema": {
"type": "number"
},
"example": "23"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjYyfQ.v58gcWW4_HGnr9bZFKQN-_U5i4EpIARObLSoWcOa9YuVC0OEgOIOGh_jnPKAeESwx1_B-ajvSGbDU_y6ZTS99Q"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns patient card": {
"summary": "returns patient card",
"value": {
"success": true,
"id": 23,
"treatment_plan": "Repellendus laborum iste. Quo nemo dignissimos. Doloremque ut officiis.",
"assistance_date": "2019-08-25T12:27:26+00:00",
"patient_complaint": "Occaecati voluptatem quo. Libero vel cum. Quia molestiae magnam.",
"illness_history": "Et fuga excepturi. Atque totam voluptatibus. A molestias voluptatem.",
"ros": "Porro optio non. Aut eius rerum. Aut voluptatum veritatis.",
"pmh": "Laborum rerum sed. Voluptatem qui beatae. Perferendis unde assumenda.",
"psh": "Sequi est consequatur. Repudiandae error inventore. Quia et dolor.",
"allergies": "Ut sed possimus. Consectetur error perferendis. Ea totam enim.",
"fh": "Aspernatur at non. Aspernatur quis unde. Et consectetur et.",
"sh": "Pariatur perspiciatis eaque. Magnam enim quis. Itaque qui quo.",
"vital_signs": "Similique corrupti ut. Est neque quae. Minima qui necessitatibus.",
"gen": "Facilis beatae in. Ut exercitationem libero. Accusamus natus minima.",
"heart": "Sit dolorum inventore. Animi eos quia. Ex quisquam similique.",
"lungs": "Blanditiis natus nulla. Voluptatibus asperiores non. Minima quo ut.",
"abdomen": "Dolorum maxime tenetur. Exercitationem totam est. Sequi sit minima.",
"other_systems": "Quia aut quas. Ipsum dolor quibusdam. Id enim velit.",
"ose": "Nihil maxime atque. Voluptatem non aut. Optio in est.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Et ratione neque. Exercitationem aut expedita. Et laudantium exercitationem.",
"somatic_dysfunction": "Delectus ad asperiores. Sunt est numquam. Vel ea suscipit.",
"miscellaneous": "Omnis deserunt est. Cupiditate sed quo. Et ut voluptates.",
"doctor_specialization": "Marketing Agent"
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only doctors have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns not found error": {
"summary": "returns not found error",
"value": {
"success": false,
"errors": [
{
"key": "base",
"messages": [
"Medical card not found."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
},
"put": {
"summary": "Update patient's Medical Card",
"tags": [
"Doctor Medical Card"
],
"description": "",
"parameters": [
{
"name": "patient_id",
"in": "path",
"schema": {
"type": "number"
},
"example": "72"
},
{
"name": "id",
"in": "path",
"schema": {
"type": "number"
},
"example": "27"
},
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjczfQ.DWYysGHk0BxaHq0QwrFLu5YJFhHVsbOojDlGPbD1hxxvHckWBcCjwBAQ0u_ne6Uq8NpXqJiV9gHHa8B1iUcaOw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"assistance_date": "2021-04-12T12:27:27.131+00:00",
"patient_complaint": "Dolor ducimus ab. Sed aut distinctio. Numquam iusto excepturi.",
"illness_history": "Suscipit ratione fuga. Quam quidem aliquam. Numquam laboriosam ullam.",
"ros": "Est ipsum non. Corporis ea nihil. Quas amet voluptate.",
"pmh": "Et optio earum. Est aperiam sit. Aperiam autem et.",
"psh": "Temporibus corporis qui. Hic doloribus consequatur. Consectetur distinctio molestiae.",
"allergies": "Quam laborum amet. Quis aut amet. Perspiciatis et quam.",
"fh": "Soluta praesentium et. Eos neque qui. Illum velit sint.",
"sh": "Nihil voluptates omnis. Enim omnis et. Ullam et quos.",
"vital_signs": "Laboriosam est hic. Illo atque repellendus. Ut nam mollitia.",
"gen": "Velit enim explicabo. Et dicta expedita. Consequatur aut velit.",
"heart": "Excepturi doloremque voluptate. Provident quaerat nam. Sunt labore harum.",
"lungs": "Nulla dolore ad. Ducimus ut unde. Ut rerum culpa.",
"abdomen": "Ab voluptas ut. Dolorum at perspiciatis. Laboriosam maiores sapiente.",
"other_systems": "Tenetur sunt optio. Voluptatem modi assumenda. Praesentium sunt debitis.",
"ose": "Consequatur unde corrupti. Possimus ullam voluptas. Sed impedit cumque.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Aut alias officiis. Quos repellat nesciunt. Ipsum eligendi quibusdam.",
"somatic_dysfunction": "Odit voluptatem mollitia. Rerum aliquid error. Dolorem error aspernatur.",
"miscellaneous": "Blanditiis dolor amet. Sed quis voluptatem. Placeat est cumque.",
"treatment_plan": "Sed unde in. Et quos provident. Quod aliquid sed."
}
},
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"assistance_date": "2019-12-01T12:27:27.291+00:00",
"patient_complaint": "Sit omnis quis. Ab ipsum cupiditate. Quo rerum ipsum.",
"illness_history": "Fuga qui quasi. Qui voluptate accusamus. Aut ut fugiat.",
"ros": "Est modi quas. Minima recusandae enim. Distinctio accusamus tempora.",
"pmh": "Eveniet quo optio. Tenetur consequatur perferendis. Deleniti non sit.",
"psh": "Nam et itaque. Eius et nisi. Quis possimus illum.",
"allergies": "Minus architecto ut. Quia accusamus dolor. Et odio dolorem.",
"fh": "Voluptates est et. Excepturi nam sit. Magnam et adipisci.",
"sh": "Eum rem incidunt. Hic doloribus expedita. Possimus nobis repellat.",
"vital_signs": "Officiis quidem nisi. Molestias architecto est. Non natus beatae.",
"gen": "Sed et rerum. Est ratione saepe. Cupiditate voluptatum amet.",
"heart": "Perspiciatis odit totam. Est porro molestias. Voluptatem facilis deleniti.",
"lungs": "Eveniet accusamus voluptate. Laboriosam eius mollitia. Repellendus animi nihil.",
"abdomen": "Rerum dolores ut. Ut inventore tenetur. Quasi omnis sit.",
"other_systems": "Dolores facilis est. Et consequatur aut. Nihil sapiente reiciendis.",
"ose": "Exercitationem qui reprehenderit. Dicta aperiam odio. Voluptas magni hic.",
"patient_first_problem": "second_different_diagnosis",
"patient_second_problem": "third_different_diagnosis",
"patient_third_problem": "Consequatur iure porro. Qui tenetur vero. Animi dicta eligendi.",
"somatic_dysfunction": "Quia et repellat. Ad dolor est. Optio possimus vel.",
"miscellaneous": "Odio autem quidem. Est vitae quis. Neque voluptas expedita.",
"treatment_plan": "Animi consectetur architecto. Nemo aliquid sint. Voluptas ut eveniet."
}
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only doctors have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/treatment_plans": {
"get": {
"summary": "List of Medical Cards",
"tags": [
"Patient Medical Card"
],
"description": "",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjIwMX0.xiRcheOjgDKmvaeJAbDHZ7-ZIH9FWwVuFoxF3rUCzMggHuj_AlCzGjdJcmYSG7H6mgGcEYkLona9KY-QvSgzhg"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns medical cards": {
"summary": "returns medical cards",
"value": {
"success": true,
"medical_cards": [
{
"id": 32,
"treatment_plan": "Repudiandae sint dolorem. Ipsa amet voluptatem. Ullam quia placeat.",
"assistance_date": "2020-07-05T12:27:29+00:00",
"doctor": {
"id": 202,
"first_name": "Elli",
"last_name": "Koelpin",
"specialization": "Healthcare Orchestrator",
"photo": "http://localhost/uploads/user/photo/202/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
},
{
"id": 31,
"treatment_plan": "Ut repellendus eligendi. Tenetur aliquam esse. Et eum deserunt.",
"assistance_date": "2019-09-15T12:27:29+00:00",
"doctor": {
"id": 202,
"first_name": "Elli",
"last_name": "Koelpin",
"specialization": "Healthcare Orchestrator",
"photo": "http://localhost/uploads/user/photo/202/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
},
{
"id": 30,
"treatment_plan": "Aut fugiat laudantium. Quis distinctio voluptatem. Eligendi quasi placeat.",
"assistance_date": "2019-06-27T12:27:29+00:00",
"doctor": {
"id": 202,
"first_name": "Elli",
"last_name": "Koelpin",
"specialization": "Healthcare Orchestrator",
"photo": "http://localhost/uploads/user/photo/202/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only patients have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/password/reset": {
"post": {
"summary": "Reset password - send the token",
"tags": [
"Password"
],
"description": "",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"email": "nancee@daugherty.name"
}
},
"returns user not found error": {
"summary": "returns user not found error",
"value": {
"email": "invalid@email"
}
},
"returns required email error": {
"summary": "returns required email error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns user not found error": {
"summary": "returns user not found error",
"value": {
"success": false,
"errors": [
{
"key": "user",
"messages": [
"User not found."
]
}
]
}
},
"returns required email error": {
"summary": "returns required email error",
"value": {
"success": false,
"errors": [
{
"key": "email",
"messages": [
"Email is required."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/password": {
"put": {
"summary": "Update the password",
"tags": [
"Password"
],
"description": "",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success with reset_token": {
"summary": "returns success with reset_token",
"value": {
"confirmation": "foobar123",
"password": "foobar123",
"reset_token": "123"
}
},
"returns expired token error": {
"summary": "returns expired token error",
"value": {
"confirmation": "foobar123",
"password": "foobar123",
"reset_token": "123"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success with reset_token": {
"summary": "returns success with reset_token",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns expired token error": {
"summary": "returns expired token error",
"value": {
"success": false,
"errors": [
{
"key": "reset_token",
"messages": [
"Reset token is invalid or has expired."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/patients/in_chat": {
"get": {
"summary": "List of chat Patients",
"tags": [
"Patient"
],
"description": "List of Patients that have successfully paid for current Doctor. It has actual and expired Patient's session for communication. Pay attention about the payment expiration field.",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjIxMH0.smOQbTjYwQyIrzQZ3QIbCjBZ2B1RYgbYGFDa7viNFkM5Ch2smzLr_FzNs-U_QyOTvr7BRe6Njs8zwBAZB7YVWw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns patients": {
"summary": "returns patients",
"value": {
"success": true,
"patients": [
{
"id": 207,
"first_name": "Delia",
"last_name": "Schoen",
"payment_expires_at": "2021-05-19T09:27:29+00:00",
"photo": "http://localhost/uploads/user/photo/207/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"age": "18 y.o."
},
{
"id": 208,
"first_name": "Mellissa",
"last_name": "Quigley",
"payment_expires_at": "2021-05-19T11:27:29+00:00",
"photo": "http://localhost/uploads/user/photo/208/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"age": "18 y.o."
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only doctors have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/patients": {
"get": {
"summary": "List of Patients",
"tags": [
"Patient"
],
"description": "",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjIyMn0.yS7cMI0CWoHZItZnq-vkOc48Y87Fxs5vjoZe7Ldn0lE1eKyrK-k1Hx8-SFg3Gb1jK1ICKciZ4wk-B6cD5K0olA"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns patients": {
"summary": "returns patients",
"value": {
"success": true,
"patients": [
{
"id": 219,
"email": "hilton@conroy.io",
"birthday": "18.05.2003",
"photo": "http://localhost/uploads/user/photo/219/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"first_name": "Vaughn",
"last_name": "Lesch",
"age": "18 years",
"doctors_specializations": [
"Advertising Associate",
"Principal Design Analyst"
]
},
{
"id": 220,
"email": "latoyia_rodriguez@fisher.net",
"birthday": "18.05.2003",
"photo": "http://localhost/uploads/user/photo/220/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"first_name": "Colby",
"last_name": "Nitzsche",
"age": "18 years",
"doctors_specializations": [
"Advertising Associate",
"Principal Design Analyst"
]
},
{
"id": 221,
"email": "bette.olson@blanda.com",
"birthday": "18.05.2003",
"photo": "http://localhost/uploads/user/photo/221/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"first_name": "Kacie",
"last_name": "Okuneva",
"age": "18 years",
"doctors_specializations": [
"Advertising Associate",
"Principal Design Analyst"
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns role mismatch error": {
"summary": "returns role mismatch error",
"value": {
"success": false,
"errors": [
{
"key": "permissions",
"messages": [
"Only doctors have access to this resource."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/payments/subscriptions": {
"post": {
"summary": "Sign up for a Paid Subscription",
"tags": [
"Payment Subscription"
],
"description": "",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"example": "application/json"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjI0MH0.JCjHDn0ZK_SFO5t5sHHi4tRHtR-d-RG_Ruzmn5y7N_L8vEmWnaFanRGVxJuO9cGHQY3bjN-z4ZdMeZFso6Q5rw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"payment_method": "pm_1GTXuQ2eZvKYlo2CuApYUpsM",
"package": "basic"
}
},
"returns stripe request error": {
"summary": "returns stripe request error",
"value": {
"payment_method": "pm_1GTXuQ2eZvKYlo2CuApYUpsM",
"package": "basic"
}
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns stripe request error": {
"summary": "returns stripe request error",
"value": {
"success": false,
"errors": [
{
"key": "base",
"messages": [
"Payment gateway request error on subscription processing"
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
},
"get": {
"summary": "Show a Payment Subscription",
"tags": [
"Payment Subscription"
],
"description": "",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjI0NH0.18wPSFwz6ws7ij8nvWDnJbt51kyZG1gwsBMPd3tZQyWg3qCkK8wuV3ladftOUijy4Njz1X3JSYsAwmCLBkS4pw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns subscription info": {
"summary": "returns subscription info",
"value": {
"success": true,
"subscription": {
"package": "basic",
"plan": "monthly",
"price": "$350.00",
"status": "active"
}
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns subscription not found error": {
"summary": "returns subscription not found error",
"value": {
"success": false,
"errors": [
{
"key": "base",
"messages": [
"Payment subscription not found."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/payments/subscriptions/packages": {
"get": {
"summary": "List of Payment Packages for Payment Subscription",
"tags": [
"Payment Subscription"
],
"description": "",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjI0Mn0.tXHNv_IQtxV3hikXS9l-C1wZ7VH4RcurhKDMqdD2FdecgRmxMqOigR1DCmlOBL2IJEUnmGI_rWMRKc-kCL5OzQ"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns packages": {
"summary": "returns packages",
"value": {
"success": true,
"packages": [
{
"amount": 10,
"currency": "usd",
"interval": "yearly",
"product": "Dungeon Keeper"
},
{
"amount": 20,
"currency": "usd",
"interval": "yearly",
"product": "Dishonored"
},
{
"amount": 30,
"currency": "usd",
"interval": "yearly",
"product": "Call of Duty: Black Ops"
},
{
"amount": 40,
"currency": "usd",
"interval": "yearly",
"product": "Doom"
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/payment_documents": {
"post": {
"summary": "Upload receipt",
"tags": [
"PaymentDocument"
],
"description": "",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"example": "multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjIzNH0.VV9FkAw5Yr8cqbnhpqHY4CPRseRzINcd6q8hHkvEw8HeL7o2xpN4r2FsVx2faERsOLxU4zPocU_lVlRU-mLhjw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": "{\n \"receipt\": {\n \"filename\": \"test.jpg\",\n \"type\": \"text/plain\",\n \"name\": \"receipt\",\n \"tempfile\": \"#<File:0x00007f5af12f5a00>\",\n \"head\": \"Content-Disposition: form-data; name=\\\"receipt\\\"; filename=\\\"test.jpg\\\"\\r\\nContent-Type: text/plain\\r\\nContent-Length: 107\\r\\n\"\n }\n}"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true,
"receipt": "http://localhost/uploads/payment_document/receipt/3/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": false,
"errors": [
{
"key": "receipt",
"messages": [
"Receipt is required."
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/profile/change_password": {
"put": {
"summary": "Change User Password",
"tags": [
"Profile"
],
"description": "",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"example": "multipart/form-data"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjI0N30.g8DewCo1E9t6YKRud-TUvtXXQeTdKpB7f5vi3KVhHYvdfzvhbWfSI-Cq2uYQ-9zDhZQ0c77mP5KWulRwfqzcVw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": "null"
},
"returns current password invalid error": {
"summary": "returns current password invalid error",
"value": "null"
},
"returns password confirmation error": {
"summary": "returns password confirmation error",
"value": "null"
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns current password invalid error": {
"summary": "returns current password invalid error",
"value": {
"success": false,
"errors": [
{
"key": "password",
"messages": [
"Password too short"
]
}
]
}
},
"returns password confirmation error": {
"summary": "returns password confirmation error",
"value": {
"success": false,
"errors": [
{
"key": "password_confirmation",
"messages": [
"Password confirmation doesn't match Password"
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
},
"/api/v1/profile": {
"get": {
"summary": "Show User Profile",
"tags": [
"Profile"
],
"description": "",
"parameters": [
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjI1Mn0.rS2JaRI_c--Gd88weNInS3Vx2eHdZntKH0AxieEIDfCN8IN_sf-ve-56wY1H2WUTWj4Oh8y-BHkZfbkSer1yRw"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns patient profile": {
"summary": "returns patient profile",
"value": {
"success": true,
"id": 252,
"first_name": "Ramon",
"last_name": "Carter",
"email": "rene_heathcote@lind.org",
"role": "patient",
"birthday": "18.05.2003",
"photo": "http://localhost/uploads/user/photo/252/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg"
}
},
"returns doctor profile": {
"summary": "returns doctor profile",
"value": {
"success": true,
"id": 253,
"first_name": "Rusty",
"last_name": "Nienow",
"email": "peggy@nikolaus.io",
"role": "doctor",
"birthday": "18.05.2003",
"photo": "http://localhost/uploads/user/photo/253/a73605cfc159cb59ccd60c2717c3aa203d2ba560.jpg",
"about_me": "Labore similique beatae. Amet cupiditate id. Ut odio accusamus.",
"specialization": "Consulting Administrator",
"educations": [
{
"location": "qui",
"graduation_year": 1945
},
{
"location": "impedit",
"graduation_year": 1962
}
],
"work_experience": 9,
"price": "$15.77",
"verified": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
},
"put": {
"summary": "Update User Profile",
"tags": [
"Profile"
],
"description": "",
"parameters": [
{
"name": "Content-Type",
"in": "header",
"example": "multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1"
},
{
"name": "session-token",
"in": "header",
"example": "eyJhbGciOiJIUzUxMiJ9.eyJ1aWQiOjI1NX0.g7kXIBMrZbN_KB06BANsADeHl5DfjqI1DuTNmOXCUskQpvFGFlJQdiGVJQ1OH-j-21tJdblxlTGEGyjghA6X_A"
},
{
"name": "Accept",
"in": "header",
"example": "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
}
],
"requestBody": {
"content": {
"text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5": {
"examples": {
"returns success": {
"summary": "returns success",
"value": "{\n \"email\": \"carroll_schumm@champlin-abbott.co\",\n \"first_name\": \"Mickey\",\n \"last_name\": \"Swift\",\n \"birthday\": \"2010-02-02\",\n \"photo\": {\n \"filename\": \"test.jpg\",\n \"type\": \"image/jpeg\",\n \"name\": \"photo\",\n \"tempfile\": \"#<File:0x00007f5af12d4e40>\",\n \"head\": \"Content-Disposition: form-data; name=\\\"photo\\\"; filename=\\\"test.jpg\\\"\\r\\nContent-Type: image/jpeg\\r\\nContent-Length: 107\\r\\n\"\n },\n \"doctor_verified\": \"true\",\n \"specialities\": [\n \"mental\",\n \"infectious\",\n \"internal\"\n ],\n \"about_me\": \"Dolores repudiandae libero. Magnam est qui. Quas quod atque.\",\n \"specialization\": \"Retail Agent\",\n \"educations\": [\n {\n \"location\": \"consequuntur\",\n \"graduation_year\": \"1947\"\n },\n {\n \"location\": \"qui\",\n \"graduation_year\": \"1993\"\n }\n ],\n \"work_experience\": \"11\",\n \"price\": \"15.77\"\n}"
},
"returns graduation year error on educations": {
"summary": "returns graduation year error on educations",
"value": "null"
},
"returns empty education fields error": {
"summary": "returns empty education fields error",
"value": "null"
},
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": "null"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns success": {
"summary": "returns success",
"value": {
"success": true
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns graduation year error on educations": {
"summary": "returns graduation year error on educations",
"value": {
"success": false,
"errors": [
{
"key": "educations",
"messages": [
"Educations has an invalid nested value (\"graduation_year\" => \"invalid\")"
]
}
]
}
},
"returns empty education fields error": {
"summary": "returns empty education fields error",
"value": {
"success": false,
"errors": [
{
"key": "educations",
"messages": [
"Educations cannot be with an empty location",
"Educations cannot be with an empty graduation year"
]
}
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json; charset=utf-8": {
"examples": {
"returns an unauthorized error": {
"summary": "returns an unauthorized error",
"value": {
"success": false,
"errors": [
"unauthorized"
]
}
}
}
}
},
"headers": {
"Content-Type": {
"description": "application/json; charset=utf-8"
}
}
}
}
}
}
},
"tags": [
{
"name": "Attachment",
"description": ""
},
{
"name": "Doctor",
"description": ""
},
{
"name": "Payment",
"description": ""
},
{
"name": "Doctor Medical Card",
"description": ""
},
{
"name": "Patient Medical Card",
"description": ""
},
{
"name": "Password",
"description": ""
},
{
"name": "Patient",
"description": ""
},
{
"name": "Payment Subscription",
"description": ""
},
{
"name": "PaymentDocument",
"description": ""
},
{
"name": "Profile",
"description": ""
}
],
"x-tagGroups": [
{
"name": "Attachment",
"tags": [
"Attachment"
]
},
{
"name": "Doctor",
"tags": [
"Doctor",
"Payment"
]
},
{
"name": "Medical Card",
"tags": [
"Doctor Medical Card",
"Patient Medical Card"
]
},
{
"name": "Password",
"tags": [
"Password"
]
},
{
"name": "Patient",
"tags": [
"Patient"
]
},
{
"name": "Payment Subscription",
"tags": [
"Payment Subscription"
]
},
{
"name": "PaymentDocument",
"tags": [
"PaymentDocument"
]
},
{
"name": "Profile",
"tags": [
"Profile"
]
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment