[ { "model-name": "NationalAlert", "resource-file": "national_alerts.json", "table-name": "national_alerts", "migrations": [ { "name": "2022_09_09_114435_create_national_alerts_table", "class-name": "CreateNationalAlertsTable", "path": "C:\\xampp\\htdocs\\kiebit\\project\\QI-Tech\\database\\migrations\\2022_09_09_114435_create_national_alerts_table.php", "is-create": true, "is-virtual": false, "is-organized": false, "with-soft-delete": true, "without-timestamps": false, "resource": { "fields": [ { "name": "id", "labels": "Id", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "", "is-on-index": false, "is-on-show": false, "is-on-form": false, "data-type": "int", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": true, "comment": null, "is-nullable": false, "is-header": false, "is-unsigned": true, "is-auto-increment": true, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter id here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "id", "is-api-visible": true, "api-description": "The id of the model." }, { "name": "title", "labels": "Title", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "string|min:1|max:255|nullable", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [ 255 ], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": true, "is-header": true, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter title here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "title", "is-api-visible": true, "api-description": "The title of the model." }, { "name": "alert_type", "labels": "Alert Type", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "string|min:1|nullable", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": true, "is-header": false, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter alert type here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "alert_type", "is-api-visible": true, "api-description": "The alert type of the model." }, { "name": "summary", "labels": "Summary", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "string|min:1|nullable", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": true, "is-header": false, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter summary here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "summary", "is-api-visible": true, "api-description": "The summary of the model." } ], "relations": [], "indexes": [], "auto-manage-created-and-updated-at": true, "table-name": null, "protection": { "is-model-protected": false, "is-controller-protected": false, "is-api-resource-protected": false, "is-api-resource-collection-protected": false, "is-api-documentation-protected": false, "is-api-documentation-controller-protected": false, "is-form-request-protected": false, "is-languages-protected": false, "is-form-view-protected": false, "is-index-view-protected": false, "is-create-view-protected": false, "is-edit-view-protected": false, "is-show-view-protected": false }, "api-documentation": { "access_token_with_bearer": "The access token prefixed with the \"Bearer \" key word.", "index_route_description": "Retrieve existing national alerts.", "index_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_key_is_the_model_property_and_the_value_is_the_model_value": "The array's key is the national alert property name where the value is the assigned value to the retrieved national alert.", "link_to_retrieve_first_page": "Link to retrieve first page.", "link_to_retrieve_last_page": "Link to retrieve last page.", "link_to_retrieve_previous_page": "Link to retrieve previous page.", "link_to_retrieve_next_page": "Link to retrieve next page.", "the_number_of_current_page": "The number of current page.", "the_index_of_the_first_retrieved_item": "The index of first retrieved national alert.", "the_number_of_the_last_page": "The number of the last page.", "the_base_link_to_the_resource": "The base link to the api resource.", "the_number_of_models_per_page": "The number of national alerts per page.", "the_index_of_the_last_retrieved_item": "The index of last retrieved national alert.", "the_total_of_available_pages": "The total of the available pages.", "store_route_description": "Create new national alert.", "store_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "update_route_description": "Update existsing national alert.", "update_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "show_route_description": "Retrieve existsing national alert.", "show_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_id_of_model_to_retrieve": "The unique id of the national alert to retrieve", "destroy_route_description": "Delete existsing national alert.", "destroy_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_id_of_model_to_delete": "The id of the national alert to delete.", "general_description": "Allows you to list, create, edit, show and delete national alerts.", "indicate_whether_the_request_was_successful_or_not": "Indicate whether the request was successful or not.", "the_id_of_the_model": "The id of the national alert.", "this_parameter_must_be_present_in_the_request": "This parameter must be present in the request.", "the_request_failed_validation": "The request failed validation.", "list_of_the_invalid_errors": "List of the invalid errors.", "the_requested_model_does_not_exists": "The requested national alert does not exists.", "the_user_does_not_have_permission_to_access_the_requested_resource": "User does not have permission to access the requested resource." } } } ] }, { "model-name": "AlertDocuments", "resource-file": "alert_documents.json", "table-name": "alert_documents", "migrations": [ { "name": "2022_09_09_114935_create_alert_documents_table", "class-name": "CreateAlertDocumentsTable", "path": "C:\\xampp\\htdocs\\kiebit\\project\\QI-Tech\\database\\migrations\\2022_09_09_114935_create_alert_documents_table.php", "is-create": true, "is-virtual": false, "is-organized": false, "with-soft-delete": true, "without-timestamps": false, "resource": { "fields": [ { "name": "id", "labels": "Id", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "", "is-on-index": false, "is-on-show": false, "is-on-form": false, "data-type": "int", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": true, "comment": null, "is-nullable": false, "is-header": false, "is-unsigned": true, "is-auto-increment": true, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter id here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "id", "is-api-visible": true, "api-description": "The id of the model." }, { "name": "national_alert_id", "labels": "National Alert", "html-type": "select", "css-class": "", "options": {}, "html-value": null, "validation": "nullable", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "int", "data-type-params": [], "data-value": null, "is-index": true, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": true, "is-header": false, "is-unsigned": true, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Select national alert", "delimiter": "; ", "range": [], "foreign-relation": { "name": "nationalAlert", "type": "belongsTo", "params": [ "App\\Models\\NationalAlert", "national_alert_id" ], "field": "title" }, "foreign-constraint": { "field": "national_alert_id", "references": "id", "on": "national_alerts", "on-delete": "cascade", "on-update": "cascade", "references-model": "App\\Models\\NationalAlert", "is-self-reference": false }, "on-store": null, "on-update": null, "api-key": "national_alert_id", "is-api-visible": true, "api-description": "The national alert of the model." }, { "name": "alert_document", "labels": "Alert Document", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "string|min:1|nullable", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": true, "is-header": false, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter alert document here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "alert_document", "is-api-visible": true, "api-description": "The alert document of the model." } ], "relations": [], "indexes": [], "auto-manage-created-and-updated-at": true, "table-name": null, "protection": { "is-model-protected": false, "is-controller-protected": false, "is-api-resource-protected": false, "is-api-resource-collection-protected": false, "is-api-documentation-protected": false, "is-api-documentation-controller-protected": false, "is-form-request-protected": false, "is-languages-protected": false, "is-form-view-protected": false, "is-index-view-protected": false, "is-create-view-protected": false, "is-edit-view-protected": false, "is-show-view-protected": false }, "api-documentation": { "access_token_with_bearer": "The access token prefixed with the \"Bearer \" key word.", "index_route_description": "Retrieve existing alert documents.", "index_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_key_is_the_model_property_and_the_value_is_the_model_value": "The array's key is the alert document property name where the value is the assigned value to the retrieved alert document.", "link_to_retrieve_first_page": "Link to retrieve first page.", "link_to_retrieve_last_page": "Link to retrieve last page.", "link_to_retrieve_previous_page": "Link to retrieve previous page.", "link_to_retrieve_next_page": "Link to retrieve next page.", "the_number_of_current_page": "The number of current page.", "the_index_of_the_first_retrieved_item": "The index of first retrieved alert document.", "the_number_of_the_last_page": "The number of the last page.", "the_base_link_to_the_resource": "The base link to the api resource.", "the_number_of_models_per_page": "The number of alert documents per page.", "the_index_of_the_last_retrieved_item": "The index of last retrieved alert document.", "the_total_of_available_pages": "The total of the available pages.", "store_route_description": "Create new alert document.", "store_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "update_route_description": "Update existsing alert document.", "update_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "show_route_description": "Retrieve existsing alert document.", "show_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_id_of_model_to_retrieve": "The unique id of the alert document to retrieve", "destroy_route_description": "Delete existsing alert document.", "destroy_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_id_of_model_to_delete": "The id of the alert document to delete.", "general_description": "Allows you to list, create, edit, show and delete alert documents.", "indicate_whether_the_request_was_successful_or_not": "Indicate whether the request was successful or not.", "the_id_of_the_model": "The id of the alert document.", "this_parameter_must_be_present_in_the_request": "This parameter must be present in the request.", "the_request_failed_validation": "The request failed validation.", "list_of_the_invalid_errors": "List of the invalid errors.", "the_requested_model_does_not_exists": "The requested alert document does not exists.", "the_user_does_not_have_permission_to_access_the_requested_resource": "User does not have permission to access the requested resource." } } } ] }, { "model-name": "ServiceMessage", "resource-file": "service_messages.json", "table-name": "service_messages", "migrations": [ { "name": "2022_10_06_133724_create_service_messages_table", "class-name": "CreateServiceMessagesTable", "path": "C:\\xampp\\htdocs\\kiebit\\project\\QI-Tech\\database\\migrations\\2022_10_06_133724_create_service_messages_table.php", "is-create": true, "is-virtual": false, "is-organized": false, "with-soft-delete": true, "without-timestamps": false, "resource": { "fields": [ { "name": "id", "labels": "Id", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "", "is-on-index": false, "is-on-show": false, "is-on-form": false, "data-type": "int", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": true, "comment": null, "is-nullable": false, "is-header": false, "is-unsigned": true, "is-auto-increment": true, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter id here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "id", "is-api-visible": true, "api-description": "The id of the model." }, { "name": "title", "labels": "Title", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "string|min:1|max:255|nullable", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [ 255 ], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": true, "is-header": true, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter title here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "title", "is-api-visible": true, "api-description": "The title of the model." }, { "name": "message", "labels": "Message", "html-type": "textarea", "css-class": "", "options": {}, "html-value": null, "validation": "required|string|min:1|max:1000", "is-on-index": false, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [ 1000 ], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": false, "is-header": false, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter message here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "message", "is-api-visible": true, "api-description": "The message of the model." }, { "name": "send_to", "labels": "Send To", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "required|string|min:1", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": false, "is-header": false, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter send to here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "send_to", "is-api-visible": true, "api-description": "The send to of the model." }, { "name": "countries", "labels": "Countries", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "required|string|min:1", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": false, "is-header": false, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter countries here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "countries", "is-api-visible": true, "api-description": "The countries of the model." }, { "name": "duration", "labels": "Duration", "html-type": "text", "css-class": "", "options": {}, "html-value": null, "validation": "required|string|min:1", "is-on-index": true, "is-on-show": true, "is-on-form": true, "data-type": "string", "data-type-params": [], "data-value": null, "is-index": false, "is-unique": false, "is-primary": false, "comment": null, "is-nullable": false, "is-header": false, "is-unsigned": false, "is-auto-increment": false, "is-inline-options": false, "is-date": false, "date-format": "", "cast-as": "", "placeholder": "Enter duration here...", "delimiter": "; ", "range": [], "foreign-relation": null, "foreign-constraint": null, "on-store": null, "on-update": null, "api-key": "duration", "is-api-visible": true, "api-description": "The duration of the model." } ], "relations": [], "indexes": [], "auto-manage-created-and-updated-at": true, "table-name": null, "protection": { "is-model-protected": false, "is-controller-protected": false, "is-api-resource-protected": false, "is-api-resource-collection-protected": false, "is-api-documentation-protected": false, "is-api-documentation-controller-protected": false, "is-form-request-protected": false, "is-languages-protected": false, "is-form-view-protected": false, "is-index-view-protected": false, "is-create-view-protected": false, "is-edit-view-protected": false, "is-show-view-protected": false }, "api-documentation": { "access_token_with_bearer": "The access token prefixed with the \"Bearer \" key word.", "index_route_description": "Retrieve existing service messages.", "index_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_key_is_the_model_property_and_the_value_is_the_model_value": "The array's key is the service message property name where the value is the assigned value to the retrieved service message.", "link_to_retrieve_first_page": "Link to retrieve first page.", "link_to_retrieve_last_page": "Link to retrieve last page.", "link_to_retrieve_previous_page": "Link to retrieve previous page.", "link_to_retrieve_next_page": "Link to retrieve next page.", "the_number_of_current_page": "The number of current page.", "the_index_of_the_first_retrieved_item": "The index of first retrieved service message.", "the_number_of_the_last_page": "The number of the last page.", "the_base_link_to_the_resource": "The base link to the api resource.", "the_number_of_models_per_page": "The number of service messages per page.", "the_index_of_the_last_retrieved_item": "The index of last retrieved service message.", "the_total_of_available_pages": "The total of the available pages.", "store_route_description": "Create new service message.", "store_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "update_route_description": "Update existsing service message.", "update_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "show_route_description": "Retrieve existsing service message.", "show_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_id_of_model_to_retrieve": "The unique id of the service message to retrieve", "destroy_route_description": "Delete existsing service message.", "destroy_route_response_description": "The API's response will be JSON based data. The JSON object will be structured as follow", "the_id_of_model_to_delete": "The id of the service message to delete.", "general_description": "Allows you to list, create, edit, show and delete service messages.", "indicate_whether_the_request_was_successful_or_not": "Indicate whether the request was successful or not.", "the_id_of_the_model": "The id of the service message.", "this_parameter_must_be_present_in_the_request": "This parameter must be present in the request.", "the_request_failed_validation": "The request failed validation.", "list_of_the_invalid_errors": "List of the invalid errors.", "the_requested_model_does_not_exists": "The requested service message does not exists.", "the_user_does_not_have_permission_to_access_the_requested_resource": "User does not have permission to access the requested resource." } } } ] } ]