-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi_data.js
1824 lines (1824 loc) · 65.6 KB
/
api_data.js
1
define({ "api": [ { "type": "get", "url": "shifts", "title": "List of Available Shifts", "name": "ListAvailableShift", "group": "AvailableShifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shift", "description": "<p>Available Shifts Collection</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"start_time\": 12324242424,\n \"end_time\": 1323242424,\n \"vacancies\": 5,\n \"members\": [ ... ]\n }...\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/available_shifts_controller.rb", "groupTitle": "AvailableShifts" }, { "type": "get", "url": "shifts", "title": "Details", "name": "ShowShift", "group": "AvailableShifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shift", "description": "<p>Available Shift Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"start_time\": 12324242424,\n \"end_time\": 1323242424,\n \"vacancies\": 5,\n \"members\": [ ... ]\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/available_shifts_controller.rb", "groupTitle": "AvailableShifts" }, { "type": "post", "url": "employees", "title": "Create", "name": "CreateEmployee", "group": "Employees", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Employee", "description": "<p>Add Employee to Organisation</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/employees_controller.rb", "groupTitle": "Employees" }, { "type": "delete", "url": "employees", "title": "Destroy", "name": "DeleteEmployee", "group": "Employees", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Employee", "description": "<p>Remove Employee</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/employees_controller.rb", "groupTitle": "Employees" }, { "type": "get", "url": "employees", "title": "List", "name": "ListEmployees", "group": "Employees", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Employee", "description": "<p>Collection of Employees</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/employees_controller.rb", "groupTitle": "Employees" }, { "type": "get", "url": "employees", "title": "Details", "name": "ShowEmployee", "group": "Employees", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Employee", "description": "<p>Employee Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/employees_controller.rb", "groupTitle": "Employees" }, { "type": "put", "url": "employees", "title": "Update", "name": "UpdateEmployee", "group": "Employees", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Employee", "description": "<p>Update Employee</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/employees_controller.rb", "groupTitle": "Employees" }, { "type": "get", "url": "immovables", "title": "App Static List", "name": "GetImmovables", "group": "Immovables", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Immovables", "description": "<p>Collection</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n {\n \"id\": \"languages\"\n }\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/immovables_controller.rb", "groupTitle": "Immovables" }, { "type": "get", "url": "immovables/{slug}", "title": "Get Immovables by Slug", "name": "Get_Immovables_by_Slug", "group": "Immovables", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Immovables", "description": "<p>model</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"languages\": [\n {\n \"slug\": \".net\",\n \"name\": \".NET\"\n },\n {\n \"slug\": \"asp.net\",\n \"name\": \"ASP.NET\"\n },\n {\n \"slug\": \"aws\",\n \"name\": \"AWS\"\n }...\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/immovables_controller.rb", "groupTitle": "Immovables" }, { "type": "get", "url": "job_applications", "title": "List", "name": "ListJobApplications", "group": "JobApplications", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobApplication", "description": "<p>Collection of JobApplications</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/job_applications_controller.rb", "groupTitle": "JobApplications" }, { "type": "get", "url": "job_applications", "title": "Details", "name": "ShowJobApplication", "group": "JobApplications", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobApplication", "description": "<p>JobApplication Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/job_applications_controller.rb", "groupTitle": "JobApplications" }, { "type": "put", "url": "job_applications", "title": "Update", "name": "UpdateJobApplication", "group": "JobApplications", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobApplication", "description": "<p>Update Job Application Status</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/job_applications_controller.rb", "groupTitle": "JobApplications" }, { "type": "get", "url": "job_interviews", "title": "List", "name": "ListJobInterviews", "group": "JobInterviews", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobInterview", "description": "<p>Collection of JobInterviews</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/job_interviews_controller.rb", "groupTitle": "JobInterviews" }, { "type": "get", "url": "job_interviews", "title": "List", "name": "ListJobInterviews", "group": "JobInterviews", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobInterview", "description": "<p>Collection of JobInterviews</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/job_interviews_controller.rb", "groupTitle": "JobInterviews" }, { "type": "get", "url": "job_interviews", "title": "Details", "name": "ShowJobInterview", "group": "JobInterviews", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobInterview", "description": "<p>JobInterview Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/job_interviews_controller.rb", "groupTitle": "JobInterviews" }, { "type": "get", "url": "job_interviews", "title": "Details", "name": "ShowJobInterview", "group": "JobInterviews", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobInterview", "description": "<p>JobInterview Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/job_interviews_controller.rb", "groupTitle": "JobInterviews" }, { "type": "put", "url": "job_interviews", "title": "Create", "name": "UpdateJobInterview", "group": "JobInterviews", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobInterview", "description": "<p>Create Job Interview</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/job_interviews_controller.rb", "groupTitle": "JobInterviews" }, { "type": "put", "url": "job_interviews", "title": "Update", "name": "UpdateJobInterview", "group": "JobInterviews", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobInterview", "description": "<p>Update Job Interview</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/job_interviews_controller.rb", "groupTitle": "JobInterviews" }, { "type": "put", "url": "job_interviews", "title": "Update", "name": "UpdateJobInterview", "group": "JobInterviews", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "JobInterview", "description": "<p>Update Job Interview Status</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/job_interviews_controller.rb", "groupTitle": "JobInterviews" }, { "type": "get", "url": "jobs", "title": "List", "name": "ListJobs", "group": "Jobs", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Job", "description": "<p>Jobs Collection</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n {\n \"id\": \"mJ7pyaY8af7sRAApHwsLHDDxXQs6KaCC\",\n \"title\": \"Government Director\",\n \"description\": \"Doloremque dolor est dolorem cumque inventore.\",\n \"job_type\": null,\n \"created_at\": 1497405601,\n \"organisation\": {\n \"id\": \"W6FRLbXA9E7kimKVbSJRyAPx4gEGshFq\",\n \"name\": \"Carey Paucek\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n },\n \"job_category\": {\n \"id\": 1,\n \"name\": \"Food & Beverage\"\n },\n \"job_education\": {\n \"id\": 1,\n \"name\": \"Any\"\n },\n \"stores\": [],\n \"job_languages\": [\n {\n \"id\": 28,\n \"language\": {\n \"id\": 1,\n \"name\": \"Cantonese\"\n },\n \"language_proficiency\": {\n \"id\": 1,\n \"name\": \"Any\"\n }\n }\n ],\n \"job_questions\": [\n {\n \"id\": 28,\n \"title\": \"Veniam velit non voluptate quisquam.?\"\n }\n ],\n \"job_salaries\": []\n }...\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/jobs_controller.rb", "groupTitle": "Jobs" }, { "type": "get", "url": "jobs", "title": "Details", "name": "ShowJob", "group": "Jobs", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Job", "description": "<p>Job Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"id\": \"47Muq1rh7RD9YY6uPF9yNFnA5YE2NXmz\",\n \"title\": \"New Intern\",\n \"description\": \"Need more Interns that can do stuff\",\n \"job_type\": null,\n \"created_at\": 1497283367,\n \"organisation\": {\n \"id\": \"W6FRLbXA9E7kimKVbSJRyAPx4gEGshFq\",\n \"name\": \"Carey Paucek\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n },\n \"job_category\": {\n \"id\": 1,\n \"name\": \"Food & Beverage\"\n },\n \"job_education\": {\n \"id\": 1,\n \"name\": \"Any\"\n },\n \"stores\": [\n {\n \"id\": \"E36uR5U5spW1Sbe8fD58XVpPvhDFZYqy\",\n \"name\": \"Maximus Trantow Sr.\",\n \"members_count\": 5\n }\n ],\n \"job_languages\": [\n {\n \"id\": 1,\n \"language\": {\n \"id\": 1,\n \"name\": \"Cantonese\"\n },\n \"language_proficiency\": {\n \"id\": 1,\n \"name\": \"Any\"\n }\n }\n ],\n \"job_questions\": [\n {\n \"id\": 1,\n \"title\": \"What would be your weakness?\"\n }\n ],\n \"job_salaries\": []\n }", "type": "json" } ] }, "filename": "./app/controllers/v1/jobs_controller.rb", "groupTitle": "Jobs" }, { "type": "post", "url": "members", "title": "Create", "name": "CreateMember", "group": "Members", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Member", "description": "<p>Add Member to Store</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n {\"id\": \"ebba953459d30c4b8a83ab109b7138a7\"}\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/members_controller.rb", "groupTitle": "Members" }, { "type": "delete", "url": "members", "title": "Destroy", "name": "DeleteMember", "group": "Members", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Member", "description": "<p>Delete Member</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/members_controller.rb", "groupTitle": "Members" }, { "type": "get", "url": "members", "title": "List", "name": "ListMember", "group": "Members", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Member", "description": "<p>Members Collection</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/members_controller.rb", "groupTitle": "Members" }, { "type": "get", "url": "members", "title": "Details", "name": "ShowMember", "group": "Members", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Member", "description": "<p>Member Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/members_controller.rb", "groupTitle": "Members" }, { "type": "put", "url": "members", "title": "Update", "name": "UpdateMember", "group": "Members", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Member", "description": "<p>Update Member</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\"\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/members_controller.rb", "groupTitle": "Members" }, { "type": "get", "url": "shifts", "title": "List", "name": "ListShift", "group": "MyShifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shift", "description": "<p>Shifts Collection</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"start_time\": 12324242424,\n \"end_time\": 1323242424,\n \"vacancies\": 5,\n \"members\": [ ... ]\n }...\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/shifts_controller.rb", "groupTitle": "MyShifts" }, { "type": "get", "url": "shifts", "title": "Details", "name": "ShowShift", "group": "MyShifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shift", "description": "<p>Shift Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"start_time\": 12324242424,\n \"end_time\": 1323242424,\n \"vacancies\": 5,\n \"members\": [ ... ]\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/shifts_controller.rb", "groupTitle": "MyShifts" }, { "type": "get", "url": "notifications", "title": "List", "name": "ListNotifications", "group": "Notifications", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "List", "description": "<p>Collection of Notifications by Current User</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"notifications\": [\n {\n \"created_at\": 1496131220,\n \"resource_url\": \"/v1/organisations/vcK4idtU4FRDmvYGKLRbW4p5xoaNJ95h\",\n \"message\": \"Updated Organisation by Alena Legros\"\n }\n ]\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/notifications_controller.rb", "groupTitle": "Notifications" }, { "type": "put", "url": "read", "title": "notifications", "name": "MarkNotificationsAsRead", "group": "Notifications", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Mark", "description": "<p>all notifications as read since last_seen</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/notifications_controller.rb", "groupTitle": "Notifications" }, { "type": "delete", "url": "jobs", "title": "Destroy", "name": "DestroyJob", "group": "OrganisationJobs", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "null", "description": "<p>Delete Job</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"成功\"\n },\n \"data\": nil\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/organisations/jobs_controller.rb", "groupTitle": "OrganisationJobs" }, { "type": "get", "url": "jobs", "title": "Organisation Jobs List", "name": "ListOrganisationJobs", "group": "OrganisationJobs", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Job", "description": "<p>Jobs Collection</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n {\n \"id\": \"mJ7pyaY8af7sRAApHwsLHDDxXQs6KaCC\",\n \"title\": \"Government Director\",\n \"description\": \"Doloremque dolor est dolorem cumque inventore.\",\n \"job_type\": null,\n \"created_at\": 1497405601,\n \"organisation\": {\n \"id\": \"W6FRLbXA9E7kimKVbSJRyAPx4gEGshFq\",\n \"name\": \"Carey Paucek\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n },\n \"job_category\": {\n \"id\": 1,\n \"name\": \"Food & Beverage\"\n },\n \"job_education\": {\n \"id\": 1,\n \"name\": \"Any\"\n },\n \"stores\": [],\n \"job_languages\": [\n {\n \"id\": 28,\n \"language\": {\n \"id\": 1,\n \"name\": \"Cantonese\"\n },\n \"language_proficiency\": {\n \"id\": 1,\n \"name\": \"Any\"\n }\n }\n ],\n \"job_questions\": [\n {\n \"id\": 28,\n \"title\": \"Veniam velit non voluptate quisquam.?\"\n }\n ],\n \"job_salaries\": []\n }...\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/organisations/jobs_controller.rb", "groupTitle": "OrganisationJobs" }, { "type": "get", "url": "jobs", "title": "Organisation Job Details", "name": "ShowOrganisationJob", "group": "OrganisationJobs", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Job", "description": "<p>Job Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"id\": \"47Muq1rh7RD9YY6uPF9yNFnA5YE2NXmz\",\n \"title\": \"New Intern\",\n \"description\": \"Need more Interns that can do stuff\",\n \"job_type\": null,\n \"created_at\": 1497283367,\n \"organisation\": {\n \"id\": \"W6FRLbXA9E7kimKVbSJRyAPx4gEGshFq\",\n \"name\": \"Carey Paucek\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n },\n \"job_category\": {\n \"id\": 1,\n \"name\": \"Food & Beverage\"\n },\n \"job_education\": {\n \"id\": 1,\n \"name\": \"Any\"\n },\n \"stores\": [\n {\n \"id\": \"E36uR5U5spW1Sbe8fD58XVpPvhDFZYqy\",\n \"name\": \"Maximus Trantow Sr.\",\n \"members_count\": 5\n }\n ],\n \"job_languages\": [\n {\n \"id\": 1,\n \"language\": {\n \"id\": 1,\n \"name\": \"Cantonese\"\n },\n \"language_proficiency\": {\n \"id\": 1,\n \"name\": \"Any\"\n }\n }\n ],\n \"job_questions\": [\n {\n \"id\": 1,\n \"title\": \"What would be your weakness?\"\n }\n ],\n \"job_salaries\": []\n }", "type": "json" } ] }, "filename": "./app/controllers/v1/organisations/jobs_controller.rb", "groupTitle": "OrganisationJobs" }, { "type": "get", "url": "organisation", "title": "Invite", "name": "ShowOrganisationInvite", "group": "Organisation", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Invite", "description": "<p>Organisation Invite</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/invites_controller.rb", "groupTitle": "Organisation" }, { "type": "get", "url": "organisation", "title": "Invites", "name": "ShowOrganisationInvites", "group": "Organisation", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Invite", "description": "<p>Organisation Invites</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/invites_controller.rb", "groupTitle": "Organisation" }, { "type": "get", "url": "reports", "title": "List", "name": "ListReports", "group": "Reports", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Report", "description": "<p>Reports Collection</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"members\": [\n {\n \"user\": {\n \"id\": \"23r2asdfasdfadf\",\n \"profile\": {\n \"first_name\": \"Gram\",\n \"last_name\": \"Stamm\",\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n },\n \"last_position\": \"Waiter\",\n \"total_days\": 5,\n \"total_shifts\": 5,\n \"total_salary\": 2423.00,\n \"shifts\": [\n {\n \"start_time\": 1423423423424,\n \"end_time\": 1423423424424,\n \"position\": \"Waiter\"\n }\n ]\n }\n }\n ]\n }\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/organisations/reports_controller.rb", "groupTitle": "Reports" }, { "type": "post", "url": "shifts", "title": "Create", "name": "CreateShift", "group": "Shifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shift", "description": "<p>Add Shift to Store</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"start_time\": 12324242424,\n \"end_time\": 1323242424,\n \"vacancies\": 5,\n \"members\": [ ... ]\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/shifts_controller.rb", "groupTitle": "Shifts" }, { "type": "delete", "url": "shifts", "title": "Destroy", "name": "DeleteShift", "group": "Shifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "null", "description": "<p>Delete Shift</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/shifts_controller.rb", "groupTitle": "Shifts" }, { "type": "get", "url": "shifts", "title": "List", "name": "ListShift", "group": "Shifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shift", "description": "<p>Shifts Collection</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": [\n {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"start_time\": 12324242424,\n \"end_time\": 1323242424,\n \"vacancies\": 5,\n \"members\": [ ... ]\n }...\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/shifts_controller.rb", "groupTitle": "Shifts" }, { "type": "put", "url": "shifts", "title": "Publish", "name": "PublishShift", "group": "Shifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shifts", "description": "<p>Published Shifts</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"shifts\": [\n {\n \"id\": \"hnmyn9toNj9hJf3wvwphUTe47SdcH1Ji\",\n \"start_time\": null,\n \"end_time\": null,\n \"break_time\": null,\n \"errors\": {\n \"start_time\": [\n \"Must be after today\"\n ]\n },\n \"vacancies\": 5,\n \"organisation\": {\n \"id\": \"9aM975WfQ1nqgJKcpjrDCsd5K9JWSNYr\",\n \"name\": \"Candelario O'Reilly\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n },\n \"user\": {\n \"id\": \"evmWtQPTp8yTm69oxw2BBQD6JJjubLoz\",\n \"role\": \"talent\",\n \"last_active\": 1500799426950,\n \"rating\": \"0.0\",\n \"preferences\": {\n \"notify\": \"email\",\n \"locale\": \"en\"\n },\n \"profile\": {\n \"first_name\": \"Katherine\",\n \"last_name\": \"Hessel\",\n \"gender\": \"male\",\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n },\n \"birthday\": -226573200000,\n \"address\": null\n }\n }\n },\n \"active\": true,\n \"store\": {\n \"id\": \"udzBeGRSiKELZ1356dmi9MaSa2NHYfoy\",\n \"name\": \"Orlo Haley\",\n \"members_count\": 4,\n \"address\": {\n \"line1\": \"56874 Reilly Burgs\",\n \"line2\": \"Apt. 233\",\n \"city\": \"Joshuaborough\",\n \"state\": \"Minnesota\",\n \"postal_code\": \"26251\",\n \"country\": \"Zimbabwe\"\n }\n },\n \"store_position\": {\n \"id\": 1,\n \"name\": \"Waiter\"\n },\n \"member_shifts\": []\n }...\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/shifts_controller.rb", "groupTitle": "Shifts" }, { "type": "get", "url": "shifts", "title": "Details", "name": "ShowShift", "group": "Shifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shift", "description": "<p>Shift Full Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"start_time\": 12324242424,\n \"end_time\": 1323242424,\n \"vacancies\": 5,\n \"members\": [ ... ]\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/shifts_controller.rb", "groupTitle": "Shifts" }, { "type": "put", "url": "shifts", "title": "Update", "name": "UpdateShift", "group": "Shifts", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Shift", "description": "<p>Update Shift</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"ebba953459d30c4b8a83ab109b7138a7\",\n \"start_time\": 12324242424,\n \"end_time\": 1323242424,\n \"vacancies\": 5,\n \"members\": [ ... ]\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/shifts_controller.rb", "groupTitle": "Shifts" }, { "type": "post", "url": "stores", "title": "Create", "name": "CreateStore", "group": "Stores", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Store", "description": "<p>Creation of a Store</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"成功\"\n },\n \"data\": {\n \"id\": \"a57d9da79e7d567e48ee3e551ccd9608\",\n \"name\": \"Wan Chai\",\n \"members\": [],\n \"address\": {\n \"line1\": \"Line 1\",\n \"line2\": null,\n \"city\": null,\n \"state\": null,\n \"postal_code\": null,\n \"country\": null\n }\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/stores_controller.rb", "groupTitle": "Stores" }, { "type": "delete", "url": "stores", "title": "Destroy", "name": "DestroyStore", "group": "Stores", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Store", "description": "<p>Delete Store</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"成功\"\n },\n \"data\": nil\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/stores_controller.rb", "groupTitle": "Stores" }, { "type": "get", "url": "stores", "title": "List", "name": "ListStores", "group": "Stores", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "List", "description": "<p>Collection of Stores by Organisation</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"stores\": [\n {\n \"id\": \"faded0a3e2b90aeb1cfaf858a5a1f955\",\n \"name\": \"Causeway Bay\",\n \"organisation\": {\n \"id\": \"9975896b1b223d3d57a1fc94dc337527\",\n \"name\": \"Pizza Hut X\",\n \"logo\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/8f915fa234866b0e8bc39e658f3090e0.png\",\n \"t640\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t640_8f915fa234866b0e8bc39e658f3090e0.png\"\n },\n \"t320\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t320_8f915fa234866b0e8bc39e658f3090e0.png\"\n },\n \"t160\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t160_8f915fa234866b0e8bc39e658f3090e0.png\"\n }\n },\n \"bio\": \"OMG about myself\",\n \"active\": false\n }\n }\n ]\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/stores_controller.rb", "groupTitle": "Stores" }, { "type": "get", "url": "stores", "title": "Details", "name": "ShowStore", "group": "Stores", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Store", "description": "<p>Details of Store</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"faded0a3e2b90aeb1cfaf858a5a1f955\",\n \"name\": \"Causeway Bay\",\n \"organisation\": {\n \"id\": \"9975896b1b223d3d57a1fc94dc337527\",\n \"name\": \"Pizza Hut X\",\n \"logo\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/8f915fa234866b0e8bc39e658f3090e0.png\",\n \"t640\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t640_8f915fa234866b0e8bc39e658f3090e0.png\"\n },\n \"t320\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t320_8f915fa234866b0e8bc39e658f3090e0.png\"\n },\n \"t160\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t160_8f915fa234866b0e8bc39e658f3090e0.png\"\n }\n },\n \"bio\": \"OMG about myself\",\n \"active\": false\n }\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/stores_controller.rb", "groupTitle": "Stores" }, { "type": "put", "url": "stores", "title": "Update", "name": "UpdateStore", "group": "Stores", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Store", "description": "<p>Update of a Store</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"成功\"\n },\n \"data\": {\n \"id\": \"a57d9da79e7d567e48ee3e551ccd9608\",\n \"name\": \"Causeway Bay\",\n \"organisation\": {\n \"id\": \"9975896b1b223d3d57a1fc94dc337527\",\n \"name\": \"Pizza Hut X\",\n \"logo\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/8f915fa234866b0e8bc39e658f3090e0.png\",\n \"t640\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t640_8f915fa234866b0e8bc39e658f3090e0.png\"\n },\n \"t320\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t320_8f915fa234866b0e8bc39e658f3090e0.png\"\n },\n \"t160\": {\n \"url\": \"http://jafar.dev/logos/118/a2e/d37/298/47b/bbf/009/ff7/9ff/ab1/t160_8f915fa234866b0e8bc39e658f3090e0.png\"\n }\n },\n \"bio\": \"OMG about myself\",\n \"active\": false\n }\n }\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/stores_controller.rb", "groupTitle": "Stores" }, { "type": "put", "url": "users", "title": "Forgot Password", "name": "ForgotPassword", "group": "Users", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "null", "description": "<p>Email Sent with Steps</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"成功\"\n },\n \"\"data\": null\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "Error", "content": "{\n \"meta\": {\n \"status\": 404,\n \"message\": \"冇User使用asdfasf。\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/users_controller.rb", "groupTitle": "Users" }, { "type": "get", "url": "users", "title": "Login", "name": "LoginUser", "group": "Users", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Authentication", "description": "<p>Authenticate User</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"cf87c814eb7249dd4a16add2d1b0d2b4\",\n \"authentication_token\": \"496d311521296821be82275b85f0dafe7ea37ef9c2a225d180ce9c9635125a66\",\n \"email\": \"[email protected]\",\n \"mobile\": \"\",\n \"preferences\": {\n \"notify\": \"email\",\n \"locale\": \"en\"\n },\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"birthday\": null,\n \"gender\": null,\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n },\n \"organisations\": []\n }\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "Error", "content": "{\n \"meta\": {\n \"status\": 400,\n \"message\": \"Can not seem to find who you're looking for.\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/authentications_controller.rb", "groupTitle": "Users" }, { "type": "delete", "url": "users", "title": "Logout", "name": "LogoutUser", "group": "Users", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Authentication", "description": "<p>Destroy old Authentication Token</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"You have successfully logged out\"\n },\n \"data\": null\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "Error", "content": "{\n \"meta\": {\n \"status\": 400,\n \"message\": \"Can not seem to find who you're looking for.\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/authentications_controller.rb", "groupTitle": "Users" }, { "type": "post", "url": "users", "title": "Register", "name": "RegisterUser", "group": "Users", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Me", "description": "<p>Register New Users</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"Success\"\n },\n \"data\": {\n \"id\": \"e6b992eabc5eee73e21c768bef97b8a3\",\n \"authentication_token\": \"b0afde57c2f1a8d1165b90355241f3202596fecdc57d669af97f6d3b19d9d368\",\n \"email\": \"[email protected]\",\n \"mobile\": \"\",\n \"preferences\": {\n \"notify\": \"email\",\n \"locale\": \"en\"\n },\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"birthday\": null,\n \"gender\": null,\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n },\n \"organisations\": []\n }\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "Email", "content": "{\n \"meta\": {\n \"status\": 422,\n \"message\": \"Email has already been taken\"\n },\n \"data\": null\n}", "type": "json" }, { "title": "Mobile", "content": "{\n \"meta\": {\n \"status\": 422,\n \"message\": \"Mobile has already been taken\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/users_controller.rb", "groupTitle": "Users" }, { "type": "get", "url": "users", "title": "Show User", "name": "ShowUser", "group": "Users", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "User", "description": "<p>View Users Public Profile</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"成功\"\n },\n \"data\": {\n \"id\": \"291f6d61ce192cd5ff9059f06c9e6e3e\",\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"birthday\": null,\n \"gender\": null,\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n }\n }\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "Error", "content": "{\n \"meta\": {\n \"status\": 404,\n \"message\": \"冇User使用asdfasf。\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/users_controller.rb", "groupTitle": "Users" }, { "type": "get", "url": "users", "title": "Show User Digest", "name": "ShowUserDigest", "group": "Users", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "User", "description": "<p>View Users Public Profile Compact</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"meta\": {\n \"status\": 200,\n \"message\": \"成功\"\n },\n \"data\": {\n \"id\": \"291f6d61ce192cd5ff9059f06c9e6e3e\",\n \"profile\": {\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"birthday\": null,\n \"gender\": null,\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n }\n }\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "Error", "content": "{\n \"meta\": {\n \"status\": 404,\n \"message\": \"冇User使用asdfasf。\"\n },\n \"data\": null\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/users_controller.rb", "groupTitle": "Users" }, { "type": "put", "url": "my", "title": "Resend Verification", "name": "ResendVerification", "group": "my", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "User", "description": "<p>Resend Verification</p>" } ] } }, "filename": "./app/controllers/v1/my/details_controller.rb", "groupTitle": "my" }, { "type": "put", "url": "my", "title": "Reset Password", "name": "ResetMyPasswordDetails", "group": "my", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "User", "description": "<p>Reset My Password</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"id\": \"pmcpuRX1KTbsT3AqsPwKT9i6SPTqRJGw\",\n \"authentication_token\": \"9Sjjjmt5eoBTdNvbskZthNgjZA46FxeF\",\n \"role\": \"talent\",\n \"email\": \"[email protected]\",\n \"mobile\": \"\",\n \"preferences\": {\n \"notify\": \"email\",\n \"locale\": \"en\",\n \"job_type\": \"part-time\"\n },\n \"last_active\": 1497408449,\n \"rating\": \"0.0\",\n \"profile\": {\n \"first_name\": \"Gram\",\n \"last_name\": \"Stamm\",\n \"gender\": \"female\",\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n },\n \"birthday\": -424688400\n },\n \"organisations\": [\n {\n \"id\": \"W6FRLbXA9E7kimKVbSJRyAPx4gEGshFq\",\n \"name\": \"Carey Paucek\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n }\n ],\n \"work_experiences\": [\n {\n \"id\": 1,\n \"company\": \"New Company\",\n \"position\": \"Waiter\",\n \"endorsement\": \"Did stuff\",\n \"start_date\": 1336694400,\n \"end_date\": 1400544000\n }\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/details_controller.rb", "groupTitle": "my" }, { "type": "get", "url": "my", "title": "Details", "name": "ShowMyDetails", "group": "my", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "User", "description": "<p>My Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"id\": \"pmcpuRX1KTbsT3AqsPwKT9i6SPTqRJGw\",\n \"authentication_token\": \"9Sjjjmt5eoBTdNvbskZthNgjZA46FxeF\",\n \"role\": \"talent\",\n \"email\": \"[email protected]\",\n \"mobile\": \"\",\n \"preferences\": {\n \"notify\": \"email\",\n \"locale\": \"en\",\n \"job_type\": \"part-time\"\n },\n \"last_active\": 1497408449,\n \"rating\": \"0.0\",\n \"profile\": {\n \"first_name\": \"Gram\",\n \"last_name\": \"Stamm\",\n \"gender\": \"female\",\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n },\n \"birthday\": -424688400\n },\n \"organisations\": [\n {\n \"id\": \"W6FRLbXA9E7kimKVbSJRyAPx4gEGshFq\",\n \"name\": \"Carey Paucek\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n }\n ],\n \"work_experiences\": [\n {\n \"id\": 1,\n \"company\": \"New Company\",\n \"position\": \"Waiter\",\n \"endorsement\": \"Did stuff\",\n \"start_date\": 1336694400,\n \"end_date\": 1400544000\n }\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/details_controller.rb", "groupTitle": "my" }, { "type": "get", "url": "my", "title": "Invites", "name": "ShowMyInvites", "group": "my", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "Invite", "description": "<p>My Invites</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/invites_controller.rb", "groupTitle": "my" }, { "type": "put", "url": "my", "title": "Details", "name": "UpdateMyDetails", "group": "my", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "User", "description": "<p>My Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"id\": \"pmcpuRX1KTbsT3AqsPwKT9i6SPTqRJGw\",\n \"authentication_token\": \"9Sjjjmt5eoBTdNvbskZthNgjZA46FxeF\",\n \"role\": \"talent\",\n \"email\": \"[email protected]\",\n \"mobile\": \"\",\n \"preferences\": {\n \"notify\": \"email\",\n \"locale\": \"en\",\n \"job_type\": \"part-time\"\n },\n \"last_active\": 1497408449,\n \"rating\": \"0.0\",\n \"profile\": {\n \"first_name\": \"Gram\",\n \"last_name\": \"Stamm\",\n \"gender\": \"female\",\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n },\n \"birthday\": -424688400\n },\n \"organisations\": [\n {\n \"id\": \"W6FRLbXA9E7kimKVbSJRyAPx4gEGshFq\",\n \"name\": \"Carey Paucek\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n }\n ],\n \"work_experiences\": [\n {\n \"id\": 1,\n \"company\": \"New Company\",\n \"position\": \"Waiter\",\n \"endorsement\": \"Did stuff\",\n \"start_date\": 1336694400,\n \"end_date\": 1400544000\n }\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/details_controller.rb", "groupTitle": "my" }, { "type": "put", "url": "my", "title": "Verify", "name": "VerifyMyDetails", "group": "my", "version": "1.0.0", "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "json", "optional": false, "field": "User", "description": "<p>My Details</p>" } ] }, "examples": [ { "title": "Success", "content": "{\n \"id\": \"pmcpuRX1KTbsT3AqsPwKT9i6SPTqRJGw\",\n \"authentication_token\": \"9Sjjjmt5eoBTdNvbskZthNgjZA46FxeF\",\n \"role\": \"talent\",\n \"email\": \"[email protected]\",\n \"mobile\": \"\",\n \"preferences\": {\n \"notify\": \"email\",\n \"locale\": \"en\",\n \"job_type\": \"part-time\"\n },\n \"last_active\": 1497408449,\n \"rating\": \"0.0\",\n \"profile\": {\n \"first_name\": \"Gram\",\n \"last_name\": \"Stamm\",\n \"gender\": \"female\",\n \"avatar\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n },\n \"birthday\": -424688400\n },\n \"organisations\": [\n {\n \"id\": \"W6FRLbXA9E7kimKVbSJRyAPx4gEGshFq\",\n \"name\": \"Carey Paucek\",\n \"logo\": {\n \"original\": null,\n \"large\": null,\n \"medium\": null,\n \"small\": null\n }\n }\n ],\n \"work_experiences\": [\n {\n \"id\": 1,\n \"company\": \"New Company\",\n \"position\": \"Waiter\",\n \"endorsement\": \"Did stuff\",\n \"start_date\": 1336694400,\n \"end_date\": 1400544000\n }\n ]\n}", "type": "json" } ] }, "filename": "./app/controllers/v1/my/details_controller.rb", "groupTitle": "my" }] });