BerniWittmann/spielplanismaning

module.exports = function (index) {
    /**
     * @apiDefine ErrorSpielplanUngueltig Spielplan ist ungültig
     *
     * @apiError (SpielplanUngueltig) {String} MESSAGE Error-Message: 'Spielplan Ungueltig'
     * @apiError (SpielplanUngueltig) {Integer} STATUSCODE Status-Code: 409
     * @apiError (SpielplanUngueltig) {String} MESSAGEKEY Key der Message: 'ERROR_SPIELPLAN_UNGUELTIG'
     * @apiError (SpielplanUngueltig) {Integer} INDEX_WITH_ERROR The index where the error is happening: 1
     *
     * @apiSuccessExample Success-Response:
     *     HTTP/1.1 409 Conflict
     *     {
     *          "MESSAGE": "Spielplan Ungueltig",
     *          "STATUSCODE": 409,
     *          "MESSAGEKEY": "ERROR_SPIELPLAN_UNGUELTIG",
     *          "INDEX_WITH_ERROR": 1
     *     }
     */
    return {
        MESSAGE: 'Spielplan Ungueltig',
        STATUSCODE: 409,
        MESSAGEKEY: 'ERROR_SPIELPLAN_UNGUELTIG',
        INDEX_WITH_ERROR: index
    };
};