万店掌 开放平台 获取施工单详情

open.shopweb.crm.getConstructionOrderInfo (获取施工单详情)

获取施工单详情

接口描述#

环境接口方法提交方式是否需要签名HTTP请求路由
正式环境open.shopweb.crm.getConstructionOrderInfoGETtruehttp://cloudapi.ovopark.com/cloud.api

公共请求参数#

参数类型是否必填最大长度描述示例值
_aidString20开放平台系统编号,固定为S107S107
_akeyString20万店掌开放平台分配给第三方的开发者key认证平台开发者后获取
_mtString100接口名称open.shopweb.crm.getConstructionOrderInfo
_smString100签名算法 md5,sha1md5
_requestModeString100请求方式post,getGET
_versionString100版本号v1
_timestampString100时间戳yyyyMMddHHmmss格式
_sigString32签名token根据签名算法生成,详情见签名算法规则
_formatString10format类型目前默认仅支持json

业务请求参数#

参数类型是否必填最大长度描述示例值
orderNo
string11 施工单号

公共响应参数#

参数类型最大长度描述示例值
statJSON-网关状态(具体参数描述如下:)查看
stat.cidString100http请求的标识符
stat.codeString100网关返回码
stat.codenameString100网关返回码名称
stat.systimeStringLong接口调用的当前时间
resultString100接口返回提示信息
dataJSON-接口调用返回的业务信息(一般是json格式数据,具体数据格式会在业务返回参数中定义)查看

业务返回参数#

参数名称类型是否一定返回返回最大长度描述示例值
data
JSON×11返回data查看
    
id
int×0施工单id
    
orderNo
string×0施工单编号
    
groupId
int×0企业id
    
groupName
string×0企业名称
    
deliveryAfterName
string×0交付/售后名称
    
deliveryAfterPhone
string×0交付/售后电话
    
deptName
string×0门店名称
    
deptAddress
string×0施工地址
    
deptContacts
string×0施工联系人
    
contactNumber
string×0施工联系电话
    
shopAddress
string×0行政区划
    
expectedDoorTime
string×0期望上门施工时间
    
serviceDescription
string×0施工要求(服务内容描述)
    
attachmentList
JSON×0施工资料列表 查看
        
filename
string×0附件名称
        
fileurl
string×0附件名称
        
filetype
string×0 附件类别
        
suffix
string×0 文件后缀
        
attachId
string×0 关联Id
    
checkDocList
JSON×11验收资料列表 查看
        
id
int×0验收项目id
        
serialNo
string×0序号
        
projectName
string×0验收项目名称
        
required
string×0是否必传(0:必传,1:非必传)
        
remark
int×0 备注
        
field_8
int×0至少上传数量
        
attachmentList
JSON×0示例验收资料列表(同验收文件列表) 查看
            
id
int×0
            
filename
string×0 附件名称
            
fileurl
string×0附件url
            
filetype
string×0 附件类别
            
suffix
string×0 文件后缀
        
acceptanceAttachmentList
JSON×0验收文件列表 查看
            
id
int×0id
            
filename
string×0附件名称
            
fileurl
string×0附件url
            
filetype
string×0附件类别
            
suffix
string×0文件后缀
            
createTime
string×0创建时间
            
createBy
string×0创建人
    
templateId
string×0 模板id
    
receiverList
JSON×11快递信息列表 查看
        
receiver
string×0收件人
        
phoneNo
string×0收件人手机号
        
logistics
string×0物流公司
        
expressNo
string×0快递单号
    
productModelList
JSON×0合同产品列表 查看
        
productId
int×0产品id
        
productName
string×0产品名称
        
materialCoding
string×0物料编码
        
quantity
int×0数量
        
unit
string×0单位
        
remark
string×0备注
        
productTypeId
string×0产品分类id
        
typeName
string×0产品分类名称
        
id
int×0主键
        
serviceOrderId
string×0服务单id
        
maxQuantity
string×0最大数量
        
contractNos
string×0合同编码集合
    
constructionStatus
string×0施工状态(4-施工完成,5-验收失败)
    
deptNumber
string×0客户门店编码
    
demandNumber
int×0客户需求单号
    
pmPhone
string×0项目经理手机号
    
pmName
string×0项目经理姓名
closingDescription
string×0结案内容描述

公共返回码#

返回码名称返回码返回码描述解决方案
SUCCESS0调用成功
KEY_NOTNULL1_akey和不能为空接口调用时传入_akey参数
KEY_UNLAWFUL2_akey不合法key是非法的,传入正确的key
KEY_HAS_EXPIRED3_akey已过期请续订服务或联系平台管理人员
SIGN_METHOD_NOTNULL4_sm参数不能为空接口调用时传入_sm参数
SIGN_TYPE_NOTEXIST5_sm类型不存在目前仅支持md5,sha1
SIGN_NOTNULL6_sig参数不能为空接口调用时传入_sig参数
SIGN_WRONG7无效的签名,请检查参数和签名格式_sig值根据签名算法生成
METHOD_NOTNULL8_mt参数不能为空接口调用时传入_mt参数
METHOD_NOTEXIST_CODE9_mt对应的方法名不存在或未注册进服务检查_mt方法名和_version版本号对应的方法是否传入错误
REQUESTMODE_NOTNULL10_requestMode参数不能为空接口调用时传入_requestMode参数
APPLICATIONID_NOTNULL11_aid参数不能为空接口调用时传入_aid参数
APPLICATIONID_NOTSAME12_aid与当前key不匹配_aid与_akey必须一一对应
VERSION_NOTNULL13_version版本号不能为空接口调用时传入_version参数
TIMESTAMP_NOTNULL14_timestamp时间戳不能为空接口调用时传入_timestamp参数
TIMESTAMP_FORMAT_ERROR15_timestamp时间戳格式化错误按照yyyyMMddHHmmss格式
TIMESTAMP_OVERTIME16_timestamp已失效_timestamp每次接口调用时重新生成
FORMAT_TYPE_NOTEXIST17_format类型不存在目前仅支持json(默认),xml
API_CALL_REPEAT-100接口重复调用接口平台调用异常
API_SYSTEM_CALL_ERROR-500api调用失败,系统发生异常接口平台调用异常
UNKNOWN_ERROR-999开放平台系统异常重新发起请求

业务返回码#

返回码名称返回码返回码描述
code
0success