5.1 发起签署流程

请求参数

Authorization

Query 参数

access_token

string

必需

授权码；正式环境联系签署平台方获取

默认值:

3e9dec5f-4a9d-4af8-8abc-23e4675a1eb6

Header 参数

X-Signit-App-Id

string

必需

应用id；正式环境联系签署平台方获取

默认值:

1931fabdb516e66ca2f8c42691a

Body 参数application/json

customTagID

string

业务方自定义标识

必需

doctorID

string

医生id

必需

工号

doctorName

string

医生姓名

必需

template

object

业务模板

必需

name

string

模板名称

必需

wsid

string

模板id

必需

hospitalDepartment

object

科室信息

必需

departmentName

string

科室名称

必需

departmentID

string

科室代码

必需

patientID

string

患者id

必需

patientName

string

患者姓名

必需

patientAge

string

患者年龄

必需

patientSex

integer

患者性别

必需

0表示男， 1表示女 2 表示不确定

admissionNumber

string

住院号

必需

idCard

string

身份证号

必需

bedNumber

string

床号

必需

mode

string

签署流程模式

可选

MANUAL - 手动模式，需调用“完成签署流程”接口确认完成
AUTO - 自动模式，模板中所有的签名成功后，自动完成签署流程（根据模板的配置，最后一个流程的签署方签署完成后自动完成，如果需要中途完成，要手动调用“完成签署流程”接口）
默认值：AUTO

示例

{
  "bedNumber": "bed1234",
  "patientID": "A00034616",
  "patientName": "刘波",
  "patientAge": 28,
  "patientSex": 0,
  "admissionNumber": "1429202208086819",
  "idCard": "510723199601034411",
  "template": {
    "name": "产科病房胎动计数",
    "wsid": "WSID_TEMP_0000018a02112bba72e10ebc53a40001"
  },
  "hospitalDepartment": {
    "departmentName": "产科",
    "departmentID": "产科代码"
  },
  "doctorName": "发起医生",
  "doctorID": "job_wutao",
  "customTagID": "{{$timestamp}}"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://m1.apifoxmock.com/m1/4604434-0-default/v1/open/hospital/hospitals/templates/form/apply?access_token=' \
--header 'X-Signit-App-Id;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "bedNumber": "bed1234",
    "patientID": "A00034616",
    "patientName": "刘波",
    "patientAge": 28,
    "patientSex": 0,
    "admissionNumber": "1429202208086819",
    "idCard": "510723199601034411",
    "template": {
        "name": "产科病房胎动计数",
        "wsid": "WSID_TEMP_0000018a02112bba72e10ebc53a40001"
    },
    "hospitalDepartment": {
        "departmentName": "产科",
        "departmentID": "产科代码"
    },
    "doctorName": "发起医生",
    "doctorID": "job_wutao",
    "customTagID": "{{$timestamp}}"
}'

返回响应

🟢200成功

application/json

Body

code

string

接口响应码

必需

100870000=成功，其他=失败

message

string

接口响应消息

必需

invokeNumber

string

当前请求唯一编号

必需

envelopeWsid

string

当前签署流程唯一标识

必需

customTag

string

业务自定义编码

必需

flowDef

array [object {3}]

流程定义

可选

fillStep

string

流程填写标识

必需

fill-in 接口需要使用此参数

sequence

integer

流程顺序

必需

序号相同则表示无序签署

participantConfigs

array [object {5}]

流程中签署方配置

必需

flowCount

integer

流程数量

必需

表示最多可填写多少次

示例

{
  "code": "100870000",
  "message": "操作成功",
  "invokeNumber": "202406210939022094001516203001",
  "envelopeWsid": "WSID_ENVE_0000019038726f50660be92327670001",
  "customTag": "1718933941",
  "flowCount": 25,
  "flowDef": [
    {
      "fillStep": "RECORD_1",
      "sequence": 1,
      "participantConfigs": [
        {
          "type": "DOCTOR",
          "sequence": 1,
          "name": "护士",
          "forms": [
            {
              "id": "18087059",
              "name": "name",
              "type": "TEXT",
              "title": "孕妇姓名",
              "position": {
                "ulx": 79.125,
                "uly": 96.64453125,
                "lrx": 124.248046875,
                "lry": 116.64453125,
                "docPage": 1
              }
            },
            {
              "id": "94173885",
              "name": "bedNo",
              "type": "TEXT",
              "title": "床号",
              "position": {
                "ulx": 145.875,
                "uly": 95.14453125,
                "lrx": 173.560546875,
                "lry": 115.14453125,
                "docPage": 1
              }
            },
            {
              "id": "51302751",
              "name": "admissionNumber",
              "type": "TEXT",
              "title": "住院号",
              "position": {
                "ulx": 203.625,
                "uly": 96.64453125,
                "lrx": 266.1796875,
                "lry": 116.64453125,
                "docPage": 1
              }
            },
            {
              "id": "4826199",
              "name": "diagnose",
              "type": "TEXT",
              "title": "诊断",
              "position": {
                "ulx": 295.875,
                "uly": 95.14453125,
                "lrx": 409.6171875,
                "lry": 115.14453125,
                "docPage": 1
              }
            },
            {
              "id": "25541730",
              "name": "rcDate",
              "type": "TEXT",
              "title": "日期",
              "position": {
                "ulx": 37.875,
                "uly": 158.89453125,
                "lrx": 96.498046875,
                "lry": 178.89453125,
                "docPage": 1
              }
            },
            {
              "id": "37125434",
              "name": "rcTime",
              "type": "TEXT",
              "title": "时间(起始-结束)",
              "position": {
                "ulx": 37.875,
                "uly": 158.89453125,
                "lrx": 96.498046875,
                "lry": 178.89453125,
                "docPage": 1
              }
            },
            {
              "id": "10875938",
              "name": "weeks",
              "type": "TEXT",
              "title": "孕周",
              "position": {
                "ulx": 181.125,
                "uly": 159.64453125,
                "lrx": 223.435546875,
                "lry": 179.64453125,
                "docPage": 1
              }
            },
            {
              "id": "23196827",
              "name": "fetalMovementCount",
              "type": "TEXT",
              "title": "胎动次数",
              "position": {
                "ulx": 226.125,
                "uly": 159.64453125,
                "lrx": 270.123046875,
                "lry": 179.64453125,
                "docPage": 1
              }
            },
            {
              "id": "74985370",
              "name": "remark",
              "type": "TEXT",
              "title": "备注",
              "position": {
                "ulx": 398.625,
                "uly": 158.89453125,
                "lrx": 555.6796875,
                "lry": 178.89453125,
                "docPage": 1
              }
            }
          ],
          "signs": [
            {
              "id": "4497415",
              "name": "signer",
              "type": "WRITE_SIGN",
              "title": "护士签名",
              "position": {
                "ulx": 335.49609375,
                "uly": 157.640625,
                "lrx": 394.640625,
                "lry": 180.28125,
                "docPage": 1
              }
            }
          ]
        },
        {
          "type": "PATIENT",
          "sequence": 2,
          "name": "孕妇",
          "forms": [],
          "signs": [
            {
              "id": "77379697",
              "name": "signer",
              "type": "WRITE_SIGN",
              "title": "孕妇签名",
              "position": {
                "ulx": 272.49609375,
                "uly": 157.640625,
                "lrx": 333.328125,
                "lry": 180.97265625,
                "docPage": 1
              }
            }
          ]
        }
      ]
    }
  ]
}

🟠400参数不正确