APIv1_收费记录 - 17kong/yiqikong-wiki GitHub Wiki

收费记录

获取单个收费记录

通用获取单个收费记录接口

GET /charge/:id

响应

Status: 200 OK
-
{
    "id": "1", // yiqikong_charge ID
    "equipment": "123", // 仪器uuid
    "user": "1", // 用户仪器控id
    "user_name": "Doe John", // 用户姓名
    "amount": "0", // 收费金额
    "custom": "0", // 0=自动计费,1=手动计费
    "object_name": "eq_record", // 计费来源(eq_record|eq_sample|eq_reserv)
    "object_id": "37", // 计费来源lims ID
    "ctime": "2018-10-10 10:31:06",
    "mtime": "2018-10-10 10:31:06",
    "source_name": "geneegroup", // LAB_ID
    "source_id": "37", // lims中eq_charge ID
    "state": "3" // 0=订单准备状态 1=订单成功 2=订单失败 3=订单已经删除
}

获取多个收费记录

GET /charge

参数

{
    "equipment": "123", // 仪器uuid
    "user": "1", // 用户仪器控id
    "user_name": "Doe John", // 用户姓名
    "amount": "0", // 收费金额
    "custom": "0", // 0=自动计费,1=手动计费
    "object_name": "eq_record", // 计费来源(eq_record|eq_sample|eq_reserv)
    "object_id": "37", // 计费来源lims ID
    "ctime": "2018-10-10 10:31:06",
    "mtime": "2018-10-10 10:31:06",
    "state": "3" // 0=订单准备状态 1=订单成功 2=订单失败 3=订单已经删除
}

以上全部字段,在传入字符串时均为精准匹配搜索,同时可传入数组,进行范围搜索,例如

{
    "state": ["in", 1, 2, 3]
}

数组第一个值及含义如下,其中ne、in支持多个参数传入,bt支持3个参数传入,其余均支持2个参数传入

    'ne' => 'isNot',
    'in' => 'isIn',
    'ni' => 'isNotIn',
    'gt' => 'isGreaterThan',
    'ge' => 'isGreaterThanOrEqual',
    'lt' => 'isLessThan',
    'le' => 'isLessThanOrEqual',
    'bt' => 'isBetween',

响应

Status: 200 OK
-
{}
  "total": N,
  "data": [
    {
        "id": "1", // yiqikong_charge ID
        "equipment": "123", // 仪器uuid
        "user": "1", // 用户仪器控id
        "user_name": "Doe John", // 用户姓名
        "amount": "0", // 收费金额
        "custom": "0", // 0=自动计费,1=手动计费
        "object_name": "eq_record", // 计费来源(eq_record|eq_sample|eq_reserv)
        "object_id": "37", // 计费来源lims ID
        "ctime": "2018-10-10 10:31:06",
        "mtime": "2018-10-10 10:31:06",
        "source_name": "geneegroup", // LAB_ID
        "source_id": "37", // lims中eq_charge ID
        "state": "3" // 0=订单准备状态 1=订单成功 2=订单失败 3=订单已经删除
    },
    ...
  ]
}

添加收费

通用添加仪器控收费接口

POST /charge

参数

{
    "equipment": "123", // 仪器uuid 必须
    "user": "1", // 用户仪器控id 必须
    "user_name": "Doe John", // 用户姓名
    "amount": "0", // 收费金额
    "custom": "0", // 0=自动计费,1=手动计费
    "description": "balabala..." // 计费描述
    "object_name": "eq_record", // 计费来源(eq_record|eq_sample|eq_reserv)
    "object_id": "37", // 计费来源lims ID
    "ctime": "2018-10-10 10:31:06",
    "mtime": "2018-10-10 10:31:06",
    "source_name": "geneegroup", // LAB_ID
    "source_id": "37", // lims中eq_charge ID
    "state": "3" // 0=订单准备状态 1=订单成功 2=订单失败 3=订单已经删除
}

响应

Status: 200 OK
-
{
    "id": "1", // yiqikong_charge ID
    "equipment": "123", // 仪器uuid
    "user": "1", // 用户仪器控id
    "user_name": "Doe John", // 用户姓名
    "amount": "0", // 收费金额
    "custom": "0", // 0=自动计费,1=手动计费
    "object_name": "eq_record", // 计费来源(eq_record|eq_sample|eq_reserv)
    "object_id": "37", // 计费来源lims ID
    "ctime": "2018-10-10 10:31:06",
    "mtime": "2018-10-10 10:31:06",
    "source_name": "geneegroup", // LAB_ID
    "source_id": "37", // lims中eq_charge ID
    "state": "3" // 0=订单准备状态 1=订单成功 2=订单失败 3=订单已经删除
}

修改收费

通用修改仪器控收费接口

PUT /charge/:id

:id 不传的情况下,接口将根据传入的source_name和source_id进行更新。若均未查到,则返回404

参数

{
    "equipment": "123", // 仪器uuid 必须
    "user": "1", // 用户仪器控id 必须
    "user_name": "Doe John", // 用户姓名
    "amount": "0", // 收费金额
    "custom": "0", // 0=自动计费,1=手动计费
    "description": "balabala..." // 计费描述
    "object_name": "eq_record", // 计费来源(eq_record|eq_sample|eq_reserv)
    "object_id": "37", // 计费来源lims ID
    "ctime": "2018-10-10 10:31:06",
    "mtime": "2018-10-10 10:31:06",
    "source_name": "geneegroup", // LAB_ID
    "source_id": "37", // lims中eq_charge ID
    "state": "3" // 0=订单准备状态 1=订单成功 2=订单失败 3=订单已经删除
}

响应

Status: 200 OK
-
{
    "id": "1", // yiqikong_charge ID
    "equipment": "123", // 仪器uuid
    "user": "1", // 用户仪器控id
    "user_name": "Doe John", // 用户姓名
    "amount": "0", // 收费金额
    "custom": "0", // 0=自动计费,1=手动计费
    "object_name": "eq_record", // 计费来源(eq_record|eq_sample|eq_reserv)
    "object_id": "37", // 计费来源lims ID
    "ctime": "2018-10-10 10:31:06",
    "mtime": "2018-10-10 10:31:06",
    "source_name": "geneegroup", // LAB_ID
    "source_id": "37", // lims中eq_charge ID
    "state": "3" // 0=订单准备状态 1=订单成功 2=订单失败 3=订单已经删除
}

删除收费

通用修改仪器控收费接口

DELETE /charge/:id

全部删除操作均是将state设置为3,而非从数据库删除

:id 不传的情况下,接口将根据传入的source_name和source_id进行更新。若均未查到,则返回404

参数

{
    "source_name": "geneegroup", // LAB_ID
    "source_id": "37", // lims中eq_charge ID
}

响应

Status: 200 OK
-
true