README

一个RebelCode模块，提供用于EDD Bookings的REST API。

REST API 详细信息

1. 预订

检索预订信息

GET /bookings/<id>

通过ID检索预订。

响应将包含具有以下属性的对象

属性	类型	描述	值
`id`	整数	预订的ID	正非零整数
`start`	整数	预订的起始时间，格式为 `Y-M-D H:i:s`	整数
`end`	整数	预订的结束时间，格式为 `Y-M-D H:i:s`	整数
`status`	字符串	预订的当前状态	`""`, `"draft"`, `"in_cart"`, `"pending"`, `"approved"`, `"rejected"`, `"scheduled"`, `"cancelled"`, `"completed"`
`service`	service	进行预订的服务	服务对象
`resource`	整数	进行预订的资源ID	正非零整数
`client`	client	预订的客户	客户对象或 `null`
`clientTzName`	字符串	客户的时区名称	任何时区名称或 `null`
`clientTzOffset`	整数	客户在预订开始时的UTC时区偏移（以秒为单位）	整数或 `null`
`payment`	整数	付款编号	整数或 `null`
`notes`	字符串	管理员预订备注	字符串

查询预订

GET /bookings?field=value&...

可以提供多个字段和值对以缩小查询。下表列出了可用的查询字段以及提供的值是如何比较的

字段	描述	值类型
`id`	具有给定ID的预订	整数
`start`	起始时间在给定UTC时间戳或之后的预订	整数
`end`	结束时间在给定UTC时间戳或之前的预订	整数
`service`	为具有给定ID的服务制作的预订	正非零整数
`resource`	为具有给定ID的资源制作的预订	正非零整数
`client`	为具有给定ID的客户制作的预订	正非零整数
`payment`	与具有给定ID的付款关联的预订	正非零整数
`status`	要过滤的预订状态	以逗号分隔的状态名称列表（无空格！）

以下也提供了其他过滤选项

过滤器	描述	值类型	默认值
`numItems`	每页接收的最多 `items` 数量	正非零整数	20
`page`	页码	正非零整数	1

响应是一个对象，包含3个键： items、count 和 statuses。示例

{
    items: [
        {
            "id": "21",
            "start": "2018-05-01 12:00:00",
            "end": "2018-05-01 13:30:00",
            "status": "draft",
            "service": {
                "id": 8,
                "name": "Test",
                "color": "#00ccff"
            },
            "resource": "0",
            "client": {
                "id": "6",
                "name": "Test User",
                "email": "test@eddbk.com"
            },
            "clientTzName": "Europe/Rome",
            "clientTzOffset": 1,
            "paymentNumber": 52,
            "notes": ""
        }
    ],
    "count": 1,
    "statuses": {
        "none": 0,
        "draft": 1,
        "in_cart": 0,
        "pending": 0,
        "approved": 0,
        "rejected": 0,
        "scheduled": 0,
        "completed": 0,
        "cancelled": 0
    }
}

statuses 计数独立于任何查询过滤器进行计算。

创建预订

POST /bookings

创建一个新的预订并返回预订对象。下表列出了可用的字段

属性	类型	描述	必填？
`start`	整数	预订的起始时间，作为UTC时间戳	✅
`end`	整数	预订的结束时间，以UTC时间戳表示	✅
`service`	正非零整数	将被预订的服务ID	✅
`resource`	正非零整数	将被预订的资源ID	✅
`转换`	`"草案"` 或 `"购物车"`	应用于预订的初始转换	✅
`client`	正非零整数	将被预订的客户ID
`clientTz`	字符串	客户的时区名称
`payment`	整数或 `null`	付款编号
`notes`	字符串	管理员预订备注

更新预订

PATCH /bookings/<id>

更新预订。下表列出了可用于更新的字段

属性	类型	描述
`start`	整数	预订的起始时间，作为UTC时间戳
`end`	整数	预订的结束时间，以UTC时间戳表示
`service`	正非零整数	将被预订的服务ID
`resource`	正非零整数	将被预订的资源ID
`client`	正非零整数	将被预订的客户ID
`clientTz`	字符串	客户的时区名称
`payment`	整数	付款编号
`notes`	字符串	管理员预订备注

删除预订

DELETE /bookings/<id>

删除具有给定ID的预订。

rebelcode / rcmod-eddbk-rest-api

维护者

详细信息