package
0.0.0-20241105225930-313ccac85a54
Repository: https://github.com/geldnetworkmvp/geldmvpbackend.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
@Summary Save Data Collection for Master Data Container @Description This creates a collections for Master Data Containers based on container type @Tags data collection @Accept json @Produce json @Param dataCollectionBody body model.DataCollection true "Data Collection Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /record/save [post].
@Summary Save Master Data Container submitted by Geld Configurations @Description This creates a container to whole master data records per type @Tags master data container @Accept json @Produce json @Param masterDataContainerBody body model.MasterData true "Master Data Container Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /masterdata/save [post].
All functions here a triggered by api Calls and invokes respective BusinessFace Class Methods */Retrevies data from the Json Body and decodes it into a model class (Stage).Then the CreateStage() method is invoked from BusinessFacade @Summary Create and Save Stages for Workflows @Description Creates Stages with Fields unique to it for data input labels by Geld App @Tags stages @Accept json @Produce json @Param stagesBody body model.Stages true "Stage Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /stage/save [post].
All functions here a triggered by api Calls and invokes respective BusinessFace Class Methods */Retrevies data from the Json Body and decodes it into a model class (User).Then the CreateUser() method is invoked from BusinessFacade @Summary Create and Save Users in Project Geld @Description Creates Users for specific designations within the pilot phase of Project Geld @Tags users @Accept json @Produce json @Param usersBody body model.UserPayload true "User Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /appuser/save [post].
All functions here a triggered by api Calls and invokes respective BusinessFace Class Methods */Retrevies data from the Json Body and decodes it into a model class (Workflow).Then the CreateWorkflow() method is invoked from BusinessFacade @Summary Create and Save Workflows for Plots @Description Creates workflows to have a series of stages to map plot chain management @Tags workflows @Accept json @Produce json @Param workflowsBody body model.Workflows true "Workflow Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /workflows/save [post].
DeleteMasterDataByID deletes an master data by ID @Summary Delete Master Data Container By ID @Description Delete an existing Master Data Container By ID @Tags master data container @Accept json @Produce json @Param _id path primitive.ObjectID true "DataID" @Success 200 @Failure 400 {object} responseDtos.ErrorResponse @Router /masterdata/remove/{_id} [delete].
DeleteMasterDataRecordByID deletes an master data records by ID @Summary Delete Master Data Records By ID @Description Delete an existing Master Data Record By ID @Tags data collection @Accept json @Produce json @Param _id path primitive.ObjectID true "CollectionID" @Success 200 @Failure 400 {object} responseDtos.ErrorResponse @Router /record/remove/{_id} [delete].
DeleteStageByID deletes a stage by ID @Summary Delete Stage By ID @Description Delete an existing Stage By ID @Tags stages @Accept json @Produce json @Param _id path primitive.ObjectID true "StageID" @Success 200 @Failure 400 {object} responseDtos.ErrorResponse @Router /stage/remove/{_id} [delete].
DeleteUserByID deletes a user by ID @Summary Delete user By ID @Description Delete an existing Geld user By ID @Tags users @Accept json @Produce json @Param _id path primitive.ObjectID true "AppUserID" @Success 200 @Failure 400 {object} responseDtos.ErrorResponse @Router /appuser/remove/{_id} [delete].
DeleteWorkflowByID deletes a workflow by ID @Summary Delete workflow By ID @Description Delete an existing workflow By ID @Tags workflows @Accept json @Produce json @Param _id path primitive.ObjectID true "WorkflowID" @Success 200 @Failure 400 {object} responseDtos.ErrorResponse @Router /workflows/remove/{_id} [delete].
No description provided by the author
No description provided by the author
Trigger the GetHTMLByPlotID() method that will return The specific HTML with the PlotID passed via the API @Summary Get HTML By Plot ID @Description Get an existing HTML for token generation By Plot ID @Tags data template @Accept json @Produce json @Param plotid path string true "PlotID" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /geldtemplate/html/{plotid} [get].
No description provided by the author
No description provided by the author
Trigger the GetMasterDataByID() method that will return The specific MasterData with the ID passed via the API @Summary Get Master Data by ID @Description Get an existing Master Data Container ID @Tags master data container @Accept json @Produce json @Param _id path primitive.ObjectID true "DataID" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /masterdata/{_id} [get].
* **Description:Retrieves all data collections for the specified master data ID in a paginated format */ @Summary Get Paginated data collection @Description Retrieves paginated data collection associated with a specific dataID @Tags data collection @Accept json @Produce json @Param dataid path int true "DataID" @Param limit query int false "Page size (default from env: PAGINATION_DEFUALT_LIMIT)" Minimum: 1 @Param page query int false "Requested page (default from env: PAGINATION_DEFAULT_PAGE)" Minimum: 0 @Param sort query int false "Sort order (-1: Desc, 1: Asc, default from env: PAGINATION_DEFAULT_SORT)" Valid values: -1, 1 @Success 200 {object} responseDtos.ResultResponse @Success 204 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Failure 500 {object} responseDtos.ErrorResponse @Router /masterrecord/{dataid} [get].
No description provided by the author
No description provided by the author
No description provided by the author
Trigger the GetRecordDataByID() method that will return The specific RecordData with the ID passed via the API @Summary Get Record Data By ID @Description Get an existing Record Data By ID @Tags data collection @Accept json @Produce json @Param _id path primitive.ObjectID true "CollectionID" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /record/{_id} [get].
Trigger the GetRecordDataByMasterDataID() method that will return The specific RecordData with the MasterDataID passed via the API @Summary Get Record Data By Master Data ID @Description Get an existing Record Data By Master Data ID @Tags data collection @Accept json @Produce json @Param dataid path string true "DataID" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /records/{dataid} [get].
Trigger the GetStageByID() method that will return The specific Stage with the ID passed via the API @Summary Get Stage By ID @Description Get existing Stage By ID @Tags stages @Accept json @Produce json @Param _id path primitive.ObjectID true "StageID" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /stage/{_id} [get].
No description provided by the author
@Summary Get Data Template By ID @Description Get an existing Data Template By ID @Tags data template @Accept json @Produce json @Param _id path primitive.ObjectID true "TemplateID" @Success 200 @Failure 400 {object} responseDtos.ErrorResponse @Router /geldtemplate/{_id} [get].
Trigger the GetTemplateByPlotID() method that will return The specific template with the PlotID passed via the API @Summary Get Data Template By Plot ID @Description Get an existing Data Template By Plot ID @Tags data template @Accept json @Produce json @Param plotid path string true "PlotID" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /geldtemplate/plotid/{plotid} [get].
No description provided by the author
Trigger the GetTokenByID() method that will return The specific Token with the ID passed via the API @Summary Get Token By ID @Description Get Existing Token By ID @Tags tokens @Accept json @Produce json @Param _id path primitive.ObjectID true "TokenID" @Success 200 {array} responseDtos.ResultResponse @Failure 400 {array} responseDtos.ErrorResponse @Router /token/{_id} [get].
Trigger the GetUserByID() method that will return The specific User with the ID passed via the API @Summary Get user By ID @Description Get an existing Geld user By ID @Tags users @Accept json @Produce json @Param _id path primitive.ObjectID true "AppUserID" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /appuser/{_id} [get].
No description provided by the author
Trigger the GetWorkflowByID() method that will return The specific Workflow with the ID passed via the API @Summary Get workflow By ID @Description Get an existing workflow By ID @Tags workflows @Accept json @Produce json @Param _id path primitive.ObjectID true "WorkflowID" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /workflows/{_id} [get].
Save Data Template submitted @Summary Save Data Templates submitted by the Geld App @Description The Data Templates aacount for 1 stage which consists of master data and real time data @Tags data template @Accept json @Produce json @Param dataTemplateBody body map[string]interface{} true "Data Template Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /geldtemplate/save [post].
@Summary Test Server Health @Description Checks if the server is up and running @Tags health @Accept json @Produce json @Success 200 {object} responseDtos.HealthCheckResponse @Router /api/health [get].
No description provided by the author
All functions here a triggered by api Calls and invokes respective BusinessFace Class Methods */Retrevies data from the Json Body and decodes it into a model class (Token).Then the SaveToken() method is invoked from BusinessFacade @Summary Create and Save Tokens per Plot @Description Gets a timeline of data templates and creates a token per plot @Tags tokens @Accept json @Produce json @Param tokensBody body model.TokenPayload true "Token Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /token/save [post].
Trigger the GetAllMasterData() method that will return all the MasterData.
Trigger the GetAllStages() method that will return all the Stages.
Trigger the GetAllUsers() method that will return all the Users.
Trigger the GetAllWorkflows() method that will return all the Workflows.
No description provided by the author
Trigger the UpdateDataCollection() method that will return The specific updated MasterDataollection with the ID passed via the API @Summary Update Master Data Container @Description Update an exisiting Master Data Container @Tags data collection @Accept json @Produce json @Param dataCollectionBody body requestDtos.UpdateDataCollection true "Data Collection Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /updaterecords [put].
Trigger the UpdateMasterData() method that will return The specific updated MasterData with the ID passed via the API @Summary Update Master Data Container @Description Update an exisiting Master Data Container @Tags master data container @Accept json @Produce json @Param masterDataContainerBody body requestDtos.UpdateMasterData true "Master Data Container Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /updatemasterdata [put].
Trigger the UpdateStages() method that will return The specific updated Stage with the ID passed via the API Trigger the UpdateMasterData() method that will return The specific updated MasterData with the ID passed via the API @Summary Update Stage Data @Description Update an exisiting Stages @Tags stages @Accept json @Produce json @Param stagesBody body requestDtos.UpdateStages true "Stage Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /updatestage [put].
Trigger the UpdateTokenStatus() method that will return The specific Token with the ID passed via the API @Summary Update Token Status @Description Update Token Status based on if it has been minted or sold and bought @Tags tokens @Accept json @Produce json @Param tokensBody body requestDtos.UpdateToken true "Token Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /tokens/updatestatus [put].
Trigger the UpdateUser() method that will return The specific User with the ID passed via the API @Summary Update User Details @Description Update geld user details @Tags users @Accept json @Produce json @Param usersBody body requestDtos.UpdateUser true "User Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /updateuser [put].
No description provided by the author
Trigger the UpdateWorkflow() method that will return The specific Workflow with the ID passed via the API @Summary Update Workflow Details @Description Update Workflow details @Tags workflows @Accept json @Produce json @Param workflowsBody body requestDtos.UpdateWorkflow true "Workflow Details" @Success 200 {object} responseDtos.ResultResponse @Failure 400 {object} responseDtos.ErrorResponse @Router /updateworkflow [put].
No description provided by the author
No description provided by the author