{ "openapi": "3.0.4", "info": { "title": "BMS.API", "version": "v1" }, "paths": { "/api/me/farmer-photo": { "get": { "tags": [ "Account" ], "summary": "Get the signed-in farmer's thumbnail", "responses": { "200": { "description": "OK" } } } }, "/BMS_PortalAdverts": { "get": { "tags": [ "Adverts" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_PortalAdvertParishs": { "get": { "tags": [ "Adverts" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "HeaderId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_PortalAdvertParishs/getfarmerparish": { "get": { "tags": [ "Adverts" ], "parameters": [ { "name": "stakeholderno", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_PortalAdverts/eligible": { "get": { "tags": [ "Adverts" ], "parameters": [ { "name": "stakeholderno", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_PortalAdvertBenefits": { "get": { "tags": [ "Adverts" ], "parameters": [ { "name": "headerid", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationStatuss": { "get": { "tags": [ "Application status" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Application status" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BMS_ApplicationStatus" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationStatuss/{id}": { "delete": { "tags": [ "Application status" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/getsection1a": { "get": { "tags": [ "Applications" ], "parameters": [ { "name": "headerid", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/getsection2": { "get": { "tags": [ "Applications" ], "parameters": [ { "name": "headerid", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/getinput": { "get": { "tags": [ "Applications" ], "parameters": [ { "name": "headerid", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationHeaders": { "get": { "tags": [ "Applications" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "Userid", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationHeaders/{id}": { "delete": { "tags": [ "Applications" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationHeaders/getnewapplicationno": { "post": { "tags": [ "Applications" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationHeaders/updatestatus": { "post": { "tags": [ "Applications" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/updatesection1a": { "post": { "tags": [ "Applications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BMS_Application_Section1A" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/updatesection2": { "post": { "tags": [ "Applications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BMS_Application_Section2" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/updateinput": { "post": { "tags": [ "Applications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BMS_Application_Input" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/getsection3": { "get": { "tags": [ "Applications" ], "parameters": [ { "name": "headerid", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/updatesection3": { "post": { "tags": [ "Applications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BMS_Application_Section3" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/BMS_ApplicationLins/deletesection3/{headerId}": { "delete": { "tags": [ "Applications" ], "parameters": [ { "name": "headerId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Reg_PROPERTYS": { "get": { "tags": [ "Applications" ], "parameters": [ { "name": "stakeHolder_idx", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/stakeholders": { "get": { "tags": [ "Applications" ], "parameters": [ { "name": "stakeholderno", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assisted/farmers": { "get": { "tags": [ "Assisted applications" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assisted/farmers/search": { "get": { "tags": [ "Assisted applications" ], "parameters": [ { "name": "farmerNumber", "in": "query", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "schema": { "type": "string" } }, { "name": "parishId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "extensionId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "districtId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assisted/farmer-locations": { "get": { "tags": [ "Assisted applications" ], "parameters": [ { "name": "parishId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "extensionId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assisted/programmes": { "get": { "tags": [ "Assisted applications" ], "parameters": [ { "name": "stakeholderId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assisted/drafts": { "get": { "tags": [ "Assisted applications" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "q", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/assisted/launch": { "post": { "tags": [ "Assisted applications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistedLaunchRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/assisted-exchange": { "post": { "tags": [ "Assisted applications" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistedHandoff" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/auth/token": { "post": { "tags": [ "Authentication" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/me": { "get": { "tags": [ "Authentication" ], "responses": { "200": { "description": "OK" } } } }, "/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/paged": { "get": { "tags": [ "BenefitsPortal" ], "parameters": [ { "name": "PageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "StatusIds", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, { "name": "AdvertId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "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" } } } }, "/api/assisted-current/declaration": { "post": { "tags": [ "BMS.API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssistedDeclaration" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/assisted-current/submit": { "post": { "tags": [ "BMS.API" ], "responses": { "200": { "description": "OK" } } } }, "/": { "get": { "tags": [ "BMS.API" ], "responses": { "200": { "description": "OK" } } } }, "/api/auth/token": { "post": { "tags": [ "BMS.API" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/dashboard/kpis": { "get": { "tags": [ "Dashboard" ], "summary": "Get application workflow KPI totals", "responses": { "200": { "description": "OK" } } } }, "/api/dashboard/application-status": { "get": { "tags": [ "Dashboard" ], "summary": "Get current application totals by workflow status", "responses": { "200": { "description": "OK" } } } }, "/api/dashboard/monthly-application-trend": { "get": { "tags": [ "Dashboard" ], "summary": "Get the latest twelve months of application workflow totals", "responses": { "200": { "description": "OK" } } } }, "/api/dashboard/applications-by-parish": { "get": { "tags": [ "Dashboard" ], "summary": "Get application workflow totals by parish", "responses": { "200": { "description": "OK" } } } }, "/api/dashboard/input-type-distribution": { "get": { "tags": [ "Dashboard" ], "summary": "Get requested input quantities by benefit type", "responses": { "200": { "description": "OK" } } } }, "/api/dashboard/distribution-tracking": { "get": { "tags": [ "Dashboard" ], "summary": "Get approved and distributed application inputs", "responses": { "200": { "description": "OK" } } } }, "/api/dashboard/email-alerts": { "get": { "tags": [ "Dashboard Email Alerts" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Dashboard Email Alerts" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailAlertConfigurationRequest" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/BMS_BenefitTypes": { "get": { "tags": [ "Reference data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Code_Crop_Types": { "get": { "tags": [ "Reference data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Code_Genders": { "get": { "tags": [ "Reference data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Code_Tenure_Types": { "get": { "tags": [ "Reference data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Code_Livestock_Types": { "get": { "tags": [ "Reference data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Code_Parish_Extensions": { "get": { "tags": [ "Reference data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Code_Parishes": { "get": { "tags": [ "Reference data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/Code_Area_Units": { "get": { "tags": [ "Reference data" ], "parameters": [ { "name": "Id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "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/tenure-types": { "get": { "tags": [ "ReferenceData" ], "responses": { "200": { "description": "OK" } } } }, "/api/reference/parish-extensions": { "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" } } } }, "/BMS_Portal_User/validateuser/{stakeholderNo}/{dateOfBirth}": { "get": { "tags": [ "Registration" ], "parameters": [ { "name": "stakeholderNo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "dateOfBirth", "in": "path", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_Portal_User/getuser/{email}": { "get": { "tags": [ "Registration" ], "parameters": [ { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_Portal_User/registeruser": { "post": { "tags": [ "Registration" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalRegistrationRequest" } } }, "required": true }, "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" } } } }, "/api/reports/application-register": { "post": { "tags": [ "Reports" ], "summary": "Generate a filtered BMS Application Register PDF", "operationId": "GetApplicationRegisterReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationRegisterReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/application-register/excel": { "post": { "tags": [ "Reports" ], "summary": "Generate a formatted Excel Application Register", "operationId": "GetApplicationRegisterExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationRegisterReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/outstanding-applications": { "post": { "tags": [ "Reports" ], "summary": "Generate a filtered BMS Outstanding Applications PDF", "operationId": "GetOutstandingApplicationsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutstandingApplicationsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/outstanding-applications/excel": { "post": { "tags": [ "Reports" ], "summary": "Generate a formatted Excel Outstanding Applications report", "operationId": "GetOutstandingApplicationsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutstandingApplicationsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/application-ageing": { "post": { "tags": [ "Reports" ], "summary": "Generate the filtered Application Ageing PDF", "operationId": "GetApplicationAgeingReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAgeingReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/application-ageing/excel": { "post": { "tags": [ "Reports" ], "summary": "Export a formatted Application Ageing workbook", "operationId": "GetApplicationAgeingExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAgeingReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/rejected-applications": { "post": { "tags": [ "Reports" ], "summary": "Generate the filtered Rejected Applications PDF", "operationId": "GetRejectedApplicationsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectedApplicationsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/rejected-applications/excel": { "post": { "tags": [ "Reports" ], "summary": "Export a formatted Rejected Applications workbook", "operationId": "GetRejectedApplicationsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectedApplicationsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/monthly-application-trends": { "post": { "tags": [ "Reports" ], "summary": "Generate the filtered Monthly Application Trends PDF", "operationId": "GetMonthlyApplicationTrendsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonthlyApplicationTrendsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/monthly-application-trends/excel": { "post": { "tags": [ "Reports" ], "summary": "Export a formatted Monthly Application Trends workbook", "operationId": "GetMonthlyApplicationTrendsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonthlyApplicationTrendsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/applications-by-parish": { "post": { "tags": [ "Reports" ], "summary": "Generate the filtered Applications by Parish PDF", "operationId": "GetApplicationsByParishReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationsByParishReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/applications-by-parish/excel": { "post": { "tags": [ "Reports" ], "summary": "Export a formatted Applications by Parish workbook", "operationId": "GetApplicationsByParishExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationsByParishReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/assessment-completion": { "post": { "tags": [ "Reports" ], "operationId": "GetAssessmentCompletionReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentCompletionReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/assessment-completion/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetAssessmentCompletionExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentCompletionReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/approval-decisions": { "post": { "tags": [ "Reports" ], "summary": "Generate the filtered Approval Decisions PDF", "operationId": "GetApprovalDecisionsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecisionsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/approval-decisions/excel": { "post": { "tags": [ "Reports" ], "summary": "Export a formatted Approval Decisions workbook", "operationId": "GetApprovalDecisionsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalDecisionsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/officer-workload": { "post": { "tags": [ "Reports" ], "operationId": "GetOfficerWorkloadReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfficerWorkloadReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/officer-workload/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetOfficerWorkloadExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OfficerWorkloadReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/assessment-turnaround": { "post": { "tags": [ "Reports" ], "operationId": "GetAssessmentTurnaroundReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentTurnaroundReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/assessment-turnaround/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetAssessmentTurnaroundExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssessmentTurnaroundReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/approval-turnaround": { "post": { "tags": [ "Reports" ], "operationId": "GetApprovalTurnaroundReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalTurnaroundReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/approval-turnaround/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetApprovalTurnaroundExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalTurnaroundReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/workflow-exceptions": { "post": { "tags": [ "Reports" ], "operationId": "GetWorkflowExceptionsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowExceptionsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/workflow-exceptions/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetWorkflowExceptionsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowExceptionsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/input-demand-summary": { "post": { "tags": [ "Reports" ], "operationId": "GetInputDemandSummaryReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputDemandSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/input-demand-summary/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetInputDemandSummaryExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputDemandSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/approved-benefits": { "post": { "tags": [ "Reports" ], "operationId": "GetApprovedBenefitsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovedBenefitsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/approved-benefits/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetApprovedBenefitsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovedBenefitsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/distribution-register": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionRegisterReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/distribution-register/excel": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionRegisterReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/outstanding-distributions": { "post": { "tags": [ "Reports" ], "operationId": "GetOutstandingDistributionsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutstandingDistributionsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/outstanding-distributions/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetOutstandingDistributionsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutstandingDistributionsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/distribution-turnaround": { "post": { "tags": [ "Reports" ], "operationId": "GetDistributionTurnaroundReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionTurnaroundReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/distribution-turnaround/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetDistributionTurnaroundExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionTurnaroundReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/parish-distribution-summary": { "post": { "tags": [ "Reports" ], "operationId": "GetParishDistributionSummaryReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParishDistributionSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/parish-distribution-summary/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetParishDistributionSummaryExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParishDistributionSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/beneficiary-register": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiaryRegisterReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/beneficiary-register/excel": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BeneficiaryRegisterReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/farmer-demographics": { "post": { "tags": [ "Reports" ], "operationId": "GetFarmerDemographicsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FarmerDemographicsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/farmer-demographics/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetFarmerDemographicsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FarmerDemographicsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/geographic-coverage": { "post": { "tags": [ "Reports" ], "operationId": "GetGeographicCoverageReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicCoverageReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/geographic-coverage/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetGeographicCoverageExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeographicCoverageReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/geographic-coverage/locations": { "get": { "tags": [ "Reports" ], "operationId": "GetGeographicCoverageLocations", "parameters": [ { "name": "level", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parishId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "extensionId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeographicCoverageLocationOption" } } } } } } } }, "/api/reports/repeat-beneficiaries": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepeatBeneficiariesReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/repeat-beneficiaries/excel": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepeatBeneficiariesReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/needs-assessment-profile": { "post": { "tags": [ "Reports" ], "operationId": "GetNeedsAssessmentProfileReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NeedsAssessmentProfileReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/needs-assessment-profile/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetNeedsAssessmentProfileExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NeedsAssessmentProfileReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/non-beneficiary-analysis": { "post": { "tags": [ "Reports" ], "operationId": "GetNonBeneficiaryAnalysisReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonBeneficiaryAnalysisReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/non-beneficiary-analysis/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetNonBeneficiaryAnalysisExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NonBeneficiaryAnalysisReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/programme-performance": { "post": { "tags": [ "Reports" ], "operationId": "GetProgrammePerformanceReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgrammePerformanceReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/programme-performance/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetProgrammePerformanceExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgrammePerformanceReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/programme-uptake": { "post": { "tags": [ "Reports" ], "operationId": "GetProgrammeUptakeReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgrammeUptakeReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/programme-uptake/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetProgrammeUptakeExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgrammeUptakeReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/sponsor-portfolio": { "post": { "tags": [ "Reports" ], "operationId": "GetSponsorPortfolioReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorPortfolioReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/sponsor-portfolio/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetSponsorPortfolioExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SponsorPortfolioReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/benefit-value-summary": { "post": { "tags": [ "Reports" ], "operationId": "GetBenefitValueSummaryReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BenefitValueSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/benefit-value-summary/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetBenefitValueSummaryExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BenefitValueSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/programme-closing-summary": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgrammeClosingSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/programme-closing-summary/excel": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProgrammeClosingSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/executive-summary": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutiveSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/executive-summary/excel": { "post": { "tags": [ "Reports" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExecutiveSummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/reports/staff-assisted-applications": { "post": { "tags": [ "Reports" ], "operationId": "GetStaffAssistedApplicationsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffAssistedApplicationsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/staff-assisted-applications/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetStaffAssistedApplicationsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StaffAssistedApplicationsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/application-audit-trail": { "post": { "tags": [ "Reports" ], "operationId": "GetApplicationAuditTrailReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAuditTrailReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/application-audit-trail/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetApplicationAuditTrailExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAuditTrailReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/consent-declaration": { "post": { "tags": [ "Reports" ], "operationId": "GetConsentDeclarationReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentDeclarationReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/consent-declaration/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetConsentDeclarationExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentDeclarationReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/email-alert-configuration": { "post": { "tags": [ "Reports" ], "operationId": "GetEmailAlertConfigurationReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailAlertConfigurationReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/email-alert-configuration/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetEmailAlertConfigurationExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailAlertConfigurationReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/data-quality-exceptions": { "post": { "tags": [ "Reports" ], "operationId": "GetDataQualityExceptionsReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityExceptionsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/data-quality-exceptions/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetDataQualityExceptionsExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataQualityExceptionsReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/user-activity-summary": { "post": { "tags": [ "Reports" ], "operationId": "GetUserActivitySummaryReport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserActivitySummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/api/reports/user-activity-summary/excel": { "post": { "tags": [ "Reports" ], "operationId": "GetUserActivitySummaryExcel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserActivitySummaryReportFilter" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" } } } }, "/health": { "get": { "tags": [ "System" ], "summary": "Check API health", "responses": { "200": { "description": "OK" } } } }, "/BMS_PortalAdverts/gettodaydate": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "OK" } } } }, "/BMS_Portal_User/getuserbyid/{id}": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/BMS_Portal_User/updateuser": { "post": { "tags": [ "Users" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BMS_Portal_Users" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "ApplicationAgeingReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "format": "date-time", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "ageBand": { "type": "string", "nullable": true }, "minimumStageDays": { "type": "integer", "format": "int32", "nullable": true }, "farmerNumber": { "type": "string", "nullable": true }, "farmerName": { "type": "string", "nullable": true }, "applicationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApplicationAuditTrailReportFilter": { "type": "object", "properties": { "occurredFrom": { "type": "string", "format": "date-time", "nullable": true }, "occurredThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "staffUserId": { "type": "integer", "format": "int32", "nullable": true }, "applicationId": { "type": "integer", "format": "int32", "nullable": true }, "applicationNumber": { "type": "string", "nullable": true }, "farmerNumber": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApplicationRegisterReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "format": "date-time", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "farmerNumber": { "type": "string", "nullable": true }, "farmerName": { "type": "string", "nullable": true }, "applicationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApplicationsByParishReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "includeDrafts": { "type": "boolean" } }, "additionalProperties": false }, "ApprovalDecisionsReportFilter": { "type": "object", "properties": { "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "decisionOutcome": { "type": "string", "nullable": true }, "decisionMaker": { "type": "string", "nullable": true }, "decisionFrom": { "type": "string", "format": "date-time", "nullable": true }, "decisionThrough": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ApprovalTurnaroundReportFilter": { "type": "object", "properties": { "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "decisionMaker": { "type": "string", "nullable": true }, "outcome": { "type": "string", "nullable": true }, "decisionFrom": { "type": "string", "format": "date-time", "nullable": true }, "decisionThrough": { "type": "string", "format": "date-time", "nullable": true }, "turnaroundDaysFrom": { "type": "integer", "format": "int32", "nullable": true }, "turnaroundDaysThrough": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ApprovedBenefitsDistributionState": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32" }, "ApprovedBenefitsReportFilter": { "type": "object", "properties": { "approvalDateFrom": { "type": "string", "format": "date-time", "nullable": true }, "approvalDateThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "inputTypeId": { "type": "integer", "format": "int32", "nullable": true }, "distributionState": { "$ref": "#/components/schemas/ApprovedBenefitsDistributionState" } }, "additionalProperties": false }, "AssessmentCompletionReportFilter": { "type": "object", "properties": { "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "officer": { "type": "string", "nullable": true }, "completionState": { "type": "string", "nullable": true }, "completedFrom": { "type": "string", "format": "date-time", "nullable": true }, "completedThrough": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "AssessmentTurnaroundReportFilter": { "type": "object", "properties": { "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "assessingOfficer": { "type": "string", "nullable": true }, "assessmentFrom": { "type": "string", "format": "date-time", "nullable": true }, "assessmentThrough": { "type": "string", "format": "date-time", "nullable": true }, "minimumTurnaroundDays": { "type": "integer", "format": "int32", "nullable": true }, "maximumTurnaroundDays": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AssistedDeclaration": { "type": "object", "properties": { "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "signatureDate": { "type": "string", "format": "date-time", "nullable": true }, "farmerConsentConfirmed": { "type": "boolean" } }, "additionalProperties": false }, "AssistedHandoff": { "type": "object", "properties": { "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssistedLaunchRequest": { "type": "object", "properties": { "stakeholderId": { "type": "integer", "format": "int32" }, "programmeId": { "type": "integer", "format": "int32" }, "applicationId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BMS_ApplicationStatus": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "nullable": true }, "createDate": { "type": "string", "format": "date-time" }, "createdBy": { "type": "integer", "format": "int32" }, "updateDate": { "type": "string", "format": "date-time" }, "updatedBy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BMS_Application_Input": { "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 }, "BMS_Application_Section1A": { "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 }, "BMS_Application_Section2": { "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_Disability": { "type": "boolean" }, "affectedBy_Explain_Notes": { "type": "string", "nullable": true }, "affectedBy_Verified": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BMS_Application_Section3": { "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 }, "BMS_Portal_Users": { "type": "object", "properties": { "abis_Users_IDX": { "type": "integer", "format": "int32" }, "username": { "type": "string", "nullable": true }, "idx_User_Type": { "type": "integer", "format": "int32", "nullable": true }, "contact_Name": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "telephone": { "type": "string", "nullable": true }, "photo": { "type": "string", "nullable": true }, "create_Date": { "type": "string", "format": "date-time", "nullable": true }, "update_Date": { "type": "string", "format": "date-time", "nullable": true }, "password_Create_Date": { "type": "string", "format": "date-time", "nullable": true }, "password_Expiry_Date": { "type": "string", "format": "date-time", "nullable": true }, "rand_String": { "type": "string", "nullable": true }, "idx_user_status": { "type": "integer", "format": "int32", "nullable": true }, "roleId": { "type": "integer", "format": "int32" }, "groupId": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BeneficiaryRegisterReportFilter": { "type": "object", "properties": { "distributionFrom": { "type": "string", "format": "date-time", "nullable": true }, "distributionThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "extensionId": { "type": "integer", "format": "int32", "nullable": true }, "genderId": { "type": "integer", "format": "int32", "nullable": true }, "farmerNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BenefitValueSummaryReportFilter": { "type": "object", "properties": { "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "sponsorId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "benefitTypeId": { "type": "integer", "format": "int32", "nullable": true }, "unitId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ConsentDeclarationReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "primaryApplicantParishId": { "type": "integer", "format": "int32", "nullable": true }, "currentStatusId": { "type": "integer", "format": "int32", "nullable": true }, "evidenceState": { "type": "string", "nullable": true }, "assistanceSource": { "type": "string", "nullable": true }, "includeDrafts": { "type": "boolean" } }, "additionalProperties": false }, "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 }, "DataQualityExceptionsReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true }, "includeDrafts": { "type": "boolean" }, "farmerId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DistributionRegisterReportFilter": { "type": "object", "properties": { "distributionFrom": { "type": "string", "format": "date-time", "nullable": true }, "distributionThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "inputTypeId": { "type": "integer", "format": "int32", "nullable": true }, "farmerNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DistributionTurnaroundReportFilter": { "type": "object", "properties": { "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "distributionFrom": { "type": "string", "format": "date-time", "nullable": true }, "distributionThrough": { "type": "string", "format": "date-time", "nullable": true }, "minimumTurnaroundDays": { "type": "integer", "format": "int32", "nullable": true }, "maximumTurnaroundDays": { "type": "integer", "format": "int32", "nullable": true }, "evidenceAvailability": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DownloadFile": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "path": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailAlertConfigurationReportFilter": { "type": "object", "properties": { "eventType": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "notifyApplicant": { "type": "boolean", "nullable": true }, "recipientSearch": { "type": "string", "nullable": true }, "updatedFrom": { "type": "string", "format": "date-time", "nullable": true }, "updatedThrough": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "EmailAlertConfigurationRequest": { "type": "object", "properties": { "eventKey": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "notifyApplicant": { "type": "boolean" }, "toRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true }, "ccRecipients": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ExecutiveSummaryReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "sponsorId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "includeDrafts": { "type": "boolean" } }, "additionalProperties": false }, "FarmerDemographicsReportFilter": { "type": "object", "properties": { "distributionFrom": { "type": "string", "format": "date-time", "nullable": true }, "distributionThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "extensionId": { "type": "integer", "format": "int32", "nullable": true }, "genderId": { "type": "integer", "format": "int32", "nullable": true }, "ageBand": { "type": "string", "nullable": true }, "disability": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GeographicCoverageLocationOption": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "extensionId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GeographicCoverageReportFilter": { "type": "object", "properties": { "distributionFrom": { "type": "string", "format": "date-time", "nullable": true }, "distributionThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "extensionId": { "type": "integer", "format": "int32", "nullable": true }, "districtId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "InputDemandSummaryReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "inputTypeId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "includeDrafts": { "type": "boolean" } }, "additionalProperties": false }, "LoginRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MonthlyApplicationTrendsReportFilter": { "type": "object", "properties": { "fromMonth": { "type": "string", "format": "date-time", "nullable": true }, "toMonth": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "includeDrafts": { "type": "boolean" } }, "additionalProperties": false }, "NeedsAssessmentProfileReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "extensionId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "condition": { "type": "string", "nullable": true }, "conditionState": { "type": "string", "nullable": true }, "affectedByVerifiedCode": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "NonBeneficiaryAnalysisReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "extensionId": { "type": "integer", "format": "int32", "nullable": true }, "currentStatus": { "type": "string", "nullable": true }, "reasonCategory": { "type": "string", "nullable": true }, "farmerNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OfficerWorkloadReportFilter": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "nullable": true }, "through": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "officer": { "type": "string", "nullable": true }, "stage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OutstandingApplicationsReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdTo": { "type": "string", "format": "date-time", "nullable": true }, "stageStatusId": { "type": "integer", "format": "int32", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "minimumDaysOutstanding": { "type": "integer", "format": "int32", "nullable": true }, "farmerNumber": { "type": "string", "nullable": true }, "farmerName": { "type": "string", "nullable": true }, "applicationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OutstandingDistributionsReportFilter": { "type": "object", "properties": { "approvalFrom": { "type": "string", "format": "date-time", "nullable": true }, "approvalThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "inputTypeId": { "type": "integer", "format": "int32", "nullable": true }, "minimumPendingDays": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ParishDistributionSummaryReportFilter": { "type": "object", "properties": { "distributionFrom": { "type": "string", "format": "date-time", "nullable": true }, "distributionThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "inputTypeId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "PortalRegistrationRequest": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/BMS_Portal_Users" }, "dateOfBirth": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ProgrammeClosingSummaryReportFilter": { "type": "object", "properties": { "expiryFrom": { "type": "string", "format": "date-time", "nullable": true }, "expiryThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "sponsorId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ProgrammePerformanceReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "sponsorId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "primaryApplicantParishId": { "type": "integer", "format": "int32", "nullable": true }, "includeDrafts": { "type": "boolean" }, "includeEmptyProgrammes": { "type": "boolean" } }, "additionalProperties": false }, "ProgrammeUptakeReportFilter": { "type": "object", "properties": { "applicationCreatedFrom": { "type": "string", "format": "date-time", "nullable": true }, "applicationCreatedThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "sponsorId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "includeProgrammesWithNoActivity": { "type": "boolean" } }, "additionalProperties": false }, "RejectedApplicationsReportFilter": { "type": "object", "properties": { "rejectedFrom": { "type": "string", "format": "date-time", "nullable": true }, "rejectedTo": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "rejectionStage": { "type": "string", "nullable": true }, "reasonContains": { "type": "string", "nullable": true }, "missingReasonOnly": { "type": "boolean" }, "farmerNumber": { "type": "string", "nullable": true }, "farmerName": { "type": "string", "nullable": true }, "applicationNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RepeatBeneficiariesReportFilter": { "type": "object", "properties": { "distributionFrom": { "type": "string", "format": "date-time", "nullable": true }, "distributionThrough": { "type": "string", "format": "date-time", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "extensionId": { "type": "integer", "format": "int32", "nullable": true }, "minimumDistinctProgrammes": { "type": "integer", "format": "int32" }, "farmerNumber": { "type": "string", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "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" }, "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 }, "SponsorPortfolioReportFilter": { "type": "object", "properties": { "sponsorId": { "type": "integer", "format": "int32", "nullable": true }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "applicationCreatedFrom": { "type": "string", "format": "date-time", "nullable": true }, "applicationCreatedThrough": { "type": "string", "format": "date-time", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "includeInactive": { "type": "boolean" } }, "additionalProperties": false }, "StaffAssistedApplicationsReportFilter": { "type": "object", "properties": { "sessionCreatedFrom": { "type": "string", "format": "date-time", "nullable": true }, "sessionCreatedThrough": { "type": "string", "format": "date-time", "nullable": true }, "staffUserId": { "type": "integer", "format": "int32", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "submitted": { "type": "boolean", "nullable": true }, "farmerNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TokenRequest": { "type": "object", "properties": { "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "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 }, "UserActivitySummaryReportFilter": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "nullable": true }, "through": { "type": "string", "format": "date-time", "nullable": true }, "staffUserId": { "type": "integer", "format": "int32", "nullable": true }, "staffName": { "type": "string", "nullable": true }, "action": { "type": "string", "nullable": true } }, "additionalProperties": false }, "WorkflowExceptionsReportFilter": { "type": "object", "properties": { "createdFrom": { "type": "string", "format": "date-time", "nullable": true }, "createdThrough": { "type": "string", "format": "date-time", "nullable": true }, "programmeId": { "type": "integer", "format": "int32", "nullable": true }, "parishId": { "type": "integer", "format": "int32", "nullable": true }, "statusId": { "type": "integer", "format": "int32", "nullable": true }, "exceptionCategory": { "type": "string", "nullable": true }, "severity": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Enter JWT token as: Bearer {token}", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { } ], "tags": [ { "name": "Account" }, { "name": "Adverts" }, { "name": "Application status" }, { "name": "Applications" }, { "name": "Assisted applications" }, { "name": "Authentication" }, { "name": "BenefitsPortal" }, { "name": "BMS.API" }, { "name": "Dashboard" }, { "name": "Dashboard Email Alerts" }, { "name": "Reference data" }, { "name": "ReferenceData" }, { "name": "Registration" }, { "name": "Reports" }, { "name": "System" }, { "name": "Users" } ] }