1672 lines
42 KiB
JavaScript
1672 lines
42 KiB
JavaScript
define({ "api": [
|
|
{
|
|
"type": "post",
|
|
"url": "/apointments",
|
|
"title": "Create apointment",
|
|
"name": "CreateApointment",
|
|
"group": "Apointment",
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "No",
|
|
"description": "<p>Apointment's No.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "PatientName",
|
|
"description": "<p>Apointment's PatientName.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "DocterName",
|
|
"description": "<p>Apointment's DocterName.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Email",
|
|
"description": "<p>Apointment's Email.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "PhoneNo",
|
|
"description": "<p>Apointment's PhoneNo.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Date",
|
|
"description": "<p>Apointment's Date.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Time",
|
|
"description": "<p>Apointment's Time.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Department",
|
|
"description": "<p>Apointment's Department.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "apointment",
|
|
"description": "<p>Apointment's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Apointment not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/apointment/index.js",
|
|
"groupTitle": "Apointment"
|
|
},
|
|
{
|
|
"type": "delete",
|
|
"url": "/apointments/:id",
|
|
"title": "Delete apointment",
|
|
"name": "DeleteApointment",
|
|
"group": "Apointment",
|
|
"success": {
|
|
"fields": {
|
|
"Success 204": [
|
|
{
|
|
"group": "Success 204",
|
|
"optional": false,
|
|
"field": "204",
|
|
"description": "<p>No Content.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Apointment not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/apointment/index.js",
|
|
"groupTitle": "Apointment"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/apointments/:id",
|
|
"title": "Retrieve apointment",
|
|
"name": "RetrieveApointment",
|
|
"group": "Apointment",
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "apointment",
|
|
"description": "<p>Apointment's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Apointment not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/apointment/index.js",
|
|
"groupTitle": "Apointment"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/apointments",
|
|
"title": "Retrieve apointments",
|
|
"name": "RetrieveApointments",
|
|
"group": "Apointment",
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Number",
|
|
"optional": false,
|
|
"field": "count",
|
|
"description": "<p>Total amount of apointments.</p>"
|
|
},
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object[]",
|
|
"optional": false,
|
|
"field": "rows",
|
|
"description": "<p>List of apointments.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/apointment/index.js",
|
|
"groupTitle": "Apointment",
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": true,
|
|
"field": "q",
|
|
"description": "<p>Query to search.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "Number",
|
|
"size": "1..30",
|
|
"optional": true,
|
|
"field": "page",
|
|
"defaultValue": "1",
|
|
"description": "<p>Page number.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "Number",
|
|
"size": "1..100",
|
|
"optional": true,
|
|
"field": "limit",
|
|
"defaultValue": "30",
|
|
"description": "<p>Amount of returned items.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String[]",
|
|
"optional": true,
|
|
"field": "sort",
|
|
"defaultValue": "-createdAt",
|
|
"description": "<p>Order of returned items.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String[]",
|
|
"optional": true,
|
|
"field": "fields",
|
|
"description": "<p>Fields to be returned.</p>"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "put",
|
|
"url": "/apointments/:id",
|
|
"title": "Update apointment",
|
|
"name": "UpdateApointment",
|
|
"group": "Apointment",
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "No",
|
|
"description": "<p>Apointment's No.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "PatientName",
|
|
"description": "<p>Apointment's PatientName.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "DocterName",
|
|
"description": "<p>Apointment's DocterName.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Email",
|
|
"description": "<p>Apointment's Email.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "PhoneNo",
|
|
"description": "<p>Apointment's PhoneNo.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Date",
|
|
"description": "<p>Apointment's Date.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Time",
|
|
"description": "<p>Apointment's Time.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Department",
|
|
"description": "<p>Apointment's Department.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "apointment",
|
|
"description": "<p>Apointment's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Apointment not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/apointment/index.js",
|
|
"groupTitle": "Apointment"
|
|
},
|
|
{
|
|
"type": "post",
|
|
"url": "/auth",
|
|
"title": "Authenticate",
|
|
"name": "Authenticate",
|
|
"group": "Auth",
|
|
"permission": [
|
|
{
|
|
"name": "master",
|
|
"title": "Master access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"header": {
|
|
"fields": {
|
|
"Header": [
|
|
{
|
|
"group": "Header",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "Authorization",
|
|
"description": "<p>Basic authorization with email and password.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>Master access_token.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 201": [
|
|
{
|
|
"group": "Success 201",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "token",
|
|
"description": "<p>User <code>access_token</code> to be passed to other requests.</p>"
|
|
},
|
|
{
|
|
"group": "Success 201",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "user",
|
|
"description": "<p>Current user's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>Master access only or invalid credentials.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/auth/index.js",
|
|
"groupTitle": "Auth"
|
|
},
|
|
{
|
|
"type": "post",
|
|
"url": "/Departments",
|
|
"title": "Create department",
|
|
"name": "CreateDepartment",
|
|
"group": "Department",
|
|
"permission": [
|
|
{
|
|
"name": "admin",
|
|
"title": "Admin access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>admin access token.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "ID",
|
|
"description": "<p>Department's ID.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Name",
|
|
"description": "<p>Department's Name.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Nos",
|
|
"description": "<p>Department's Nos.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "department",
|
|
"description": "<p>Department's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Department not found.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>admin access only.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Department/index.js",
|
|
"groupTitle": "Department"
|
|
},
|
|
{
|
|
"type": "delete",
|
|
"url": "/Departments/:id",
|
|
"title": "Delete department",
|
|
"name": "DeleteDepartment",
|
|
"group": "Department",
|
|
"success": {
|
|
"fields": {
|
|
"Success 204": [
|
|
{
|
|
"group": "Success 204",
|
|
"optional": false,
|
|
"field": "204",
|
|
"description": "<p>No Content.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Department not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Department/index.js",
|
|
"groupTitle": "Department"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/Departments/:id",
|
|
"title": "Retrieve department",
|
|
"name": "RetrieveDepartment",
|
|
"group": "Department",
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "department",
|
|
"description": "<p>Department's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Department not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Department/index.js",
|
|
"groupTitle": "Department"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/Departments",
|
|
"title": "Retrieve departments",
|
|
"name": "RetrieveDepartments",
|
|
"group": "Department",
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Number",
|
|
"optional": false,
|
|
"field": "count",
|
|
"description": "<p>Total amount of departments.</p>"
|
|
},
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object[]",
|
|
"optional": false,
|
|
"field": "rows",
|
|
"description": "<p>List of departments.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Department/index.js",
|
|
"groupTitle": "Department",
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": true,
|
|
"field": "q",
|
|
"description": "<p>Query to search.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "Number",
|
|
"size": "1..30",
|
|
"optional": true,
|
|
"field": "page",
|
|
"defaultValue": "1",
|
|
"description": "<p>Page number.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "Number",
|
|
"size": "1..100",
|
|
"optional": true,
|
|
"field": "limit",
|
|
"defaultValue": "30",
|
|
"description": "<p>Amount of returned items.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String[]",
|
|
"optional": true,
|
|
"field": "sort",
|
|
"defaultValue": "-createdAt",
|
|
"description": "<p>Order of returned items.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String[]",
|
|
"optional": true,
|
|
"field": "fields",
|
|
"description": "<p>Fields to be returned.</p>"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"type": "put",
|
|
"url": "/Departments/:id",
|
|
"title": "Update department",
|
|
"name": "UpdateDepartment",
|
|
"group": "Department",
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "ID",
|
|
"description": "<p>Department's ID.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Name",
|
|
"description": "<p>Department's Name.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Nos",
|
|
"description": "<p>Department's Nos.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "department",
|
|
"description": "<p>Department's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Department not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Department/index.js",
|
|
"groupTitle": "Department"
|
|
},
|
|
{
|
|
"type": "post",
|
|
"url": "/Doctors",
|
|
"title": "Create doctor",
|
|
"name": "CreateDoctor",
|
|
"group": "Doctor",
|
|
"permission": [
|
|
{
|
|
"name": "admin",
|
|
"title": "Admin access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>admin access token.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "ID",
|
|
"description": "<p>Doctor's ID.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Name",
|
|
"description": "<p>Doctor's Name.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Dapartment",
|
|
"description": "<p>Doctor's Dapartment.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "doctor",
|
|
"description": "<p>Doctor's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Doctor not found.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>admin access only.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Doctor/index.js",
|
|
"groupTitle": "Doctor"
|
|
},
|
|
{
|
|
"type": "delete",
|
|
"url": "/Doctors/:id",
|
|
"title": "Delete doctor",
|
|
"name": "DeleteDoctor",
|
|
"group": "Doctor",
|
|
"permission": [
|
|
{
|
|
"name": "admin",
|
|
"title": "Admin access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>admin access token.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 204": [
|
|
{
|
|
"group": "Success 204",
|
|
"optional": false,
|
|
"field": "204",
|
|
"description": "<p>No Content.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Doctor not found.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>admin access only.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Doctor/index.js",
|
|
"groupTitle": "Doctor"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/Doctors/:id",
|
|
"title": "Retrieve doctor",
|
|
"name": "RetrieveDoctor",
|
|
"group": "Doctor",
|
|
"permission": [
|
|
{
|
|
"name": "admin",
|
|
"title": "Admin access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>admin access token.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "doctor",
|
|
"description": "<p>Doctor's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Doctor not found.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>admin access only.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Doctor/index.js",
|
|
"groupTitle": "Doctor"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/Doctors",
|
|
"title": "Retrieve doctors",
|
|
"name": "RetrieveDoctors",
|
|
"group": "Doctor",
|
|
"permission": [
|
|
{
|
|
"name": "admin",
|
|
"title": "Admin access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>admin access token.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": true,
|
|
"field": "q",
|
|
"description": "<p>Query to search.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "Number",
|
|
"size": "1..30",
|
|
"optional": true,
|
|
"field": "page",
|
|
"defaultValue": "1",
|
|
"description": "<p>Page number.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "Number",
|
|
"size": "1..100",
|
|
"optional": true,
|
|
"field": "limit",
|
|
"defaultValue": "30",
|
|
"description": "<p>Amount of returned items.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String[]",
|
|
"optional": true,
|
|
"field": "sort",
|
|
"defaultValue": "-createdAt",
|
|
"description": "<p>Order of returned items.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String[]",
|
|
"optional": true,
|
|
"field": "fields",
|
|
"description": "<p>Fields to be returned.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Number",
|
|
"optional": false,
|
|
"field": "count",
|
|
"description": "<p>Total amount of doctors.</p>"
|
|
},
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object[]",
|
|
"optional": false,
|
|
"field": "rows",
|
|
"description": "<p>List of doctors.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>admin access only.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Doctor/index.js",
|
|
"groupTitle": "Doctor"
|
|
},
|
|
{
|
|
"type": "put",
|
|
"url": "/Doctors/:id",
|
|
"title": "Update doctor",
|
|
"name": "UpdateDoctor",
|
|
"group": "Doctor",
|
|
"permission": [
|
|
{
|
|
"name": "admin",
|
|
"title": "Admin access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>admin access token.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "ID",
|
|
"description": "<p>Doctor's ID.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Name",
|
|
"description": "<p>Doctor's Name.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"optional": false,
|
|
"field": "Dapartment",
|
|
"description": "<p>Doctor's Dapartment.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "doctor",
|
|
"description": "<p>Doctor's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>Doctor not found.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>admin access only.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/Doctor/index.js",
|
|
"groupTitle": "Doctor"
|
|
},
|
|
{
|
|
"type": "post",
|
|
"url": "/users",
|
|
"title": "Create user",
|
|
"name": "CreateUser",
|
|
"group": "User",
|
|
"permission": [
|
|
{
|
|
"name": "master",
|
|
"title": "Master access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>Master access_token.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "email",
|
|
"description": "<p>User's email.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"size": "6..",
|
|
"optional": false,
|
|
"field": "password",
|
|
"description": "<p>User's password.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": true,
|
|
"field": "name",
|
|
"description": "<p>User's name.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": true,
|
|
"field": "picture",
|
|
"description": "<p>User's picture.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"allowedValues": [
|
|
"user",
|
|
"admin"
|
|
],
|
|
"optional": true,
|
|
"field": "role",
|
|
"defaultValue": "user",
|
|
"description": "<p>User's role.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Sucess 201": [
|
|
{
|
|
"group": "Sucess 201",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "user",
|
|
"description": "<p>User's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>Master access only.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "409",
|
|
"description": "<p>Email already registered.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/user/index.js",
|
|
"groupTitle": "User"
|
|
},
|
|
{
|
|
"type": "delete",
|
|
"url": "/users/:id",
|
|
"title": "Delete user",
|
|
"name": "DeleteUser",
|
|
"group": "User",
|
|
"permission": [
|
|
{
|
|
"name": "admin",
|
|
"title": "Admin access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>User access_token.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 204": [
|
|
{
|
|
"group": "Success 204",
|
|
"optional": false,
|
|
"field": "204",
|
|
"description": "<p>No Content.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>Admin access only.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>User not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/user/index.js",
|
|
"groupTitle": "User"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/users/me",
|
|
"title": "Retrieve current user",
|
|
"name": "RetrieveCurrentUser",
|
|
"group": "User",
|
|
"permission": [
|
|
{
|
|
"name": "user",
|
|
"title": "User access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>User access_token.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "user",
|
|
"description": "<p>User's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/user/index.js",
|
|
"groupTitle": "User"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/users/:id",
|
|
"title": "Retrieve user",
|
|
"name": "RetrieveUser",
|
|
"group": "User",
|
|
"permission": [
|
|
{
|
|
"name": "public"
|
|
}
|
|
],
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "user",
|
|
"description": "<p>User's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>User not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/user/index.js",
|
|
"groupTitle": "User"
|
|
},
|
|
{
|
|
"type": "get",
|
|
"url": "/users",
|
|
"title": "Retrieve users",
|
|
"name": "RetrieveUsers",
|
|
"group": "User",
|
|
"permission": [
|
|
{
|
|
"name": "admin",
|
|
"title": "Admin access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>User access_token.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": true,
|
|
"field": "q",
|
|
"description": "<p>Query to search.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "Number",
|
|
"size": "1..30",
|
|
"optional": true,
|
|
"field": "page",
|
|
"defaultValue": "1",
|
|
"description": "<p>Page number.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "Number",
|
|
"size": "1..100",
|
|
"optional": true,
|
|
"field": "limit",
|
|
"defaultValue": "30",
|
|
"description": "<p>Amount of returned items.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String[]",
|
|
"optional": true,
|
|
"field": "sort",
|
|
"defaultValue": "-createdAt",
|
|
"description": "<p>Order of returned items.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String[]",
|
|
"optional": true,
|
|
"field": "fields",
|
|
"description": "<p>Fields to be returned.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object[]",
|
|
"optional": false,
|
|
"field": "users",
|
|
"description": "<p>List of users.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>Admin access only.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/user/index.js",
|
|
"groupTitle": "User"
|
|
},
|
|
{
|
|
"type": "put",
|
|
"url": "/users/:id/password",
|
|
"title": "Update password",
|
|
"name": "UpdatePassword",
|
|
"group": "User",
|
|
"header": {
|
|
"fields": {
|
|
"Header": [
|
|
{
|
|
"group": "Header",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "Authorization",
|
|
"description": "<p>Basic authorization with email and password.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"size": "6..",
|
|
"optional": false,
|
|
"field": "password",
|
|
"description": "<p>User's new password.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 201": [
|
|
{
|
|
"group": "Success 201",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "user",
|
|
"description": "<p>User's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>Current user access only.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>User not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/user/index.js",
|
|
"groupTitle": "User"
|
|
},
|
|
{
|
|
"type": "put",
|
|
"url": "/users/:id",
|
|
"title": "Update user",
|
|
"name": "UpdateUser",
|
|
"group": "User",
|
|
"permission": [
|
|
{
|
|
"name": "user",
|
|
"title": "User access only",
|
|
"description": "<p>You must pass <code>access_token</code> parameter or a Bearer Token authorization header to access this endpoint.</p>"
|
|
}
|
|
],
|
|
"parameter": {
|
|
"fields": {
|
|
"Parameter": [
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": false,
|
|
"field": "access_token",
|
|
"description": "<p>User access_token.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": true,
|
|
"field": "name",
|
|
"description": "<p>User's name.</p>"
|
|
},
|
|
{
|
|
"group": "Parameter",
|
|
"type": "String",
|
|
"optional": true,
|
|
"field": "picture",
|
|
"description": "<p>User's picture.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"success": {
|
|
"fields": {
|
|
"Success 200": [
|
|
{
|
|
"group": "Success 200",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "user",
|
|
"description": "<p>User's data.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"error": {
|
|
"fields": {
|
|
"Error 4xx": [
|
|
{
|
|
"group": "Error 4xx",
|
|
"type": "Object",
|
|
"optional": false,
|
|
"field": "400",
|
|
"description": "<p>Some parameters may contain invalid values.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "401",
|
|
"description": "<p>Current user or admin access only.</p>"
|
|
},
|
|
{
|
|
"group": "Error 4xx",
|
|
"optional": false,
|
|
"field": "404",
|
|
"description": "<p>User not found.</p>"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"version": "0.0.0",
|
|
"filename": "src/api/user/index.js",
|
|
"groupTitle": "User"
|
|
}
|
|
] });
|