his查询人数控制
https://api.mytijian.com/open-api/V2/ws/counter/queryCounterCapacity?accessToken=ACCESS_TOKEN
请求协议:HTTPS
请求方式:POST
需要签名: 否
URL参数:
参数名 |
是否必须 |
类型 |
说明 |
accessToken |
是 |
string |
当前有效的accessToken |
POST参数示例
{
"startDate":"2020-03-01",
"endDate":"2020-03-01"
}
请求参数说明:
参数名 |
是否必须 |
类型 |
说明 |
startDate |
是 |
string |
开始时间 |
endDate |
是 |
string |
结束时间 |
companyId |
否 |
int |
平台单位id |
正确返回示例:
{
"data": [
{
"date": "2020-03-01",
"week": 7,
"periodExamItemDtoList": [
{
"examItemCapacityDtoList": [
{
"period": 1244,
"expandNum": 0,
"occupyNum": 0,
"periodName": "7:00-8:00",
"availableNum": 0,
"maxNum": 0,
"usedNum": 0
},
{
"period": 4001373,
"expandNum": 0,
"occupyNum": 0,
"periodName": "8:00-9:00",
"availableNum": 0,
"maxNum": 0,
"usedNum": 0
},
{
"period": 4002346,
"expandNum": 0,
"occupyNum": 0,
"periodName": "12:00-14:00",
"availableNum": 0,
"maxNum": 0,
"usedNum": 0
}
],
"examItemName": "人数控制测试",
"examItemId": 4142065
},
{
"examItemCapacityDtoList": [
{
"period": 1244,
"expandNum": 0,
"occupyNum": 0,
"capacityId": 661209,
"periodName": "7:00-8:00",
"availableNum": 1000,
"maxNum": 1000,
"usedNum": 0
},
{
"period": 4001373,
"expandNum": 0,
"occupyNum": 4,
"capacityId": 292627,
"periodName": "8:00-9:00",
"availableNum": 996,
"maxNum": 1000,
"usedNum": 0
},
{
"period": 4002346,
"expandNum": 0,
"occupyNum": 0,
"capacityId": 661208,
"periodName": "12:00-14:00",
"availableNum": 1000,
"maxNum": 1000,
"usedNum": 0
}
],
"examItemId": -1
}
]
}
],
"msg": "success",
"success": "T"
}
返回参数说明:
参数名 |
类型 |
说明 |
success |
String |
T成功,F失败 |
errCode |
String |
错误码,只有失败的时候才有 |
msg |
String |
描述消息 |
data |
List(CounterCapacityDto) |
人数控制返回对象集合 |
CounterCapacityDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
date |
是 |
string |
日期,格式yyyy-MM-dd |
week |
是 |
int |
1:周一,,,7:周七 |
periodExamItemDtoList |
是 |
List(PeriodExamItemDto) |
时段单项集合 |
PeriodExamItemDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
examItemId |
是 |
int |
控制项id(-1:为全局控制项) |
examItemName |
否 |
string |
控制项名称(-1无名称) |
examItemCapacityDtoList |
是 |
List(ExamItemCapacityDto) |
项目容量明细 |
ExamItemCapacityDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
usedNum |
是 |
int |
预约数 |
maxNum |
是 |
string |
限额或容量 |
availableNum |
是 |
int |
可约数 |
expandNum |
是 |
int |
扩容数 |
occupyNum |
是 |
int |
占用数 |
period |
是 |
int |
时段id |
periodName |
是 |
string |
时段名称 |
his人数控制同步至平台接口
https://api.mytijian.com/open-api/V2/ws/counter/setCounterCapacity?accessToken=ACCESS_TOKEN&nonce=NONCE&sign=SIGN
请求协议:HTTPS
请求方式:POST
需要签名: 是
URL参数:
参数名 |
是否必须 |
类型 |
说明 |
accessToken |
是 |
string |
当前有效的accessToken |
nonce |
是 |
string |
当前有效的nonce |
sign |
是 |
string |
数据sign值 |
POST参数示例
{
"type": 1,
"capacityConfigDtoList": [
{
"capacityPeriodSettingDetailDtoList": [
{
"period": "1244",
"itemSettings": [
{
"itemName": "-1",
"capacityCellDto": {
"reserveNum": 20,
"limit": 20
}
},
{
"itemName": "男项",
"capacityCellDto": {
"reserveNum": 10,
"limit": 10
}
},
{
"itemName": "女项",
"capacityCellDto": {
"reserveNum": 10,
"limit": 10
}
}
]
},
{
"period": "4001373",
"itemSettings": [
{
"itemName": "-1",
"capacityCellDto": {
"reserveNum": 0,
"limit": 0
}
}
]
},
{
"period": "4002346",
"itemSettings": [
{
"itemName": "-1",
"capacityCellDto": {
"reserveNum": 0,
"limit": 0
}
}
]
}
],
"date": "2020-06-26"
}
]
}
请求参数说明:
参数名 |
是否必须 |
类型 |
说明 |
type |
是 |
int |
1:体检中心容量设置,2:单位容量设置 |
capacityConfigDtoList |
是 |
List(CapacityConfigDto) |
容量设置集合 |
CapacityConfigDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
date |
是 |
string |
日期,格式:yyyy-MM-dd |
companyId |
否 |
int |
单位id,单位容量设置必传 |
capacityPeriodSettingDetailDtoList |
是 |
List(CapacityPeriodSettingDto) |
容量时段设置集合 |
CapacityPeriodSettingDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
period |
是 |
string |
时段id字符串 |
itemSettings |
是 |
List(ItemSettingDto) |
单项设置集合 |
CapacityPeriodSettingDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
itemName |
是 |
string |
单项名称,-1为人数项 |
capacityCellDto |
是 |
CapacityCellDto |
容量单元对象 |
CapacityCellDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
reserveNum |
是 |
int |
预留数 |
limit |
是 |
int |
限额数 |
根据时段名称查询时段信息
https://api.mytijian.com/open-api/V2/ws/counter/queryPeriodSetting?accessToken=ACCESS_TOKEN
请求协议:HTTPS
请求方式:POST
需要签名: 否
URL参数:
参数名 |
是否必须 |
类型 |
说明 |
accessToken |
是 |
string |
当前有效的accessToken |
POST参数示例
{
"periodName":"7:00-8:00"
}
请求参数说明:
参数名 |
是否必须 |
类型 |
说明 |
periodName |
是 |
string |
时段名称 |
正确返回示例:
{
"data": {
"hospitalId": 197,
"name": "7:00-8:00",
"id": 1244
},
"msg": "success",
"success": "T"
}
返回参数说明:
参数名 |
类型 |
说明 |
success |
String |
T成功,F失败 |
errCode |
String |
错误码,只有失败的时候才有 |
msg |
String |
描述消息 |
data |
HospitalPeriodSettingDto |
时段信息对象 |
HospitalPeriodSettingDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
hospitalId |
是 |
int |
体检中心id |
name |
是 |
string |
体检中心时段名称 |
id |
是 |
int |
体检中心时段id |
单位人数控制详情
https://api.mytijian.com/open-api/V2/ws/counter/queryCompanyCounterDetail?accessToken=ACCESS_TOKEN
请求协议:HTTPS
请求方式:POST
需要签名: 否
URL参数:
参数名 |
是否必须 |
类型 |
说明 |
accessToken |
是 |
string |
当前有效的accessToken |
POST参数示例
{
"companyIds":[4400508],
"date":"2020-05-26"
}
请求参数说明:
参数名 |
是否必须 |
类型 |
说明 |
companyIds |
是 |
List(int) |
单位id集合 |
date |
是 |
string |
日期,格式yyyy-MM-dd |
正确返回示例:
{
"data": [
{
"capacityPeriodSettingDetailDtoList": [
{
"itemSettings": [
{
"item": "男项",
"capacityCellDto": {
"limit": -1,
"reserveNum": -1,
"usedNum": 0
}
},
{
"item": "女项",
"capacityCellDto": {
"limit": -1,
"reserveNum": -1,
"usedNum": 0
}
},
{
"item": "-1",
"capacityCellDto": {
"limit": -1,
"reserveNum": 1,
"usedNum": 0
}
}
],
"period": "1244"
},
{
"itemSettings": [
{
"item": "男项",
"capacityCellDto": {
"limit": -1,
"reserveNum": -1,
"usedNum": 0
}
},
{
"item": "女项",
"capacityCellDto": {
"limit": -1,
"reserveNum": -1,
"usedNum": 0
}
},
{
"item": "-1",
"capacityCellDto": {
"limit": -1,
"reserveNum": -1,
"usedNum": 0
}
}
],
"period": "4001373"
},
{
"itemSettings": [
{
"item": "男项",
"capacityCellDto": {
"limit": -1,
"reserveNum": -1,
"usedNum": 0
}
},
{
"item": "女项",
"capacityCellDto": {
"limit": -1,
"reserveNum": -1,
"usedNum": 0
}
},
{
"item": "-1",
"capacityCellDto": {
"limit": -1,
"reserveNum": -1,
"usedNum": 0
}
}
],
"period": "4002346"
}
],
"date": "2020-05-26",
"companyId": 4400508
}
],
"msg": "success",
"success": "T"
}
返回参数说明:
参数名 |
类型 |
说明 |
success |
String |
T成功,F失败 |
errCode |
String |
错误码,只有失败的时候才有 |
msg |
String |
描述消息 |
data |
List(CapacityConfigDto) |
容量配置集合 |
CapacityConfigDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
date |
是 |
string |
日期,格式:yyyy-MM-dd |
companyId |
是 |
int |
单位id |
capacityPeriodSettingDetailDtoList |
是 |
List(CapacityPeriodSettingDto) |
容量时段设置详情集合,若当天该单位没有设置过容量,则返回空数组 |
CapacityPeriodSettingDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
period |
是 |
string |
时段id字符串 |
itemSettings |
是 |
List(ItemSettingDto) |
单项设置集合 |
CapacityPeriodSettingDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
itemName |
是 |
string |
单项名称,-1为人数项 |
capacityCellDto |
是 |
CapacityCellDto |
容量单元对象 |
CapacityCellDto对象说明
参数名 |
是否必须 |
类型 |
说明 |
reserveNum |
是 |
int |
预留数,-1为没有设置 |
usedNum |
是 |
int |
已预约数 |
limit |
是 |
int |
限额数,-1为没有设置 |
文档更新时间: 2022-03-03 14:26