1. 获取项目基本信息接口
根据项目id获取指定的项目详情
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/platform/project/info |
请求方法 | GET |
请求数据类型 | URL参数 |
响应数据类型 | JSON |
1.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. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
projectId | string | 是 | 项目id |
teamId | string | 是 | 项目团队id |
name | string | 是 | 项目名称 |
code | string | 是 | 编码 |
shortName | string | 是 | 项目简称 |
type | string | 是 | 项目类型id |
typeName | string | 是 | 项目类型名称 |
projectType | number | 是 | 项目类型(1 = 普通项目 2 = 父项目 3= 子项目 4=标段项目) |
state | string | 是 | 工程状态(1 = 筹备、2= 在建、3 = 停工、4 = 完工) |
operationNature | string | 是 | 经营性质(1 = 自营、2 = 合作经营、3 = 混合经营) |
startTime | number | 是 | 预计开始时间 |
endTime | number | 是 | 预计完工时间 |
projectInitiationTime | number | 否 | 立项时间 |
projectCompletionPercent | number | 否 | 完工百分比 |
contractAmount | number | 是 | 合同额 |
constructCompanyId | string | 是 | 建设单位ID |
constructCompany | string | 是 | 建设单位 |
buildCompanyId | string | 是 | 施工单位ID |
buildCompany | string | 是 | 施工单位 |
supervisionCompanyId | string | 是 | 监理单位ID |
supervisionCompany | string | 是 | 监理单位 |
designCompanyId | string | 是 | 设计单位ID |
designCompany | string | 是 | 设计单位 |
surveyCompanyId | string | 是 | 勘察单位ID |
surveyCompany | string | 是 | 勘察单位 |
responsibleUserId | string | 是 | 项目负责人团队成员id |
responsibleUserName | string | 是 | 项目负责人姓名 |
province | string | 是 | 省编码 |
city | string | 是 | 市编码 |
town | string | 是 | 市编码 |
region | string | 是 | 所在地区 |
address | string | 是 | 详细地址 |
latitude | string | 是 | 维度 |
longitude | string | 是 | 经度 |
remarks | string | 是 | 备注 |
tagVos | array | 是 | 备注 |
tagId | string | 是 | 标签ID |
tagName | string | 是 | 标签名字 |
tagRemark | string | 是 | 标签备注 |
type | string | 是 | 标签类型 |
响应数据结构如下所示:
{
"projectId": "",
"teamId": "",
"name": "",
"code": "",
"shortName": "",
"type": "",
"typeNane": "",
"projectType": 2,
"state": "",
"operationNature": "",
"startTime": 1111,
"endTime": 1111,
"contractAmount": 1111,
"constructCompanyId": "",
"constructCompany": "",
"buildCompanyId": "",
"buildCompany": "",
"supervisionCompanyId": "",
"supervisionCompany": "",
"designCompanyId": "",
"designCompany": "",
"surveyCompanyId": "",
"surveyCompany": "",
"responsibleUserId": "",
"responsibleUserName": "",
"province": "",
"city": "",
"town": "",
"region": "",
"address": "",
"latitude": "",
"longitude": "",
"remarks": "",
"tagVos": [{
"tagId": "xxxxxxxxxxxx",
"tagName": "智慧工地",
"tagRemark": "",
"type": 0
}]
}
1.4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。