API 文档

Appearance

创建司机 ​

请求地址 ​

https://www.xxyb.cn/union/api/wlpt/consignor/createDriver

参数名必选类型说明
Token是string应用令牌
cid是string合作ID

注意事项 ​

部分字段是否必填由业务决定，请联系对接方获取

请求参数 ​

参数名必选类型层级说明备注
driverPhone是string1司机手机号
driverRealAuthDomain是object1司机基础信息
driverName是string2司机姓名
driverIdCard是string2身份证号码
driverIdCardAddress否string2身份证地址
idCardFrontImg是string2身份证人像面图片
idCardBackImg是string2身份证国徽面图片
driverAuthDomain否object1司机认证信息
driverLicense否string2驾驶证号
driverLicenseFrontImg否string2驾驶证正本图片
driverLicenseBackImg否string2驾驶证副本图片
driverLicenseIssuingAuthority否string2驾驶证发证机关
driverLicenseExpireStartTime否string2驾驶证有效期-起yyyy-MM-dd
driverLicenseExpireEndTime否string2驾驶证有效期-止yyyy-MM-dd
professionalQualificationCertificate否string2从业资格证件号
professionalQualificationCertificateImg否string2从业资格证图片
professionalQualificationCertificateExpireStartTime否string2从业资格证有效期-起yyyy-MM-dd
professionalQualificationCertificateExpireEndTime否string2从业资格证有效期-止yyyy-MM-dd
approvedDrivingType否enum2准驾车型见下方准驾车型代码

入参示例 ​

json
{
  "driverPhone": "13476646726",
  "driverRealAuthDomain": {
    "driverName": "张三",
    "driverIdCard": "421124199101017511",
    "driverIdCardAddress": "湖北省武汉市洪山区",
    "idCardFrontImg": "https://example.com/example.jpg",
    "idCardBackImg": "https://example.com/example.jpg"
  },
  "driverAuthDomain": {
    "driverLicense": "421124199101017511",
    "driverLicenseFrontImg": "https://example.com/example.jpg",
    "driverLicenseBackImg": "https://example.com/example.jpg",
    "driverLicenseIssuingAuthority": "湖北省武汉市洪山区发证机关",
    "driverLicenseExpireStartTime": "2024-05-20",
    "driverLicenseExpireEndTime": "2034-05-20",
    "professionalQualificationCertificate": "421124199101017511",
    "professionalQualificationCertificateImg": "https://example.com/example.jpg",
    "professionalQualificationCertificateExpireStartTime": "2024-05-20",
    "professionalQualificationCertificateExpireEndTime": "2034-05-20",
    "approvedDrivingType": "A1"
  }
}

入参对象 ​

java

@Setter
@Getter
@AllArgsConstructor
@NoArgsConstructor
@Schema(description = "创建司机")
public class ApiConsignorDriverCreateReq {

    @Schema(description = "司机手机号", example = "13800000000")
    @NotBlank(message = "司机手机号不能为空")
    @Pattern(regexp = "^1[3-9]\\d{9}$", message = "司机手机号格式错误")
    private String driverPhone;

    @Schema(description = "司机基础信息")
    @Valid
    private ApiDriverRealAuthDomain driverRealAuthDomain;

    @Schema(description = "司机认证信息")
    @Valid
    private ApiDriverAuthDomain driverAuthDomain;

    @Setter
    @Getter
    @Accessors(chain = true)
    @Schema(description = "司机基础信息")
    public class ApiDriverRealAuthDomain {

        @Schema(description = "司机姓名", example = "张三 | 尼古拉斯·赵四")
        @NotBlank(message = "司机姓名不能为空")
        @Pattern(regexp = "^[\u2E80-\u9FFF·]{2,60}$", message = "司机姓名格式错误")
        private String driverName;

        @Schema(description = "身份证件号", example = "410181198107110012")
        @NotBlank(message = "身份证件号不能为空")
        @Pattern(regexp = "^[1-9]\\d{5}[1-2]\\d{3}((0\\d)|(1[0-2]))(([012]\\d)|3[0-1])\\d{3}(\\d|X|x)$", message = "身份证件号格式错误")
        private String driverIdCard;

        @Schema(description = "身份证地址")
        private String driverIdCardAddress;

        @Schema(description = "身份证人像面图片", example = "https://xx/yy.png")
        @NotBlank(message = "身份证人像面图片不能为空")
        private String idCardFrontImg;

        @Schema(description = "身份证国徽面图片", example = "https://xx/yy.png")
        @NotBlank(message = "身份证国徽面图片不能为空")
        private String idCardBackImg;

    }

    @Setter
    @Getter
    @Accessors(chain = true)
    @Schema(description = "司机认证信息")
    public class ApiDriverAuthDomain {

        @Schema(description = "驾驶证件号")
        private String driverLicense;

        @Schema(description = "驾驶证正面图片", example = "https://xx/yy.png")
        private String driverLicenseFrontImg;

        @Schema(description = "驾驶证背面图片", example = "https://xx/yy.png")
        private String driverLicenseBackImg;

        @Schema(description = "驾驶证发证机关")
        private String driverLicenseIssuingAuthority;

        @Schema(description = "驾驶证有效期-起", example = "yyyy-MM-dd")
        @Pattern(regexp = "^\\d{4}-\\d{2}-\\d{2}$", message = "驾驶证有效期-起格式不正确")
        private String driverLicenseExpireStartTime;

        @Schema(description = "驾驶证有效期-止", example = "yyyy-MM-dd | 长期")
        @Pattern(regexp = "^(\\d{4}-\\d{2}-\\d{2})|(长期)$", message = "驾驶证有效期-止格式不正确")
        private String driverLicenseExpireEndTime;

        @Schema(description = "从业资格证件号")
        private String professionalQualificationCertificate;

        @Schema(description = "从业资格证图片", example = "https://xx/yy.png")
        private String professionalQualificationCertificateImg;

        @Schema(description = "从业资格证有效期-起", example = "yyyy-MM-dd")
        @Pattern(regexp = "^\\d{4}-\\d{2}-\\d{2}$", message = "从业资格证有效期-起格式不正确")
        private String professionalQualificationCertificateExpireStartTime;

        @Schema(description = "从业资格证有效期-止", example = "yyyy-MM-dd | 长期")
        @Pattern(regexp = "^(\\d{4}-\\d{2}-\\d{2})|(长期)$", message = "从业资格证有效期-止格式不正确")
        private String professionalQualificationCertificateExpireEndTime;

        @Schema(description = "准驾车型")
        private ApprovedDrivingTypeEnum approvedDrivingType;

    }

}

返回参数 ​

参数名类型层级说明备注
codeint1状态码
msgstring1请求结果
totalint1返回总条数
requestIdstring1请求编号
dataobject1返回数据
idstring2司机ID

反参示例 ​

json
{
  "code": 200,
  "data": {
    "id": "131321321"
  },
  "msg": "业务处理成功",
  "total": null,
  "requestId": "1eb7cb0e"
}

反参对象 ​

java

@Setter
@Getter
@Schema(description = "创建司机")
public class ApiConsignorDriverCreateRes {

    @Schema(description = "司机ID")
    private String id;

}

准驾车型代码（ApprovedDrivingTypeEnum）：

NameMessage
A1A1
A2A2
A3A3
B1B1
B2B2
B3B3
C1C1
C2C2
C3C3
A1A2A1A2
A1A3A1A3
A1B1A1B1
A1B2A1B2
A1B3A1B3
A1C1A1C1
A1C2A1C2
A1C3A1C3
A2B1A2B1
A2B2A2B2
A2B3A2B3
A2C1A2C1
A2C2A2C2
A2C3A2C3
A3B1A3B1
A3B2A3B2
A3B3A3B3
A3C1A3C1
A3C2A3C2
A3C3A3C3
A1DA1D
A1EA1E
A2DA2D
A2EA2E
A2FA2F
A2A3A2A3
B1B2B1B2
B1B3B1B3
B1C1B1C1
B1C2B1C2
B1C3B1C3
B2B3B2B3
B2C1B2C1
B2C2B2C2
B2C3B2C3
B3C1B3C1
B3C2B3C2
B3C3B3C3
B2DB2D
B2EB2E
C1C2C1C2
C1C3C1C3
C2C3C2C3
C1DC1D
C1MC1M
A1A2EA1A2E
A1A2DA1A2D
A2A3EA2A3E
A2A3DA2A3D
B1B2EB1B2E