POST api/CheckTicket/ByBarCode/V5
2024-01-31不再推荐使用这个API。本API在检票第一步时,不会同步返回人脸信息,建议使用api/CheckTicket/FaceType/ByBarCode/V5来替代本API。 第五版的使用条码(含一维码,二维码、手机条码等情形),发起检票,本方法不适用于人脸仪。,2023-06-13修改,添加了发起检票的凭据类型参数;添加了系统要求的检票凭证类型的返回。 获得的返回“checkresultcode”为0(表示当前票可以检或已检),“jpwc”为“0”表示检票未完成,需要后续操作;“jpwc”为“1”表示检票已完成。当“checkresultcode”为“0”且“jpwc”也为“0”时,检票终端需依据"rzfs"(认证方式)采样生物特征样本或对比生物特征样本后,再调用本其他API完成检票的后续操作。
Request Information
URI Parameters
None.
Body Parameters
TicketCheckByBarcodeParmV5| Name | Description | Type | Additional information |
|---|---|---|---|
| mediatype |
介质类型。 当用户直接用条码开始检票,此值取值为‘B'; 当用户通过人脸识别,人脸仪在本地库中查询匹配成功后,获得票号(相当于条码)发起检票的,此值取值为“F”; 当手持机强制验票时,此值取值为“Q”; 当使用二代证、电子护照发起检票时,此值取值为“I”; 当使用IC卡发起验票时,此值取值为“U" 当使用二代证,但人脸仪已前置进行过“人证比对的”,此值取值为I。 当用户通过人脸识别,人脸仪在本地库中本询匹配成功后,获得二代证号(证件号)发起检票的,此值取值为“F”; 以上都不是,取值为“O". 非常重要的参数。 |
string |
Required Max length: 1 Min length: 1 |
| facematched |
当用户通过人脸识别,人脸仪在本地库中查询匹配成功后,获得票号(相当于条码)发起检票的,此值取值为“1”,否则为0。 |
string |
Required Max length: 1 Min length: 1 |
| barcode |
条码的内容 |
string |
Required |
| gateparm |
检票时需要的闸机参数 |
CheckGateParm |
Required |
Request Formats
application/json, text/json
{
"mediatype": "sample string 1",
"facematched": "sample string 2",
"barcode": "sample string 3",
"gateparm": {
"dzid": "sample string 1",
"jpfx": "sample string 2",
"cansamplefinger": "sample string 3",
"cansampleface": "sample string 4",
"cansampleidentitycard": "sample string 5",
"machinetype": "sample string 6"
}
}
application/xml, text/xml
<TicketCheckByBarcodeParmV5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Tour.V5.Parm">
<barcode>sample string 3</barcode>
<gateparm>
<cansampleface>sample string 4</cansampleface>
<cansamplefinger>sample string 3</cansamplefinger>
<cansampleidentitycard>sample string 5</cansampleidentitycard>
<dzid>sample string 1</dzid>
<jpfx>sample string 2</jpfx>
<machinetype>sample string 6</machinetype>
</gateparm>
<facematched>sample string 2</facematched>
<mediatype>sample string 1</mediatype>
</TicketCheckByBarcodeParmV5>
application/x-www-form-urlencoded
Sample not available.
application/bson
Binary JSON content. See http://bsonspec.org for details.
Response Information
Resource Description
2024-01-31不再推荐使用这个API。本API在检票第一步时,不会同步返回人脸信息,建议使用api/CheckTicket/FaceType/ByBarCode/V5来替代本API。 第五版的使用条码(含一维码,二维码、手机条码等情形),发起检票,本方法不适用于人脸仪。,2023-06-13修改,添加了发起检票的凭据类型参数;添加了系统要求的检票凭证类型的返回。 获得的返回“checkresultcode”为0(表示当前票可以检或已检),“jpwc”为“0”表示检票未完成,需要后续操作;“jpwc”为“1”表示检票已完成。当“checkresultcode”为“0”且“jpwc”也为“0”时,检票终端需依据"rzfs"(认证方式)采样生物特征样本或对比生物特征样本后,再调用本其他API完成检票的后续操作。
TicketCheckingResultV5| Name | Description | Type | Additional information |
|---|---|---|---|
| additionalbioinfo |
附属特征值。 2021-02-26添加。 专用于富士智能ZRS692,694,696PRO地平线算法的特征扩展属性。 这个值来源于注册时,从人脸设备上上传的同一个值。 其他设备请不要采信这个值。 |
byte |
None. |
| face_image |
标准化的人脸图片内容。 内容格式:高质量JPG。 2023-02以后建设的系统为标准化图片,大小398*480。 必有且只有一个人脸。 人脸必基本居中。 人脸有很高的清晰度。 人脸必然没有大的偏转。 人脸必然没有遮挡。 |
Collection of byte |
None. |
| face_feature |
专用于富士智能ZRS692,694,696PRO地平线算法的人脸特征。 其他设备请不要采信这个值。 |
Collection of byte |
None. |
| checkinmeidatype |
系统要求的发起验票的验证介质。 A任意,B限条码 I限二代证,F限人脸 P限指纹 U限IC卡。 其中,只有B,I,A,U是有意义的。 |
string |
None. |
| lbsbh |
内部识别号 |
string |
None. |
| jpfx |
检票方向,“I”表示检入,“O”表示检出。 |
string |
None. |
| dzid |
闸机ID |
string |
None. |
| rzfs |
认证方式,“1”仅有效性验证(只需要检查票是否合法,是否有效;“3”有效性+身份证核对;“4”有效性+指纹;“5”有效性+面相 |
string |
None. |
| jpwc |
是否检票完成,“1”检票完成,没有后续流程,这通常发生在“仅有效性验证”时,一次访问可以完成检票;“0”表示仅给客户端返回了票的相关信息,需要客户端进行身份认证或其他操作之后再调用检票接口~/api/Checking/Continue接口。 |
string |
None. |
| yxqs |
有效期始(YYYYMMDD) |
string |
None. |
| yxqz |
有效期止(YYYYMMDD) |
string |
None. |
| mplxid |
门票类型ID |
string |
None. |
| mplxmc |
门票类型的名称 |
string |
None. |
| bioinfo1 |
指纹特征1 |
Collection of byte |
None. |
| bioinfo2 |
指纹特征2 |
Collection of byte |
None. |
| bioinfo3 |
指纹特征3 |
Collection of byte |
None. |
| bioinfo4 |
指纹特征4 |
Collection of byte |
None. |
| checkresultcode |
检票的返回结果 |
integer |
None. |
| checkresult |
检票结果的描述 |
string |
None. |
| rcs |
当前票的人次数 |
integer |
None. |
| zjlx |
证件类型代码,1身份证,2护照,3其他 |
string |
None. |
| zjmc |
证件名称 |
string |
None. |
| zjhm |
证件号码 |
string |
None. |
| xm |
姓名 |
string |
None. |
| sprqsj |
售票的日期时间,格式yyyyMMddHHmmss。 |
string |
None. |
| scjp |
是否首次检票,“1”表示是第一次检票,“0”表示不是第一次检票。这是指整个票的生命周期中,是否第一次使用。 |
string |
None. |
| spzddm |
售票站点代码 |
string |
None. |
| spzdmc |
售票站点的名称 |
string |
None. |
| yqid |
当前闸机,当前方向对应的园区的ID |
string |
None. |
| yqmc |
当前闸机,当前方向对应的园区的名称。 |
string |
None. |
| tslx |
提示的类型,“1”常规提示,如“请进”“请通行”;“2”提示“请验证件”或“请核对证件”。 |
string |
None. |
| sytxcs |
当前闸机所在检票站点的剩余通行次数,当jpwc=0时,表示当前仍剩余的通行许可次数,当jpwc=1时,表示此次检票后剩余的许可次数。 |
integer |
None. |
| lastcheckdzid |
最后一次的检票道闸ID。 最后一次检票:指当前门票,在当前检票进入或离开的园区(依据dzid系统自动获提),当前检票方向(依据jpfx指定),最后一次成功检票的记录。 当检票返回“无此权限(-1015)”时,此数据可以用于向检票员展示,此票在哪个闸机上消费掉了。 |
string |
None. |
| lastcheckjpzdid |
最后一次的检票站点ID。 最后一次检票:指当前门票,在当前检票进入或离开的园区(依据dzid系统自动获提),当前检票方向(依据jpfx指定),最后一次成功检票的记录。 |
string |
None. |
| lastcheckjpzdmc |
最后一次检票的检票站点名称。 最后一次检票:指当前门票,在当前检票进入或离开的园区(依据dzid系统自动获提),当前检票方向(依据jpfx指定),最后一次成功检票的记录。 |
string |
None. |
| lastjprqsj |
最后一次检票的日期时间 最后一次检票:指当前门票,在当前检票进入或离开的园区(依据dzid系统自动获提),当前检票方向(依据jpfx指定),最后一次成功检票的记录。 |
string |
None. |
Response Formats
application/json, text/json
{
"additionalbioinfo": 64,
"face_image": "QEA=",
"face_feature": "QEA=",
"checkinmeidatype": "sample string 2",
"lbsbh": "sample string 3",
"jpfx": "sample string 4",
"dzid": "sample string 5",
"rzfs": "sample string 6",
"jpwc": "sample string 7",
"yxqs": "sample string 8",
"yxqz": "sample string 9",
"mplxid": "sample string 10",
"mplxmc": "sample string 11",
"bioinfo1": "QEA=",
"bioinfo2": "QEA=",
"bioinfo3": "QEA=",
"bioinfo4": "QEA=",
"checkresultcode": 12,
"checkresult": "sample string 13",
"rcs": 14,
"zjlx": "sample string 15",
"zjmc": "sample string 16",
"zjhm": "sample string 17",
"xm": "sample string 18",
"sprqsj": "sample string 19",
"scjp": "sample string 20",
"spzddm": "sample string 21",
"spzdmc": "sample string 22",
"yqid": "sample string 23",
"yqmc": "sample string 24",
"tslx": "sample string 25",
"sytxcs": 26,
"lastcheckdzid": "sample string 27",
"lastcheckjpzdid": "sample string 28",
"lastcheckjpzdmc": "sample string 29",
"lastjprqsj": "sample string 30"
}
application/xml, text/xml
<TicketCheckingResultV5 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DigitalScience.DataTransfer.Tour.V5.Result"> <bioinfo1>QEA=</bioinfo1> <bioinfo2>QEA=</bioinfo2> <bioinfo3>QEA=</bioinfo3> <bioinfo4>QEA=</bioinfo4> <checkresult>sample string 13</checkresult> <checkresultcode>12</checkresultcode> <dzid>sample string 5</dzid> <jpfx>sample string 4</jpfx> <jpwc>sample string 7</jpwc> <lastcheckdzid>sample string 27</lastcheckdzid> <lastcheckjpzdid>sample string 28</lastcheckjpzdid> <lastcheckjpzdmc>sample string 29</lastcheckjpzdmc> <lastjprqsj>sample string 30</lastjprqsj> <lbsbh>sample string 3</lbsbh> <mplxid>sample string 10</mplxid> <mplxmc>sample string 11</mplxmc> <rcs>14</rcs> <rzfs>sample string 6</rzfs> <scjp>sample string 20</scjp> <sprqsj>sample string 19</sprqsj> <spzddm>sample string 21</spzddm> <spzdmc>sample string 22</spzdmc> <sytxcs>26</sytxcs> <tslx>sample string 25</tslx> <xm>sample string 18</xm> <yqid>sample string 23</yqid> <yqmc>sample string 24</yqmc> <yxqs>sample string 8</yxqs> <yxqz>sample string 9</yxqz> <zjhm>sample string 17</zjhm> <zjlx>sample string 15</zjlx> <zjmc>sample string 16</zjmc> <additionalbioinfo>64</additionalbioinfo> <checkinmeidatype>sample string 2</checkinmeidatype> <face_feature>QEA=</face_feature> <face_image>QEA=</face_image> </TicketCheckingResultV5>
application/bson
Binary JSON content. See http://bsonspec.org for details.