1. 创建项目
用于创建项目
注意
- 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
- 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过
网页授权
接口获取相关信息。
1.1. 1. 基本信息
概况 | 内容 |
---|---|
接口地址 | /api/platform/project/add |
请求方法 | POST |
请求数据类型 | JSON |
响应数据类型 | JSON |
1.2. 2. 请求数据
1.2.1. 请求头(request-header)
请求头除了默认的参数还需要添加如下请求头参数:
字段 | 描述 |
---|---|
auth-token | 接口访问凭据,你可以通过平台下发的appid和secret获取凭据 |
Content-Type | application/json;charset=UTF-8 |
1.2.2. 请求体(request-body)
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
name | string | 是 | 项目名称 |
userId | string | 是 | 创建用户id |
code | string | 否 | 项目编码 |
typeCode | string | 是 | 项目子类型code |
state | string | 是 | 项目状态(1 = 筹备、2= 在建、3 = 停工、4 = 完工) |
enterpriseOrgId | string | 是 | 企业组织机构id |
contractAmount | number | 否 | 项目合同金额 |
startTime | number | 否 | 预计开始时间 |
endTime | number | 否 | 预计结束时间 |
shortName | string | 否 | 项目简称 |
realStartTime | number | 否 | 实际开工时间 |
realEndTime | number | 否 | 实际完工时间 |
responsibleUserName | string | 否 | 项目负责人姓名(同时设置为管理人员) |
responsibleUserPhone | string | 否 | 项目负责人电话(同时设置为管理电话) |
projectLeaderName | string | 否 | 项目领导名字 |
address | string | 否 | 项目地址 |
remarks | string | 否 | 备注 |
1.3. 3. 响应数据
响应数据中 code, message, data 为默认字段,所有字段如下表所示:
字段 | 类型 | 是否必填 | 描述 |
---|---|---|---|
code | number | 是 | 返回码,1为正常返回,其他为错误返回 |
message | string | 是 | 返回消息 |
data | string | 是 | 正常返回数据字段,可能为null |
响应数据结构如下所示:
{
"code" : 0,
"message" : "XXX",
"data" : null
}
1.4. 4. 错误码
当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。