# 全国律师综合管理信息系统接口文档-武汉定制版
# 测试环境
如果有特殊需要测试指定所的数据,请联系我们导入对应的测试数据.
==测试地址:`http://test.oa.acla.org.cn/api/`==
在正式环境替换对应的appId和秘钥即可.
# 线上运行环境需指定调用的ip地址
# API调用说明
==本文档中,所有调用接口的请求都需要按此规则校验。==
### API 校验
以下参数需要放在Http Request Header中
| 参数说明 | 说明 |
| :-------- | :----- |
| AppId | 开发者平台分配的appId |
| Nonce | 当前UTC时间戳,从1970年1月1日0点0 分0 秒开始到现在的毫秒数(String) |
| Sign | SHA1(秘钥(秘钥由同道信息技术有限公司提供) + Nonce ),两个参数拼接的字符串,进行SHA1哈希计算,转化成16进制字符(String,小写) |
Sign有效期:出于安全性考虑,每个Sign的有效期为5分钟,建议每次请求都生成新的Sign,同时请确认发起请求的服务器是与标准时间同步的,比如有NTP服务。
重要提示: 本文档中提供的所有接口均面向开发者服务器端调用,用于计算Sign的AppId开发者应妥善保管,可在应用的服务器端存储和使用,但不应存储或传递到客户端,也不应在网页等前端代码中嵌入。
### 计算Sign的java代码举例如下:
```
import java.io.IOException;
import java.io.InputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import org.apache.commons.codec.binary.Hex;
import org.apache.commons.codec.binary.StringUtils;
public class DigestUtils {
//传入秘钥+时间戳字符串
public static String sha1Hex(final String data) {
return Hex.encodeHexString(sha1(data));
}
}
```
# 所有接口返回数据格式
接口返回格式json
{
"result": {
},
"code": 1,
"javaClass": "com.homolo.framework.service.ServiceResult",
"structSupport": true
}
| 参数 | 说明 |备注|
|------:|------:|------:|
|result|所有接口返回的信息的主体||
|code|表示返回的结果|1表示调用成功 -2表示参数出错 其他表示系统错误
|javaClass|返回的类||
|structSupport|是否成功||
# 律所接口
## 1 律所基本信息
### 1.1 获取律所基本信息
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :---- |
| 接口url |/api/open/lawFirm/getRelatedInfoByName |
| 接口参数 | name | 必填 |
> #### 返回的数据字段说明
| 字段名 | 中文解释 | 说明 |
| -------- | :----- | :---- |
|name|律所名称||
|shortName|中文简称||
|englishName|英文名称||
|nameHistory|曾用名||
|taxWay|征税方式||
|approveDate|批准日期||
|officeArea|办公面积||
|licenseDate|发证日期||
|justiceBureau|主管机关||
|orgType|总分所形式||
|executive|行政主管||
|creditCode|统一社会信用代码||
|lawFirmType|组织形式||
|registeredCapital|设立资产||
|intro|机构简介||
|licenseNumber|执业许可证号||
|practiceStatus|执业状态||
|approveNumber|批准文号||
|fax|传真||
|email|邮箱||
|longitude|纬度||
|latitude|经度||
|website|单位网站||
|director|负责人||
|officeZone|办公地区||
|officeAddress|办公地址||
|officePostcode|办公邮编||
|officeType|办公地性质||
|businessArea|业务专长||
|phone|联系方式||
|partners|合伙人||
|partyForms|党组织形式||
|partyNumber|党员人数||
|partyOrg|党组织名称||
|domicileAddress|住所地||
|domicileZone|住所地区||
|domicilePostcode|住所邮编||
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/lawFirm/getRelatedInfoByName?name=国浩律师事务所
```
> #### 返回的数据格式
```
{
"result": {
"englishName": "",
"nameHistory": "",
"taxWay": "",
"approveDate": "2013年03月14日",
"latitude": "",
"officeArea": "",
"licenseDate": "2013年03月14日",
"justiceBureau": "江汉区司法局",
"orgType": "总所",
"executive": "",
"domicileAddress": "武汉市尔萨街道250号",
"creditCode": "31110000H52630374P",
"lawFirmType": "普通合伙",
"registeredCapital": "100.0",
"intro": "",
"partyForms": "",
"licenseNumber": "",
"practiceStatus": "正常执业",
"approveNumber": "京司发【2013】99号",
"fax": "66218093",
"email": "",
"longitude": "",
"website": "",
"officeZone": "",
"director": "陆绮",
"officeAddress": "武汉市尔萨街道250号",
"officePostcode": "",
"businessArea": "",
"domicilePostcode": "",
"phone": "66216823",
"partners": "陆绮,费国平,揭梅,张海燕,董事,浦理斌",
"name": "国浩律师事务所",
"shortName": "国浩",
"partyNumber": "0",
"partyOrg": "",
"domicileZone": "武昌区",
"officeType": ""
},
"code": 1,
"javaClass": "com.homolo.framework.service.ServiceResult",
"structSupport": true
}
```
### 1.2 获取律所基本信息 增量接口
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/lawFirm/getInfoByDateModified | |
| 接口参数 | dateModified | 修改时间 |
| 接口参数 | pageNo | 分页参数,如果不填默认返回第一页 |
| 接口参数 | pageSize | 分页参数, 如果不填默认每页返回100条数据|
每次请求默认返回100条数据
> #### 返回的数据字段说明
```
见律所接口1.1 字段说明
```
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/lawFirm/getInfoByDateModified?pageNo=1&pageSize=10&dateModified=2000-10-10
```
> #### 返回的数据格式
```
{
"result": {
"result": [
{
"approveStatus": "未提交",
"professionalTitles": "无",
......
},
{
"approveStatus": "未提交",
"professionalTitles": "无",
......
},......
],
"pageCount": 3367,
"pageNo": 1,
"count": 6733,
"pageSize": 10,
"dateModified": "2000-10-10"
},
"code": 1,
"javaClass": "com.homolo.framework.service.ServiceResult",
"structSupport": true
}
```
---
## 2. 律所奖励信息
### 2.1 获取律所奖励信息
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFHonor/getRelatedInfoByName | |
| 接口参数 | name | 律所名称 必填 |
> #### 返回的数据字段说明
| 字段名 | 中文解释 | 说明 |
| -------- | :----- | :----: |
|result|返回的信息主体||
|count|共有多少条数据||
|--------------- |-------------------------|---------------|
|date|获奖日期||
|reason|表彰事由||
|level|表彰等级||
|subject|表彰奖励名称||
|issueOrg|表彰机构||
|attachements|证明材料||
|current|当前的事务所||
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFHonor/getRelatedInfoByName?name=国浩律师事务所
```
> #### 返回的数据格式
```
见律所接口1.1 返回的数据格式
```
### 2.2. 获取律所奖励信息 增量接口
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFHonor/getInfoByDateModified | |
| 接口参数 | dateModified | 修改时间 |
| 接口参数 | pageNo | 分页参数,如果不填默认返回第一页 |
| 接口参数 | pageSize | 分页参数, 如果不填默认每页返回100条数据|
每次请求默认返回100条数据
> #### 返回的数据字段说明
```
见律所接口2.1 字段说明
```
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFHonor/getInfoByDateModified?pageNo=1&pageSize=10&dateModified=2000-10-10
```
> #### 返回的数据格式
```
见律所接口1.2 返回的数据格式
```
---
## 3 律所处罚信息
### 3.1 获取律所处罚信息
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFPunish/getRelatedInfoByName | |
| 接口参数 | name | 律所名称 必填 |
> #### 返回的数据字段说明
| 字段名 | 中文解释 | 说明 |
| -------- | :----- | :----: |
|result|返回的信息主体||
|count|共有多少条数据||
|--------------- |-------------------------|---------------|
|date|处罚日期||
|endDate|处罚结束日期||
|reason|处罚事由||
|level|处罚等级||
|effectDate|处罚生效时间||
|dateExpired|失效日期||
|punishDecisionNumber|处罚决定文号||
|attachments|证明材料||
|dateBeginPublicity|公示开始日期||
|dateEndPublicity|公示结束日期||
|issueOrg|处罚机构||
|current|当前的事务所||
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFPunish/getRelatedInfoByName?name=武汉市第一律师事务所
```
> #### 返回的数据格式
```
见律所接口1.1 返回的数据格式
```
### 3.2 获取律所处罚信息 增量接口
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFHonor/getInfoByDateModified | |
| 接口参数 | dateModified | 修改时间 |
| 接口参数 | pageNo | 分页参数,如果不填默认返回第一页 |
| 接口参数 | pageSize | 分页参数, 如果不填默认每页返回100条数据|
每次请求默认返回100条数据
> #### 返回的数据字段说明
```
见律所接口3.1 字段说明
```
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFHonor/getInfoByDateModified?pageNo=1&pageSize=10&dateModified=2000-10-10
```
> #### 返回的数据格式
```
见律所接口1.2 返回的数据格式
```
---
## 4 律所分支
### 4.1 获取律所分支
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFPunish/getRelatedInfoByName | |
| 接口参数 | name | 律所名称 必填 |
> #### 返回的数据字段说明
| 字段名 | 中文解释 | 说明 |
| -------- | :----- | :----: |
|result|返回的信息主体||
|count|共有多少条数据||
|--------------- |-------------------------|---------------|
|creditCode|统一社会信用代码||
|phone|联系方式||
|name|分支名称||
|domicileZone|分支住所地||
|email|邮箱||
|justiceBureau|主管机关||
|current|总所名称||
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFBranch/getRelatedInfoByName?name=国浩律师事务所
```
> #### 返回的数据格式
```
见律所接口1.1 返回的数据格式
```
### 4.2 律所分支 不提供增量接口
---
## 5 律所年度考核
### 5.1 获取律所年度考核信息
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFAnnualInspection/getRelatedInfoByName | |
| 接口参数 | name | 律所名称 必填 |
> #### 返回的数据字段说明
| 字段名 | 中文解释 | 说明 |
| -------- | :----- | :----: |
|result|返回的信息主体||
|count|共有多少条数据||
|--------------- |-------------------------|---------------|
|result|考核结果||
|year|考核年份||
|director|负责人||
|feePaid|是否缴费||
|amountTotal|应缴纳总会费||
|lawyerNumber|律师人数||
|status|状态||
|current|当前律所||
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFAnnualInspection/getRelatedInfoByName?name=国浩律师事务所
```
> #### 返回的数据格式
```
见律所接口1.1 返回的数据格式
```
### 5.2 获取律所年度考核信息 增量接口
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFAnnualInspection/getInfoByDateModified | |
| 接口参数 | dateModified | 修改时间 |
| 接口参数 | pageNo | 分页参数,如果不填默认返回第一页 |
| 接口参数 | pageSize | 分页参数, 如果不填默认每页返回100条数据|
每次请求默认返回100条数据
> #### 返回的数据字段说明
```
见律所接口5.1 字段说明
```
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFAnnualInspection/getInfoByDateModified?pageNo=1&pageSize=10&dateModified=2000-10-10
```
> #### 返回的数据格式
```
见律所接口1.2 返回的数据格式
```
---
## 6 律所执业许可证
### 6.1 获取律所执业许可证信息
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFLicense/getRelatedInfoByName | |
| 接口参数 | name | 律所名称 必填 |
> #### 返回的数据字段说明
| 字段名 | 中文解释 | 说明 |
| -------- | :----- | :----: |
|result|返回的信息主体|
|count|共有多少条数据|
|--------------- |-------------------------|---------------|
|originalSerialNumber|正本流水号||
|lawFirmType|组织形式||
|copySerialNumber|副本流水号||
|licenseNumber|执业证号||
|licenseDate|发证日期||
|justiceBureau|直管机关||
|status|执业状态||
|current|当前律所||
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFLicense/getRelatedInfoByName?name=国浩律师事务所
```
> #### 返回的数据格式
```
见律所接口1.1 返回的数据格式
```
### 6.2 获取律所执业许可证 增量接口
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/LFLicense/getInfoByDateModified | |
| 接口参数 | dateModified | 修改时间 |
| 接口参数 | pageNo | 分页参数,如果不填默认返回第一页 |
| 接口参数 | pageSize | 分页参数, 如果不填默认每页返回100条数据|
每次请求默认返回100条数据
> #### 返回的数据字段说明
```
见律所接口6.1 字段说明
```
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/LFLicense/getInfoByDateModified?pageNo=1&pageSize=10&dateModified=2000-10-10
```
> #### 返回的数据格式
```
见律所接口1.2 返回的数据格式
```
---
# 律师接口
## 1 律师基本信息接口
### 1.1 获取律师基本信息
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :---- |
| 接口url |/api/open/lawyer/getRelatedInfoByName |
| 接口参数 | name | 必填 |
| 接口参数 | idNumber | 必填 |
> #### 返回的数据字段说明
| 字段名 | 中文解释 | 说明 |
| -------- | :----- | :---- |
|name|律师姓名||
|idType|证件类型||
|idNumber|证件编号||
|justiceBureau|主管机关||
|justiceBureaus|管辖多级机关||
|acceptTrainee|能否接受实习||
|allDay|是否全日制||
|approveAdvise|审核意见||
|approveStatus|审核状态||
|assessmentYear|考核年度||
|association|所属律师协会||
|dateFirstJoinAssociation|首次入会时间||
|associations|管辖协会||
|dateJoinAssociation|入会时间||
|dateLocalFirstLicense|首次执业时间||
|discipline|专业||
|displayId|显示ID||
|education|学历||
|email|邮箱||
|firstLicenseDate|首次执业日期||
|firstLicenseZone|首次执业地||
|foreginEducation|是否有国外教育经历||
|foreginWorkExperience|是否有国外工作经历||
|foreignLawyerCer|国外律师资格||
|foreignName|外文名称||
|gainTitleDate|获得职称时间||
|gender|性别||
|graduatedFrom|毕业院校||
|hasPunish|曾有处罚||
|issueTitleDate|职称办法日期||
|issueTitleOrg|职称办法机构||
|judgeWorkExperience|法官工作经验||
|lastPunishDate|最后处罚日期||
|lawMajor|是否法学专业毕业||
|licenseDate|发证日期||
|licenseNumber|执业证号||
|litigate|是否参与诉讼代理||
|localPracticeYears|本地执业年限||
|localTrainee|是否在本地实习过||
|lordAdvocate|是否担任过政府法律顾问||
|memberId|会员ID||
|memberNumber|会员编号||
|mobile|手机号码||
|nameHistory|曾用名||
|nation|民族||
|onPunishing|在处罚期||
|partyBranch|所在党支部||
|joinPartyDate|入党时间||
|personId|人员标识||
|phone|联系电话||
|politic|政治面貌||
|position|所内身份||
|practiceOrg|执业机构||
|practiceScope|业务专长||
|practiceStatus|执业状态||
|practiceType|执业类别||
|practiceYears|执业年限||
|professionalTitles|律师职称||
|prosecutorWorkExperience|检察官从业经验||
|qualificationDate|职业资格证书取得时间||
|qualificationNumber|职业资格证书编号||
|qualificationType|职业资格证书类别||
|qualificationWay|职业资格证书取得方式||
|qualificationZone|职业资格证书取得地||
|servedCppccMember|担任过政协委员||
|servedNpcMember|担任过人大代表||
|servedPartyMember|担任过党代表||
|servingCppccMember|目前担任政协委员||
|servingNpcMember|目前担任人大代表||
|servingPartyMember|目前担任党代表||
|socialSecurityNumber|社会保险号||
|status|会员状态||
|summary|律师简介||
|tags|表征||
|urgentName|紧急联系人||
|urgentPhone|紧急联系人联系方式||
|workingStatus|在职状态||
|accreditStatus|派驻状态||
|accredited|是否派驻||
|accreditedJusticeBureau|派驻地||
|approveStatus|审核状态||
|archiveJusticeBureau|执业关系所在地||
|dateFirstJoinAssociation|首次入会时间||
|dateJoinAssociation|入会时间||
|director|是否负责人||
|hukouAddress|户口地址||
|partTimeUnit|兼职单位||
|partner|是否合伙人||
|position|所内身份||
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/lawyer/getRelatedInfoByName?name=唐渊&idNumber=420107199602140512
```
> #### 返回的数据格式
```json
{
"result": {
"approveStatus": "已审核",
"professionalTitles": "无",
"lawMajor": "",
"nameHistory": "",
"education": "本科",
"servedPartyMember": "否",
"approveAdvise": "",
"nation": "汉族",
"servingCppccMember": "否",
"practiceYears": "13",
"discipline": "",
"accredited": "否",
"justiceBureaus": "江汉区司法局,武汉市司法局,湖北省司法厅,中华人民共和国司法部",
"allDay": "是",
"assessment": "",
"foreginWorkExperience": "否",
"politic": "无党派",
"practiceStatus": "正常执业",
"partTimeUnit": "",
"workingStatus": "",
"memberId": "5279470466c04299bbb09e234b233a47",
"associations": "",
"gender": "女",
"socialSecurityNumber": "",
......
},
"code": 1,
"javaClass": "com.homolo.framework.service.ServiceResult",
"structSupport": true
}
```
### 1.2 获取律师基本信息 增量接口
> #### 请求的接口数据
| | 项目 | 说明 |
| -------- | :----- | :----: |
| 接口url | /api/open/layer/getInfoByDateModified | |
| 接口参数 | dateModified | 修改时间 |
| 接口参数 | pageNo | 分页参数,如果不填默认返回第一页 |
| 接口参数 | pageSize | 分页参数, 如果不填默认每页返回100条数据|
每次请求默认返回100条数据
> #### 返回的数据字段说明
```
见律师接口1.1 字段说明
```
> #### 接口调用示例
```
http://test.oa.acla.org.cn/api/open/layer/getInfoByDateModified?pageNo=1&pageSize=10&dateModified=2000-10-10
```
> #### 返回的数据格式
```
{
"result": {
"result": [
{
"approveStatus": "未提交",
"professionalTitles": "无",
"lawMajor": "",
"nameHistory": "",
"education": "",
"servedPartyMember": "否",
"approveAdvise": "",
......
},
{
"approveStatus": "未提交",
"professionalTitles": "无",
"lawMajor": "",
"nameHistory": "",
"status": "正常",
"dateFirstJoinAssociation": "",
"associations": "",
"gender": "女",
"socialSecurityNumber": "",
......
}......
],
"pageCount": 3367,
"pageNo": 1,
"count": 6733,
"pageSize": 10,
"dateModified": "2000-10-10"
},
"code": 1,
"javaClass": "com.homolo.framework.service.ServiceResult",
"structSupport": true
}
```
---