update api param desc...

examcloud-exchange-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/bean/OuterScoreDataBean.java

@@ -1,135 +1,149 @@
 package cn.com.qmth.examcloud.exchange.outer.api.bean;
 
-import io.swagger.annotations.ApiModel;
+import cn.com.qmth.examcloud.api.commons.exchange.JsonSerializable;
 import io.swagger.annotations.ApiModelProperty;
 
 import java.util.Date;
 
-import cn.com.qmth.examcloud.api.commons.exchange.JsonSerializable;
-
 /**
- * 
- * @author  	chenken
- * @date    	2018年11月27日 下午5:41:09
- * @company 	QMTH
- * @description OuterGetScoreDataBean.java
+ * @author chenken
+ * @date 2018年11月27日 下午5:41:09
+ * @company QMTH
  */
-@ApiModel(value = "scoreDataBean", description = "考生成绩数据")
-public class OuterScoreDataBean implements JsonSerializable{
-
-	/**
-	 * 
-	 */
-	private static final long serialVersionUID = 7476060044159007486L;
-
-	@ApiModelProperty(value = "考试记录ID", example = "1", required = true)
-	private Long examRecordDataId;
-	
-	@ApiModelProperty(value = "学生姓名", example = "XX", required = true)
-	private String studentName;
-	
-	@ApiModelProperty(value = "学生学号", example = "X000001", required = true)
-	private String studentCode;
-	
-	@ApiModelProperty(value = "学生身份证号码", example = "10XXXX", required = true)
-	private String identityNumber;
-	
-	@ApiModelProperty(value = "课程名称", example = "语文001", required = true)
-	private String courseName;
-	
-	@ApiModelProperty(value = "课程code", example = "A000001", required = true)
-	private String courseCode;
-	
-	@ApiModelProperty(value = "开考时间", example = "2018-11-16 10:00:00", required = true)
-	private Date startTime;
-	
-	@ApiModelProperty(value = "交卷时间", example = "2018-11-16 10:30:00", required = true)
-	private Date endTime;
-	
-	@ApiModelProperty(value = "得分", example = "100.0", required = true)
-	private Double totalScore;
-	
-	@ApiModelProperty(value = "是否异常数据", example = "false", required = true)
-	private Boolean isWarn;
-	
-	@ApiModelProperty(value = "是否被审核", example = "false", required = true)
-	private Boolean isAudit;
-	
-	@ApiModelProperty(value = "是否违纪", example = "false", required = true)
-	private Boolean isIllegality;
-	
-	public Long getExamRecordDataId() {
-		return examRecordDataId;
-	}
-	public void setExamRecordDataId(Long examRecordDataId) {
-		this.examRecordDataId = examRecordDataId;
-	}
-	public String getStudentName() {
-		return studentName;
-	}
-	public void setStudentName(String studentName) {
-		this.studentName = studentName;
-	}
-	public String getStudentCode() {
-		return studentCode;
-	}
-	public void setStudentCode(String studentCode) {
-		this.studentCode = studentCode;
-	}
-	public String getIdentityNumber() {
-		return identityNumber;
-	}
-	public void setIdentityNumber(String identityNumber) {
-		this.identityNumber = identityNumber;
-	}
-	public String getCourseName() {
-		return courseName;
-	}
-	public void setCourseName(String courseName) {
-		this.courseName = courseName;
-	}
-	public String getCourseCode() {
-		return courseCode;
-	}
-	public void setCourseCode(String courseCode) {
-		this.courseCode = courseCode;
-	}
-	public Date getStartTime() {
-		return startTime;
-	}
-	public void setStartTime(Date startTime) {
-		this.startTime = startTime;
-	}
-	public Date getEndTime() {
-		return endTime;
-	}
-	public void setEndTime(Date endTime) {
-		this.endTime = endTime;
-	}
-	public Double getTotalScore() {
-		return totalScore;
-	}
-	public void setTotalScore(Double totalScore) {
-		this.totalScore = totalScore;
-	}
-	public Boolean getIsWarn() {
-		return isWarn;
-	}
-	public void setIsWarn(Boolean isWarn) {
-		this.isWarn = isWarn;
-	}
-	public Boolean getIsAudit() {
-		return isAudit;
-	}
-	public void setIsAudit(Boolean isAudit) {
-		this.isAudit = isAudit;
-	}
-	public Boolean getIsIllegality() {
-		return isIllegality;
-	}
-	public void setIsIllegality(Boolean isIllegality) {
-		this.isIllegality = isIllegality;
-	}
-	
-	
+public class OuterScoreDataBean implements JsonSerializable {
+
+    private static final long serialVersionUID = 7476060044159007486L;
+
+    @ApiModelProperty(value = "考试记录ID", example = "123")
+    private Long examRecordDataId;
+
+    @ApiModelProperty(value = "学生姓名", example = "张三")
+    private String studentName;
+
+    @ApiModelProperty(value = "证件号", example = "123456789123456789")
+    private String identityNumber;
+
+    @ApiModelProperty(value = "学号", example = "12345678")
+    private String studentCode;
+
+    @ApiModelProperty(value = "考试课程代码", example = "c101")
+    private String courseCode;
+
+    @ApiModelProperty(value = "考试课程名称", example = "C语言")
+    private String courseName;
+
+    @ApiModelProperty(value = "得分", example = "100.0")
+    private Double totalScore;
+
+    @ApiModelProperty(value = "开考时间", example = "2024-06-01 08:00:00")
+    private Date startTime;
+
+    @ApiModelProperty(value = "交卷时间", example = "2024-06-01 10:00:00")
+    private Date endTime;
+
+    @ApiModelProperty(value = "是否异常数据", example = "false")
+    private Boolean isWarn;
+
+    @ApiModelProperty(value = "是否被审核", example = "false")
+    private Boolean isAudit;
+
+    @ApiModelProperty(value = "是否违纪", example = "false")
+    private Boolean isIllegality;
+
+    public Long getExamRecordDataId() {
+        return examRecordDataId;
+    }
+
+    public void setExamRecordDataId(Long examRecordDataId) {
+        this.examRecordDataId = examRecordDataId;
+    }
+
+    public String getStudentName() {
+        return studentName;
+    }
+
+    public void setStudentName(String studentName) {
+        this.studentName = studentName;
+    }
+
+    public String getStudentCode() {
+        return studentCode;
+    }
+
+    public void setStudentCode(String studentCode) {
+        this.studentCode = studentCode;
+    }
+
+    public String getIdentityNumber() {
+        return identityNumber;
+    }
+
+    public void setIdentityNumber(String identityNumber) {
+        this.identityNumber = identityNumber;
+    }
+
+    public String getCourseName() {
+        return courseName;
+    }
+
+    public void setCourseName(String courseName) {
+        this.courseName = courseName;
+    }
+
+    public String getCourseCode() {
+        return courseCode;
+    }
+
+    public void setCourseCode(String courseCode) {
+        this.courseCode = courseCode;
+    }
+
+    public Date getStartTime() {
+        return startTime;
+    }
+
+    public void setStartTime(Date startTime) {
+        this.startTime = startTime;
+    }
+
+    public Date getEndTime() {
+        return endTime;
+    }
+
+    public void setEndTime(Date endTime) {
+        this.endTime = endTime;
+    }
+
+    public Double getTotalScore() {
+        return totalScore;
+    }
+
+    public void setTotalScore(Double totalScore) {
+        this.totalScore = totalScore;
+    }
+
+    public Boolean getIsWarn() {
+        return isWarn;
+    }
+
+    public void setIsWarn(Boolean isWarn) {
+        this.isWarn = isWarn;
+    }
+
+    public Boolean getIsAudit() {
+        return isAudit;
+    }
+
+    public void setIsAudit(Boolean isAudit) {
+        this.isAudit = isAudit;
+    }
+
+    public Boolean getIsIllegality() {
+        return isIllegality;
+    }
+
+    public void setIsIllegality(Boolean isIllegality) {
+        this.isIllegality = isIllegality;
+    }
+
 }

examcloud-exchange-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/request/OuterQueryScoreDataReq.java

@@ -4,79 +4,78 @@ import cn.com.qmth.examcloud.api.commons.exchange.EnterpriseRequest;
 import io.swagger.annotations.ApiModelProperty;
 
 /**
- *
- * @author  	chenken
- * @date    	2018年11月27日 下午5:51:08
- * @company 	QMTH
- * @description OuterQueryScoreDataReq.java
+ * @author chenken
+ * @date 2018年11月27日 下午5:51:08
+ * @company QMTH
  */
-public class OuterQueryScoreDataReq extends EnterpriseRequest{
+public class OuterQueryScoreDataReq extends EnterpriseRequest {
 
-	/**
-	 *
-	 */
-	private static final long serialVersionUID = -5033520077132433253L;
+    private static final long serialVersionUID = -5033520077132433253L;
 
-	@ApiModelProperty(value = "考试代码,推荐使用")
-	private String examCode;
-	@ApiModelProperty(value = "考试名称(废弃属性,实际上作为考试编码使用)", example = "2018年6月期末考试", required = false)
-	@Deprecated
-	private String examName;
+    @ApiModelProperty(value = "顶级机构ID", example = "123", required = true)
+    private Long rootOrgId;
 
-	private Long rootOrgId;
+    @ApiModelProperty(value = "考试编码", example = "2024年6月期末考试", required = true)
+    private String examCode;
 
-	private String studentCode;
+    @ApiModelProperty(value = "考试名称（实际作为考试编码使用）", example = "2024年6月期末考试")
+    private String examName;
 
-	private String identityNumber;
+    @ApiModelProperty(value = "证件号", example = "123456789123456789", required = true)
+    private String identityNumber;
 
-	private String courseCode;
+    @ApiModelProperty(value = "学号", example = "12345678")
+    private String studentCode;
 
-	public String getExamName() {
-		return examName;
-	}
+    @ApiModelProperty(value = "考试课程代码", example = "c101", required = true)
+    private String courseCode;
 
-	public void setExamName(String examName) {
-		this.examName = examName;
-	}
+    public String getExamName() {
+        return examName;
+    }
 
-	public String getExamCode() {
-		return examCode;
-	}
+    public void setExamName(String examName) {
+        this.examName = examName;
+    }
 
-	public void setExamCode(String examCode) {
-		this.examCode = examCode;
-	}
+    public String getExamCode() {
+        return examCode;
+    }
 
-	public Long getRootOrgId() {
-		return rootOrgId;
-	}
+    public void setExamCode(String examCode) {
+        this.examCode = examCode;
+    }
 
-	public void setRootOrgId(Long rootOrgId) {
-		this.rootOrgId = rootOrgId;
-	}
+    public Long getRootOrgId() {
+        return rootOrgId;
+    }
 
-	public String getStudentCode() {
-		return studentCode;
-	}
+    public void setRootOrgId(Long rootOrgId) {
+        this.rootOrgId = rootOrgId;
+    }
 
-	public void setStudentCode(String studentCode) {
-		this.studentCode = studentCode;
-	}
+    public String getStudentCode() {
+        return studentCode;
+    }
 
-	public String getIdentityNumber() {
-		return identityNumber;
-	}
+    public void setStudentCode(String studentCode) {
+        this.studentCode = studentCode;
+    }
 
-	public void setIdentityNumber(String identityNumber) {
-		this.identityNumber = identityNumber;
-	}
+    public String getIdentityNumber() {
+        return identityNumber;
+    }
 
-	public String getCourseCode() {
-		return courseCode;
-	}
+    public void setIdentityNumber(String identityNumber) {
+        this.identityNumber = identityNumber;
+    }
 
-	public void setCourseCode(String courseCode) {
-		this.courseCode = courseCode;
-	}
+    public String getCourseCode() {
+        return courseCode;
+    }
+
+    public void setCourseCode(String courseCode) {
+        this.courseCode = courseCode;
+    }
 
 }

examcloud-exchange-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/request/OuterQueryScoreListReq.java

@@ -7,17 +7,16 @@ public class OuterQueryScoreListReq extends EnterpriseRequest {
 
     private static final long serialVersionUID = 1L;
 
-    @ApiModelProperty(value = "学校ID", required = true)
+    @ApiModelProperty(value = "顶级机构ID", example = "123", required = true)
     private Long rootOrgId;
 
-    @ApiModelProperty(value = "考试代码，推荐使用")
+    @ApiModelProperty(value = "考试编码", example = "2024年6月期末考试", required = true)
     private String examCode;
 
-    @Deprecated
-    @ApiModelProperty(value = "考试名称(废弃属性，实际上作为“考试代码”使用)")
+    @ApiModelProperty(value = "考试名称（实际作为考试编码使用）", example = "2024年6月期末考试")
     private String examName;
 
-    @ApiModelProperty(value = "课程代码")
+    @ApiModelProperty(value = "考试课程代码", example = "c101")
     private String courseCode;
 
     @ApiModelProperty(value = "查询起始时间，格式：yyyy-MM-dd HH:mm:ss")
@@ -26,10 +25,10 @@ public class OuterQueryScoreListReq extends EnterpriseRequest {
     @ApiModelProperty(value = "查询结束时间，格式：yyyy-MM-dd HH:mm:ss")
     private String queryEndTime;
 
-    @ApiModelProperty(value = "分页：第几页，起始为1")
+    @ApiModelProperty(value = "分页第几页（起始为1）")
     private Integer pageNo;
 
-    @ApiModelProperty(value = "分页：每页条数，限制最大100条")
+    @ApiModelProperty(value = "分页每页条数（最大100条）")
     private Integer pageSize;
 
     public Long getRootOrgId() {
@@ -95,4 +94,5 @@ public class OuterQueryScoreListReq extends EnterpriseRequest {
     public void setPageSize(Integer pageSize) {
         this.pageSize = pageSize;
     }
-}
+
+}

examcloud-exchange-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/response/OuterGetScoreDataResp.java

@@ -2,29 +2,27 @@ package cn.com.qmth.examcloud.exchange.outer.api.response;
 
 import cn.com.qmth.examcloud.api.commons.exchange.EnterpriseResponse;
 import cn.com.qmth.examcloud.exchange.outer.api.bean.OuterScoreDataBean;
+import io.swagger.annotations.ApiModelProperty;
 
 /**
- * 
- * @author  	chenken
- * @date    	2018年11月16日 上午11:31:26
- * @company 	QMTH
+ * @author chenken
+ * @date 2018年11月16日 上午11:31:26
+ * @company QMTH
  * @description 获取成绩数据返回
  */
-public class OuterGetScoreDataResp extends EnterpriseResponse{
+public class OuterGetScoreDataResp extends EnterpriseResponse {
 
-	/**
-	 * 
-	 */
-	private static final long serialVersionUID = -9186364236466166910L;
-	
-	private OuterScoreDataBean outerScoreDataBean;
+    private static final long serialVersionUID = -9186364236466166910L;
 
-	public OuterScoreDataBean getOuterScoreDataBean() {
-		return outerScoreDataBean;
-	}
+    @ApiModelProperty(value = "考生成绩数据")
+    private OuterScoreDataBean outerScoreDataBean;
 
-	public void setOuterScoreDataBean(OuterScoreDataBean outerScoreDataBean) {
-		this.outerScoreDataBean = outerScoreDataBean;
-	}
+    public OuterScoreDataBean getOuterScoreDataBean() {
+        return outerScoreDataBean;
+    }
+
+    public void setOuterScoreDataBean(OuterScoreDataBean outerScoreDataBean) {
+        this.outerScoreDataBean = outerScoreDataBean;
+    }
 
 }

examcloud-exchange-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/response/OuterQueryScoreDataResp.java

@@ -1,26 +1,24 @@
 package cn.com.qmth.examcloud.exchange.outer.api.response;
 
-import java.util.List;
-
 import cn.com.qmth.examcloud.api.commons.exchange.EnterpriseResponse;
 import cn.com.qmth.examcloud.exchange.outer.api.bean.OuterScoreDataBean;
+import io.swagger.annotations.ApiModelProperty;
+
+import java.util.List;
 
-public class OuterQueryScoreDataResp extends EnterpriseResponse{
+public class OuterQueryScoreDataResp extends EnterpriseResponse {
 
-	/**
-	 * 
-	 */
-	private static final long serialVersionUID = 7651693026235437061L;
+    private static final long serialVersionUID = 7651693026235437061L;
 
-	
-	private List<OuterScoreDataBean> outerScoreDataBeanList;
+    @ApiModelProperty(value = "考生成绩数据集合")
+    private List<OuterScoreDataBean> outerScoreDataBeanList;
 
-	public List<OuterScoreDataBean> getOuterScoreDataBeanList() {
-		return outerScoreDataBeanList;
-	}
+    public List<OuterScoreDataBean> getOuterScoreDataBeanList() {
+        return outerScoreDataBeanList;
+    }
 
-	public void setOuterScoreDataBeanList(List<OuterScoreDataBean> outerScoreDataBeanList) {
-		this.outerScoreDataBeanList = outerScoreDataBeanList;
-	}
+    public void setOuterScoreDataBeanList(List<OuterScoreDataBean> outerScoreDataBeanList) {
+        this.outerScoreDataBeanList = outerScoreDataBeanList;
+    }
 
 }

examcloud-exchange-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/response/OuterQueryScoreListResp.java

@@ -10,6 +10,7 @@ public class OuterQueryScoreListResp extends EnterpriseResponse {
 
     private static final long serialVersionUID = 1L;
 
+    @ApiModelProperty(value = "考生成绩数据集合")
     private List<OuterScoreDataBean> scoreList;
 
     @ApiModelProperty(value = "总条数")
@@ -41,4 +42,5 @@ public class OuterQueryScoreListResp extends EnterpriseResponse {
     public void setTotalPages(int totalPages) {
         this.totalPages = totalPages;
     }
-}
+
+}