{ "openapi": "3.0.0", "info": { "title": "MVP Swagger", "version": "1.0.0" }, "servers": [ { "url": "api" } ], "paths": { "/v1/login": { "post": { "tags": [ "Authentication" ], "summary": "User Login", "description": "Authenticates a user and returns an authentication token.", "operationId": "loginUser", "requestBody": { "description": "User credentials", "required": true, "content": { "application/json": { "schema": { "required": [ "identity" ], "properties": { "identity": { "type": "string", "example": "1041111509" } }, "type": "object" } } } }, "responses": { "200": { "description": "User authenticated successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "User is successfully authenticated" }, "token": { "type": "string", "example": "auth_token" } }, "type": "object" } } } }, "404": { "description": "User not found", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "User not found in system" } }, "type": "object" } } } } } } }, "/v1/auth": { "get": { "tags": [ "Users" ], "summary": "Retrieve all user's organizations data", "description": "Get a list of all user's organizations data", "operationId": "cce9711cefcd5db09dbf73b8bb07bc48", "parameters": [ { "name": "page_number", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "page_size", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "example": 10 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer", "example": 200 }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/auth/{organizationId}": { "get": { "tags": [ "Users" ], "summary": "Retrieve all user's organizations data", "description": "Get a list of all user's organizations data", "operationId": "f0c987647ee498fd2fe4e0bcf931d332", "parameters": [ { "name": "organizationId", "in": "path", "description": "id of the organization", "required": true, "schema": { "type": "integer" } }, { "name": "page_number", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "page_size", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "example": 10 } }, { "name": "name", "in": "query", "description": "Service name to be searched", "required": false, "schema": { "type": "string" } }, { "name": "category_id", "in": "query", "description": "id of the category", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/categories": { "get": { "tags": [ "Categories" ], "summary": "Retrieve all categories data", "description": "Get a list of all categories data", "operationId": "f0bf3bf0f81d56854e31a43415df876c", "parameters": [ { "name": "page_number", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "page_size", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "example": 10 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/categories/create": { "post": { "tags": [ "Categories" ], "summary": "Create Category", "description": "Create Category", "operationId": "8c0e3fd4402fc5df9b7f8b0c7a885b6a", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "Category Name" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful Creation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Category", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/categories/update/{id}": { "patch": { "tags": [ "Categories" ], "summary": "Update Category", "description": "Update Category", "operationId": "c24c23833273739a52232df985dafc84", "parameters": [ { "name": "id", "in": "path", "description": "id of the Category to be obtained", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "Category Name" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful Updated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Category", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/categories/delete/{id}": { "delete": { "tags": [ "Categories" ], "summary": "Delete Category", "description": "Delete Category", "operationId": "77ed0b2db6d2f3d6a8895887271b1467", "parameters": [ { "name": "id", "in": "path", "description": "id of the Category to be obtained", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful Deleted", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Category", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/generalizations": { "get": { "tags": [ "Generalizations" ], "summary": "Retrieve all generalizations data", "description": "Get a list of all generalizations data", "operationId": "0331b5df723a003f7d29a73ab5548b2f", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer" }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer" }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/member_types": { "get": { "tags": [ "MemberTypes" ], "summary": "Retrieve all member_types data", "description": "Get a list of all member_types data", "operationId": "eec0b2f835ff63ac0c633297db67ed22", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/member_types/create": { "post": { "tags": [ "MemberTypes" ], "summary": "Create Member Type", "description": "Create Member Type", "operationId": "286466dcc34f057f427f8ae48d4520b8", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "service_id" ], "properties": { "name": { "type": "string" }, "service_id": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful Creation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Member Type", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/member_types/update/{id}": { "patch": { "tags": [ "MemberTypes" ], "summary": "Update Member Type", "description": "Update Member Type", "operationId": "868f251a78bd9b3becd4f40d0c714694", "parameters": [ { "name": "id", "in": "path", "description": "id of the Member Type to be obtained", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "service_id" ], "properties": { "name": { "type": "string" }, "service_id": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful Updated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Member Type", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/member_types/delete/{id}": { "delete": { "tags": [ "MemberTypes" ], "summary": "Delete Member Type", "description": "Delete Member Type", "operationId": "849103646ef7d1c70097a1473abe820f", "parameters": [ { "name": "id", "in": "path", "description": "id of the Member Type to be obtained", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful Deleted", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Member Type", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/members": { "get": { "tags": [ "Members" ], "summary": "Retrieve all members data", "description": "Get a list of all members data", "operationId": "2bf5840764d026633f5cfc17f6783098", "parameters": [ { "name": "page_number", "in": "query", "description": "Page number for pagination", "required": false, "schema": { "type": "integer", "example": 1 } }, { "name": "page_size", "in": "query", "description": "Number of items per page", "required": false, "schema": { "type": "integer", "example": 10 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/members/create": { "post": { "tags": [ "Members" ], "summary": "Create Member", "description": "Create Member", "operationId": "21e74ed142f3754534bf5792adadcb9e", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "nationalId", "position", "positionKey", "organization_id", "member_type_id" ], "properties": { "name": { "type": "string" }, "mobile": { "type": "string" }, "email": { "type": "string", "format": "email" }, "nationalId": { "type": "string" }, "userName": { "type": "string" }, "haveMobile": { "type": "boolean" }, "position": { "type": "string" }, "positionKey": { "type": "string" }, "organization_id": { "type": "array", "items": { "type": "string" } }, "member_type_id": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful Creation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Member", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/members/update/{id}": { "patch": { "tags": [ "Members" ], "summary": "Update Member", "description": "Update Member", "operationId": "b6ad22002d1696627bbd0e7a6a78d026", "parameters": [ { "name": "id", "in": "path", "description": "id of the Member to be obtained", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "nationalId", "position", "positionKey", "organization_id", "member_type_id" ], "properties": { "name": { "type": "string" }, "mobile": { "type": "string" }, "email": { "type": "string", "format": "email" }, "nationalId": { "type": "string" }, "userName": { "type": "string" }, "haveMobile": { "type": "boolean" }, "position": { "type": "string" }, "positionKey": { "type": "string" }, "organization_id": { "type": "array", "items": { "type": "string" } }, "member_type_id": { "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful Updated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Member", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/members/delete/{id}": { "delete": { "tags": [ "Members" ], "summary": "Delete Member", "description": "Delete Member", "operationId": "4f31deb3bbab0dd8b6960ee3e8a0e262", "parameters": [ { "name": "id", "in": "path", "description": "id of the Member to be obtained", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful Deleted", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Member", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/notifications": { "get": { "tags": [ "Notifications" ], "summary": "Retrieve all notifications data", "description": "Get a list of all notifications data", "operationId": "3de6335bad079fd88eccae70379fa624", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer" }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer" }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/organizations/show": { "get": { "tags": [ "Organizations" ], "summary": "Retrieve organization data", "description": "Get an object of organization data", "operationId": "f651589dd6421e49effbb440529fc3fb", "parameters": [ { "name": "organizationId", "in": "query", "description": "organizationId of the organization object", "required": true, "schema": { "type": "string" } }, { "name": "type_id", "in": "query", "description": "Type of the organization object", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer" }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer" }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/organizations": { "get": { "tags": [ "Organizations" ], "summary": "Retrieve all organizations data", "description": "Get a list of all organizations data", "operationId": "6d4f7bb707e23d325032836b959ef744", "parameters": [ { "name": "filter", "in": "query", "description": "filter data", "required": false, "schema": { "type": "array", "items": { "properties": { "name": { "type": "string", "example": "متعددة الأغراض" }, "buildNo": { "type": "string", "example": "6394" }, "city": { "type": "string", "example": "الدرعية" }, "supervisor": { "type": "string", "example": "وزارة الدخلية" }, "type": { "type": "string", "example": "privateCorporation" } }, "type": "object" } } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/organizations/type": { "get": { "tags": [ "Organizations" ], "summary": "Retrieve all types of organizations data", "description": "Get a list of all types of organizations data", "operationId": "4975ce39e326796b34530b869f09ba1e", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/organizations/city": { "get": { "tags": [ "Organizations" ], "summary": "Retrieve all cities of organizations data", "description": "Get a list of all cities of organizations data", "operationId": "1e32dfa032ed76d5f7f6da56b5b6cbfb", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/organizations/supervisor": { "get": { "tags": [ "Organizations" ], "summary": "Retrieve all supervisors of organizations data", "description": "Get a list of all supervisors of organizations data", "operationId": "8ee1802f2f2b974d9a1a92b3b6512b31", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/organizations/create": { "post": { "tags": [ "Organizations" ], "summary": "Create Organization", "description": "Create Organization", "operationId": "be1c0553999e54f6f58977ec28e7372d", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "type_id", "name", "organizationId", "system", "order", "unifiedKey" ], "properties": { "type_id": { "type": "integer" }, "name": { "type": "string" }, "oldId": { "type": "string" }, "organizationId": { "type": "string" }, "unifiedNumber700": { "type": "string" }, "mobileUserOwner": { "type": "string" }, "city": { "type": "string" }, "street": { "type": "string" }, "buildNo": { "type": "string" }, "neighborhood": { "type": "string" }, "system": { "type": "string" }, "order": { "type": "integer" }, "supervisor": { "type": "string" }, "unifiedKey": { "type": "string" }, "isAutoMerge": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful Creation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Organization", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/organizations/update/{id}": { "patch": { "tags": [ "Organizations" ], "summary": "Update Organization", "description": "Update Organization", "operationId": "72d46f7c492995c8d27195b6bb92bd47", "parameters": [ { "name": "id", "in": "path", "description": "id of the Organization to be obtained", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "type_id", "name", "organizationId", "system", "order", "unifiedKey" ], "properties": { "type_id": { "type": "integer" }, "name": { "type": "string" }, "oldId": { "type": "string" }, "organizationId": { "type": "string" }, "unifiedNumber700": { "type": "string" }, "mobileUserOwner": { "type": "string" }, "city": { "type": "string" }, "street": { "type": "string" }, "buildNo": { "type": "string" }, "neighborhood": { "type": "string" }, "system": { "type": "string" }, "order": { "type": "integer" }, "supervisor": { "type": "string" }, "unifiedKey": { "type": "string" }, "isAutoMerge": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful Updated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Organization", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/organizations/delete/{id}": { "delete": { "tags": [ "Organizations" ], "summary": "Delete Organization", "description": "Delete Organization", "operationId": "6c12fc4ea598c9e33ee8c42f6e668aa1", "parameters": [ { "name": "id", "in": "path", "description": "id of the Organization to be obtained", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful Deleted", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Organization", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/services": { "get": { "tags": [ "Services" ], "summary": "Retrieve all services data", "description": "Get a list of all services data", "operationId": "dadaf9383e24941bf6e9651bef38f887", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/services/create": { "post": { "tags": [ "Services" ], "summary": "Create Service", "description": "Create Service", "operationId": "6016602736db7ebdfea2f2fda30209fb", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "category_id", "name", "url" ], "properties": { "category_id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "isPublic": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful Creation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Service", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/services/update/{id}": { "patch": { "tags": [ "Services" ], "summary": "Update Service", "description": "Update Service", "operationId": "35bd8c3596e10401f77d9baf182c0b8e", "parameters": [ { "name": "id", "in": "path", "description": "id of the Service to be obtained", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "category_id", "name", "url" ], "properties": { "category_id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string" }, "isPublic": { "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful Updated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Service", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/services/delete/{id}": { "delete": { "tags": [ "Services" ], "summary": "Delete Service", "description": "Delete Service", "operationId": "5bfa93208f52259cfa2b9520cc9861d9", "parameters": [ { "name": "id", "in": "path", "description": "id of the Service to be obtained", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful Deleted", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer", "example": 400 }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Service", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/surveys": { "get": { "tags": [ "Surveys" ], "summary": "Retrieve all surveys data", "description": "Get a list of all surveys data", "operationId": "59e128fbb4301d387da8c0fa08ad48f8", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer" }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "type": { "type": "string" }, "code": { "type": "integer" }, "reason": { "type": "string" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/types": { "get": { "tags": [ "Types" ], "summary": "Retrieve all types data", "description": "Get a list of all types data", "operationId": "a9e1ef2a1bd76c28249252a1f0b1c5f4", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/types/create": { "post": { "tags": [ "Types" ], "summary": "Create Type", "description": "Create Type", "operationId": "89b38a22862d7438abe0f8818e41a587", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "Type Name" } }, "type": "object" } } } }, "responses": { "201": { "description": "Successful Creation", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Types", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/types/update/{id}": { "patch": { "tags": [ "Types" ], "summary": "Update Type", "description": "Update Type", "operationId": "c59ad70f2140a952e9134cf08d799902", "parameters": [ { "name": "id", "in": "path", "description": "id of the Type to be obtained", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "type": "string", "example": "Type Name" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful Updated", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Type", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/v1/types/delete/{id}": { "delete": { "tags": [ "Types" ], "summary": "Delete Type", "description": "Delete Type", "operationId": "21043ef27a0832fc03636d316919ea84", "parameters": [ { "name": "id", "in": "path", "description": "id of the Type to be obtained", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful Deleted", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "type": "object" } } } }, "422": { "description": "Unprocessable Type", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "errors": { "type": "object" } }, "type": "object" } } } } }, "security": [ { "bearerAuth": [] } ] } } } }