Documentation
¶
Index ¶
- type APaymentTokenController
- type CategoryController
- type ContributionController
- type ControlCategoryController
- type ControlPointController
- type CowController
- type JournalController
- type LackController
- type LegalFormController
- type PingController
- type PlantTypeController
- type PointGroupController
- type RequestController
- func (this *RequestController) AddInspection()
- func (this *RequestController) AddInspector()
- func (this *RequestController) Get()
- func (this *RequestController) GetAll()
- func (this *RequestController) GetAllForInspection()
- func (this *RequestController) Pay()
- func (this *RequestController) Post()
- func (this *RequestController) UpdateGVE()
- type UserController
- func (u *UserController) Delete()
- func (this *UserController) Get()
- func (this *UserController) GetAll()
- func (this *UserController) Login()
- func (u *UserController) Logout()
- func (this *UserController) Post()
- func (this *UserController) Profile()
- func (u *UserController) Put()
- func (this *UserController) Register()
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APaymentTokenController ¶
type APaymentTokenController struct {
beego.Controller
}
Operations about APaymentToken
func (*APaymentTokenController) GetAllTransactions ¶
func (this *APaymentTokenController) GetAllTransactions()
@Title Get Transactions @Description get all transactions @Success 200 {Object} models.APaymentTokenTransaction @router /transactions [get]
func (*APaymentTokenController) Transfer ¶
func (this *APaymentTokenController) Transfer()
@Title Creates a new APayment Token Transfer @Description Endpoint to transfer APayment Token from the System Account to the selected account @Param body body models.APaymentTokenTransfer true "body for request content" @Success 200 {Object} models.APaymentTokenTransfer @Failure 403 body is empty @router / [post]
type CategoryController ¶
type CategoryController struct {
beego.Controller
}
Cow Category Controll
func (*CategoryController) AddCategory ¶
func (this *CategoryController) AddCategory()
@Title Add new Category @Param Authorization header string true "JWT token" @Param body body models.Category true "body for category content" @router / [post]
func (*CategoryController) DeleteCategory ¶
func (this *CategoryController) DeleteCategory()
@Title Delete Category @Param Authorization header string true "JWT token" @Param categoryId path int64 true "Category ID" @router /:categoryId [put]
func (*CategoryController) GetCategories ¶
func (this *CategoryController) GetCategories()
@Title Add new Category @Param Authorization header string true "JWT token" @router / [get]
func (*CategoryController) UpdateCategory ¶
func (this *CategoryController) UpdateCategory()
@Title Update Category @Param Authorization header string true "JWT token" @Param body body models.Category true "body for category content" @Param categoryId path int64 true "Category ID" @router /:categoryId [put]
type ContributionController ¶
type ContributionController struct {
beego.Controller
}
Operations about Contributions
func (*ContributionController) Get ¶
func (this *ContributionController) Get()
@Title Get @Description get contribution by uid @Param uid path string true "The key for staticblock" @Success 200 {Object} models.Contribution @Failure 403 :cid is empty @router /:cid [get]
func (*ContributionController) GetAll ¶
func (this *ContributionController) GetAll()
@Title GetAll @Description get all Contributions @Success 200 {Object} models.Contribution @router / [get]
func (*ContributionController) Post ¶
func (this *ContributionController) Post()
@Title CreateContribution @Description Endpoint to create a new Contribution @Param body body models.Contribution true "body for contribution content" @Success 200 {Object} models.Contribution @Failure 403 body is empty @router / [post]
type ControlCategoryController ¶
type ControlCategoryController struct {
beego.Controller
}
Operations about ControlCategories
func (*ControlCategoryController) GetAll ¶
func (this *ControlCategoryController) GetAll()
@Title GetAll @Description get all Control Categories @Success 200 {Object} models.ControlCategory @router / [get]
func (*ControlCategoryController) Post ¶
func (this *ControlCategoryController) Post()
@Title Create a Control Category @Description Endpoint to create a new Control Category @Param body body models.ControlCategory true "body for control category content" @Success 200 {Object} models.ControlCategory @Failure 403 body is empty @router / [post]
type ControlPointController ¶
type ControlPointController struct {
beego.Controller
}
Operations about ControlPoints
func (*ControlPointController) GetAll ¶
func (this *ControlPointController) GetAll()
@Title GetAll @Description get all Control Points @Success 200 {Object} models.ControlPoint @router / [get]
func (*ControlPointController) Post ¶
func (this *ControlPointController) Post()
@Title Create a Control Point @Description Endpoint to create a new Control Point @Param body body models.ControlPoint true "body for control point content" @Success 200 {Object} models.ControlPoint @Failure 403 body is empty @router / [post]
type CowController ¶
type CowController struct {
beego.Controller
}
Operations about PointGroups
func (*CowController) GetCows ¶
func (this *CowController) GetCows()
@Title Get Cows from user @Description Get all cows of user @Param Authorization header string true "JWT token" @Param category query int64 false "Category ID" @router / [get]
type JournalController ¶
type JournalController struct {
beego.Controller
}
Operations about PointGroups
func (*JournalController) AddJournalEntry ¶
func (this *JournalController) AddJournalEntry()
@Title Add Entry Journal @Description Add new Entry to the Journal @Param Authorization header string true "JWT token" @Param journalEntry body model.JournalEntry true "JournalEntry" @router / [post]
func (*JournalController) GetMonthlyStats ¶
func (this *JournalController) GetMonthlyStats()
@Title Get Monthly Stat @Description Get monthly statistics @Param Authorization header string true "JWT token" @Param month query int8 true "month" @Param year query int8 true "year" @router /monthlystats [get]
type LackController ¶
type LackController struct {
beego.Controller
}
Operations about Lacks
func (*LackController) GetAll ¶
func (this *LackController) GetAll()
@Title GetAll @Description get all Lacks @Success 200 {Object} models.Lack @router / [get]
func (*LackController) Post ¶
func (this *LackController) Post()
@Title Create a Lack @Description Endpoint to create a new Lack @Param body body models.Lack true "body for lackcontent" @Success 200 {Object} models.Lack @Failure 403 body is empty @router / [post]
type LegalFormController ¶
type LegalFormController struct {
beego.Controller
}
func (*LegalFormController) GetAll ¶
func (this *LegalFormController) GetAll()
@Title GetAll @Description get all LegalForms @Success 200 {Object} models.LegalForm @router / [get]
type PingController ¶
type PingController struct {
beego.Controller
}
func (*PingController) Ping ¶
func (this *PingController) Ping()
@Title Ping @Success 200 {string} pong @router / [get]
type PlantTypeController ¶
type PlantTypeController struct {
beego.Controller
}
func (*PlantTypeController) GetAll ¶
func (this *PlantTypeController) GetAll()
@Title GetAll @Description get all PlantTypes @Success 200 {Object} models.PlantType @router / [get]
type PointGroupController ¶
type PointGroupController struct {
beego.Controller
}
Operations about PointGroups
func (*PointGroupController) GetAll ¶
func (this *PointGroupController) GetAll()
@Title GetAll @Description get all Control Categories @Success 200 {Object} models.ControlCategory @router / [get]
func (*PointGroupController) Post ¶
func (this *PointGroupController) Post()
@Title Create a Point Group @Description Endpoint to create a new Point Group @Param body body models.PointGroup true "body for point group content" @Success 200 {Object} models.PointGroup @Failure 403 body is empty @router / [post]
type RequestController ¶
type RequestController struct {
beego.Controller
}
Operations about Contributions
func (*RequestController) AddInspection ¶
func (this *RequestController) AddInspection()
@Title Add Inspection @Description Add the report of the inspection @Param body body models.Request true "body for requestion content" @Success 200 {object} models.Request @router /inspection [post]
func (*RequestController) AddInspector ¶
func (this *RequestController) AddInspector()
@Title Add Inspector @Description add Inspector to Requestion @Param body body models.Request true "body for requestion content" @Success 200 {object} models.Request @router /inspector [put]
func (*RequestController) Get ¶
func (this *RequestController) Get()
@Title Get @Description find request by requestID @Param jwtToken header string true "jwt Token for Authorization" @Param requestId path string true "the requestid you want to get" @Success 200 {object} models.Request @Failure 403 :requestId is empty @router /:requestId [get]
func (*RequestController) GetAll ¶
func (this *RequestController) GetAll()
@Title GetAll @Description get all request @Success 200 {object} models.Request @router / [get]
func (*RequestController) GetAllForInspection ¶
func (this *RequestController) GetAllForInspection()
@Title GetAll @Description get all request which have an inspector assigned @Success 200 {object} models.Request @router /inspection [get]
func (*RequestController) Pay ¶
func (this *RequestController) Pay()
@Title Pay DirectPayment @Description Update GVE of request @Param body body models.Request true "body for requestion content" @Success 200 {object} models.Request @router /pay [post]
func (*RequestController) Post ¶
func (this *RequestController) Post()
@Title Create a new Request @Description Endpoint to create a new Request @Param body body models.Request true "body for request content" @Success 200 {Object} models.Request @Failure 403 body is empty @router / [post]
func (*RequestController) UpdateGVE ¶
func (this *RequestController) UpdateGVE()
@Title Update GVE @Description Update GVE of request @Param body body models.Request true "body for requestion content" @Success 200 {object} models.Request @Failure 403 :requestId is empty @router /gve [put]
type UserController ¶
type UserController struct {
beego.Controller
}
Operations about Users
func (*UserController) Delete ¶
func (u *UserController) Delete()
@Title Delete @Description delete the user @Param uid path string true "The uid you want to delete" @Success 200 {string} delete success! @Failure 403 uid is empty @router /:uid [delete]
func (*UserController) Get ¶
func (this *UserController) Get()
@Title Get @Description get user by uid @Param uid path string true "The key for staticblock" @Success 200 {object} models.User @Failure 403 :uid is empty @router /:uid [get]
func (*UserController) GetAll ¶
func (this *UserController) GetAll()
@Title GetAll @Description get all Users @Success 200 {Object} models.User @router / [get]
func (*UserController) Login ¶
func (this *UserController) Login()
@Title Login @Description Logs user into the system @Param body body models.User true "body for user content" @Success 200 {string} login success @Failure 403 user not exist @router /login [post]
func (*UserController) Logout ¶
func (u *UserController) Logout()
@Title logout @Description Logs out current logged in user session @Success 200 {string} logout success @router /logout [get]
func (*UserController) Post ¶
func (this *UserController) Post()
@Title CreateUser @Description create users @Param body body models.User true "body for user content" @Success 200 {int} models.User.Id @Failure 403 body is empty @router / [post]
func (*UserController) Profile ¶
func (this *UserController) Profile()
@Title Get my Profile @Description get user based on JWT Token @Param Authorization header string true "JWT token" @Success 200 {object} models.User @Failure 404 @router /profile [get]
func (*UserController) Put ¶
func (u *UserController) Put()
@Title Update @Description update the user @Param uid path string true "The uid you want to update" @Param body body models.User true "body for user content" @Success 200 {object} models.User @Failure 403 :uid is not int @router /:uid [put]
func (*UserController) Register ¶
func (this *UserController) Register()
@Title RegisterUser @Description create users @Param body body models.User true "body for user content" @Success 200 {int} models.User.Id @Failure 403 body is empty @router /register [post]
Source Files