导入假期

导入步骤

请求 URL

POST {base_url}/{api_path}/holidays/import?access_token={access_token}

请求参数


参数	是否必填	类型	说明
file	是	File	包含待导入假期信息的 CSV 文件。
format	是	String	待导入文件的格式。取值范围： `csv`：CSV 格式。
extend	是	String	假期关联的时区。注：可通过查询时区列表接口查询时区 ID。

响应参数


参数	类型	说明
errcode	Integer	返回错误码。 `0`：请求成功。非零值：请求失败。注：更多错误码和错误信息说明，请参见错误码 & 错误信息。
errmsg	String	返回信息。 `SUCCESS`：请求成功。 `FAILURE`：请求失败。
error_file_url	String	包含导入失败记录的文件的下载地址。仅当存在失败记录时，此字段有值。
fail_number	Integer	导入失败的记录数。
succ_number	Integer	导入成功的记录数。
total_number	Integer	导入文件中的记录总数。

示例

请求示例

POST /openapi/v1.0/holidays/import?format=csv&access_token=gwakjgu9ZBUfz36wql4ndsVKkryI0kdj HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: multipart/form-data; boundary=----Boundary123

------Boundary123
Content-Disposition: form-data; name="file"; filename="holidays.csv"
Content-Type: text/csv

Name,Holiday Type,Date
{holiday_name},{holiday_type},{DD/MM/YYYY HH:MM}
------Boundary123
Content-Disposition: form-data; name="format"

csv
------Boundary123
Content-Disposition: form-data; name="extend"

{timezone_id}
------Boundary123--

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "submsg": "",
    "total_number": 1,
    "succ_number": 1,
    "fail_number": 0,
    "error_file_url": ""
}