1. 获取项目基本信息接口
根据项目id获取指定的项目详情
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/platform/project/info |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.2. 2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
1.2.2. 请求参数(request-parameter)
字段 | 是否必传 | 描述 |
---|---|---|
projectId | 是 | 项目id |
参数请求示例:
http://api.example.com/xxx?key=value
1.3. 3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | |
message | string | 是 | |
data | object | 是 | |
projectId | string | 是 | 项目id |
name | string | 是 | 项目名称 |
code | string | 是 | 编码 |
teamId | string | 是 | 项目团队id |
enterpriseId | string | 是 | 直属企业id |
enterpriseOrgId | string | 是 | 直属企业机构id |
enterpriseOrgName | string | 是 | 直属企业机构名称 |
type | string | 是 | 项目类型id |
typeName | string | 是 | 项目类型名称 |
projectType | number | 是 | 项目类型(1 = 普通项目 2 = 父项目 3= 子项目 4=标段项目) |
hasSection | number | 是 | 是否有标段(0:否 1:有) |
state | string | 是 | 工程状态(1 = 筹备、2= 在建、3 = 停工、4 = 完工) |
longitude | number | 是 | 经度 |
latitude | number | 是 | 维度 |
province | string | 是 | 省编码 |
city | string | 是 | 市编码 |
town | string | 是 | 区编码 |
address | string | 是 | 详细地址 |
startTime | number | 是 | 预计开始时间 |
endTime | number | 是 | 预计完工时间 |
operationNature | string | 是 | 经营性质(1 = 自营、2 = 合作经营、3 = 混合经营) |
operationNatureLabel | string | 是 | 经营性质名称 |
supervisionCompany | string | 是 | 监理单位 |
supervisionCompanyId | string | 是 | 监理单位ID |
buildCompany | string | 是 | 施工单位 |
buildCompanyId | string | 是 | 施工单位ID |
constructCompany | string | 是 | 建设单位 |
constructCompanyId | string | 是 | 建设单位ID |
designCompany | string | 是 | 设计单位 |
designCompanyId | string | 是 | 设计单位ID |
surveyCompany | string | 是 | 勘察单位 |
surveyCompanyId | string | 是 | 勘察单位ID |
contractAmount | number | 是 | 项目合同金额 |
region | string | 是 | 项目所在地区 |
aliasName | string | 是 | 项目别名 |
shortName | string | 是 | 项目简称 |
responsibleUserId | string | 是 | 项目负责人id |
responsiblePhone | string | 是 | 项目负责人电话号码 |
projectLeaderName | string | 是 | 项目领导名称 |
responsibleUserName | string | 是 | 项目负责人姓名 |
remarks | string | 是 | 备注 |
projectInitiationTime | number | 是 | 立项时间 |
projectCompletionPercent | number | 是 | 项目完工百分比 |
realStartTime | number | 是 | 实际开工时间 |
realEndTime | number | 是 | 实际完工时间 |
buildArea | number | 是 | 建筑面积,单位万平方米 |
响应数据结构如下所示:
{
"code": 0,
"message": null,
"data": {
"projectId": "x",
"name": "轻筑展厅项目",
"code": "x",
"teamId": "x",
"enterpriseId": "x",
"enterpriseOrgId": "x",
"enterpriseOrgName": "轻筑测试企业2",
"type": "x",
"typeName": "房屋建筑工程",
"projectType": 2,
"hasSection": 0,
"typeLabel": "房屋建筑工程",
"state": "2",
"longitude": 106.56646,
"latitude": 29.66635,
"province": "430000",
"city": "430100",
"town": "430102",
"address": "重庆市渝北区鸳鸯街道大雅云居山",
"startTime": 1644422400000,
"endTime": 1671984000000,
"operationNature": "1",
"operationNatureLabel": null,
"supervisionCompany": "中冶赛迪电气技术有限公司",
"supervisionCompanyId": "x",
"buildCompany": "中冶赛迪重庆信息技术有限公司",
"buildCompanyId": "x",
"constructCompany": "中冶赛迪重庆信息技术有限公司",
"constructCompanyId": "x",
"designCompany": null,
"designCompanyId": null,
"surveyCompany": "",
"surveyCompanyId": null,
"contractAmount": 10.0,
"region": "湖南省 / 长沙市 / 芙蓉区",
"aliasName": "",
"shortName": "轻筑A",
"responsibleUserId": "x",
"responsiblePhone": "x",
"projectLeaderName": "张三",
"responsibleUserName": "王五",
"remarks": "",
"projectInitiationTime": 1733673600000,
"projectCompletionPercent": 100.0,
"realStartTime": 1723046400000,
"realEndTime": 1724256000000,
"buildArea": 21312.0
}
}
1.4. 4. 错误码
当返回数据中的 code 不为 1 时,为错误返回。其中errCode为详细的错误码。