Browse Source

教材技术文档

warrior 4 months ago
parent
commit
9b017f9a0c
1 changed files with 382 additions and 265 deletions
  1. 382 265
      docs/README.md

+ 382 - 265
docs/README.md

@@ -110,274 +110,391 @@
     ```
   - EduTextbook 【教材】
     ```js
-        "fields": {
-        "status": {
-            /*状态 
-            101:待完善资料  
-            102:可提交状态 
-            103:已提交至高校管理员
-            200:已提交遴选中 
-            201:公示中 
-            300:退回
-            400:已报送
-            */
-            "type": "String",
-            "required": false
-        },
-        "childrens":{//指向所有分册
-            "type": "String",
-            "required": false
-        },
-        "user": {
-            "type": "Pointer",
-            "targetClass":"_User",
-            "required": false
-        },
-        "department": { //所属流程
-            "type": "Pointer",
-            "targetClass":"Department",
-            "required": false
-        },
-        "render": { //是否提交
-            "type": "Boolean",
-            "required": false
-        },
-        "recommend": { //是否推荐
-            "type": "Boolean",
-            "required": false
-        },
-        "complete": { //是否填写完整
-            "type": "Boolean",
-            "required": false
-        },
-        "isDeleted": {
-            "type": "Boolean",
-            "required": false
-        },
-        "discard": { //删除至回收站
-            "type": "Boolean",
-            "required": false
-        },
-        "title": {
-            "type": "String",
-            "required": false
-        },
-        "ISBN": {
-            "type": "String",
-            "required": false
-        },
-        "author": {
-            "type": "String",
-            "required": false
-        },
-        "unit": {
-            "type": "String",
-            "required": false
-        },
-        "type": {
-            "type": "String",
-            "required": false
-        },
-        "typeNumber": {//全册次数
-            "type": "Number",
-            "required": false
-        },
-        "majorPoniter": {
-            "type": "String",
-            "required": false
-        },
-        "lang": {
-            "type": "String",
-            "required": false
-        },
-        "authors": {
-            "type": "String",
-            "required": false
-        },
-        "editor": {
-            "type": "String",
-            "required": false
-        },
-        "approval": {//是否为重点立项教材
-            "type": "String",
-            "required": false
-        },
-        "edition": {
-            "type": "String",
-            "required": false
-        },
-        "editionFirst": {
-            "type": "Date",
-            "required": false
-        },
-        "carrierShape": {
-            "type": "String",
-            "required": false
-        },
-        "editionDate": {
-            "type": "Date",
-            "required": false
-        },
-        "editionNumber": {//出版版次
-            "type": "Number",
-            "required": false
-        },
-        "printDate": {
-            "type": "Date",
-            "required": false
-        },
-        "printNumber": {
-            "type": "Number",
-            "required": false
-        },
-        "printSum": {
-            "type": "Number",
-            "required": false
-        },
-        "importantProject": {//重点项目
-            "type": "Array",
-            "required": false
-        },
-        "importantProjectOther": {//重点项目-其他
-            "type": "String",
-            "required": false
-        },
-        "copyright": {
-            "type": "Array",
-            "required": false
-        },
-        "CIP": {
-            "type": "Array",
-            "required": false
-        },
-        'majors':{//适用专业代码(六位)及名称
-            "type":'Number',
-            "required": false  
-        },
-        "period": {
-            "type": "Number",
-            "required": false
-        },
-        "lessons": {
-            "type": "Array",
-            "required": false
-        },
-        "characteristic": {
-            "type": "Array",
-            "required": false
-        },
-        "authorList": {
-            "type": "Array",
-            "required": false
-        },
-        "authorDetails": {
-            "type": "String",
-            "required": false
-        },
-        "achievementOptions": {
-            "type": "Array",
-            "required": false
-        },
-        "courses": {
-            "type": "Array",
-            "required": false
-        },
-        "innovateExplain": {
-            "type": "String",
-            "required": false
-        },
-        "influence": {
-            "type": "String",
-            "required": false
-        },
-        "textbookFiles": {
-            "type": "Array",
-            "required": false
-        },
-        "links": {
-            "type": "Array",
-            "required": false
-        },
-        "opinions": {
-            "type": "Array",
-            "required": false
-        },
-        "selfResults": {
-            "type": "Object",
-            "required": false
-        },
-        "expertOpinion": {
-            "type": "Object",
-            "required": false
-        },
-        "evidence": {
-            "type": "Object",
-            "required": false
-        },
-        "moreMaterial": {
-            "type": "Array",
-            "required": false
-        },
-        "authorSign": {
-            "type": "Array",
-            "required": false
-        },
-        "unitMaterial": {
-            "type": "Object",
-            "required": false
-        },
-        "accept": {//填写承诺书
-            "type": "String",
-            "required": false
-        },
-        "approvedImgUrl":{//重点立项教材获批截图            
-            "type":'String',
-            "required": false
-        },
-        "eduProcess": {//所属流程
-            "type": "Pointer",
-            "targetClass":"EduProcess",
-            "required": false
-        },
-        "code":{//编号
-            "type":'String',
-            "required": false
-        },
-        'editionUnit':{
-            "type":'String',
-            "required": false
-        },
-        'copyrightImgUrl':{
-            "type":'String',
-            "required": false  
-        },
-        'CIPImgurl':{
-            "type":'String',
-            "required": false  
-        },
-        'examine':{//作者政治审核表
-            "type":'Array',
-            "required": false  
-        },
-        'cipProveFile':{//cip相关截图
-            "type":'Array',
-            "required": false  
-        },
-        'inviteUnit':{//推荐单位
-            "type":'Array',
-            "required": false  
-        },
-        'unitType':{//推荐单位类型
-            "type":'Array',
-            "required": false  
-        },
-        'score':{//平均分
-            "type":'Number',
-            "required": false  
-        },
+    "fields": {
+      "status": {
+          /*状态 
+          101:待完善资料  
+          102:可提交状态 
+          103:已提交至高校管理员
+          200:已提交遴选中 
+          201:公示中 
+          300:退回
+          400:已报送
+          */
+          "type": "String",
+          "required": false
+      },
+      "childrens":{//指向所有分册
+          "type": "String",
+          "required": false
+      },
+      "user": {
+          "type": "Pointer",
+          "targetClass":"_User",
+          "required": false
+      },
+      "department": { //所属流程
+          "type": "Pointer",
+          "targetClass":"Department",
+          "required": false
+      },
+      "render": { //是否提交
+          "type": "Boolean",
+          "required": false
+      },
+      "recommend": { //是否推荐
+          "type": "Boolean",
+          "required": false
+      },
+      "complete": { //是否填写完整
+          "type": "Boolean",
+          "required": false
+      },
+      "isDeleted": {
+          "type": "Boolean",
+          "required": false
+      },
+      "discard": { //删除至回收站
+          "type": "Boolean",
+          "required": false
+      },
+      "title": {
+          "type": "String",
+          "required": false
+      },
+      "ISBN": {
+          "type": "String",
+          "required": false
+      },
+      "author": {
+          "type": "String",
+          "required": false
+      },
+      "unit": {
+          "type": "String",
+          "required": false
+      },
+      "type": {
+          "type": "String",
+          "required": false
+      },
+      "typeNumber": {//全册次数
+          "type": "Number",
+          "required": false
+      },
+      "majorPoniter": {
+          "type": "String",
+          "required": false
+      },
+      "lang": {
+          "type": "String",
+          "required": false
+      },
+      "authors": {
+          "type": "String",
+          "required": false
+      },
+      "editor": {
+          "type": "String",
+          "required": false
+      },
+      "approval": {//是否为重点立项教材
+          "type": "String",
+          "required": false
+      },
+      "edition": {
+          "type": "String",
+          "required": false
+      },
+      "editionFirst": {
+          "type": "Date",
+          "required": false
+      },
+      "carrierShape": {
+          "type": "String",
+          "required": false
+      },
+      "editionDate": {
+          "type": "Date",
+          "required": false
+      },
+      "editionNumber": {//出版版次
+          "type": "Number",
+          "required": false
+      },
+      "printDate": {
+          "type": "Date",
+          "required": false
+      },
+      "printNumber": {
+          "type": "Number",
+          "required": false
+      },
+      "printSum": {
+          "type": "Number",
+          "required": false
+      },
+      "importantProject": {//重点项目
+          "type": "Array",
+          "required": false
+      },
+      "importantProjectOther": {//重点项目-其他
+          "type": "String",
+          "required": false
+      },
+      "copyright": {
+          "type": "Array",
+          "required": false
+      },
+      "CIP": {
+          "type": "Array",
+          "required": false
+      },
+      'majors':{//适用专业代码(六位)及名称
+          "type":'Number',
+          "required": false  
+      },
+      "period": {
+          "type": "Number",
+          "required": false
+      },
+      "lessons": {
+          "type": "Array",
+          "required": false
+      },
+      "characteristic": {
+          "type": "Array",
+          "required": false
+      },
+      "authorList": {
+          "type": "Array",
+          "required": false
+      },
+      "authorDetails": {
+          "type": "String",
+          "required": false
+      },
+      "achievementOptions": {
+          "type": "Array",
+          "required": false
+      },
+      "courses": {
+          "type": "Array",
+          "required": false
+      },
+      "innovateExplain": {
+          "type": "String",
+          "required": false
+      },
+      "influence": {
+          "type": "String",
+          "required": false
+      },
+      "textbookFiles": {
+          "type": "Array",
+          "required": false
+      },
+      "links": {
+          "type": "Array",
+          "required": false
+      },
+      "opinions": {
+          "type": "Array",
+          "required": false
+      },
+      "selfResults": {
+          "type": "Object",
+          "required": false
+      },
+      "expertOpinion": {
+          "type": "Object",
+          "required": false
+      },
+      "evidence": {
+          "type": "Object",
+          "required": false
+      },
+      "moreMaterial": {
+          "type": "Array",
+          "required": false
+      },
+      "authorSign": {
+          "type": "Array",
+          "required": false
+      },
+      "unitMaterial": {
+          "type": "Object",
+          "required": false
+      },
+      "accept": {//填写承诺书
+          "type": "String",
+          "required": false
+      },
+      "approvedImgUrl":{//重点立项教材获批截图            
+          "type":'String',
+          "required": false
+      },
+      "eduProcess": {//所属流程
+          "type": "Pointer",
+          "targetClass":"EduProcess",
+          "required": false
+      },
+      "code":{//编号
+          "type":'String',
+          "required": false
+      },
+      'editionUnit':{
+          "type":'String',
+          "required": false
+      },
+      'copyrightImgUrl':{
+          "type":'String',
+          "required": false  
+      },
+      'CIPImgurl':{
+          "type":'String',
+          "required": false  
+      },
+      'examine':{//作者政治审核表
+          "type":'Array',
+          "required": false  
+      },
+      'cipProveFile':{//cip相关截图
+          "type":'Array',
+          "required": false  
+      },
+      'inviteUnit':{//推荐单位
+          "type":'Array',
+          "required": false  
+      },
+      'unitType':{//推荐单位类型
+          "type":'Array',
+          "required": false  
+      },
+      'score':{//平均分
+          "type":'Number',
+          "required": false  
+      },
     },
     ```
   - EduTextbookVolume 【分册】
+    ```js
+    "fields": {
+      "user": {
+          "type": "Pointer",
+          "targetClass":"_User",
+          "required": false
+      },
+      "isDeleted": {
+          "type": "Boolean",
+          "required": false
+      },
+      "title": {
+          "type": "String",
+          "required": false
+      },
+      "ISBN": {
+          "type": "String",
+          "required": false
+      },
+      "author": {
+          "type": "String",
+          "required": false
+      },
+      "unit": {
+          "type": "String",
+          "required": false
+      },
+      "lang": {
+          "type": "String",
+          "required": false
+      },
+      "authors": {
+          "type": "String",
+          "required": false
+      },
+      "editor": {
+          "type": "String",
+          "required": false
+      },
+      "editionFirst": {
+          "type": "Date",
+          "required": false
+      },
+      "carrierShape": {
+          "type": "String",
+          "required": false
+      },
+      "editionDate": {
+          "type": "Date",
+          "required": false
+      },
+      "editionNumber": {//出版版次
+          "type": "Number",
+          "required": false
+      },
+      "printDate": {
+          "type": "Date",
+          "required": false
+      },
+      "printNumber": {
+          "type": "Number",
+          "required": false
+      },
+      "printSum": {
+          "type": "Number",
+          "required": false
+      },
+      "importantProject": {//重点项目
+          "type": "Array",
+          "required": false
+      },
+      "importantProjectOther": {//重点项目-其他
+          "type": "String",
+          "required": false
+      },
+      "authorList": {
+          "type": "Array",
+          "required": false
+      },
+      "authorDetails": {
+          "type": "String",
+          "required": false
+      },
+      "achievementOptions": {
+          "type": "Array",
+          "required": false
+      },
+      "courses": {
+          "type": "Array",
+          "required": false
+      },
+      'editionUnit':{
+          "type":'String',
+          "required": false
+      },
+      'unitType':{//推荐单位类型
+          "type":'Array',
+          "required": false  
+      },
+      "collectFIles": {//纸质教材文件
+          "type": "Object",
+          "required": false
+      },
+      "collectDigitFiles":{//纸质数字文件
+          "type": "Object",
+          "required": false
+      },
+      "collectCheck":{//教材文件上传类型
+          "type": "Object",
+          "required": false
+      },
+      "collectStatus":{//教材文件上传状态
+          "type": "Object",
+          "required": false
+      },
+    },
+    ```
   - Activity 【评审活动】
     ```js
     "fields": {