17th-Ranger-Battalion-ORG/17th-Battalion-Tracker
6
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
main
17th-Battalion-Tracker/api/db/sequelize-docgen.js
IndigoFox 9f2473801c Initial commit 
TODO: change api.conf URL references to use environment variables and add these variables to the docker-compose configuration for host domain
2023-03-28 00:08:50 -07:00

2530 lines
73 KiB
JavaScript
Raw Permalink Blame History

/**
* @apiDefine MemberParam
* @apiParam {integer} id
* @apiParam {string} name
* @apiParam {string} [email]
* @apiParam {string} [website]
* @apiParam {string} [steamId64]
* @apiParam {string} [steamProfileName]
* @apiParam {string} [discordId]
* @apiParam {string} [discordUsername]
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} [rankId]
* @apiParam {integer} [statusId]
* @apiParam {Rank} rank
* @apiParam {MemberStatus} status
* @apiParam {Award[]} awards
* @apiParam {Course[]} courseSMEFor
* @apiParam {CourseInstance[]} coursesTaught
* @apiParam {CourseInstance[]} coursesAttended
*/
/**
* @apiDefine MemberRequest
* @apiParamExample {json} Request
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
*/
/**
* @apiDefine MemberArrayRequest
* @apiParamExample {json} Request
* [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ]
*/
/**
* @apiDefine MemberResponse
* @apiSuccessExample {json} Response
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
*/
/**
* @apiDefine MemberArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ]
*/
/**
* @apiDefine AwardParam
* @apiParam {integer} id
* @apiParam {string} name
* @apiParam {string} shortname
* @apiParam {string} description
* @apiParam {string} [imageUrl]
* @apiParam {string} footprint
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} [categoryId]
* @apiParam {Member[]} awardHolders
* @apiParam {Course[]} coursesRequired
* @apiParam {TrainingCategory} trainingCategory
*/
/**
* @apiDefine AwardRequest
* @apiParamExample {json} Request
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "coursesRequired": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "possibleAwards": [
* {}
* ],
* "sme": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ],
* "awardHolders": [
* {}
* ]
* }
*/
/**
* @apiDefine AwardArrayRequest
* @apiParamExample {json} Request
* [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "coursesRequired": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "possibleAwards": [
* {}
* ],
* "sme": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ],
* "awardHolders": [
* {}
* ]
* }
* ]
*/
/**
* @apiDefine AwardResponse
* @apiSuccessExample {json} Response
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "coursesRequired": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "possibleAwards": [
* {}
* ],
* "sme": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ],
* "awardHolders": [
* {}
* ]
* }
*/
/**
* @apiDefine AwardArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "coursesRequired": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "possibleAwards": [
* {}
* ],
* "sme": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ],
* "awardHolders": [
* {}
* ]
* }
* ]
*/
/**
* @apiDefine CourseParam
* @apiParam {integer} id
* @apiParam {string} name
* @apiParam {string} shortname
* @apiParam {string} description
* @apiParam {string} [image]
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} [categoryId]
* @apiParam {CourseInstance[]} trainingsHeld
* @apiParam {Member[]} sme
* @apiParam {Award[]} possibleAwards
* @apiParam {TrainingCategory} trainingCategory
*/
/**
* @apiDefine CourseRequest
* @apiParamExample {json} Request
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
*/
/**
* @apiDefine CourseArrayRequest
* @apiParamExample {json} Request
* [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ]
*/
/**
* @apiDefine CourseResponse
* @apiSuccessExample {json} Response
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
*/
/**
* @apiDefine CourseArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ]
*/
/**
* @apiDefine TrainingCategoryParam
* @apiParam {integer} id
* @apiParam {string} name
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
*/
/**
* @apiDefine TrainingCategoryRequest
* @apiParamExample {json} Request
* {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* }
*/
/**
* @apiDefine TrainingCategoryArrayRequest
* @apiParamExample {json} Request
* [
* {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* }
* ]
*/
/**
* @apiDefine TrainingCategoryResponse
* @apiSuccessExample {json} Response
* {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* }
*/
/**
* @apiDefine TrainingCategoryArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* }
* ]
*/
/**
* @apiDefine RankParam
* @apiParam {integer} id
* @apiParam {string} name
* @apiParam {string} category
* @apiParam {integer} sortId
* @apiParam {string} [imageUrl]
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {Member[]} members
*/
/**
* @apiDefine RankRequest
* @apiParamExample {json} Request
* {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {}
* }
* ]
* }
*/
/**
* @apiDefine RankArrayRequest
* @apiParamExample {json} Request
* [
* {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {}
* }
* ]
* }
* ]
*/
/**
* @apiDefine RankResponse
* @apiSuccessExample {json} Response
* {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {}
* }
* ]
* }
*/
/**
* @apiDefine RankArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {}
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* }
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {}
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {}
* }
* ]
* }
* ]
*/
/**
* @apiDefine MembersAwardsParam
* @apiParam {dateonly} actionDate
* @apiParam {boolean} awarded
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} awardId
* @apiParam {integer} memberId
*/
/**
* @apiDefine MembersAwardsRequest
* @apiParamExample {json} Request
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "awardId": 1,
* "memberId": 1
* }
*/
/**
* @apiDefine MembersAwardsArrayRequest
* @apiParamExample {json} Request
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "awardId": 1,
* "memberId": 1
* }
* ]
*/
/**
* @apiDefine MembersAwardsResponse
* @apiSuccessExample {json} Response
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "awardId": 1,
* "memberId": 1
* }
*/
/**
* @apiDefine MembersAwardsArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "awardId": 1,
* "memberId": 1
* }
* ]
*/
/**
* @apiDefine MembersCoursesParam
* @apiParam {dateonly} attendedDate
* @apiParam {boolean} passed
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} attendeeId
* @apiParam {integer} courseInstanceId
*/
/**
* @apiDefine MembersCoursesRequest
* @apiParamExample {json} Request
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "attendeeId": 1,
* "courseInstanceId": 1
* }
*/
/**
* @apiDefine MembersCoursesArrayRequest
* @apiParamExample {json} Request
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "attendeeId": 1,
* "courseInstanceId": 1
* }
* ]
*/
/**
* @apiDefine MembersCoursesResponse
* @apiSuccessExample {json} Response
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "attendeeId": 1,
* "courseInstanceId": 1
* }
*/
/**
* @apiDefine MembersCoursesArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "attendeeId": 1,
* "courseInstanceId": 1
* }
* ]
*/
/**
* @apiDefine CourseInstanceParam
* @apiParam {integer} id
* @apiParam {dateonly} runDate
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} [courseId]
* @apiParam {Course} courseTaught
* @apiParam {Member[]} trainers
* @apiParam {Member[]} attendees
*/
/**
* @apiDefine CourseInstanceRequest
* @apiParamExample {json} Request
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {}
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
*/
/**
* @apiDefine CourseInstanceArrayRequest
* @apiParamExample {json} Request
* [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {}
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ]
*/
/**
* @apiDefine CourseInstanceResponse
* @apiSuccessExample {json} Response
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {}
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
*/
/**
* @apiDefine CourseInstanceArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "id": 1,
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "courseId": 1,
* "attendees": [
* {
* "id": 1,
* "name": "string",
* "email": "string",
* "website": "string",
* "steamId64": "string",
* "steamProfileName": "string",
* "discordId": "string",
* "discordUsername": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "rankId": 1,
* "statusId": 1,
* "coursesAttended": [
* {}
* ],
* "coursesTaught": [
* {}
* ],
* "courseSMEFor": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "image": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "possibleAwards": [
* {
* "id": 1,
* "name": "string",
* "shortname": "string",
* "description": "string",
* "imageUrl": "string",
* "footprint": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "categoryId": 1,
* "trainingCategory": {},
* "coursesRequired": [
* {}
* ],
* "awardHolders": [
* {}
* ]
* }
* ],
* "sme": [
* {}
* ],
* "trainingsHeld": [
* {}
* ]
* }
* ],
* "awards": [
* {}
* ],
* "status": {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* },
* "rank": {
* "id": 1,
* "name": "string",
* "category": "string",
* "sortId": 1,
* "imageUrl": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "members": [
* {}
* ]
* }
* }
* ],
* "trainers": [
* {}
* ],
* "courseTaught": {}
* }
* ]
*/
/**
* @apiDefine MemberStatusParam
* @apiParam {integer} id
* @apiParam {string} name
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
*/
/**
* @apiDefine MemberStatusRequest
* @apiParamExample {json} Request
* {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* }
*/
/**
* @apiDefine MemberStatusArrayRequest
* @apiParamExample {json} Request
* [
* {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* }
* ]
*/
/**
* @apiDefine MemberStatusResponse
* @apiSuccessExample {json} Response
* {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* }
*/
/**
* @apiDefine MemberStatusArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "id": 1,
* "name": "string",
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123"
* }
* ]
*/
/**
* @apiDefine CoursesSMEParam
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} memberId
* @apiParam {integer} courseId
*/
/**
* @apiDefine CoursesSMERequest
* @apiParamExample {json} Request
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "memberId": 1,
* "courseId": 1
* }
*/
/**
* @apiDefine CoursesSMEArrayRequest
* @apiParamExample {json} Request
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "memberId": 1,
* "courseId": 1
* }
* ]
*/
/**
* @apiDefine CoursesSMEResponse
* @apiSuccessExample {json} Response
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "memberId": 1,
* "courseId": 1
* }
*/
/**
* @apiDefine CoursesSMEArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "memberId": 1,
* "courseId": 1
* }
* ]
*/
/**
* @apiDefine CourseInstancesTrainersParam
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} trainerId
*/
/**
* @apiDefine CourseInstancesTrainersRequest
* @apiParamExample {json} Request
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "trainerId": 1
* }
*/
/**
* @apiDefine CourseInstancesTrainersArrayRequest
* @apiParamExample {json} Request
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "trainerId": 1
* }
* ]
*/
/**
* @apiDefine CourseInstancesTrainersResponse
* @apiSuccessExample {json} Response
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "trainerId": 1
* }
*/
/**
* @apiDefine CourseInstancesTrainersArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "trainerId": 1
* }
* ]
*/
/**
* @apiDefine CoursesAwardsParam
* @apiParam {date} createdAt
* @apiParam {date} updatedAt
* @apiParam {integer} awardId
* @apiParam {integer} courseId
*/
/**
* @apiDefine CoursesAwardsRequest
* @apiParamExample {json} Request
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "awardId": 1,
* "courseId": 1
* }
*/
/**
* @apiDefine CoursesAwardsArrayRequest
* @apiParamExample {json} Request
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "awardId": 1,
* "courseId": 1
* }
* ]
*/
/**
* @apiDefine CoursesAwardsResponse
* @apiSuccessExample {json} Response
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "awardId": 1,
* "courseId": 1
* }
*/
/**
* @apiDefine CoursesAwardsArrayResponse
* @apiSuccessExample {json} Response
* [
* {
* "createdAt": "2015-12-31T23:59:59.123",
* "updatedAt": "2015-12-31T23:59:59.123",
* "awardId": 1,
* "courseId": 1
* }
* ]
*/
Reference in New Issue View Git Blame Copy Permalink