update api param desc...

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

@@ -12,51 +12,50 @@ import io.swagger.annotations.ApiModelProperty;
  */
 public class OuterGetExamReq extends EnterpriseRequest {
 
-	private static final long serialVersionUID = -2827676106721670081L;
+    private static final long serialVersionUID = -2827676106721670081L;
 
-	@ApiModelProperty(value = "考试ID", example = "128", required = true)
-	private Long id;
+    @ApiModelProperty(value = "顶级机构", example = "123", required = true)
+    private Long rootOrgId;
 
-	@ApiModelProperty(value = "顶级机构", example = "0", required = true)
-	private Long rootOrgId;
+    @ApiModelProperty(value = "考试ID", example = "123")
+    private Long id;
 
-	@ApiModelProperty(value = "考试名称(废弃属性,实际上作为考试编码使用)", example = "2018年6月期末考试", required = false)
-	@Deprecated
-	private String name;
+    @ApiModelProperty(value = "考试名称", example = "2024年6月期末考试")
+    private String name;
 
-	@ApiModelProperty(value = "考试编码(不传时取考试名称)", example = "2018年6月期末考试", required = true)
-	private String code;
+    @ApiModelProperty(value = "考试编码", example = "xxx")
+    private String code;
 
-	public Long getId() {
-		return id;
-	}
+    public Long getId() {
+        return id;
+    }
 
-	public void setId(Long id) {
-		this.id = id;
-	}
+    public void setId(Long id) {
+        this.id = id;
+    }
 
-	public Long getRootOrgId() {
-		return rootOrgId;
-	}
+    public Long getRootOrgId() {
+        return rootOrgId;
+    }
 
-	public void setRootOrgId(Long rootOrgId) {
-		this.rootOrgId = rootOrgId;
-	}
+    public void setRootOrgId(Long rootOrgId) {
+        this.rootOrgId = rootOrgId;
+    }
 
-	public String getName() {
-		return name;
-	}
+    public String getName() {
+        return name;
+    }
 
-	public void setName(String name) {
-		this.name = name;
-	}
+    public void setName(String name) {
+        this.name = name;
+    }
 
-	public String getCode() {
-		return code;
-	}
+    public String getCode() {
+        return code;
+    }
 
-	public void setCode(String code) {
-		this.code = code;
-	}
+    public void setCode(String code) {
+        this.code = code;
+    }
 
 }

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

@@ -1,13 +1,13 @@
 package cn.com.qmth.examcloud.exchange.outer.api.request;
 
-import java.util.Date;
-import java.util.List;
-import java.util.Map;
-
 import cn.com.qmth.examcloud.api.commons.enums.ExamType;
 import cn.com.qmth.examcloud.api.commons.exchange.EnterpriseRequest;
 import io.swagger.annotations.ApiModelProperty;
 
+import java.util.Date;
+import java.util.List;
+import java.util.Map;
+
 /**
  * 类注释
  *
@@ -17,164 +17,163 @@ import io.swagger.annotations.ApiModelProperty;
  */
 public class OuterSaveExamReq extends EnterpriseRequest {
 
-	private static final long serialVersionUID = 8298816850875139485L;
+    private static final long serialVersionUID = 8298816850875139485L;
+
+    @ApiModelProperty(value = "顶级机构", example = "123", required = true)
+    private Long rootOrgId;
+
+    @ApiModelProperty(value = " 考试开始时间", example = "2024-06-01 08:00:00", required = true)
+    private Date beginTime;
+
+    @ApiModelProperty(value = " 考试结束时间", example = "2024-06-01 10:00:00", required = true)
+    private Date endTime;
+
+    @ApiModelProperty(value = "考试名称（不允许重复）", example = "2024年6月期末考试", required = true)
+    private String name;
+
+    @ApiModelProperty(value = "考试编码（不允许重复，不传时取考试名称的值）", example = "xxx")
+    private String code;
+
+    @ApiModelProperty(value = " 考试类型（ONLINE:网考；OFFLINE:离线；PRACTICE:练习）", example = "ONLINE", required = true)
+    private ExamType examType;
+
+    @ApiModelProperty(value = "考试时长（单位：分钟）", example = "120", required = true)
+    private Integer duration;
+
+    @ApiModelProperty(value = "考试备注", example = "xxx")
+    private String remark;
+
+    @ApiModelProperty(value = "考试次数", example = "1")
+    private Long examTimes;
+
+    @ApiModelProperty(value = "是否开启默认场次", example = "false")
+    private Boolean enableExamStage;
+
+    @ApiModelProperty(value = "迟到分钟数限制", example = "30")
+    private Integer lateMinuteLimit;
+
+    //	@ApiModelProperty(value = "抽题模式（WHOLE_SET:成套调用；RANDOM_PAPER:随机抽题）", example = "WHOLE_SET")
+    //	private CallType callType;
+
+    @ApiModelProperty(value = "是否定点交卷", example = "false")
+    private Boolean enableTimingEnd;
 
-	@ApiModelProperty(value = "顶级机构", example = "0", required = true)
-	private Long rootOrgId;
+    @ApiModelProperty(value = "IP白名单", example = "[\"192.168.1.123\"]")
+    private List<String> ipWhitelist;
 
-	@ApiModelProperty(value = " 考试批次开始时间", example = "2018-10-10 08:00:00", required = true)
-	private Date beginTime;
+    @ApiModelProperty(value = "扩展属性集合", example = "{\"MARKING_TYPE\":\"ALL\",\"IS_FACE_ENABLE\":\"false\",\"IP_LIMIT\":\"false\"}")
+    private Map<String, String> properties;
 
-	@ApiModelProperty(value = " 考试批次结束时间", example = "2018-10-10 08:00:00", required = true)
-	private Date endTime;
+    public Long getRootOrgId() {
+        return rootOrgId;
+    }
 
-	@ApiModelProperty(value = "考试名称", example = "2018年6月期末考试", required = true)
-	private String name;
+    public void setRootOrgId(Long rootOrgId) {
+        this.rootOrgId = rootOrgId;
+    }
 
-	@ApiModelProperty(value = "考试编码(不传时取考试名称)", example = "2018年6月期末考试", required = false)
-	private String code;
+    public Date getBeginTime() {
+        return beginTime;
+    }
 
-	@ApiModelProperty(value = " 考试类型(ONLINE:网考;TRADITION:传统;OFFLINE:离线;PRACTICE:练习;PRINT_EXAM:PRINT_EXAM.)", example = "ONLINE", required = true)
-	private ExamType examType;
+    public void setBeginTime(Date beginTime) {
+        this.beginTime = beginTime;
+    }
 
-	@ApiModelProperty(value = "考试时长(单位：分钟)", example = "120", required = true)
-	private Integer duration;
+    public Date getEndTime() {
+        return endTime;
+    }
 
-	@ApiModelProperty(value = "考试备注", example = "xxx", required = true)
-	private String remark;
+    public void setEndTime(Date endTime) {
+        this.endTime = endTime;
+    }
 
-	@ApiModelProperty(value = "考试次数", example = "2", required = true)
-	private Long examTimes;
-	
-	@ApiModelProperty(value = "是否开启默认场次", example = "true", required = false)
-	private Boolean enableExamStage;
-	
-	@ApiModelProperty(value = "迟到分钟数限制", example = "30", required = false)
-	private Integer lateMinuteLimit;
-//	
-//	@ApiModelProperty(value = "抽题模式(WHOLE_SET:成套调用;RANDOM_PAPER:随机抽题)", example = "WHOLE_SET", required = false)
-//	private CallType callType;
-	
-	@ApiModelProperty(value = "是否定点交卷", example = "true", required = false)
-	private Boolean enableTimingEnd;
-	
-	@ApiModelProperty(value = "ip白名单", example = "[\"xxx.xxx.xxx.xxx\",\"xxx.xxx.xxx.xxx\"]", required = false)
-	private List<String> ipWhitelist;
+    public String getName() {
+        return name;
+    }
 
-	@ApiModelProperty(value = "扩展属性", example = "{\"IS_FACE_ENABLE\":\"false\"}", required = true)
-	private Map<String, String> properties;
+    public void setName(String name) {
+        this.name = name;
+    }
 
-	public Long getRootOrgId() {
-		return rootOrgId;
-	}
+    public ExamType getExamType() {
+        return examType;
+    }
 
-	public void setRootOrgId(Long rootOrgId) {
-		this.rootOrgId = rootOrgId;
-	}
+    public void setExamType(ExamType examType) {
+        this.examType = examType;
+    }
 
-	public Date getBeginTime() {
-		return beginTime;
-	}
+    public Integer getDuration() {
+        return duration;
+    }
 
-	public void setBeginTime(Date beginTime) {
-		this.beginTime = beginTime;
-	}
+    public void setDuration(Integer duration) {
+        this.duration = duration;
+    }
 
-	public Date getEndTime() {
-		return endTime;
-	}
+    public String getRemark() {
+        return remark;
+    }
 
-	public void setEndTime(Date endTime) {
-		this.endTime = endTime;
-	}
+    public void setRemark(String remark) {
+        this.remark = remark;
+    }
 
-	public String getName() {
-		return name;
-	}
+    public Long getExamTimes() {
+        return examTimes;
+    }
 
-	public void setName(String name) {
-		this.name = name;
-	}
+    public void setExamTimes(Long examTimes) {
+        this.examTimes = examTimes;
+    }
 
-	public ExamType getExamType() {
-		return examType;
-	}
+    public Map<String, String> getProperties() {
+        return properties;
+    }
 
-	public void setExamType(ExamType examType) {
-		this.examType = examType;
-	}
+    public void setProperties(Map<String, String> properties) {
+        this.properties = properties;
+    }
 
-	public Integer getDuration() {
-		return duration;
-	}
+    public String getCode() {
+        return code;
+    }
 
-	public void setDuration(Integer duration) {
-		this.duration = duration;
-	}
+    public void setCode(String code) {
+        this.code = code;
+    }
 
-	public String getRemark() {
-		return remark;
-	}
+    public Boolean getEnableExamStage() {
+        return enableExamStage;
+    }
 
-	public void setRemark(String remark) {
-		this.remark = remark;
-	}
-
-	public Long getExamTimes() {
-		return examTimes;
-	}
-
-	public void setExamTimes(Long examTimes) {
-		this.examTimes = examTimes;
-	}
-
-	public Map<String, String> getProperties() {
-		return properties;
-	}
-
-	public void setProperties(Map<String, String> properties) {
-		this.properties = properties;
-	}
-
-	public String getCode() {
-		return code;
-	}
-
-	public void setCode(String code) {
-		this.code = code;
-	}
-
-	public Boolean getEnableExamStage() {
-		return enableExamStage;
-	}
-
-	public void setEnableExamStage(Boolean enableExamStage) {
-		this.enableExamStage = enableExamStage;
-	}
-
-	public Integer getLateMinuteLimit() {
-		return lateMinuteLimit;
-	}
+    public void setEnableExamStage(Boolean enableExamStage) {
+        this.enableExamStage = enableExamStage;
+    }
 
-	public void setLateMinuteLimit(Integer lateMinuteLimit) {
-		this.lateMinuteLimit = lateMinuteLimit;
-	}
+    public Integer getLateMinuteLimit() {
+        return lateMinuteLimit;
+    }
 
+    public void setLateMinuteLimit(Integer lateMinuteLimit) {
+        this.lateMinuteLimit = lateMinuteLimit;
+    }
 
-	public Boolean getEnableTimingEnd() {
-		return enableTimingEnd;
-	}
+    public Boolean getEnableTimingEnd() {
+        return enableTimingEnd;
+    }
 
-	public void setEnableTimingEnd(Boolean enableTimingEnd) {
-		this.enableTimingEnd = enableTimingEnd;
-	}
+    public void setEnableTimingEnd(Boolean enableTimingEnd) {
+        this.enableTimingEnd = enableTimingEnd;
+    }
 
-	public List<String> getIpWhitelist() {
-		return ipWhitelist;
-	}
+    public List<String> getIpWhitelist() {
+        return ipWhitelist;
+    }
 
-	public void setIpWhitelist(List<String> ipWhitelist) {
-		this.ipWhitelist = ipWhitelist;
-	}
+    public void setIpWhitelist(List<String> ipWhitelist) {
+        this.ipWhitelist = ipWhitelist;
+    }
 
 }

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

@@ -1,10 +1,10 @@
 package cn.com.qmth.examcloud.exchange.outer.api.response;
 
-import java.util.Date;
-
 import cn.com.qmth.examcloud.api.commons.exchange.EnterpriseResponse;
 import io.swagger.annotations.ApiModelProperty;
 
+import java.util.Date;
+
 /**
  * 类注释
  *
@@ -14,146 +14,116 @@ import io.swagger.annotations.ApiModelProperty;
  */
 public class OuterGetExamResp extends EnterpriseResponse {
 
-	private static final long serialVersionUID = 1030154836013325322L;
-
-	/**
-	 * ID
-	 */
-	@ApiModelProperty(value = "考试ID", example = "128", required = true)
-	private Long id;
-
-	/**
-	 * 顶级机构Id
-	 */
-	@ApiModelProperty(value = "顶级机构", example = "0", required = true)
-	private Long rootOrgId;
-
-	/**
-	 * 考试批次开始时间
-	 */
-	@ApiModelProperty(value = " 考试批次开始时间", example = "2018-10-10 08:00:00", required = true)
-	private Date beginTime;
-
-	/**
-	 * 考试批次结束时间
-	 */
-	@ApiModelProperty(value = " 考试批次结束时间", example = "2018-10-10 08:00:00", required = true)
-	private Date endTime;
-
-	/**
-	 * 考试名称
-	 */
-	@ApiModelProperty(value = "考试名称(实际上为考试编码)", example = "2018年6月期末考试", required = true)
-	private String name;
-
-	/**
-	 * 考试类型
-	 */
-	@ApiModelProperty(value = " 考试类型(ONLINE:网考;TRADITION:传统;OFFLINE:离线;PRACTICE:练习;PRINT_EXAM:PRINT_EXAM.)", example = "ONLINE", required = true)
-	private String examType;
-
-	/**
-	 * 考试时长(分钟)
-	 */
-	@ApiModelProperty(value = "考试时长(单位：分钟)", example = "120", required = true)
-	private Integer duration;
-
-	/**
-	 * 是否可用
-	 */
-	@ApiModelProperty(value = "是否可用", example = "true", required = true)
-	private Boolean enable;
-
-	/**
-	 * 考试备注
-	 */
-	@ApiModelProperty(value = "考试备注", example = "xxx", required = true)
-	private String remark;
-
-	/**
-	 * 考试次数
-	 */
-	@ApiModelProperty(value = "考试次数", example = "2", required = true)
-	private Long examTimes;
-
-	public Long getId() {
-		return id;
-	}
-
-	public void setId(Long id) {
-		this.id = id;
-	}
-
-	public Long getRootOrgId() {
-		return rootOrgId;
-	}
-
-	public void setRootOrgId(Long rootOrgId) {
-		this.rootOrgId = rootOrgId;
-	}
-
-	public Date getBeginTime() {
-		return beginTime;
-	}
-
-	public void setBeginTime(Date beginTime) {
-		this.beginTime = beginTime;
-	}
-
-	public Date getEndTime() {
-		return endTime;
-	}
-
-	public void setEndTime(Date endTime) {
-		this.endTime = endTime;
-	}
-
-	public String getName() {
-		return name;
-	}
-
-	public void setName(String name) {
-		this.name = name;
-	}
-
-	public String getExamType() {
-		return examType;
-	}
-
-	public void setExamType(String examType) {
-		this.examType = examType;
-	}
-
-	public Integer getDuration() {
-		return duration;
-	}
-
-	public void setDuration(Integer duration) {
-		this.duration = duration;
-	}
-
-	public Boolean getEnable() {
-		return enable;
-	}
-
-	public void setEnable(Boolean enable) {
-		this.enable = enable;
-	}
-
-	public String getRemark() {
-		return remark;
-	}
-
-	public void setRemark(String remark) {
-		this.remark = remark;
-	}
-
-	public Long getExamTimes() {
-		return examTimes;
-	}
-
-	public void setExamTimes(Long examTimes) {
-		this.examTimes = examTimes;
-	}
+    private static final long serialVersionUID = 1030154836013325322L;
+
+    @ApiModelProperty(value = "顶级机构", example = "123")
+    private Long rootOrgId;
+
+    @ApiModelProperty(value = "考试ID", example = "123")
+    private Long id;
+
+    @ApiModelProperty(value = " 考试开始时间", example = "2024-06-01 08:00:00")
+    private Date beginTime;
+
+    @ApiModelProperty(value = " 考试结束时间", example = "2024-06-01 10:00:00")
+    private Date endTime;
+
+    @ApiModelProperty(value = "考试名称（实际为考试编码）", example = "2024年6月期末考试")
+    private String name;
+
+    @ApiModelProperty(value = " 考试类型（ONLINE:网考；OFFLINE:离线；PRACTICE:练习）", example = "ONLINE")
+    private String examType;
+
+    @ApiModelProperty(value = "考试时长（单位：分钟）", example = "120")
+    private Integer duration;
+
+    @ApiModelProperty(value = "是否启用", example = "true")
+    private Boolean enable;
+
+    @ApiModelProperty(value = "考试备注", example = "xxx")
+    private String remark;
+
+    @ApiModelProperty(value = "考试次数", example = "1")
+    private Long examTimes;
+
+    public Long getId() {
+        return id;
+    }
+
+    public void setId(Long id) {
+        this.id = id;
+    }
+
+    public Long getRootOrgId() {
+        return rootOrgId;
+    }
+
+    public void setRootOrgId(Long rootOrgId) {
+        this.rootOrgId = rootOrgId;
+    }
+
+    public Date getBeginTime() {
+        return beginTime;
+    }
+
+    public void setBeginTime(Date beginTime) {
+        this.beginTime = beginTime;
+    }
+
+    public Date getEndTime() {
+        return endTime;
+    }
+
+    public void setEndTime(Date endTime) {
+        this.endTime = endTime;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public void setName(String name) {
+        this.name = name;
+    }
+
+    public String getExamType() {
+        return examType;
+    }
+
+    public void setExamType(String examType) {
+        this.examType = examType;
+    }
+
+    public Integer getDuration() {
+        return duration;
+    }
+
+    public void setDuration(Integer duration) {
+        this.duration = duration;
+    }
+
+    public Boolean getEnable() {
+        return enable;
+    }
+
+    public void setEnable(Boolean enable) {
+        this.enable = enable;
+    }
+
+    public String getRemark() {
+        return remark;
+    }
+
+    public void setRemark(String remark) {
+        this.remark = remark;
+    }
+
+    public Long getExamTimes() {
+        return examTimes;
+    }
+
+    public void setExamTimes(Long examTimes) {
+        this.examTimes = examTimes;
+    }
 
 }

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

@@ -12,17 +12,17 @@ import io.swagger.annotations.ApiModelProperty;
  */
 public class OuterSaveExamResp extends EnterpriseResponse {
 
-	private static final long serialVersionUID = -8997559197584414927L;
+    private static final long serialVersionUID = -8997559197584414927L;
 
-	@ApiModelProperty(value = "考试ID", example = "128", required = true)
-	private Long examId;
+    @ApiModelProperty(value = "考试ID", example = "123")
+    private Long examId;
 
-	public Long getExamId() {
-		return examId;
-	}
+    public Long getExamId() {
+        return examId;
+    }
 
-	public void setExamId(Long examId) {
-		this.examId = examId;
-	}
+    public void setExamId(Long examId) {
+        this.examId = examId;
+    }
 
 }