admin

Documentation

Index

• func RequestDelete(input *context.Input)
• func RequestGet(input *context.Input)
• func RequestGetList(input *context.Input)
• func RequestPost(input *context.Input)
• func RequestPut(input *context.Input)
• func ResponseDelete()
• func ResponseGet()
• func ResponseGetList()
• func ResponsePost()
• func ResponsePut()

Functions

func RequestDelete

func RequestDelete(input *context.Input)

*

• @apiDefine AdminDeleteRequest *
• @apiParam {String} adminId The admin user id

func RequestGet

func RequestGet(input *context.Input)

*

• @apiDefine AdminGetRequest *
• @apiParam {String} adminId The admin user id

func RequestGetList

func RequestGetList(input *context.Input)

*

• @apiDefine AdminGetListRequest *

func RequestPost

func RequestPost(input *context.Input)

*

• @apiDefine AdminPostRequest *
• @apiParam {String} mail The E-Mail Address of the admin user
• @apiParam {Object[]} roleList A array of all roles
• @apiParam {Int} roleList.id Role id (see full list at Appendix)
• @apiParam {String} roleList.name Role name

func RequestPut

func RequestPut(input *context.Input)

*

• @apiDefine AdminPutRequest *
• @apiParam {String} adminId The admin user id
• @apiParam {String} mail The E-Mail Address of the admin user
• @apiParam {Object[]} roleList A array of all roles
• @apiParam {Int} roleList.id Role id (see full list at Appendix)
• @apiParam {String} roleList.name Role name

func ResponseDelete

func ResponseDelete()

*

• @apiDefine AdminDeleteResponse *
• @apiSuccessExample {json} Success-Response:
• HTTP/1.1 200 OK

func ResponseGet

func ResponseGet()

*

• @apiDefine AdminGetResponse *
• @apiSuccess {String} id The id
• @apiSuccess {String} mail The E-Mail Address of the admin user
• @apiSuccess {Object[]} roleList A array of all roles
• @apiSuccess {Int} roleList.id Role id (see full list at Appendix)
• @apiSuccess {String} roleList.name Role name
• @apiSuccess {Int} createStamp Unix time stamp of create time *
• @apiSuccessExample {json} Success-Response:
• HTTP/1.1 200 OK
• {
• "id": "KAJFDA7GFTRE87FDS78F7",
• "mail": "son.goku@dragonball.com",
• "roleList": [
• {
• "id": "2",
• "name": "admin"
• },
• ...
• "createStamp": "1415637736",
• }

func ResponseGetList

func ResponseGetList()

*

• @apiDefine AdminGetListResponse *
• @apiSuccess {Object[]} adminList Array of all admin users
• @apiSuccess {String} adminList.id The id
• @apiSuccess {String} adminList.mail The E-Mail Address of the admin user
• @apiSuccess {Object[]} adminList.roleList A array of all roles
• @apiSuccess {Int} adminList.roleList.id Role id (see full list at Appendix)
• @apiSuccess {String} adminList.roleList.name Role name
• @apiSuccess {Int} adminList.createStamp Unix time stamp of create time *
• @apiSuccessExample {json} Success-Response:
• HTTP/1.1 200 OK
• "adminList": [
• {
• "id": "KAJFDA7GFTRE87FDS78F7",
• "mail": "son.goku@dragonball.com",
• "roleList": [
• {
• "id": "2",
• "name": "admin"
• },
• ...
• "createStamp": "1415637736",
• },
• ...
• ]
• }

func ResponsePost

func ResponsePost()

*

• @apiDefine AdminPostResponse *
• @apiSuccess {String} id The id
• @apiSuccess {String} mail The E-Mail Address of the admin user
• @apiSuccess {Object[]} roleList A array of all roles
• @apiSuccess {Int} roleList.id Role id (see full list at Appendix)
• @apiSuccess {String} roleList.name Role name
• @apiSuccess {Int} createStamp Unix time stamp of create time *
• @apiSuccessExample {json} Success-Response:
• HTTP/1.1 200 OK
• {
• "id": "KAJFDA7GFTRE87FDS78F7",
• "mail": "son.goku@dragonball.com",
• "roleList": [
• {
• "id": "2",
• "name": "admin"
• },
• ...
• "createStamp": "1415637736",
• }

func ResponsePut

func ResponsePut()

*

• @apiDefine AdminPutResponse *
• @apiSuccess {String} id The id
• @apiSuccess {String} mail The E-Mail Address of the admin user
• @apiSuccess {Object[]} roleList A array of all roles
• @apiSuccess {Int} roleList.id Role id (see full list at Appendix)
• @apiSuccess {String} roleList.name Role name
• @apiSuccess {Int} createStamp Unix time stamp of create time *
• @apiSuccessExample {json} Success-Response:
• HTTP/1.1 200 OK
• {
• "id": "KAJFDA7GFTRE87FDS78F7",
• "mail": "son.goku@dragonball.com",
• "roleList": [
• {
• "id": "2",
• "name": "admin"
• },
• ...
• "createStamp": "1415637736",
• }