修改外部出行人

请求地址

https://api.es.xiaojukeji.com/open-apis/v1/traveler/update

请求方式

POST

Content-Type: application/json

是否需要登录

是关于登录授权，参见如何登录授权

请求参数

名称	类型	必填	示例	描述
client_id	string	Y	87fca1dde0a96c20fccf2ccaa40_test	申请应用时分配的AppKey
access_token	string	Y	8d7479966691fccbd6d4f04ed77b61	授权后的access token 详见如何授权
timestamp	bigint	Y	1689667125	当前时间戳（秒级）
company_id	string	Y	1125915646167936	滴滴侧公司ID 托管模式下为操作的公司ID，同时需要开启托管的员工管理权限非托管模式下为自己公司ID
param_json	string	Y	详见下方 param_json 格式	请求参数将 param_json 转为 json 字符串
sign	string	Y	5d3a57a8fd898a9eba1d82a8fc49620b	签名

param_json 格式

名称	类型	必填	示例	备注
traveler_id	string	Y	4441232560273757550	滴滴侧出行人 ID
phone	string	Y	15100000000	外部出行人手机号
name	string	Y	张三	外部出行人姓名不大于 26个字符
english_surname	string	N	zhang	英文姓 *英文姓 + 英文名不大于 26 字符
english_name	string	N	san	英文名英文姓 + 英文名不大于 26 字符
remark	string	N	因xx原因更新外部出行人信息	备注信息不大于 64 个字符
sex	int	N	1	0-空；1-男；2-女。默认为 0
out_traveler_id	string	N	out_zhangsan_001	外部出行人唯一ID 不大于 32个字符
birth_date	string	N	98a9eba1	出生日期（YYYY-MM-DD）加密传输
force_clear_fields	[]string	N	["card_list"]	强制清空字段，目前只支持传 card_list

data.card 格式

名称	类型	是否必填	示例	备注
card_type	int	Y	1	证件类型： 1. 身份证 2. 护照 3. 港澳台居民居住证 4. 台胞证 5. 军官证 6. 回乡证 7. 外国人永久居留身份证 8.往来港澳通行证 9. 公务护照 10. 外交护照 11.其他注意：身份证如果有值，则校验身份证长度必须合规
card_no	string	Y	1jua6691d	证件号码加密传输
expire_date	string	N	d6d4f04ed	证件有效期 (YYYY-MM-DD) （需加密）加密传输默认为空字符串

注意事项

注：

接口字段不传或者传空代表不更新。

对证件信息编辑时，如果想要新增证件类型，之前想要保留的证件类型数据也需要传输，不然会被清空；

请求示例

curl --location 'https://api.es.xiaojukeji.com/open-apis/v1/traveler/update' \
--header 'Content-Type: application/json' \
--data '{
    "access_token":"bad4960ce20d05b601f1360151fbeaaf",
    "client_id":"87fca1dc60c6c20fccf2ccaa40",
    "company_id":"1125915646167936",
    "param_json":"{\"phone\":\"11100009911\",\"name\":\"name\",\"sex\":1,\"out_traveler_id\":\"11111\",\"card_list\":[{\"card_type\":1,\"card_no\":\"xxxxxxxxxxxx\",\"expire_date\":\"xxxxxxxxxxxxxx\"}],\"traveler_id\":\"1125921887518261\"}",
    "sign":"484eb0a84a76a02bbb7ef8055b3b97a3",
    "timestamp":1689667995
}'

返回参数说明

字段	类型	说明
errno	int	0表示成功，非0表示失败
errmsg	string	errno=0时为常量"SUCCESS"，errno!=0时为错误信息
data	object	返回值对象详见data格式

data

字段	类型	说明
id	string	滴滴侧出行人 ID

返回示例

{
    "errno":0,
    "errmsg":"SUCCESS",
    "data":{
        "id": "4441232560273757550"
    }
}

results matching ""

No results matching ""