分页查询业务受理单
功能介绍
分页查询业务受理单
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/work-orders
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
main_search_key |
否 |
String |
业务受理ID 最小长度：0 最大长度：17 |
limit |
否 |
Long |
分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：10 最大值：500 缺省值：10 |
offset |
否 |
Long |
分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：1 最大值：1000000 缺省值：1 |
sim_type |
否 |
Integer |
SIM卡类型: 1.vSIM 2.eSIM 3.实体卡 最小值：1 最大值：10 |
work_order_type |
否 |
Integer |
业务受理类型：1.批量激活实体卡 2.批量转移实体卡 3.创建流量池 4.实体卡复机 5.实体卡停机 6.批量启用或复机 7.批量停用或停机 8.批量订购 9.批量退订 10.实体卡激活 11.申请断网 12.达量断网 13.机卡重绑 14.实名制信息清除 15.实体卡限速 16.批量补卡 17.批量机卡重绑 18.重启已废弃后向流量池 19.批量达量断网 20断网恢复 21取消达量断网 22批量取消达量断网 23批量拆机 最小值：1 最大值：99 |
status |
否 |
Integer |
业务受理状态:：1审核中、2已审核、3处理中、4已完成、5已取消、6失败、7 审核不通过 最小值：1 最大值：7 |
请求参数
无
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
limit |
Long |
每页的记录数 最小值：10 最大值：500 |
offset |
Long |
页码，最小值是1，最大值为1000000。默认值是1. 最小值：1 最大值：1000000 |
count |
Long |
记录总数 最小值：0 |
work_orders |
Array of WorkOrderVo objects |
业务受理单列表 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
Long |
业务受理ID |
sim_type |
Integer |
SIM卡类型: 1.vSIM 2.eSIM 3.实体卡 |
work_order_type |
Integer |
业务受理类型：1.批量激活实体卡 2.批量转移实体卡 3.创建流量池 4.实体卡复机 5.实体卡停机 6.批量启用或复机 7.批量停用或停机 8.批量订购 9.批量退订 10.实体卡激活 11.申请断网 12.达量断网 13.机卡重绑 14.实名制信息清除 15.实体卡限速 16.批量补卡 17.批量机卡重绑 18.重启已废弃后向流量池 19.批量达量断网 20断网恢复 21取消达量断网 22批量取消达量断网 23批量拆机 |
req_detail |
String |
请求详情 |
total_count |
Integer |
业务受理明细总数 |
success_count |
Integer |
业务受理明细成功数 |
fail_count |
Integer |
业务受理明细失败数 |
process_count |
Integer |
业务受理明细处理中数 |
status |
Integer |
业务受理状态：1审核中、2已审核、3处理中、4已完成、5已取消、6失败、7 审核不通过 |
create_time |
String |
创建时间 |
finish_time |
String |
完成时间 |
fail_reason |
String |
失败原因 |
response |
String |
响应内容 |
work_order_source |
Integer |
业务受理单来源,1:运营人员生成,2:用户操作生成(console),3:自动化规则生成,4:后向流量池超阈值停用次月自动复机任务,5:单卡没流量停机定时任务,6:SIM卡到期自动停机定时任务,7:流量池停机定时任务,8:用户操作生成(api) |
work_order_source_desc |
String |
业务受理单来源描述 |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码： 500
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
查询业务受理单，每页返回10条数据，从第1页开始。
GET https://{endpoint}/v1/work-orders?offset=1&limit=10
响应示例
状态码： 200
OK
{
"limit" : 10,
"offset" : 1,
"count" : 1,
"work_orders" : [ {
"id" : 5388214536425984,
"sim_type" : 3,
"work_order_type" : 4,
"req_detail" : "容器ID:89860484192070060448",
"total_count" : 1,
"success_count" : 1,
"fail_count" : 0,
"process_count" : 0,
"status" : 4,
"create_time" : "2023-07-29T09:50:58.000+00:00",
"finish_time" : "2023-07-29T09:55:00.000+00:00",
"fail_reason" : null,
"response" : null,
"work_order_source" : 8,
"work_order_source_desc" : "用户操作生成(api)"
} ]
}
状态码： 400
Parameter Invalid
{
"error_code" : "GSL.00010004",
"error_msg" : "参数异常"
}
状态码： 500
Internal Server Error
{
"error_code" : "GSL.00010003",
"error_msg" : "系统繁忙，请稍后重试。"
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Parameter Invalid |
500 |
Internal Server Error |
错误码
请参见错误码。
