{ "swagger": "2.0", "info": { "title": "Buzz Express API", "description": "BuzzExpress API Documentation", "termsOfService": "only authorized users", "contact": { "email": "adzikahyao@gmail.com" }, "license": { "name": "BSD License" }, "version": "v1" }, "basePath": "/", "consumes": [ "application/json" ], "produces": [ "application/json" ], "securityDefinitions": { "Basic": { "type": "basic" } }, "security": [ { "Basic": [] } ], "paths": { "/api/v1/dj-rest-auth/login/": { "post": { "operationId": "api_v1_dj-rest-auth_login_create", "description": "Check the credentials and return the REST Token\nif the credentials are valid and authenticated.\nCalls Django Auth login method to register User ID\nin Django session framework\n\nAccept the following POST parameters: username, password\nReturn the REST Framework Token Object's key.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Login" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Login" } } }, "tags": [ "api" ] }, "parameters": [] }, "/api/v1/dj-rest-auth/logout/": { "get": { "operationId": "api_v1_dj-rest-auth_logout_list", "summary": "Calls Django logout method and delete the Token object\nassigned to the current User object.", "description": "Accepts/Returns nothing.", "parameters": [], "responses": { "200": { "description": "" } }, "tags": [ "api" ] }, "post": { "operationId": "api_v1_dj-rest-auth_logout_create", "summary": "Calls Django logout method and delete the Token object\nassigned to the current User object.", "description": "Accepts/Returns nothing.", "parameters": [], "responses": { "201": { "description": "" } }, "tags": [ "api" ] }, "parameters": [] }, "/api/v1/dj-rest-auth/password/change/": { "post": { "operationId": "api_v1_dj-rest-auth_password_change_create", "summary": "Calls Django Auth SetPasswordForm save method.", "description": "Accepts the following POST parameters: new_password1, new_password2\nReturns the success/fail message.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PasswordChange" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/PasswordChange" } } }, "tags": [ "api" ] }, "parameters": [] }, "/api/v1/dj-rest-auth/password/reset/": { "post": { "operationId": "api_v1_dj-rest-auth_password_reset_create", "summary": "Calls Django Auth PasswordResetForm save method.", "description": "Accepts the following POST parameters: email\nReturns the success/fail message.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PasswordReset" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/PasswordReset" } } }, "tags": [ "api" ] }, "parameters": [] }, "/api/v1/dj-rest-auth/password/reset/confirm/": { "post": { "operationId": "api_v1_dj-rest-auth_password_reset_confirm_create", "summary": "Password reset e-mail link is confirmed, therefore\nthis resets the user's password.", "description": "Accepts the following POST parameters: token, uid,\n new_password1, new_password2\nReturns the success/fail message.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/PasswordResetConfirm" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/PasswordResetConfirm" } } }, "tags": [ "api" ] }, "parameters": [] }, "/api/v1/dj-rest-auth/registration/": { "post": { "operationId": "api_v1_dj-rest-auth_registration_create", "summary": "Registers a new user.", "description": "Accepts the following POST parameters: username, email, password1, password2.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Register" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/Register" } } }, "tags": [ "api" ] }, "parameters": [] }, "/api/v1/dj-rest-auth/registration/resend-email/": { "post": { "operationId": "api_v1_dj-rest-auth_registration_resend-email_create", "summary": "Resends another email to an unverified email.", "description": "Accepts the following POST parameter: email.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ResendEmailVerification" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/ResendEmailVerification" } } }, "tags": [ "api" ] }, "parameters": [] }, "/api/v1/dj-rest-auth/registration/verify-email/": { "post": { "operationId": "api_v1_dj-rest-auth_registration_verify-email_create", "summary": "Verifies the email associated with the provided key.", "description": "Accepts the following POST parameter: key.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VerifyEmail" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/VerifyEmail" } } }, "tags": [ "api" ] }, "parameters": [] }, "/api/v1/dj-rest-auth/user/": { "get": { "operationId": "api_v1_dj-rest-auth_user_read", "summary": "Reads and updates UserModel fields\nAccepts GET, PUT, PATCH methods.", "description": "Default accepted fields: username, first_name, last_name\nDefault display fields: pk, username, email, first_name, last_name\nRead-only fields: pk, email\n\nReturns UserModel fields.", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserDetails" } } }, "tags": [ "api" ] }, "put": { "operationId": "api_v1_dj-rest-auth_user_update", "summary": "Reads and updates UserModel fields\nAccepts GET, PUT, PATCH methods.", "description": "Default accepted fields: username, first_name, last_name\nDefault display fields: pk, username, email, first_name, last_name\nRead-only fields: pk, email\n\nReturns UserModel fields.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDetails" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserDetails" } } }, "tags": [ "api" ] }, "patch": { "operationId": "api_v1_dj-rest-auth_user_partial_update", "summary": "Reads and updates UserModel fields\nAccepts GET, PUT, PATCH methods.", "description": "Default accepted fields: username, first_name, last_name\nDefault display fields: pk, username, email, first_name, last_name\nRead-only fields: pk, email\n\nReturns UserModel fields.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UserDetails" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/UserDetails" } } }, "tags": [ "api" ] }, "parameters": [] }, "/auth/convert-token/": { "post": { "operationId": "auth_convert-token_create", "summary": "Implements an endpoint to convert a provider token to an access token", "description": "The endpoint is used in the following flows:\n\n* Authorization code\n* Client credentials", "parameters": [], "responses": { "201": { "description": "" } }, "tags": [ "auth" ] }, "parameters": [] }, "/auth/disconnect-backend/": { "post": { "operationId": "auth_disconnect-backend_create", "description": "An endpoint for disconnect social auth backend providers such as Facebook.", "parameters": [], "responses": { "201": { "description": "" } }, "tags": [ "auth" ] }, "parameters": [] }, "/auth/invalidate-sessions/": { "post": { "operationId": "auth_invalidate-sessions_create", "description": "", "parameters": [], "responses": { "201": { "description": "" } }, "tags": [ "auth" ] }, "parameters": [] }, "/auth/revoke-token/": { "post": { "operationId": "auth_revoke-token_create", "description": "Implements an endpoint to revoke access or refresh tokens", "parameters": [], "responses": { "201": { "description": "" } }, "tags": [ "auth" ] }, "parameters": [] }, "/auth/token/": { "post": { "operationId": "auth_token_create", "summary": "Implements an endpoint to provide access tokens", "description": "The endpoint is used in the following flows:\n\n* Authorization code\n* Password\n* Client credentials", "parameters": [], "responses": { "201": { "description": "" } }, "tags": [ "auth" ] }, "parameters": [] }, "/buzzexpress/admineventlog/": { "get": { "operationId": "buzzexpress_admineventlog_list", "description": "", "parameters": [ { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer" }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "x-nullable": true }, "previous": { "type": "string", "format": "uri", "x-nullable": true }, "results": { "type": "array", "items": { "$ref": "#/definitions/AdminEventLog" } } } } } }, "tags": [ "buzzexpress" ] }, "post": { "operationId": "buzzexpress_admineventlog_create", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminEventLog" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/AdminEventLog" } } }, "tags": [ "buzzexpress" ] }, "parameters": [] }, "/buzzexpress/admineventlog/{id}/": { "get": { "operationId": "buzzexpress_admineventlog_read", "description": "", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminEventLog" } } }, "tags": [ "buzzexpress" ] }, "put": { "operationId": "buzzexpress_admineventlog_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminEventLog" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminEventLog" } } }, "tags": [ "buzzexpress" ] }, "patch": { "operationId": "buzzexpress_admineventlog_partial_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminEventLog" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminEventLog" } } }, "tags": [ "buzzexpress" ] }, "delete": { "operationId": "buzzexpress_admineventlog_delete", "description": "", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "buzzexpress" ] }, "parameters": [ { "name": "id", "in": "path", "description": "A unique integer value identifying this admin event log.", "required": true, "type": "integer" } ] }, "/buzzexpress/admineventtype/": { "get": { "operationId": "buzzexpress_admineventtype_list", "description": "", "parameters": [ { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer" }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "x-nullable": true }, "previous": { "type": "string", "format": "uri", "x-nullable": true }, "results": { "type": "array", "items": { "$ref": "#/definitions/AdminEventType" } } } } } }, "tags": [ "buzzexpress" ] }, "post": { "operationId": "buzzexpress_admineventtype_create", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminEventType" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/AdminEventType" } } }, "tags": [ "buzzexpress" ] }, "parameters": [] }, "/buzzexpress/admineventtype/{id}/": { "get": { "operationId": "buzzexpress_admineventtype_read", "description": "", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminEventType" } } }, "tags": [ "buzzexpress" ] }, "put": { "operationId": "buzzexpress_admineventtype_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminEventType" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminEventType" } } }, "tags": [ "buzzexpress" ] }, "patch": { "operationId": "buzzexpress_admineventtype_partial_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminEventType" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminEventType" } } }, "tags": [ "buzzexpress" ] }, "delete": { "operationId": "buzzexpress_admineventtype_delete", "description": "", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "buzzexpress" ] }, "parameters": [ { "name": "id", "in": "path", "description": "A unique integer value identifying this admin event type.", "required": true, "type": "integer" } ] }, "/buzzexpress/adminmenugroup/": { "get": { "operationId": "buzzexpress_adminmenugroup_list", "description": "", "parameters": [ { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer" }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "x-nullable": true }, "previous": { "type": "string", "format": "uri", "x-nullable": true }, "results": { "type": "array", "items": { "$ref": "#/definitions/AdminMenuGroup" } } } } } }, "tags": [ "buzzexpress" ] }, "post": { "operationId": "buzzexpress_adminmenugroup_create", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuGroup" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuGroup" } } }, "tags": [ "buzzexpress" ] }, "parameters": [] }, "/buzzexpress/adminmenugroup/{id}/": { "get": { "operationId": "buzzexpress_adminmenugroup_read", "description": "", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuGroup" } } }, "tags": [ "buzzexpress" ] }, "put": { "operationId": "buzzexpress_adminmenugroup_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuGroup" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuGroup" } } }, "tags": [ "buzzexpress" ] }, "patch": { "operationId": "buzzexpress_adminmenugroup_partial_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuGroup" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuGroup" } } }, "tags": [ "buzzexpress" ] }, "delete": { "operationId": "buzzexpress_adminmenugroup_delete", "description": "", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "buzzexpress" ] }, "parameters": [ { "name": "id", "in": "path", "description": "A unique integer value identifying this admin menu group.", "required": true, "type": "integer" } ] }, "/buzzexpress/adminmenusubgroup/": { "get": { "operationId": "buzzexpress_adminmenusubgroup_list", "description": "", "parameters": [ { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer" }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "x-nullable": true }, "previous": { "type": "string", "format": "uri", "x-nullable": true }, "results": { "type": "array", "items": { "$ref": "#/definitions/AdminMenuSubGroup" } } } } } }, "tags": [ "buzzexpress" ] }, "post": { "operationId": "buzzexpress_adminmenusubgroup_create", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubGroup" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubGroup" } } }, "tags": [ "buzzexpress" ] }, "parameters": [] }, "/buzzexpress/adminmenusubgroup/{id}/": { "get": { "operationId": "buzzexpress_adminmenusubgroup_read", "description": "", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubGroup" } } }, "tags": [ "buzzexpress" ] }, "put": { "operationId": "buzzexpress_adminmenusubgroup_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubGroup" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubGroup" } } }, "tags": [ "buzzexpress" ] }, "patch": { "operationId": "buzzexpress_adminmenusubgroup_partial_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubGroup" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubGroup" } } }, "tags": [ "buzzexpress" ] }, "delete": { "operationId": "buzzexpress_adminmenusubgroup_delete", "description": "", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "buzzexpress" ] }, "parameters": [ { "name": "id", "in": "path", "description": "A unique integer value identifying this admin menu sub group.", "required": true, "type": "integer" } ] }, "/buzzexpress/adminmenusubgroupdetail/": { "get": { "operationId": "buzzexpress_adminmenusubgroupdetail_list", "description": "", "parameters": [ { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer" }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "x-nullable": true }, "previous": { "type": "string", "format": "uri", "x-nullable": true }, "results": { "type": "array", "items": { "$ref": "#/definitions/AdminMenuSubGroupDetail" } } } } } }, "tags": [ "buzzexpress" ] }, "post": { "operationId": "buzzexpress_adminmenusubgroupdetail_create", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubGroupDetail" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubGroupDetail" } } }, "tags": [ "buzzexpress" ] }, "parameters": [] }, "/buzzexpress/adminmenusubgroupdetail/{id}/": { "get": { "operationId": "buzzexpress_adminmenusubgroupdetail_read", "description": "", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubGroupDetail" } } }, "tags": [ "buzzexpress" ] }, "put": { "operationId": "buzzexpress_adminmenusubgroupdetail_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubGroupDetail" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubGroupDetail" } } }, "tags": [ "buzzexpress" ] }, "patch": { "operationId": "buzzexpress_adminmenusubgroupdetail_partial_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubGroupDetail" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubGroupDetail" } } }, "tags": [ "buzzexpress" ] }, "delete": { "operationId": "buzzexpress_adminmenusubgroupdetail_delete", "description": "", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "buzzexpress" ] }, "parameters": [ { "name": "id", "in": "path", "description": "A unique integer value identifying this admin menu sub group detail.", "required": true, "type": "integer" } ] }, "/buzzexpress/adminmenusubusers/": { "get": { "operationId": "buzzexpress_adminmenusubusers_list", "description": "", "parameters": [ { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer" }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "x-nullable": true }, "previous": { "type": "string", "format": "uri", "x-nullable": true }, "results": { "type": "array", "items": { "$ref": "#/definitions/AdminMenuSubUsers" } } } } } }, "tags": [ "buzzexpress" ] }, "post": { "operationId": "buzzexpress_adminmenusubusers_create", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubUsers" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubUsers" } } }, "tags": [ "buzzexpress" ] }, "parameters": [] }, "/buzzexpress/adminmenusubusers/{id}/": { "get": { "operationId": "buzzexpress_adminmenusubusers_read", "description": "", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubUsers" } } }, "tags": [ "buzzexpress" ] }, "put": { "operationId": "buzzexpress_adminmenusubusers_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubUsers" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubUsers" } } }, "tags": [ "buzzexpress" ] }, "patch": { "operationId": "buzzexpress_adminmenusubusers_partial_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminMenuSubUsers" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminMenuSubUsers" } } }, "tags": [ "buzzexpress" ] }, "delete": { "operationId": "buzzexpress_adminmenusubusers_delete", "description": "", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "buzzexpress" ] }, "parameters": [ { "name": "id", "in": "path", "description": "A unique integer value identifying this admin menu sub users.", "required": true, "type": "integer" } ] }, "/buzzexpress/adminuserpermission/": { "get": { "operationId": "buzzexpress_adminuserpermission_list", "description": "", "parameters": [ { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer" }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "x-nullable": true }, "previous": { "type": "string", "format": "uri", "x-nullable": true }, "results": { "type": "array", "items": { "$ref": "#/definitions/AdminUserPermission" } } } } } }, "tags": [ "buzzexpress" ] }, "post": { "operationId": "buzzexpress_adminuserpermission_create", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminUserPermission" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/AdminUserPermission" } } }, "tags": [ "buzzexpress" ] }, "parameters": [] }, "/buzzexpress/adminuserpermission/{id}/": { "get": { "operationId": "buzzexpress_adminuserpermission_read", "description": "", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminUserPermission" } } }, "tags": [ "buzzexpress" ] }, "put": { "operationId": "buzzexpress_adminuserpermission_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminUserPermission" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminUserPermission" } } }, "tags": [ "buzzexpress" ] }, "patch": { "operationId": "buzzexpress_adminuserpermission_partial_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminUserPermission" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminUserPermission" } } }, "tags": [ "buzzexpress" ] }, "delete": { "operationId": "buzzexpress_adminuserpermission_delete", "description": "", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "buzzexpress" ] }, "parameters": [ { "name": "id", "in": "path", "description": "A unique integer value identifying this admin user permission.", "required": true, "type": "integer" } ] }, "/buzzexpress/adminusers/": { "get": { "operationId": "buzzexpress_adminusers_list", "description": "", "parameters": [ { "name": "ordering", "in": "query", "description": "Which field to use when ordering the results.", "required": false, "type": "string" }, { "name": "search", "in": "query", "description": "A search term.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of results to return per page.", "required": false, "type": "integer" }, { "name": "offset", "in": "query", "description": "The initial index from which to return the results.", "required": false, "type": "integer" } ], "responses": { "200": { "description": "", "schema": { "required": [ "count", "results" ], "type": "object", "properties": { "count": { "type": "integer" }, "next": { "type": "string", "format": "uri", "x-nullable": true }, "previous": { "type": "string", "format": "uri", "x-nullable": true }, "results": { "type": "array", "items": { "$ref": "#/definitions/AdminUsers" } } } } } }, "tags": [ "buzzexpress" ] }, "post": { "operationId": "buzzexpress_adminusers_create", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminUsers" } } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/AdminUsers" } } }, "tags": [ "buzzexpress" ] }, "parameters": [] }, "/buzzexpress/adminusers/{id}/": { "get": { "operationId": "buzzexpress_adminusers_read", "description": "", "parameters": [], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminUsers" } } }, "tags": [ "buzzexpress" ] }, "put": { "operationId": "buzzexpress_adminusers_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminUsers" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminUsers" } } }, "tags": [ "buzzexpress" ] }, "patch": { "operationId": "buzzexpress_adminusers_partial_update", "description": "", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/AdminUsers" } } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdminUsers" } } }, "tags": [ "buzzexpress" ] }, "delete": { "operationId": "buzzexpress_adminusers_delete", "description": "", "parameters": [], "responses": { "204": { "description": "" } }, "tags": [ "buzzexpress" ] }, "parameters": [ { "name": "id", "in": "path", "description": "A unique integer value identifying this admin users.", "required": true, "type": "integer" } ] } }, "definitions": { "Login": { "required": [ "password" ], "type": "object", "properties": { "username": { "title": "Username", "type": "string" }, "email": { "title": "Email", "type": "string", "format": "email" }, "password": { "title": "Password", "type": "string", "minLength": 1 } } }, "PasswordChange": { "required": [ "new_password1", "new_password2" ], "type": "object", "properties": { "new_password1": { "title": "New password1", "type": "string", "maxLength": 128, "minLength": 1 }, "new_password2": { "title": "New password2", "type": "string", "maxLength": 128, "minLength": 1 } } }, "PasswordReset": { "required": [ "email" ], "type": "object", "properties": { "email": { "title": "Email", "type": "string", "format": "email", "minLength": 1 } } }, "PasswordResetConfirm": { "required": [ "new_password1", "new_password2", "uid", "token" ], "type": "object", "properties": { "new_password1": { "title": "New password1", "type": "string", "maxLength": 128, "minLength": 1 }, "new_password2": { "title": "New password2", "type": "string", "maxLength": 128, "minLength": 1 }, "uid": { "title": "Uid", "type": "string", "minLength": 1 }, "token": { "title": "Token", "type": "string", "minLength": 1 } } }, "Register": { "required": [ "username", "password1", "password2" ], "type": "object", "properties": { "username": { "title": "Username", "type": "string", "maxLength": 150, "minLength": 1 }, "email": { "title": "Email", "type": "string", "format": "email", "minLength": 1 }, "password1": { "title": "Password1", "type": "string", "minLength": 1 }, "password2": { "title": "Password2", "type": "string", "minLength": 1 } } }, "ResendEmailVerification": { "type": "object", "properties": { "email": { "title": "Email", "type": "string", "format": "email", "minLength": 1 } } }, "VerifyEmail": { "required": [ "key" ], "type": "object", "properties": { "key": { "title": "Key", "type": "string", "minLength": 1 } } }, "UserDetails": { "required": [ "username" ], "type": "object", "properties": { "pk": { "title": "ID", "type": "integer", "readOnly": true }, "username": { "title": "Username", "description": "Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.", "type": "string", "pattern": "^[\\w.@+-]+$", "maxLength": 150, "minLength": 1 }, "email": { "title": "Email address", "type": "string", "format": "email", "readOnly": true, "minLength": 1 }, "first_name": { "title": "First name", "type": "string", "maxLength": 150 }, "last_name": { "title": "Last name", "type": "string", "maxLength": 150 } } }, "AdminEventLog": { "required": [ "evtcode", "memid", "name", "activities", "ip", "session_id", "browser" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "evtdate": { "title": "Evtdate", "type": "string", "format": "date-time", "readOnly": true }, "evtcode": { "title": "Evtcode", "type": "string", "maxLength": 100, "minLength": 1 }, "memid": { "title": "Memid", "type": "string", "maxLength": 100, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 180, "minLength": 1 }, "activities": { "title": "Activities", "type": "string", "maxLength": 600, "minLength": 1 }, "ip": { "title": "Ip", "type": "string", "maxLength": 50, "minLength": 1 }, "session_id": { "title": "Session id", "type": "string", "maxLength": 200, "minLength": 1 }, "browser": { "title": "Browser", "type": "string", "maxLength": 300, "minLength": 1 } } }, "AdminEventType": { "required": [ "code", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "code": { "title": "Code", "type": "string", "maxLength": 50, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 200, "minLength": 1 } } }, "AdminMenuGroup": { "required": [ "code", "name" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "code": { "title": "Code", "type": "string", "maxLength": 10, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 50, "minLength": 1 }, "description": { "title": "Description", "type": "string", "maxLength": 200, "x-nullable": true }, "date": { "title": "Date", "type": "string", "format": "date-time", "readOnly": true } } }, "AdminMenuSubGroup": { "required": [ "menugpcode", "code", "name", "namespace", "icons" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "menugpcode": { "title": "Menugpcode", "type": "string", "maxLength": 50, "minLength": 1 }, "code": { "title": "Code", "type": "string", "maxLength": 50, "minLength": 1 }, "name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "namespace": { "title": "Namespace", "type": "string", "maxLength": 255, "minLength": 1 }, "icons": { "title": "Icons", "type": "string", "maxLength": 150, "minLength": 1 }, "status": { "title": "Status", "type": "string", "enum": [ "0", "1" ] }, "date": { "title": "Date", "type": "string", "format": "date-time", "readOnly": true } } }, "AdminMenuSubGroupDetail": { "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "menugpcode": { "title": "Menugpcode", "type": "string", "maxLength": 50, "x-nullable": true }, "menucatcode": { "title": "Menucatcode", "type": "string", "maxLength": 50, "x-nullable": true }, "code": { "title": "Code", "type": "string", "maxLength": 50, "x-nullable": true }, "icons": { "title": "Icons", "type": "string", "maxLength": 150, "x-nullable": true }, "name": { "title": "Name", "type": "string", "maxLength": 100, "x-nullable": true }, "namespace": { "title": "Namespace", "type": "string", "maxLength": 255, "x-nullable": true }, "imageuniname": { "title": "Imageuniname", "type": "string", "maxLength": 150, "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "0", "1" ] }, "notification": { "title": "Notification", "type": "string", "enum": [ "0", "1" ] }, "sidebar": { "title": "Sidebar", "type": "string", "enum": [ "0", "1" ] }, "dashboard": { "title": "Dashboard", "type": "string", "enum": [ "0", "1" ] }, "windview": { "title": "Windview", "type": "string", "enum": [ "0", "1" ] }, "windviewgeneralreport": { "title": "Windviewgeneralreport", "type": "string", "enum": [ "0", "1" ], "x-nullable": true }, "windviewfinancialreport": { "title": "Windviewfinancialreport", "type": "string", "enum": [ "0", "1" ], "x-nullable": true }, "windviewstatisticalreport": { "title": "Windviewstatisticalreport", "type": "string", "enum": [ "0", "1" ], "x-nullable": true }, "admin_accessright": { "title": "Admin accessright", "type": "string", "enum": [ "1", "2" ] }, "date": { "title": "Date", "type": "string", "format": "date-time", "readOnly": true }, "targeted": { "title": "Targeted", "type": "string", "maxLength": 255, "x-nullable": true }, "viewer": { "title": "Viewer", "type": "string", "maxLength": 255, "x-nullable": true } } }, "AdminMenuSubUsers": { "required": [ "usruserid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "usruserid": { "title": "Usruserid", "type": "string", "maxLength": 50, "minLength": 1 }, "menudetcode": { "title": "Menudetcode", "type": "string", "maxLength": 50, "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "0", "1" ] }, "addedby": { "title": "Addedby", "type": "string", "maxLength": 50, "x-nullable": true }, "date": { "title": "Date", "type": "string", "format": "date-time", "readOnly": true } } }, "AdminUserPermission": { "required": [ "usruserid" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "usruserid": { "title": "Usruserid", "type": "string", "maxLength": 50, "minLength": 1 }, "menudetcode": { "title": "Menudetcode", "type": "string", "maxLength": 50, "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "0", "1" ] }, "addedby": { "title": "Addedby", "type": "string", "maxLength": 50, "x-nullable": true }, "date": { "title": "Date", "type": "string", "format": "date-time", "readOnly": true } } }, "AdminUsers": { "required": [ "code", "surname", "othernames", "password", "username", "level" ], "type": "object", "properties": { "id": { "title": "ID", "type": "integer", "readOnly": true }, "code": { "title": "Code", "type": "string", "maxLength": 50, "minLength": 1 }, "surname": { "title": "Surname", "type": "string", "maxLength": 100, "minLength": 1 }, "othernames": { "title": "Othernames", "type": "string", "maxLength": 100, "minLength": 1 }, "password": { "title": "Password", "type": "string", "maxLength": 400, "minLength": 1 }, "username": { "title": "Username", "type": "string", "maxLength": 50, "minLength": 1 }, "startdate": { "title": "Startdate", "type": "string", "format": "date", "readOnly": true }, "emergencyphone": { "title": "Emergencyphone", "type": "string", "maxLength": 255, "x-nullable": true }, "phoneno": { "title": "Phoneno", "type": "string", "maxLength": 100, "x-nullable": true }, "level": { "title": "Level", "type": "integer", "maximum": 2147483647, "minimum": -2147483648 }, "passwordchange": { "title": "Passwordchange", "type": "string", "enum": [ "0", "1" ] }, "organisationcode": { "title": "Organisationcode", "type": "string", "maxLength": 50 }, "organisationname": { "title": "Organisationname", "type": "string", "maxLength": 150 }, "position": { "title": "Position", "type": "string", "maxLength": 100 }, "email": { "title": "Email", "type": "string", "maxLength": 255, "x-nullable": true }, "status": { "title": "Status", "type": "string", "enum": [ "-1", "0", "1" ] }, "actorid": { "title": "Actorid", "type": "string", "maxLength": 50, "x-nullable": true }, "actorname": { "title": "Actorname", "type": "string", "maxLength": 150 }, "type": { "title": "Type", "type": "string", "maxLength": 50 }, "regioncode": { "title": "Regioncode", "type": "string", "maxLength": 100 }, "regionname": { "title": "Regionname", "type": "string", "maxLength": 100 }, "districtcode": { "title": "Districtcode", "type": "string", "maxLength": 100 }, "districtname": { "title": "Districtname", "type": "string", "maxLength": 100 } } } } }