# 徽章相关API

# 获取单个企业徽章数据

获取单个企业徽章数据

请求路径: /v1/badge/{badgeId}

请求方法: GET

# 请求参数

参数名	数据类型	必填	参数位置	参数说明
badgeId	string	Y	path	徽章ID

# 返回结果

状态码	说明	返回值	响应头
200	OK	无	无

# 请求示例

GET /v1/badge/{badgeId}

# 返回示例

200

Content-Type: application/json

{
  "date" : "string"                   //请求时当前服务器时间,
  "code" : "integer"                  //结果码 200:成功,
  "data" : {
    "image" : "string"                //封面图,
    "createdByName" : "string"        //创建人,
    "createdDate" : "string"          //创建时间,
    "eCode" : "string"             //所属租户,
    "name" : "string"                 //徽章名称,
    "icon" : "string"                 //主图标,
    "remark" : "string"               //徽章描述,
    "id" : "string"                   //徽章ID,
    "pendantIcon" : "string           //挂饰图标"
  },
  "message" : "string                 //当状态码不是200时，错误信息"
}

# 更新企业徽章

更新企业徽章

请求路径: /v1/badge/{badgeId}

请求方法: POST

# 请求参数

参数名	数据类型	必填	参数位置	参数说明
badgeId	string	Y	path	徽章ID
ModifyBadgeRequest	Y	body

# 返回结果

状态码	说明	返回值	响应头
200	OK	无	无

# 请求示例

POST /v1/badge/{badgeId}

# 返回示例

200

Content-Type: application/json

{
  "date" : "string"           //请求时当前服务器时间,
  "code" : "integer"          //结果码 200:成功,
  "data" : "string"           //请求返回的数据,
  "message" : "string         //当状态码不是200时，错误信息"
}

# 查询企业徽章列表

查询企业徽章列表

请求路径: /v1/badge/list

请求方法: GET

# 请求参数

参数名	数据类型	必填	参数位置	参数说明
keyword	string	N	query	关键字
offset	integer	N	query	分页偏移量
limit	integer	N	query	查询条数
isCount	boolean	N	query	是否返回总数
eCode	string	N	query	所属租户

# 返回结果

状态码	说明	返回值	响应头
200	OK	无	无

# 请求示例

GET /v1/badge/list?keyword={keyword}&offset={offset}&limit={limit}&isCount={isCount}&eCode={eCode}

# 返回示例

200

Content-Type: application/json

{
  "data" : [                          //请求返回的数据{
    "image" : "string"                //封面图,
    "createdByName" : "string"        //创建人,
    "createdDate" : "string"          //创建时间,
    "eCode" : "string"             //所属租户,
    "name" : "string"                 //徽章名称,
    "icon" : "string"                 //主图标,
    "remark" : "string"               //徽章描述,
    "id" : "string"                   //徽章ID,
    "pendantIcon" : "string           //挂饰图标"
  } ],
  "date" : "string"                   //请求时当前服务器时间,
  "total" : "integer"                 //数据总数,
  "code" : "integer"                  //结果码 200:成功,
  "count" : "integer"                 //请求返回的数据总数,
  "message" : "string                 //当状态码不是200时，错误信息"
}

# 新增企业徽章

新增企业徽章

请求路径: /v1/badge

请求方法: POST

访问权限:

# 请求参数

参数名	数据类型	必填	参数位置	参数说明
CreatedBadgeRequest	Y	body

# 返回结果

状态码	说明	返回值	响应头
200	OK	无	无

# 请求示例

POST /v1/badge

# 返回示例

200

Content-Type: application/json

{
  "date" : "string"                   //请求时当前服务器时间,
  "code" : "integer"                  //结果码 200:成功,
  "data" : {
    "image" : "string"                //封面图,
    "createdByName" : "string"        //创建人,
    "createdDate" : "string"          //创建时间,
    "eCode" : "string"             //所属租户,
    "name" : "string"                 //徽章名称,
    "icon" : "string"                 //主图标,
    "remark" : "string"               //徽章描述,
    "id" : "string"                   //徽章ID,
    "pendantIcon" : "string           //挂饰图标"
  },
  "message" : "string                 //当状态码不是200时，错误信息"
}

# 批量删除企业徽章

批量删除企业徽章

请求路径: /v1/badge

请求方法: DELETE

访问权限:

# 请求参数

参数名	数据类型	必填	参数位置	参数说明
object	Y	body

# 返回结果

状态码	说明	返回值	响应头
200	OK	无	无

# 请求示例

DELETE /v1/badge

# 返回示例

200

Content-Type: application/json

{
  "date" : "string"           //请求时当前服务器时间,
  "code" : "integer"          //结果码 200:成功,
  "data" : "string"           //请求返回的数据,
  "message" : "string         //当状态码不是200时，错误信息"
}

← 待办接入接入示例 →