Browse Source

update api param desc...

deason 8 months ago
parent
commit
222abc01dd

+ 130 - 129
examcloud-exchange-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/request/cug/OuterSaveCugStudentAndExamStudentReq.java

@@ -12,181 +12,182 @@ import io.swagger.annotations.ApiModelProperty;
  */
 public class OuterSaveCugStudentAndExamStudentReq extends EnterpriseRequest {
 
-	private static final long serialVersionUID = 8293200048902081959L;
+    private static final long serialVersionUID = 8293200048902081959L;
 
-	@ApiModelProperty(value = "学生姓名", example = "陈圆圆", required = true)
-	private String name;
+    @ApiModelProperty(value = "顶级机构ID", example = "123", required = true)
+    private Long rootOrgId;
 
-	@ApiModelProperty(value = "顶级机构", example = "0", required = true)
-	private Long rootOrgId;
+    @ApiModelProperty(value = "考试编码", example = "2024年6月期末考试", required = true)
+    private String examCode;
 
-	@ApiModelProperty(value = "学习中心编码", example = "LC111", required = true)
-	private String orgCode;
+    @ApiModelProperty(value = "考试名称(实际作为考试编码使用)", example = "2024年6月期末考试")
+    private String examName;
 
-	@ApiModelProperty(value = "学习中心名称", example = "XXX", required = true)
-	private String orgName;
+    @ApiModelProperty(value = "考试试卷类型(大写字母A-Z)", example = "X", required = true)
+    private String paperType;
 
-	@ApiModelProperty(value = "学生学号", example = "2018001001", required = true)
-	private String studentCode;
+    @ApiModelProperty(value = "学生姓名", example = "张三", required = true)
+    private String name;
 
-	@ApiModelProperty(value = "学生身份证号", example = "XXXXXXXXXXXXXXXXXX", required = true)
-	private String identityNumber;
+    @ApiModelProperty(value = "证件号", example = "123456789123456789", required = true)
+    private String identityNumber;
 
-	@ApiModelProperty(value = "备注", example = "XX", required = false)
-	private String remark;
+    @ApiModelProperty(value = "学号", example = "12345678")
+    private String studentCode;
 
-	@ApiModelProperty(value = "照片URL", example = "http://xxxx.xx/123.jpg", required = false)
-	private String photoUrl;
+    @ApiModelProperty(value = "专业名称", example = "计算机专业")
+    private String specialtyName;
 
-	@ApiModelProperty(value = "手机号码", example = "XXXXXXXXXXX", required = true)
-	private String phoneNumber;
+    @ApiModelProperty(value = "信息采集人", example = "xxx")
+    private String infoCollector;
 
-	@ApiModelProperty(value = "操作者", example = "XX系统", required = true)
-	private String operator;
+    @ApiModelProperty(value = "备注", example = "xxx")
+    private String remark;
 
-	@ApiModelProperty(value = "考试代码", example = "2018年秋季入学考试", required = false)
-	private String examCode;
-	@ApiModelProperty(value = "考试名称", example = "2018年秋季入学考试", required = true)
-	private String examName;
+    @ApiModelProperty(value = "课程组", example = "本科", required = true)
+    private String courseGroupName;
 
-	@ApiModelProperty(value = "专业名称", example = "计算机", required = false)
-	private String specialtyName;
+    @ApiModelProperty(value = "学习中心编码", example = "org123", required = true)
+    private String orgCode;
 
-	@ApiModelProperty(value = "课程组", example = "本科", required = true)
-	private String courseGroupName;
+    @ApiModelProperty(value = "学习中心名称", example = "中心123", required = true)
+    private String orgName;
 
-	@ApiModelProperty(value = "试卷类型,大写字母A-Z", example = "X", required = true)
-	private String paperType;
+    @ApiModelProperty(value = "手机号码", example = "18600000001")
+    private String phoneNumber;
 
-	@ApiModelProperty(value = "信息采集人", example = "王二小", required = false)
-	private String infoCollector;
+    @ApiModelProperty(value = "底照图片URL", example = "http://xxx.xxx/xxx.jpg", hidden = true)
+    private String photoUrl;
 
-	public String getExamCode() {
-		return examCode;
-	}
+    @ApiModelProperty(value = "操作者", example = "xxx")
+    private String operator;
 
-	public void setExamCode(String examCode) {
-		this.examCode = examCode;
-	}
+    public String getExamCode() {
+        return examCode;
+    }
 
-	public String getName() {
-		return name;
-	}
+    public void setExamCode(String examCode) {
+        this.examCode = examCode;
+    }
 
-	public void setName(String name) {
-		this.name = name;
-	}
+    public String getName() {
+        return name;
+    }
 
-	public Long getRootOrgId() {
-		return rootOrgId;
-	}
+    public void setName(String name) {
+        this.name = name;
+    }
 
-	public void setRootOrgId(Long rootOrgId) {
-		this.rootOrgId = rootOrgId;
-	}
+    public Long getRootOrgId() {
+        return rootOrgId;
+    }
 
-	public String getOrgCode() {
-		return orgCode;
-	}
+    public void setRootOrgId(Long rootOrgId) {
+        this.rootOrgId = rootOrgId;
+    }
 
-	public void setOrgCode(String orgCode) {
-		this.orgCode = orgCode;
-	}
+    public String getOrgCode() {
+        return orgCode;
+    }
 
-	public String getOrgName() {
-		return orgName;
-	}
+    public void setOrgCode(String orgCode) {
+        this.orgCode = orgCode;
+    }
 
-	public void setOrgName(String orgName) {
-		this.orgName = orgName;
-	}
+    public String getOrgName() {
+        return orgName;
+    }
 
-	public String getStudentCode() {
-		return studentCode;
-	}
+    public void setOrgName(String orgName) {
+        this.orgName = orgName;
+    }
 
-	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 getRemark() {
-		return remark;
-	}
+    public void setIdentityNumber(String identityNumber) {
+        this.identityNumber = identityNumber;
+    }
 
-	public void setRemark(String remark) {
-		this.remark = remark;
-	}
+    public String getRemark() {
+        return remark;
+    }
 
-	public String getPhotoUrl() {
-		return photoUrl;
-	}
+    public void setRemark(String remark) {
+        this.remark = remark;
+    }
 
-	public void setPhotoUrl(String photoUrl) {
-		this.photoUrl = photoUrl;
-	}
+    public String getPhotoUrl() {
+        return photoUrl;
+    }
 
-	public String getPhoneNumber() {
-		return phoneNumber;
-	}
+    public void setPhotoUrl(String photoUrl) {
+        this.photoUrl = photoUrl;
+    }
 
-	public void setPhoneNumber(String phoneNumber) {
-		this.phoneNumber = phoneNumber;
-	}
+    public String getPhoneNumber() {
+        return phoneNumber;
+    }
 
-	public String getOperator() {
-		return operator;
-	}
+    public void setPhoneNumber(String phoneNumber) {
+        this.phoneNumber = phoneNumber;
+    }
 
-	public void setOperator(String operator) {
-		this.operator = operator;
-	}
+    public String getOperator() {
+        return operator;
+    }
 
-	public String getExamName() {
-		return examName;
-	}
+    public void setOperator(String operator) {
+        this.operator = operator;
+    }
 
-	public void setExamName(String examName) {
-		this.examName = examName;
-	}
+    public String getExamName() {
+        return examName;
+    }
 
-	public String getSpecialtyName() {
-		return specialtyName;
-	}
+    public void setExamName(String examName) {
+        this.examName = examName;
+    }
 
-	public void setSpecialtyName(String specialtyName) {
-		this.specialtyName = specialtyName;
-	}
+    public String getSpecialtyName() {
+        return specialtyName;
+    }
 
-	public String getCourseGroupName() {
-		return courseGroupName;
-	}
+    public void setSpecialtyName(String specialtyName) {
+        this.specialtyName = specialtyName;
+    }
 
-	public void setCourseGroupName(String courseGroupName) {
-		this.courseGroupName = courseGroupName;
-	}
+    public String getCourseGroupName() {
+        return courseGroupName;
+    }
 
-	public String getPaperType() {
-		return paperType;
-	}
+    public void setCourseGroupName(String courseGroupName) {
+        this.courseGroupName = courseGroupName;
+    }
 
-	public void setPaperType(String paperType) {
-		this.paperType = paperType;
-	}
+    public String getPaperType() {
+        return paperType;
+    }
 
-	public String getInfoCollector() {
-		return infoCollector;
-	}
+    public void setPaperType(String paperType) {
+        this.paperType = paperType;
+    }
 
-	public void setInfoCollector(String infoCollector) {
-		this.infoCollector = infoCollector;
-	}
+    public String getInfoCollector() {
+        return infoCollector;
+    }
+
+    public void setInfoCollector(String infoCollector) {
+        this.infoCollector = infoCollector;
+    }
 
 }

+ 43 - 43
examcloud-exchange-api/src/main/java/cn/com/qmth/examcloud/exchange/outer/api/response/cug/SaveCugStudentAndExamStudentResp.java

@@ -1,10 +1,10 @@
 package cn.com.qmth.examcloud.exchange.outer.api.response.cug;
 
-import java.util.List;
-
 import cn.com.qmth.examcloud.api.commons.exchange.EnterpriseResponse;
 import io.swagger.annotations.ApiModelProperty;
 
+import java.util.List;
+
 /**
  * 类注释
  *
@@ -14,61 +14,61 @@ import io.swagger.annotations.ApiModelProperty;
  */
 public class SaveCugStudentAndExamStudentResp extends EnterpriseResponse {
 
-	private static final long serialVersionUID = -7321764983963904493L;
+    private static final long serialVersionUID = -7321764983963904493L;
 
-	@ApiModelProperty(value = "学生ID", example = "500", required = true)
-	private Long studentId;
+    @ApiModelProperty(value = "顶级机构ID", example = "123")
+    private Long rootOrgId;
 
-	@ApiModelProperty(value = "顶级机构ID", example = "0", required = true)
-	private Long rootOrgId;
+    @ApiModelProperty(value = "学生ID", example = "123")
+    private Long studentId;
 
-	@ApiModelProperty(value = "学习中心ID", example = "0", required = true)
-	private Long orgId;
+    @ApiModelProperty(value = "学习中心ID", example = "123")
+    private Long orgId;
 
-	@ApiModelProperty(value = "学习中心名称", example = "0", required = true)
-	private String orgName;
+    @ApiModelProperty(value = "学习中心名称", example = "中心123")
+    private String orgName;
 
-	@ApiModelProperty(value = "考生ID集合", required = true)
-	private List<Long> examStudentIdList;
+    @ApiModelProperty(value = "考生ID集合")
+    private List<Long> examStudentIdList;
 
-	public Long getStudentId() {
-		return studentId;
-	}
+    public Long getStudentId() {
+        return studentId;
+    }
 
-	public void setStudentId(Long studentId) {
-		this.studentId = studentId;
-	}
+    public void setStudentId(Long studentId) {
+        this.studentId = studentId;
+    }
 
-	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 Long getOrgId() {
-		return orgId;
-	}
+    public Long getOrgId() {
+        return orgId;
+    }
 
-	public void setOrgId(Long orgId) {
-		this.orgId = orgId;
-	}
+    public void setOrgId(Long orgId) {
+        this.orgId = orgId;
+    }
 
-	public String getOrgName() {
-		return orgName;
-	}
+    public String getOrgName() {
+        return orgName;
+    }
 
-	public void setOrgName(String orgName) {
-		this.orgName = orgName;
-	}
+    public void setOrgName(String orgName) {
+        this.orgName = orgName;
+    }
 
-	public List<Long> getExamStudentIdList() {
-		return examStudentIdList;
-	}
+    public List<Long> getExamStudentIdList() {
+        return examStudentIdList;
+    }
 
-	public void setExamStudentIdList(List<Long> examStudentIdList) {
-		this.examStudentIdList = examStudentIdList;
-	}
+    public void setExamStudentIdList(List<Long> examStudentIdList) {
+        this.examStudentIdList = examStudentIdList;
+    }
 
 }