{ "openapi": "3.0.4", "info": { "title": "BMS.DASHBOARD.API", "version": "v1" }, "paths": { "/api/benefits-portal/benefit-types": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateBenefitTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/benefit-types/{id}": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBenefitTypeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/portal-adverts": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortalAdvertRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/portal-adverts/{id}": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePortalAdvertRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/portal-adverts/{headerId}/benefits": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/portal-adverts/{headerId}/parishes": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/users/{userId}/application-headers": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/{headerId}/section1a": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-sections/section1a": { "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveApplicationSection1ARequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-sections/section1a/{id}": { "delete": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/{headerId}/section2": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-sections/section2": { "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveApplicationSection2Request" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-sections/section2/{id}": { "delete": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/{headerId}/inputs": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-inputs": { "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveApplicationInputRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/{headerId}/section3": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-sections/section3": { "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveApplicationSection3Request" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-sections/section3/by-header/{headerId}": { "delete": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/stakeholders/{stakeholderId}/properties": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "stakeholderId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/{headerId}/stakeholder": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/portal-advert-benefits": { "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortalAdvertBenefitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/portal-advert-benefits/{id}": { "put": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePortalAdvertBenefitRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/portal-advert-parishes": { "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePortalAdvertParishRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/portal-advert-parishes/{id}": { "put": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePortalAdvertParishRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers": { "get": { "tags": [ "BenefitsPortal" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApplicationHeaderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/{id}": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApplicationHeaderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/statuses": { "get": { "tags": [ "BenefitsPortal" ], "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/new": { "post": { "tags": [ "BenefitsPortal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApplicationHeaderNewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/benefits-portal/application-headers/{id}/status": { "patch": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/": { "get": { "tags": [ "BMS.DASHBOARD.API" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/token": { "post": { "tags": [ "BMS.DASHBOARD.API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reference/projects": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/sponsors": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/parishes": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/genders": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/parish-extensions": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/tenure-types": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/quantity-units": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/crops": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/livestock": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reports/getassessmentreport": { "post": { "tags": [ "Reports" ], "summary": "Generate BMS Assessment Report PDF from application header ID", "operationId": "GetAssessmentReport", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DownloadFile" } } } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" } } } } }, "components": { "schemas": { "CreateApplicationHeaderNewRequest": { "type": "object", "properties": { "advertId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "applicationFor": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateApplicationHeaderRequest": { "type": "object", "properties": { "applicationFor": { "type": "integer", "format": "int32" }, "adverId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateBenefitTypeRequest": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "unitCost": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CreatePortalAdvertBenefitRequest": { "type": "object", "properties": { "headerId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32" }, "unitId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreatePortalAdvertParishRequest": { "type": "object", "properties": { "headerId": { "type": "integer", "format": "int32" }, "parishId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreatePortalAdvertRequest": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32" }, "sponsorId": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "base64String": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "createdBy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DownloadFile": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LoginRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SaveApplicationInputRequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "applicationId": { "type": "integer", "format": "int32" }, "inputId": { "type": "integer", "format": "int32" }, "inputQuantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SaveApplicationSection1ARequest": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "linenum": { "type": "integer", "format": "int32" }, "headerId": { "type": "integer", "format": "int32" }, "idX_StakeHolder": { "type": "integer", "format": "int32", "nullable": true }, "stakeHolder_Num": { "type": "string", "nullable": true }, "firstname": { "type": "string", "nullable": true }, "middlename": { "type": "string", "nullable": true }, "lastname": { "type": "string", "nullable": true }, "genderid": { "type": "integer", "format": "int32" }, "address1": { "type": "string", "nullable": true }, "address2": { "type": "string", "nullable": true }, "parishid": { "type": "integer", "format": "int32" }, "extensionid": { "type": "integer", "format": "int32" }, "homephone": { "type": "string", "nullable": true }, "cellphone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "trn": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "SaveApplicationSection2Request": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "headerId": { "type": "integer", "format": "int32" }, "tenureId": { "type": "integer", "format": "int32" }, "propertyId": { "type": "integer", "format": "int32" }, "propertyDescription": { "type": "string", "nullable": true }, "informationUse": { "type": "boolean" }, "affectedBy_Drought": { "type": "boolean" }, "affectedBy_Flood": { "type": "boolean" }, "affectedBy_Pest": { "type": "boolean" }, "affectedBy_Desease": { "type": "boolean" }, "affectedBy_Explain_Notes": { "type": "string", "nullable": true }, "affectedBy_Verified": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SaveApplicationSection3Request": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "headerId": { "type": "integer", "format": "int32" }, "linenum": { "type": "integer", "format": "int32" }, "categoryId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "quantity": { "type": "number", "format": "double" }, "verified": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpdateApplicationHeaderRequest": { "type": "object", "properties": { "applicationNumber": { "type": "string", "nullable": true }, "applicationFor": { "type": "integer", "format": "int32" }, "adverId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "extension_Narrative_Date": { "type": "string", "format": "date-time", "nullable": true }, "extension_Narrative_DoneBy": { "type": "string", "nullable": true }, "extension_Narrative": { "type": "string", "nullable": true }, "pM_Narrative_Date": { "type": "string", "format": "date-time", "nullable": true }, "pM_Narrative_DoneBy": { "type": "string", "nullable": true }, "pM_Narrative": { "type": "string", "nullable": true }, "distribution_Narrative_Date": { "type": "string", "format": "date-time", "nullable": true }, "distribution_Narrative_DoneBy": { "type": "string", "nullable": true }, "distribution_Narrative": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateBenefitTypeRequest": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "unitCost": { "type": "number", "format": "double" } }, "additionalProperties": false }, "UpdatePortalAdvertBenefitRequest": { "type": "object", "properties": { "headerId": { "type": "integer", "format": "int32" }, "typeId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32" }, "unitId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpdatePortalAdvertParishRequest": { "type": "object", "properties": { "headerId": { "type": "integer", "format": "int32" }, "parishId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpdatePortalAdvertRequest": { "type": "object", "properties": { "statusId": { "type": "integer", "format": "int32" }, "sponsorId": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "base64String": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "expiryDate": { "type": "string", "format": "date-time", "nullable": true }, "updatedBy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpdateStatusRequest": { "type": "object", "properties": { "sectionId": { "type": "integer", "format": "int32" }, "statusId": { "type": "integer", "format": "int32" }, "doneBy": { "type": "string", "nullable": true }, "narrative": { "type": "string", "nullable": true }, "signature": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Enter JWT token as: Bearer {token}", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { } ], "tags": [ { "name": "BenefitsPortal" }, { "name": "BMS.DASHBOARD.API" }, { "name": "ReferenceData" }, { "name": "Reports" } ] }