public class CreateSchemeUrlRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
CreateSchemeUrlRequest() |
CreateSchemeUrlRequest(CreateSchemeUrlRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
Agent |
getAgent()
Get 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
Boolean |
getAutoJumpBack()
Get 签署完成后是否自动回跳
**false**:否, 签署完成不会自动跳转回来(默认)**true**:是, 签署完成会自动跳转回来
注:
1.
|
String |
getEndPoint()
Get 要跳转的链接类型
**HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)
**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
|
String |
getFlowGroupId()
Get 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
|
FlowGroupUrlInfo |
getFlowGroupUrlInfo()
Get 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
|
String |
getFlowId()
Get 合同流程ID
注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
|
Long[] |
getHides()
Get 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
**0** :合同签署页面更多操作按钮
**1** :合同签署页面更多操作的拒绝签署按钮
**2** :合同签署页面更多操作的转他人处理按钮
**3** :签署成功页的查看详情按钮
注: `字段为数组, 可以传值隐藏多个按钮`
|
String |
getIdCardNumber()
Get 证件号码,应符合以下规则
居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。
港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
|
String |
getIdCardType()
Get 证件类型,支持以下类型
ID_CARD : 居民身份证
HONGKONG_AND_MACAO : 港澳居民来往内地通行证
HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
|
String |
getMobile()
Get 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
String |
getName()
Get 合同流程里边签署方经办人的姓名。
|
UserInfo |
getOperator()
Get 执行本接口操作的员工信息, userId 必填。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
String |
getOrganizationName()
Get 合同流程签署方的组织机构名称。如果名称中包含英文括号(),请使用中文括号()代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
|
Long |
getPathType()
|
String |
getRecipientId()
Get 签署节点ID,用于生成动态签署人链接完成领取。
注:`生成动态签署人补充链接时必传。`
|
void |
setAgent(Agent Agent)
Set 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
void |
setAutoJumpBack(Boolean AutoJumpBack)
Set 签署完成后是否自动回跳
**false**:否, 签署完成不会自动跳转回来(默认)**true**:是, 签署完成会自动跳转回来
注:
1.
|
void |
setEndPoint(String EndPoint)
Set 要跳转的链接类型
**HTTP**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回长链 (默认类型)
**HTTP_SHORT_URL**:跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型,此时返回短链
**APP**: 第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型
|
void |
setFlowGroupId(String FlowGroupId)
Set 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值
|
void |
setFlowGroupUrlInfo(FlowGroupUrlInfo FlowGroupUrlInfo)
Set 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。
|
void |
setFlowId(String FlowId)
Set 合同流程ID
注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`
|
void |
setHides(Long[] Hides)
Set 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
**0** :合同签署页面更多操作按钮
**1** :合同签署页面更多操作的拒绝签署按钮
**2** :合同签署页面更多操作的转他人处理按钮
**3** :签署成功页的查看详情按钮
注: `字段为数组, 可以传值隐藏多个按钮`
|
void |
setIdCardNumber(String IdCardNumber)
Set 证件号码,应符合以下规则
居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。
港澳居民来往内地通行证号码共11位。第1位为字母,“H”字头签发给香港居民,“M”字头签发给澳门居民;第2位至第11位为数字。
港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。
|
void |
setIdCardType(String IdCardType)
Set 证件类型,支持以下类型
ID_CARD : 居民身份证
HONGKONG_AND_MACAO : 港澳居民来往内地通行证
HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)
|
void |
setMobile(String Mobile)
Set 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
void |
setName(String Name)
Set 合同流程里边签署方经办人的姓名。
|
void |
setOperator(UserInfo Operator)
Set 执行本接口操作的员工信息, userId 必填。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
void |
setOrganizationName(String OrganizationName)
Set 合同流程签署方的组织机构名称。如果名称中包含英文括号(),请使用中文括号()代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
|
void |
setPathType(Long PathType)
|
void |
setRecipientId(String RecipientId)
Set 签署节点ID,用于生成动态签署人链接完成领取。
注:`生成动态签署人补充链接时必传。`
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public CreateSchemeUrlRequest()
public CreateSchemeUrlRequest(CreateSchemeUrlRequest source)
public UserInfo getOperator()
public void setOperator(UserInfo Operator)
Operator
- 执行本接口操作的员工信息, userId 必填。
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`public String getOrganizationName()
public void setOrganizationName(String OrganizationName)
OrganizationName
- 合同流程签署方的组织机构名称。如果名称中包含英文括号(),请使用中文括号()代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`public String getName()
public void setName(String Name)
Name
- 合同流程里边签署方经办人的姓名。public String getMobile()
public void setMobile(String Mobile)
Mobile
- 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。public String getIdCardType()
public void setIdCardType(String IdCardType)
IdCardType
- 证件类型,支持以下类型
public String getIdCardNumber()
public void setIdCardNumber(String IdCardNumber)
IdCardNumber
- 证件号码,应符合以下规则
public String getEndPoint()
public void setEndPoint(String EndPoint)
EndPoint
- 要跳转的链接类型
public String getFlowId()
public void setFlowId(String FlowId)
FlowId
- 合同流程ID
注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传, 跳转其他页面可不传`public String getFlowGroupId()
public void setFlowGroupId(String FlowGroupId)
FlowGroupId
- 合同流程组的组ID, 在合同流程组场景下,生成合同流程组的签署链接时需要赋值public Long getPathType()
public void setPathType(Long PathType)
public Boolean getAutoJumpBack()
public void setAutoJumpBack(Boolean AutoJumpBack)
AutoJumpBack
- 签署完成后是否自动回跳
public Agent getAgent()
public void setAgent(Agent Agent)
Agent
- 代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。public Long[] getHides()
public void setHides(Long[] Hides)
Hides
- 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
public String getRecipientId()
public void setRecipientId(String RecipientId)
RecipientId
- 签署节点ID,用于生成动态签署人链接完成领取。
注:`生成动态签署人补充链接时必传。`public FlowGroupUrlInfo getFlowGroupUrlInfo()
public void setFlowGroupUrlInfo(FlowGroupUrlInfo FlowGroupUrlInfo)
FlowGroupUrlInfo
- 合同组相关信息,指定合同组子合同和签署方的信息,用于补充动态签署人。Copyright © 2024. All rights reserved.