{ "openapi": "3.0.0", "paths": { "/api": { "get": { "operationId": "AppController_getApi", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["App"] } }, "/api/email-test": { "post": { "operationId": "AppController_testEmail", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["App"] } }, "/api/health": { "get": { "operationId": "AppController_getHealth", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["App"] } }, "/api/callback": { "post": { "operationId": "ProcessCallbackController_processCallback", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessCallbackDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormFilloutProcessResult" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["ProcessCallback"] } }, "/api/callback/__internal": { "post": { "operationId": "ProcessCallbackController_internalProcessCallback", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormFilloutProcessResult" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["ProcessCallback"] } }, "/api/auth/self": { "post": { "operationId": "AuthController_entitySelf", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfEntityResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/auth/public/register-company": { "post": { "operationId": "AuthPublicRegisterCompany", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompanyDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "summary": "", "tags": ["Auth", "Auth"] } }, "/api/auth/login": { "post": { "operationId": "AuthController_signIn", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginEntityDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/auth/logout": { "post": { "operationId": "AuthController_signOut", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/auth/school/login": { "post": { "operationId": "AuthController_schoolSignIn", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginSchoolDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/auth/school/self": { "post": { "operationId": "AuthController_schoolSelf", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SelfSchoolResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/auth/school/logout": { "post": { "operationId": "AuthController_schoolSignOut", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/auth/docs/login/request": { "post": { "operationId": "AuthController_signatoryLoginRequest", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatoryRequestOtpDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatoryRequestOtpResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/auth/docs/login/verify": { "post": { "operationId": "AuthController_signatoryLoginVerify", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatoryVerifyOtpDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/auth/docs/logout": { "post": { "operationId": "AuthController_signatorySignOut", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Auth"] } }, "/api/docs/auth/magic-link": { "get": { "operationId": "SignatoryMagicLinkController_magicLinkLogin", "parameters": [ { "name": "id", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "hash", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "redirect", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MagicLinkResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SignatoryMagicLink"] } }, "/api/entities/list": { "get": { "operationId": "EntitiesController_getList", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Entities"] } }, "/api/entities/me": { "get": { "operationId": "EntitiesController_getSelf", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Entities"] } }, "/api/entities/reconsider": { "post": { "operationId": "EntitiesController_reconsider", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReconsiderEntityDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Entities"] } }, "/api/school/entities/my-partners": { "get": { "operationId": "SchoolEntitiesController_getMyPartners", "parameters": [ { "name": "offset", "required": true, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolEntities"] } }, "/api/school/entities/requests": { "get": { "operationId": "SchoolEntitiesController_getMyRequests", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolEntities"] } }, "/api/school/entities/requests/{id}": { "get": { "operationId": "SchoolEntitiesController_getRequest", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolEntities"] } }, "/api/school/entities/requests/{id}/approve": { "post": { "operationId": "SchoolEntitiesController_approveRequest", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEntityRequestReplyDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolEntities"] } }, "/api/school/entities/requests/{id}/deny": { "post": { "operationId": "SchoolEntitiesController_denyRequest", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEntityRequestReplyDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolEntities"] } }, "/api/school/entities/blacklist/{entityId}": { "post": { "operationId": "SchoolEntitiesController_blacklistEntity", "parameters": [ { "name": "entityId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolEntities"] } }, "/api/school/entities/{id}": { "get": { "operationId": "SchoolEntitiesController_getAPartner", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolEntities"] } }, "/api/school/entities": { "post": { "operationId": "SchoolEntitiesController_createCompany", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCompanyDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolEntities"] } }, "/api/school/moa/mine": { "get": { "operationId": "SchoolMoaController_getMine", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaRequestsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolMoa"] } }, "/api/school/moa/thread/{id}": { "get": { "operationId": "SchoolMoaController_getOneThread", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaThreadResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolMoa"] } }, "/api/school/moa/history/{id}": { "get": { "operationId": "SchoolMoaController_getOneHistory", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaHistoryResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolMoa"] } }, "/api/school/moa/{id}": { "get": { "operationId": "SchoolMoaController_getOne", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaRequestResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolMoa"] } }, "/api/school/moa/{id}/deny": { "post": { "operationId": "SchoolMoaController_deny", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaDenyDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolMoa"] } }, "/api/school/moa/{id}/respond": { "post": { "operationId": "SchoolMoaController_respond", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaRespondDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolMoa"] } }, "/api/school/moa/sign-custom": { "post": { "operationId": "SchoolMoaController_signApprovedCustom", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignCustomMoaRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCustomMoaRequestResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["SchoolMoa"] } }, "/api/entity/moa/mine": { "get": { "operationId": "EntityMoaController_getMine", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaRequestsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["EntityMoa"] } }, "/api/entity/moa/me/latest": { "get": { "operationId": "EntityMoaController_getLatestMoaRequest", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaRequestResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["EntityMoa"] } }, "/api/entity/moa/request": { "post": { "operationId": "EntityMoaController_requestNewStandard", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewStandardMoaRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewStandardMoaRequestResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["EntityMoa"] } }, "/api/entity/moa/thread/{id}": { "get": { "operationId": "EntityMoaController_getOneThread", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaThreadResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["EntityMoa"] } }, "/api/entity/moa/thread/{id}/document": { "get": { "operationId": "EntityMoaController_getOneThreadLatestDocument", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoaDocumentThreadResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["EntityMoa"] } }, "/api/entity/moa/request-custom": { "post": { "operationId": "EntityMoaController_requestNewCustom", "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/NewCustomMoaRequestDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCustomMoaRequestResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["EntityMoa"] } }, "/api/entity/moa/{id}/respond": { "post": { "operationId": "EntityMoaController_respond", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MoaRespondDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["EntityMoa"] } }, "/api/docs/query/{code}": { "get": { "operationId": "DocsController_getByVerificationCode", "parameters": [ { "name": "code", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryDocResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Docs"] } }, "/api/docs/moa/{id}": { "get": { "operationId": "DocsController_getMoaSignedDocument", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryMoaResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Docs"] } }, "/api/docs/student-moa": { "post": { "operationId": "DocsController_pushStudentMoa", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["Docs"] } }, "/api/docs/student-moa/{id}": { "get": { "operationId": "DocsController_getStudentMoa", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "tags": ["Docs"] } }, "/api/docs/entity-forms": { "get": { "operationId": "DocsController_getEntityForms", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatoryFormtemplatesResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Docs"] } }, "/api/schools/me": { "get": { "operationId": "SchoolsController_getSelfAccount", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchoolAccountResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/schools/own": { "get": { "operationId": "SchoolsController_getSelfSchool", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchoolResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/schools/company-requests": { "get": { "operationId": "SchoolsController_listCompanyRequests", "parameters": [ { "name": "offset", "required": true, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/schools/company-requests/{entityId}": { "get": { "operationId": "SchoolsController_getCompanyRequestForEntity", "parameters": [ { "name": "entityId", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/schools/active-moas": { "get": { "operationId": "SchoolsController_listActiveMoas", "parameters": [ { "name": "offset", "required": true, "in": "query", "schema": { "type": "number" } }, { "name": "limit", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/schools/stats/active-moas": { "get": { "operationId": "SchoolsController_countActiveMoas", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/schools/stats/pending-moas": { "get": { "operationId": "SchoolsController_countPendingMoas", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/schools/stats/active-entities": { "get": { "operationId": "SchoolsController_countActiveEntities", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/schools/stats/registered-entities": { "get": { "operationId": "SchoolsController_countRegisteredEntities", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Schools"] } }, "/api/entity/schools/my-partners": { "get": { "operationId": "EntitySchoolsController_getMyPartners", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchoolsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["EntitySchools"] } }, "/api/forms/registry": { "get": { "operationId": "FormsController_getRegistry", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormRegistryResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/form-templates": { "get": { "operationId": "FormsController_getFormGroupTemplates", "parameters": [ { "name": "formGroupId", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/last-updated/__internal": { "get": { "operationId": "FormsController_getFormTemplatesLastUpdated", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/form-metadata": { "get": { "operationId": "FormsController_getRegistryFormMetadata", "parameters": [ { "name": "name", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "version", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormMetadataResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/form-document": { "get": { "operationId": "FormsController_getRegistryFormDocument", "parameters": [ { "name": "name", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "version", "required": true, "in": "query", "schema": { "type": "number" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormDocumentResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/form-latest": { "get": { "operationId": "FormsController_getLatestFormDocumentAndMetadata", "parameters": [ { "name": "name", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormLatestResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/register-form": { "post": { "operationId": "FormsController_registerForm", "parameters": [], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/RegisterFormSchemaDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/fields": { "get": { "operationId": "FormsController_getFieldRegistry", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRegistryResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/add-field": { "post": { "operationId": "FormsController_registerField", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterFieldDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/edit-field": { "post": { "operationId": "FormsController_updateField", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFieldDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/field": { "get": { "operationId": "FormsController_getFieldFromRegistry", "parameters": [ { "name": "id", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRequestResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/process": { "get": { "operationId": "FormsController_getFormProcess", "parameters": [ { "name": "formProcessId", "required": true, "in": "query", "schema": { "type": "string" } }, { "name": "signingPartyId", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormProcessResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/continue": { "post": { "operationId": "FormsController_continueFormProcess", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContinueFormDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/reject": { "post": { "operationId": "FormsController_rejectFormProcess", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectFormDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/cancel": { "post": { "operationId": "FormsController_cancelFormProcess", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelFormDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/cancel/__internal": { "post": { "operationId": "FormsController_cancelFormProcessInternally", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/resend/__internal": { "post": { "operationId": "FormsController_resendFormProcessInternally", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/initiate": { "post": { "operationId": "FormsController_initiateFormProcess", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateFormDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/initiate/__internal": { "post": { "operationId": "FormsController_initiateFormProcessInternally", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/fillout": { "post": { "operationId": "FormsController_filloutFormProcess", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateFormDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/fillout/__internal": { "post": { "operationId": "FormsController_filloutFormProcessInternally", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/test-generate": { "post": { "operationId": "FormsController_generateTestForm", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitiateFormDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/bulk-processes": { "post": { "operationId": "FormsController_getBulkFormProcesses", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExportForSignatoryDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportableFormsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/forms/mark-first-viewed": { "post": { "operationId": "FormsController_markFormAsFirstViewed", "parameters": [ { "name": "formProcessId", "required": true, "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Forms"] } }, "/api/form-groups": { "get": { "operationId": "FormGroupsController_getAllFormGroups", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["FormGroups"] }, "post": { "operationId": "FormGroupsController_createFormGroup", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFormGroupDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["FormGroups"] } }, "/api/form-groups/{id}": { "get": { "operationId": "FormGroupsController_getFormGroupById", "parameters": [ { "name": "id", "required": true, "in": "path", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["FormGroups"] } }, "/api/form-groups/add-form": { "post": { "operationId": "FormGroupsController_addFormToGroup", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddFormToGroupDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["FormGroups"] } }, "/api/form-sync/compare": { "get": { "operationId": "FormSyncController_compareFormVersions", "parameters": [], "responses": { "200": { "description": "" } }, "tags": ["FormSync"] } }, "/api/form-sync/sync": { "post": { "operationId": "FormSyncController_syncAllForms", "parameters": [], "responses": { "201": { "description": "" } }, "tags": ["FormSync"] } }, "/api/form-sync/sync-single": { "post": { "operationId": "FormSyncController_syncSingleForm", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncSingleFormDto" } } } }, "responses": { "201": { "description": "" } }, "tags": ["FormSync"] } }, "/api/signatory/create/__internal": { "post": { "operationId": "SignatoryController_createAccountInternally", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSignatoryResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Signatory"] } }, "/api/signatory/me": { "get": { "operationId": "SignatoryController_getSelf", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatorySelfResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Signatory"] }, "put": { "operationId": "SignatoryController_updateSelf", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSignatoryDto" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Signatory"] } }, "/api/signatory/me/forms": { "get": { "operationId": "SignatoryController_getSignedDocumentsBySignatory", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatorySignedFormsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Signatory"] } }, "/api/signatory/me/forms/__internal": { "post": { "operationId": "SignatoryController_getSignedDocumentsBySignatoryInternally", "parameters": [], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatorySignedFormsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Signatory"] } }, "/api/signatory/me/form-settings": { "post": { "operationId": "SignatoryController_getSignatoryFormSettings", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSignatoryFormSettingsRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSignatoryFormSettingsResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Signatory"] }, "put": { "operationId": "SignatoryController_setSignatoryFormSettings", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetSignatoryFormSettingsRequest" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BaseResponse" } } } }, "400": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "tags": ["Signatory"] } } }, "info": { "title": "BetterInternship MOA API", "description": "The official API of the BetterInternship MOA platform.", "version": "1.0", "contact": {} }, "tags": [], "servers": [], "components": { "schemas": { "ProcessCallbackDto": { "type": "object", "properties": {} }, "FormFilloutProcessResult": { "type": "object", "properties": {} }, "ErrorResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "type": "number" }, "message": { "type": "string" } }, "required": ["success", "status", "message"] }, "SelfEntityResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "entity": { "type": "object" } }, "required": ["success", "message", "entity"] }, "ContactDto": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } }, "required": ["name", "phone", "email"] }, "ProfileDto": { "type": "object", "properties": { "acceptsNonUniversityInterns": { "type": "boolean" }, "ongoingMoaWithDlsu": { "type": "boolean" } } }, "CreateCompanyDto": { "type": "object", "properties": { "display_name": { "type": "string" }, "legal_name": { "type": "string" }, "office_location": { "type": "string" }, "industry": { "type": "string" }, "contact": { "$ref": "#/components/schemas/ContactDto" }, "profile": { "$ref": "#/components/schemas/ProfileDto" }, "password": { "type": "string" }, "type": { "type": "string" } }, "required": [ "display_name", "legal_name", "office_location", "industry", "contact", "password" ] }, "BaseResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"] }, "LoginEntityDto": { "type": "object", "properties": { "legal_entity_name": { "type": "string" }, "password": { "type": "string" } }, "required": ["legal_entity_name", "password"] }, "LoginSchoolDto": { "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } }, "required": ["email", "password"] }, "SelfSchoolResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "school": { "type": "object" }, "schoolAccount": { "type": "object" } }, "required": ["success", "message", "school", "schoolAccount"] }, "SignatoryRequestOtpDto": { "type": "object", "properties": { "email": { "type": "string" } }, "required": ["email"] }, "SignatoryRequestOtpResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "resendIn": { "type": "number" }, "ttl": { "type": "number" } }, "required": ["success", "message", "resendIn", "ttl"] }, "SignatoryVerifyOtpDto": { "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" } }, "required": ["email", "code"] }, "MagicLinkResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "redirect": { "type": "string" } }, "required": ["success", "message", "redirect"] }, "PublicEntityDto": { "type": "object", "properties": { "id": { "type": "string" }, "display_name": { "type": "object", "nullable": true }, "legal_identifier": { "type": "string" }, "type": { "type": "object" }, "contact_name": { "type": "object" }, "contact_email": { "type": "object" }, "contact_phone": { "type": "object" }, "address": { "type": "object" } }, "required": ["id", "display_name", "legal_identifier", "type"] }, "EntitiesResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/PublicEntityDto" } } }, "required": ["success", "message", "entities"] }, "EntityResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "entity": { "$ref": "#/components/schemas/PublicEntityDto" } }, "required": ["success", "message", "entity"] }, "ReconsiderEntityDto": { "type": "object", "properties": { "school_id": { "type": "string" } }, "required": ["school_id"] }, "RequestsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "requests": { "type": "array", "items": { "type": "string" } } }, "required": ["success", "message", "requests"] }, "NewEntityRequestReplyDto": { "type": "object", "properties": { "reason": { "type": "string" } }, "required": ["reason"] }, "MoaRequestsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "requests": { "type": "array", "items": { "type": "string" } } }, "required": ["success", "message", "requests"] }, "MoaThreadResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "messages": { "type": "array", "items": { "type": "string" } } }, "required": ["success", "message", "messages"] }, "MoaHistoryResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "history": { "type": "object" } }, "required": ["success", "message", "history"] }, "MoaRequestResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "request": { "type": "object" } }, "required": ["success", "message", "request"] }, "MoaDenyDto": { "type": "object", "properties": { "message": { "type": "string" } }, "required": ["message"] }, "MoaRespondDto": { "type": "object", "properties": { "message": { "type": "string" }, "revised_moa": { "type": "string", "format": "binary" } }, "required": ["message"] }, "SignCustomMoaRequestDto": { "type": "object", "properties": { "entity_id": { "type": "string" }, "request_id": { "type": "string" }, "additional_form_schema": { "type": "array", "items": { "type": "string" } } }, "required": ["entity_id", "request_id", "additional_form_schema"] }, "NewCustomMoaRequestResponse": { "type": "object", "properties": { "requestId": { "type": "string" } }, "required": ["requestId"] }, "NewStandardMoaRequestDto": { "type": "object", "properties": { "school_id": { "type": "string" }, "entity_signatory_name": { "type": "string" }, "entity_signatory_title": { "type": "string" } }, "required": ["school_id", "entity_signatory_name", "entity_signatory_title"] }, "NewStandardMoaRequestResponse": { "type": "object", "properties": { "moaRequestId": { "type": "string" }, "signedDocumentId": { "type": "string" }, "verificationCode": { "type": "string" } }, "required": ["moaRequestId", "signedDocumentId", "verificationCode"] }, "MoaDocumentThreadResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "document_url": { "type": "string" } }, "required": ["success", "message", "document_url"] }, "NewCustomMoaRequestDto": { "type": "object", "properties": { "school_id": { "type": "string" }, "reason": { "type": "string" }, "proposed_moa": { "type": "string", "format": "binary" } }, "required": ["school_id", "reason", "proposed_moa"] }, "SignatoryInfo": { "type": "object", "properties": { "name": { "type": "string" } }, "required": ["name"] }, "SignedOrExternalDocumentInfo": { "type": "object", "properties": { "url": { "type": "string" }, "signatories": { "type": "array", "items": { "$ref": "#/components/schemas/SignatoryInfo" } }, "date_made": { "type": "string" }, "form_label": { "type": "string" }, "uploaded_at": { "type": "string" }, "verification_code": { "type": "string" }, "code": { "type": "string" } }, "required": [ "url", "signatories", "date_made", "form_label", "uploaded_at", "verification_code", "code" ] }, "QueryDocResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "signedDocument": { "$ref": "#/components/schemas/SignedOrExternalDocumentInfo" } }, "required": ["success", "message", "signedDocument"] }, "QueryMoaResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "signedDocument": { "type": "object" } }, "required": ["success", "message", "signedDocument"] }, "SignatoryFormtemplatesResponse": { "type": "object", "properties": { "forms": { "type": "array", "items": { "type": "string" } } }, "required": ["forms"] }, "SchoolAccountResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "school_account": { "type": "object" } }, "required": ["success", "message", "school_account"] }, "SchoolResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "school": { "type": "object" } }, "required": ["success", "message", "school"] }, "CountResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "count": { "type": "number" } }, "required": ["success", "message", "count"] }, "SchoolsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "schools": { "type": "array", "items": { "type": "string" } } }, "required": ["success", "message", "schools"] }, "FormRegistryEntry": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "version": { "type": "number" }, "time_generated": { "format": "date-time", "type": "string" } }, "required": ["name", "label", "version", "time_generated"] }, "FormRegistryResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "registry": { "type": "array", "items": { "$ref": "#/components/schemas/FormRegistryEntry" } } }, "required": ["success", "message", "registry"] }, "FormTemplatePreview": { "type": "object", "properties": { "formDocument": { "type": "string" }, "formVersion": { "type": "number" }, "formName": { "type": "string" }, "formLabel": { "type": "string" }, "time_generated": { "format": "date-time", "type": "string" } }, "required": ["formDocument", "formVersion", "formName", "formLabel", "time_generated"] }, "FormTemplatesResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "formTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/FormTemplatePreview" } } }, "required": ["success", "message", "formTemplates"] }, "FormField": { "type": "object", "properties": { "field": { "type": "string" }, "type": { "type": "string", "enum": ["text", "signature"] }, "x": { "type": "number" }, "y": { "type": "number" }, "w": { "type": "number" }, "h": { "type": "number" }, "page": { "type": "number" }, "label": { "type": "string" }, "tooltip_label": { "type": "string" }, "shared": { "type": "boolean" }, "signing_party_id": { "type": "string" }, "source": { "type": "string", "enum": ["auto", "prefill", "derived", "manual"] }, "prefiller": { "type": "string" }, "validator": { "type": "string" }, "validator_ir": { "type": "object", "nullable": true } }, "required": [ "field", "type", "x", "y", "w", "h", "page", "label", "tooltip_label", "shared", "signing_party_id", "source", "prefiller", "validator" ] }, "FormPhantomField": { "type": "object", "properties": { "field": { "type": "string" }, "type": { "type": "string", "enum": ["text", "signature"] }, "label": { "type": "string" }, "tooltip_label": { "type": "string" }, "shared": { "type": "boolean" }, "signing_party_id": { "type": "string" }, "source": { "type": "string", "enum": ["auto", "prefill", "derived", "manual"] }, "prefiller": { "type": "string" }, "validator": { "type": "string" }, "validator_ir": { "type": "object", "nullable": true } }, "required": [ "field", "type", "label", "tooltip_label", "shared", "signing_party_id", "source", "prefiller", "validator" ] }, "FormBlock": { "type": "object", "properties": { "_id": { "type": "string" }, "block_type": { "type": "string", "enum": ["header", "paragraph", "form_field", "form_phantom_field", "divider", "image"] }, "order": { "type": "number" }, "signing_party_id": { "type": "string" }, "text_content": { "type": "string" }, "field_schema": { "$ref": "#/components/schemas/FormField" }, "phantom_field_schema": { "$ref": "#/components/schemas/FormPhantomField" } }, "required": [ "_id", "block_type", "order", "signing_party_id", "field_schema", "phantom_field_schema" ] }, "Form": { "type": "object", "properties": { "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/FormBlock" } } }, "required": ["blocks"] }, "FormSignatory": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "title": { "type": "string" }, "honorific": { "type": "string" } }, "required": ["email"] }, "SignatorySource": { "type": "object", "properties": { "_id": { "type": "string" }, "label": { "type": "string" }, "tooltip_label": { "type": "string" } }, "required": ["_id", "label", "tooltip_label"] }, "FormSigningParty": { "type": "object", "properties": { "_id": { "type": "string" }, "order": { "type": "number" }, "signatory_title": { "type": "string" }, "signatory_account": { "$ref": "#/components/schemas/FormSignatory" }, "signatory_source": { "$ref": "#/components/schemas/SignatorySource" }, "signed": { "type": "boolean" } }, "required": ["_id", "order", "signatory_title", "signatory_account", "signatory_source"] }, "FormSubscriber": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": ["name", "email"] }, "FormMetadata": { "type": "object", "properties": { "schema_version": { "type": "number" }, "name": { "type": "string" }, "label": { "type": "string" }, "version": { "type": "number" }, "schema": { "$ref": "#/components/schemas/Form" }, "signing_parties": { "type": "array", "items": { "$ref": "#/components/schemas/FormSigningParty" } }, "subscribers": { "type": "array", "items": { "$ref": "#/components/schemas/FormSubscriber" } } }, "required": ["schema_version", "name", "label", "version", "schema", "signing_parties"] }, "FormMetadataResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "formMetadata": { "$ref": "#/components/schemas/FormMetadata" } }, "required": ["success", "message", "formMetadata"] }, "FormDocumentResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "formDocument": { "type": "string" } }, "required": ["success", "message", "formDocument"] }, "FormTemplate": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "version": { "type": "number" }, "base_document_id": { "type": "string" }, "time_generated": { "type": "string" } }, "required": ["name", "label", "version", "base_document_id", "time_generated"] }, "FormLatestResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "formMetadata": { "$ref": "#/components/schemas/FormMetadata" }, "formTemplate": { "$ref": "#/components/schemas/FormTemplate" }, "formVersion": { "type": "number" }, "documentUrl": { "type": "string" } }, "required": [ "success", "message", "formMetadata", "formTemplate", "formVersion", "documentUrl" ] }, "RegisterFormSchemaDto": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "schema_version": { "type": "number" }, "schema": { "$ref": "#/components/schemas/Form" }, "signing_parties": { "type": "array", "items": { "$ref": "#/components/schemas/FormSigningParty" } }, "subscribers": { "type": "array", "items": { "$ref": "#/components/schemas/FormSubscriber" } }, "base_document": { "type": "string", "format": "binary" } }, "required": ["name", "label", "schema_version", "schema", "signing_parties"] }, "FieldRegistryEntryDetails": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": ["text", "signature"] }, "party": { "type": "string" }, "source": { "type": "string", "enum": ["auto", "prefill", "derived", "manual"] }, "tag": { "type": "string" }, "shared": { "type": "boolean" }, "preset": { "type": "string" }, "prefiller": { "type": "string", "nullable": true }, "tooltip_label": { "type": "string", "nullable": true }, "validator": { "type": "string", "nullable": true }, "validator_ir": { "type": "object", "nullable": true }, "is_phantom": { "type": "boolean" } }, "required": [ "id", "name", "label", "type", "party", "source", "tag", "shared", "preset", "prefiller", "tooltip_label", "validator", "is_phantom" ] }, "FieldRegistryResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldRegistryEntryDetails" } } }, "required": ["success", "message", "fields"] }, "RegisterFieldDto": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "party": { "type": "string" }, "shared": { "type": "boolean" }, "source": { "type": "string", "enum": ["auto", "prefill", "derived", "manual"] }, "tag": { "type": "string" }, "prefiller": { "type": "string", "nullable": true }, "preset": { "type": "string" }, "tooltip_label": { "type": "string", "nullable": true }, "validator": { "type": "string", "nullable": true }, "validator_ir": { "type": "object", "nullable": true }, "is_phantom": { "type": "boolean" } }, "required": [ "name", "label", "type", "party", "shared", "source", "tag", "prefiller", "preset", "tooltip_label", "validator", "is_phantom" ] }, "UpdateFieldDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "shared": { "type": "boolean" }, "party": { "type": "string" }, "source": { "type": "string", "enum": ["auto", "prefill", "derived", "manual"] }, "tag": { "type": "string" }, "prefiller": { "type": "string", "nullable": true }, "preset": { "type": "string" }, "tooltip_label": { "type": "string", "nullable": true }, "validator": { "type": "string", "nullable": true }, "validator_ir": { "type": "object", "nullable": true }, "is_phantom": { "type": "boolean" } }, "required": [ "id", "name", "label", "type", "shared", "party", "source", "tag", "prefiller", "preset", "tooltip_label", "validator", "is_phantom" ] }, "FieldRequestResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "field": { "$ref": "#/components/schemas/FieldRegistryEntryDetails" } }, "required": ["success", "message", "field"] }, "FormProcessDto": { "type": "object", "properties": { "my_signing_party_id": { "type": "string" }, "display_information": { "type": "object" }, "form_label": { "type": "string" }, "form_name": { "type": "string" }, "form_version": { "type": "number" }, "schema_version": { "type": "number" }, "latest_document_url": { "type": "string" }, "prefilled_document_id": { "type": "string" }, "signed_document_id": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "my_signing_party_id", "display_information", "form_label", "form_name", "form_version", "schema_version", "latest_document_url", "prefilled_document_id", "signed_document_id", "timestamp" ] }, "FormProcessResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "formProcess": { "$ref": "#/components/schemas/FormProcessDto" } }, "required": ["success", "message", "formProcess"] }, "ContinueFormDto": { "type": "object", "properties": { "formProcessId": { "type": "string" }, "supposedSigningPartyId": { "type": "string" }, "values": { "type": "object" }, "audit": { "type": "object" } }, "required": ["formProcessId", "supposedSigningPartyId", "values", "audit"] }, "RejectFormDto": { "type": "object", "properties": { "formProcessId": { "type": "string" }, "reason": { "type": "string" } }, "required": ["formProcessId", "reason"] }, "CancelFormDto": { "type": "object", "properties": { "formProcessId": { "type": "string" } }, "required": ["formProcessId"] }, "InitiateFormDto": { "type": "object", "properties": { "formName": { "type": "string" }, "formVersion": { "type": "number" }, "values": { "type": "object" }, "audit": { "type": "object" } }, "required": ["formName", "formVersion", "values", "audit"] }, "ProcessResponse": { "type": "object", "properties": { "processId": { "type": "string" }, "processName": { "type": "string" }, "processCallbackUrl": { "type": "string" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["processId", "processName", "processCallbackUrl", "success", "message"] }, "GetExportForSignatoryDto": { "type": "object", "properties": { "signatoryId": { "type": "string" }, "formName": { "type": "string" } }, "required": ["signatoryId", "formName"] }, "ExportableFormDto": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "inputs": { "type": "object" }, "signingParties": { "type": "array", "items": { "type": "object" } }, "formLabel": { "type": "string" }, "formName": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "documentUrl": { "type": "string", "nullable": true } }, "required": [ "id", "status", "inputs", "signingParties", "formLabel", "formName", "createdAt", "updatedAt", "documentUrl" ] }, "ExportableFormsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "processes": { "type": "array", "items": { "$ref": "#/components/schemas/ExportableFormDto" } } }, "required": ["success", "message", "processes"] }, "CreateFormGroupDto": { "type": "object", "properties": { "name": { "type": "string" } } }, "AddFormToGroupDto": { "type": "object", "properties": { "formName": { "type": "string" }, "groupId": { "type": "string" } }, "required": ["formName", "groupId"] }, "SyncSingleFormDto": { "type": "object", "properties": { "formName": { "type": "string", "description": "The name of the form to sync", "example": "internship-agreement" } }, "required": ["formName"] }, "CreateSignatoryResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"] }, "SignatoryProfile": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "object" }, "honorific": { "type": "object" }, "autofill": { "type": "object" }, "autoFormPermissions": { "type": "object" }, "coordinatorId": { "type": "string" }, "god": { "type": "boolean" } }, "required": ["id", "email", "name", "title", "honorific", "autofill", "autoFormPermissions"] }, "SignatorySelfResponse": { "type": "object", "properties": { "profile": { "$ref": "#/components/schemas/SignatoryProfile" } }, "required": ["profile"] }, "SigningParty": { "type": "object", "properties": { "_id": { "type": "string" }, "order": { "type": "number" }, "signatory_account": { "$ref": "#/components/schemas/FormSignatory" }, "signed": { "type": "boolean" } }, "required": ["_id", "order", "signatory_account", "signed"] }, "FormProcess": { "type": "object", "properties": { "prefilled_document_id": { "type": "string" }, "pending_document_id": { "type": "string" }, "signed_document_id": { "type": "string" }, "latest_document_url": { "type": "string" }, "rejection_reason": { "type": "string" }, "display_information": { "type": "object", "additionalProperties": { "type": "string" } }, "signing_parties": { "type": "array", "items": { "$ref": "#/components/schemas/SigningParty" } } }, "required": [ "prefilled_document_id", "pending_document_id", "signed_document_id", "latest_document_url", "rejection_reason", "display_information", "signing_parties" ] }, "_SignatoryForm": { "type": "object", "properties": { "id": { "type": "string" }, "form_label": { "type": "string" }, "form_name": { "type": "string" }, "form_process_id": { "type": "string" }, "form_process_status": { "type": "string" }, "signatory_id": { "type": "string" }, "rejection_response": { "type": "string" }, "timestamp": { "type": "string" }, "form_processes": { "$ref": "#/components/schemas/FormProcess" }, "first_viewed": { "type": "string", "format": "date-time", "nullable": true } }, "required": [ "id", "form_label", "form_name", "form_process_id", "form_process_status", "signatory_id", "rejection_response", "timestamp", "form_processes", "first_viewed" ] }, "SignatorySignedFormsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "forms": { "type": "array", "items": { "$ref": "#/components/schemas/_SignatoryForm" } } }, "required": ["success", "message", "forms"] }, "GetSignatoryFormSettingsRequest": { "type": "object", "properties": { "formName": { "type": "string" } }, "required": ["formName"] }, "GetSignatoryFormSettingsResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "settings": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FormSettings" } } }, "required": ["success", "message", "settings"] }, "SetSignatoryFormSettingsRequest": { "type": "object", "properties": { "formName": { "type": "string" }, "settings": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FormSettings" } }, "audit": { "type": "object" } }, "required": ["formName", "settings", "audit"] }, "UpdateSignatoryDto": { "type": "object", "properties": {} } } } }