12-卷宗入卷服务接口

简介:12-卷宗入卷服务接口

HOST:127.0.0.1:8200

Version:1.0

[TOC]

接口说明

## 一、http交互

基于Restful风格的Http接口。

接口是Http方式的调用，只要满足接口要求，可以不限于客户端语言，进行接口对接。接口返回格式为JSON。

## 二、接口请求全局参数设置

所有接口都需要请求头携带两个请求头参数,

headers: {

​    ClientId: xxxx,

​    ClientSecret: xxxxxxxxxxxx

}

## 三、接口响应返回值说明

接口响应是否成功，用HTTP状态码标识

500的异常信息示例：

{
  "code": 400,  //业务状态码，其值，参考状态码列表
  "message": "文件扩展名必须是[jpg,jpeg,gif,png,bmp,tif,pdf],文件大小不能超过10M",   //错误提示信息
  "detailMessage": "OCRFileParamter 参数错误",    //错误详情
  "data": null  //返回的数据体，根据部分接口需求，会返回错误的数据体或者传参的原数据，一般情况下，该值为null
}

同步新增文件结构

接口地址:/caseinfo/fyy/file/append 北投接口地址:/caseinfo/fyy/file/append/beitou 华宇接口地址:/caseinfo/fyy/file/append/huayu

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:增量新增文件到卷宗

请求示例:

{
 "caseCode": "10100000637584",
 "caseName": "（xxxx）京xx刑终xx号",
 "caseType": "1",
 "files": [
  {
   "cls": "EFILE",
   "derivatives": [
       {
          "name": "案件登记表",
          "path": "dzjz101-6/2020/01/06/27419099551683401/2092600683589972.pdf",
          "size": 122,
          "type": "PDF"
        },
        {
            "name": "案件登记表",
            "path": "dzjz101-6/2020/01/06/27419099551683401/2092600683589972.jpg",
            "size": 132,
            "type": "THUMBNAIL"
          }
    ],
   "dir": ["正卷","案件登记表"],
   "name": "案件登记表",
   "path": "dzjz101-6/2020/01/06/27419099551683401/2092600683589972.pdf",
   "size": 123,
   "createTime": "2010-01-01 01:01:01",
   "properties":{
      "fileId": "222222222",
      "aa": "bb"
    }            
  }
 ]
}

请求参数:

请求参数:

响应状态:

响应参数:

响应示例:

{
 "caseCode": "10100000637584",
 "caseName": "（xxxx）京xx刑终xx号",
 "caseType": "1",
 "files": [
  {
   "id": "1419576746731597825",
   "cls": "EFILE",
   "derivatives": [
       {
          "id": "1419576746731597825",
          "name": "案件登记表",
          "path": "dzjz101-6/2020/01/06/27419099551683401/2092600683589972.pdf",
          "size": 122,
          "type": "PDF"
        },
        {
            "id": "1419576746731597826",
            "name": "案件登记表",
            "path": "dzjz101-6/2020/01/06/27419099551683401/2092600683589972.jpg",
            "size": 132,
            "type": "THUMBNAIL"
          }
    ],
   "dir": ["正卷","案件登记表"],
   "name": "案件登记表",
   "path": "dzjz101-6/2020/01/06/27419099551683401/2092600683589972.pdf",
   "size": 123,
   "createTime": "2010-01-01 01:01:01",
   "properties":{
      "fileId": "222222222",
      "aa": "bb"
    }  
  }
 ]
}

消息通知

消息体结构

{
    "code":0,         //=0 为成功，其他业务状态码，参考状态码列表
    "message":"消息提示",
    "detailMessage":null,
    "data":{
        "id":"任务ID",
        "type":"消息类别",
        "result":{                //返回的消息结果
            .........
        }
    }
}

## 一、统一存储文件变更通知

{
    "code":0,         //=0 忽略
    "message":"变更信息",
    "data":{
        "id":"消息ID",
        "type":"STORAGE_CHANGE",
        "result":{                //返回的消息结果
            "courtCode":"0001",            //法院代码
            "caseCode":"2520201002013555",          //案件标识
            "caseName":"（xxxx）京xxxx执xxx号",          //案号
            "xmlPath":"dzjz101-6/2021/07/22//1295e079-894c-486d-b4b7-26da200b4ba6.xml",      //xml地址
            "version":1,      //版本值
            "createTime":"2020-01-01 08:00:00",      //Xml生成时间
        }
    }
}

状态码列表