巡店报告

获取巡店报告列表

接口描述: 分页获取当前企业下所有的巡店报告信息

接口地址: https://yd.yunding360.com/openapi/patrol_reports/page

请求方式：GET

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
creator	巡检人	query	false	string
endTime	结束时间	query	false	integer
keyword	关键字搜索	query	false	string
page	页数(从0开始计数,默认为0)	query	true	integer
size	每页数量(默认20)	query	true	integer
startTime	开始时间	query	false	integer
status	报告状态：UNCOMMITTED('未提交'), CORRECTING('待整改'), VALIDATING('待审核'), COMMITTED('已完成'), 可用值: UNCOMMITTED, CORRECTING, VALIDATING, COMMITTED	query	false	string
storeIds	门店ID	query	false	array	string

响应示例:

{
    "content": [
        {
            "createdTime": 0,
            "creator": "",
            "enterpriseId": "",
            "groupId": "",
            "id": "",
            "inspectEndTime": 0,
            "inspectStartTime": 0,
            "name": "",
            "patrolSubType": "",
            "patrolType": "",
            "problemNumber": 0,
            "rectifyNumber": 0,
            "rectifyPerson": "",
            "remark": "",
            "score": 0,
            "status": "",
            "storeId": "",
            "taskId": "",
            "type": ""
        }
    ],
    "metadata": {
        "page": 0,
        "size": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

响应参数:

参数名称	参数说明	类型	schema
content		array	PatrolReportSummaryInfo
metadata	分页信息	PageMetadata	PageMetadata

schema属性说明

PatrolReportSummaryInfo

参数名称	参数说明	类型
createdTime	创建时间	integer(int64)
creator	创建人/巡查人	string(uuid)
enterpriseId	企业id	string(uuid)
groupId	所属分组id	string(uuid)
id	Id	string(uuid)
inspectEndTime	检查结束时间	integer(int64)
inspectStartTime	检查开始时间	integer(int64)
name	报告名称	string
patrolSubType	巡检子类型：PATROL_TEMPLATE('模板巡检'),PATROL_USER_DEFINED('自定义巡检'),可用值: PATROL_TEMPLATE, PATROL_USER_DEFINED	string
patrolType	巡店方式：PATROL_REALTIME('实时巡店'),PATROL_LIVE('现场巡店'),PATROL_VIDEO('录像巡店'),可用值: PATROL_REALTIME, PATROL_LIVE, PATROL_VIDEO	string
problemNumber	有问题数量	integer(int32)
rectifyNumber	整改次数	integer(int32)
rectifyPerson	整改负责人id	string
remark	备注	string
score	得分	number(double)
status	报告状态：UNCOMMITTED('未提交'),CORRECTING('待整改'),VALIDATING('待审核'),COMMITTED('已完成'),可用值: UNCOMMITTED, CORRECTING, VALIDATING, COMMITTED	string
storeId	门店id	string(uuid)
taskId	任务id	string(uuid)
type	报告类型：PATROL('巡店'),CUSTOMER_TRACKING('顾客追踪'),CASHIER_INSPECT('收银巡检'),可用值: PATROL, CUSTOMER_TRACKING, CASHIER_INSPECT	string

PageMetadata

参数名称	参数说明	类型
page	页数	integer(int64)
size	每页数量	integer(int64)
totalElements	总数	integer(int64)
totalPages	总页数	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PagedPatrolReportSummaryInfo

获取单个巡店报告详细信息

接口描述: 根据巡店报告id获取对应巡店报告的详细信息

接口地址: https://yd.yunding360.com/openapi/patrol_reports/{uuid}

请求方式：GET

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
uuid	巡店报告id	path	true	string

响应示例:

{
    "createdTime": 0,
    "creator": "",
    "detail": {
        "aggregateScore": 0,
        "description": "",
        "id": "",
        "level": 0,
        "mapping": [
            {
                "description": "",
                "imagePath": "",
                "itemId": "",
                "key": ""
            }
        ],
        "markStrategy": "",
        "name": "",
        "nodes": [
            {
                "children": [
                    {
                        "children": [
                            {}
                        ],
                        "context": {
                            "completionStatus": 0,
                            "finalScore": 0,
                            "id": "",
                            "isItem": true,
                            "label": "",
                            "name": "",
                            "nodeType": "",
                            "parentId": "",
                            "patrolScore": 0,
                            "remark": "",
                            "reportRectifyResult": "",
                            "score": 0,
                            "templateId": "",
                            "tips": ""
                        },
                        "hasChildren": true,
                        "id": "",
                        "parentId": "",
                        "uuid": ""
                    }
                ],
                "context": {
                    "completionStatus": 0,
                    "finalScore": 0,
                    "id": "",
                    "isItem": true,
                    "label": "",
                    "name": "",
                    "nodeType": "",
                    "parentId": "",
                    "patrolScore": 0,
                    "remark": "",
                    "reportRectifyResult": "",
                    "score": 0,
                    "templateId": "",
                    "tips": ""
                },
                "hasChildren": true,
                "id": "",
                "parentId": "",
                "uuid": ""
            }
        ]
    },
    "enterpriseId": "",
    "groupId": "",
    "id": "",
    "inspectEndTime": 0,
    "inspectStartTime": 0,
    "name": "",
    "patrolSubType": "",
    "patrolType": "",
    "problemNumber": 0,
    "rectifyNumber": 0,
    "rectifyPerson": "",
    "remark": "",
    "score": 0,
    "status": "",
    "storeId": "",
    "taskId": "",
    "type": ""
}

响应参数:

参数名称	参数说明	类型	schema
createdTime	创建时间	integer(int64)	integer(int64)
creator	创建人/巡查人	string(uuid)	string(uuid)
detail	评分详情（当为列表接口时，该返回为NULL；当为详情接口时，返回具体评分详情	PatrolReportDetail	PatrolReportDetail
enterpriseId	企业id	string(uuid)	string(uuid)
groupId	所属分组id	string(uuid)	string(uuid)
id	Id	string(uuid)	string(uuid)
inspectEndTime	检查结束时间	integer(int64)	integer(int64)
inspectStartTime	检查开始时间	integer(int64)	integer(int64)
name	报告名称	string
patrolSubType	巡检子类型：PATROL_TEMPLATE('模板巡检'), PATROL_USER_DEFINED('自定义巡检'),可用值: PATROL_TEMPLATE, PATROL_USER_DEFINED	string
patrolType	巡店方式：PATROL_REALTIME('实时巡店'), PATROL_LIVE('现场巡店'), PATROL_VIDEO('录像巡店'), 可用值: PATROL_REALTIME, PATROL_LIVE, PATROL_VIDEO	string
problemNumber	有问题数量	integer(int32)	integer(int32)
rectifyNumber	整改次数	integer(int32)	integer(int32)
rectifyPerson	整改负责人id	string
remark	备注	string
score	得分	number(double)	number(double)
status	报告状态：UNCOMMITTED('未提交'),CORRECTING('待整改'), VALIDATING('待审核'), COMMITTED('已完成'), 可用值: UNCOMMITTED, CORRECTING, VALIDATING, COMMITTED	string
storeId	门店id	string(uuid)	string(uuid)
taskId	任务id	string(uuid)	string(uuid)
type	报告类型：PATROL('巡店'),CUSTOMER_TRACKING('顾客追踪'),CASHIER_INSPECT('收银巡检'),可用值: PATROL, CUSTOMER_TRACKING, CASHIER_INSPECT	string

schema属性说明

PatrolReportDetail

参数名称	参数说明	类型	schema
aggregateScore	模板总分	number(double)
description	描述	string
id	Id	string(uuid)
level	模板的层数	integer(int32)
mapping	图片与评分项的映射	array	PatrolReportItemImageMapping
markStrategy	打分策略,可用值: DEDUCTION, SCORE	string
name	名称	string
nodes	包含的所有层级分类和评分项	array	TreeNode«PatrolReportDetailNode,uuid»

PatrolReportItemImageMapping

参数名称	参数说明	类型
description	图片问题描述	string
imagePath	图片路径	string
itemId	评分项id	string(uuid)
key	图片key	string

TreeNode«PatrolReportDetailNode,uuid»

参数名称	类型	schema
children	array	TreeNode«PatrolReportDetailNode,uuid»
context	PatrolReportDetailNode	PatrolReportDetailNode
hasChildren	boolean
id	string(uuid)
parentId	string(uuid)
uuid	string(uuid)

PatrolReportDetailNode

参数名称	参数说明	类型
completionStatus	完成状态	integer(int32)
finalScore	修改后的最终得分	number(double)
id	Id	string(uuid)
isItem	是否为具体的评分项(否则为分组)	boolean
label	标签	string
name	名称	string
nodeType	节点	string
parentId	上级节点id	string(uuid)
patrolScore	巡店得分	number(double)
remark	备注	string
reportRectifyResult	有无问题,可用值: NONE, NO_PROBLEM, HAS_PROBLEM	string
score	分值	number(double)
templateId	模板id	string(uuid)
tips	提示	string

响应状态:

状态码	说明	schema
200	OK	PatrolReportSummaryInfo

获取门店问题统计列表

接口描述: 按巡店分类项统计各项统计次数

接口地址: https://yd.yunding360.com/openapi/patrol_reports/statistics/issue

请求方式：GET

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
endTime	查询结束时间	query	false	integer
keyWord	关键字	query	false	string
page	页数(从0开始计数,默认为0)	query	true	integer
size	每页数量(默认20)	query	true	integer
startTime	查询开始时间	query	false	integer
storeIds	门店id列表	query	false	array	string

响应示例:

{
    "content": [
        {
            "classification": "",
            "count": 0,
            "scoring": "",
            "time": 0
        }
    ],
    "metadata": {
        "page": 0,
        "size": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

响应参数:

参数名称	参数说明	类型	schema
content		array	IssueStatisticsInfo
metadata	分页信息	PageMetadata	PageMetadata

schema属性说明

IssueStatisticsInfo

参数名称	参数说明	类型
classification	分类项	string
count	计数	integer(int32)
scoring	得分项	string
time	时间	integer(int64)

PageMetadata

参数名称	参数说明	类型
page	页数	integer(int64)
size	每页数量	integer(int64)
totalElements	总数	integer(int64)
totalPages	总页数	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PagedIssueStatisticsInfo

获取任务汇总报告列表

接口描述:

接口地址: https://yd.yunding360.com/openapi/patrol_reports/task/summary

请求方式：GET

请求参数：

参数名称	参数说明	in	是否必须	数据类型
finishEndTime	报告完成结束时间	query	false	integer
finishStartTime	报告完成开始时间	query	false	integer
keyword	关键字	query	false	string
page	页数(从0开始计数,默认为0)	query	true	integer
size	每页数量(默认20)	query	true	integer
storeId	门店id	query	false	string

响应示例:

{
    "content": [
        {
            "executor": [],
            "groupId": "",
            "id": "",
            "images": [],
            "issues": [
                {
                    "classification": "",
                    "count": 0,
                    "scoring": "",
                    "time": 0
                }
            ],
            "reports": [
                {
                    "creator": "",
                    "id": "",
                    "inspectEndTime": 0,
                    "inspectStartTime": 0,
                    "name": "",
                    "patrolSubType": "",
                    "problemNumber": 0,
                    "rectifyNumber": 0,
                    "score": 0
                }
            ],
            "score": 0,
            "storeId": "",
            "taskCreatedTime": 0,
            "taskId": ""
        }
    ],
    "metadata": {
        "page": 0,
        "size": 0,
        "totalElements": 0,
        "totalPages": 0
    }
}

响应参数:

参数名称	参数说明	类型	schema
content		array	任务汇总报告
metadata	分页信息	PageMetadata	PageMetadata

schema属性说明

任务汇总报告

参数名称	参数说明	类型	schema
executor	巡查人（可能有多个）	array
groupId	所属分组id	string(uuid)
id	Id	string(uuid)
images	相关图片	array
issues	巡店问题情况	array	IssueStatistics
reports	巡店执行情况	array	TaskSummarySubReport
score	得分	number(double)
storeId	门店id	string(uuid)
taskCreatedTime	任务创建时间	integer(int64)
taskId	任务Id	string(uuid)

IssueStatistics

参数名称	参数说明	类型
classification	分类项	string
count	计数	integer(int32)
scoring	得分项	string
time	时间	integer(int64)

TaskSummarySubReport

参数名称	参数说明	类型
creator	创建人/巡查人	string(uuid)
id	Id	string(uuid)
inspectEndTime	检查结束时间	integer(int64)
inspectStartTime	检查开始时间	integer(int64)
name	报告名称，自动生成	string
patrolSubType	巡检子类型：PATROL_TEMPLATE('模板巡检'), PATROL_USER_DEFINED('自定义巡检'), 可用值: PATROL_TEMPLATE, PATROL_USER_DEFINED	string
problemNumber	有问题数量	integer(int32)
rectifyNumber	整改次数	integer(int32)
score	得分	number(double)

PageMetadata

参数名称	参数说明	类型
page	页数	integer(int64)
size	每页数量	integer(int64)
totalElements	总数	integer(int64)
totalPages	总页数	integer(int64)

响应状态:

状态码	说明	schema
200	OK	PagedTaskSummaryReportInfo

获取单个任务汇总报告详细信息

接口描述: 根据任务汇总报告id获取单个任务汇总报告的详细信息

接口地址: https://yd.yunding360.com/openapi/patrol_reports/task/summary/{uuid}

请求方式：GET

请求参数：

参数名称	参数说明	in	是否必须	数据类型	schema
uuid	任务汇总报告id	path	true	string

响应示例:

{
    "executor": [],
    "groupId": "",
    "id": "",
    "images": [],
    "issues": [
        {
            "classification": "",
            "count": 0,
            "scoring": "",
            "time": 0
        }
    ],
    "reports": [
        {
            "creator": "",
            "id": "",
            "inspectEndTime": 0,
            "inspectStartTime": 0,
            "name": "",
            "patrolSubType": "",
            "problemNumber": 0,
            "rectifyNumber": 0,
            "score": 0
        }
    ],
    "score": 0,
    "storeId": "",
    "taskCreatedTime": 0,
    "taskId": ""
}

响应参数:

参数名称	参数说明	类型	schema
executor	巡查人（可能有多个）	array
groupId	所属分组id	string(uuid)	string(uuid)
id	Id	string(uuid)	string(uuid)
images	相关图片	array
issues	巡店问题情况	array	IssueStatistics
reports	巡店执行情况	array	TaskSummarySubReport
score	得分	number(double)	number(double)
storeId	门店id	string(uuid)	string(uuid)
taskCreatedTime	任务创建时间	integer(int64)	integer(int64)
taskId	任务Id	string(uuid)	string(uuid)

schema属性说明

IssueStatistics

参数名称	参数说明	类型
classification	分类项	string
count	计数	integer(int32)
scoring	得分项	string
time	时间	integer(int64)

TaskSummarySubReport

参数名称	参数说明	类型
creator	创建人/巡查人	string(uuid)
id	Id	string(uuid)
inspectEndTime	检查结束时间	integer(int64)
inspectStartTime	检查开始时间	integer(int64)
name	报告名称，自动生成	string
patrolSubType	巡检子类型：PATROL_TEMPLATE('模板巡检'),PATROL_USER_DEFINED('自定义巡检'),可用值: PATROL_TEMPLATE, PATROL_USER_DEFINED	string
problemNumber	有问题数量	integer(int32)
rectifyNumber	整改次数	integer(int32)
score	得分	number(double)

响应状态:

状态码	说明	schema
200	OK	任务汇总报告

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search