hl-api-changelog/api-docs/hl-contract-service.json
2026-03-17 09:21:07 +08:00

2327 行
63 KiB
JSON

此文件含有模棱两可的 Unicode 字符

此文件含有可能会与其他字符混淆的 Unicode 字符。 如果您是想特意这样的,可以安全地忽略该警告。 使用 Escape 按钮显示他们。

{
"swagger": "2.0",
"info": {
"title": "合同服务",
"version": "1.0.0"
},
"basePath": "/",
"paths": {
"/admin/contract/active-by-order/{orderId}": {
"get": {
"tags": [
"合同管理"
],
"summary": "获取订单有效合同",
"description": "返回订单当前有效的合同(非作废状态的最新合同),用于检查订单是否已有签署中或已签署的合同。\n\n**权限**:需管理员登录。\n\n**关联字典**\n- contract_status合同状态显示",
"operationId": "getActiveByOrderUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "订单ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同信息»",
"originalRef": "统一响应结果«合同信息»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同信息»",
"originalRef": "统一响应结果«合同信息»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/agencies": {
"get": {
"tags": [
"合同管理"
],
"summary": "可用旅行社列表",
"description": "返回系统配置的旅行社列表,创建合同时选择签约旅行社",
"operationId": "listAgenciesUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«旅行社信息»»",
"originalRef": "统一响应结果«List«旅行社信息»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«旅行社信息»»",
"originalRef": "统一响应结果«List«旅行社信息»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/by-order/{orderId}": {
"get": {
"tags": [
"合同管理"
],
"summary": "按订单查询合同",
"description": "查询指定订单下的所有合同记录(含已作废),按创建时间倒序排列。用于订单详情页展示合同历史。\n\n**权限**:需管理员登录。\n\n**关联字典**\n- contract_status合同状态列表显示",
"operationId": "getByOrderUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "订单ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«合同信息»»",
"originalRef": "统一响应结果«List«合同信息»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«合同信息»»",
"originalRef": "统一响应结果«List«合同信息»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/clause-template": {
"post": {
"tags": [
"补充约定模板管理"
],
"summary": "创建补充约定模板",
"description": "创建合同补充约定的模板,支持变量占位符。创建后默认启用",
"operationId": "createUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"$ref": "#/definitions/补充约定模板请求",
"originalRef": "补充约定模板请求"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«补充约定模板»",
"originalRef": "统一响应结果«补充约定模板»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«补充约定模板»",
"originalRef": "统一响应结果«补充约定模板»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/clause-template/list": {
"get": {
"tags": [
"补充约定模板管理"
],
"summary": "获取启用的补充约定模板列表(创建合同用)",
"description": "返回所有启用状态的补充约定模板,创建合同时选择需要附加的补充约定条款。\n\n**权限**:需管理员登录。",
"operationId": "listActiveUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«补充约定模板»»",
"originalRef": "统一响应结果«List«补充约定模板»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«补充约定模板»»",
"originalRef": "统一响应结果«List«补充约定模板»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/clause-template/list-all": {
"get": {
"tags": [
"补充约定模板管理"
],
"summary": "获取全部补充约定模板(管理页用)",
"description": "**关联字典**\n- common_status通用状态列表显示,ACTIVE=启用/INACTIVE=停用)",
"operationId": "listAllUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«补充约定模板»»",
"originalRef": "统一响应结果«List«补充约定模板»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«补充约定模板»»",
"originalRef": "统一响应结果«List«补充约定模板»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/clause-template/{id}": {
"put": {
"tags": [
"补充约定模板管理"
],
"summary": "更新补充约定模板",
"description": "更新模板的标题和内容。已被合同引用的模板更新不影响已创建的合同(合同记录的是快照内容)。\n\n**权限**:需管理员登录。",
"operationId": "updateUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "模板ID",
"required": false,
"type": "integer",
"format": "int64"
},
{
"in": "body",
"name": "request",
"description": "request",
"required": true,
"schema": {
"$ref": "#/definitions/补充约定模板请求",
"originalRef": "补充约定模板请求"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«补充约定模板»",
"originalRef": "统一响应结果«补充约定模板»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«补充约定模板»",
"originalRef": "统一响应结果«补充约定模板»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
},
"delete": {
"tags": [
"补充约定模板管理"
],
"summary": "删除补充约定模板",
"description": "软删除模板。已被合同引用的模板仍可删除,不影响已创建的合同",
"operationId": "deleteUsingDELETE",
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "模板ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«Void»",
"originalRef": "统一响应结果«Void»"
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«Void»",
"originalRef": "统一响应结果«Void»"
}
},
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/clause-template/{id}/toggle-status": {
"put": {
"tags": [
"补充约定模板管理"
],
"summary": "切换模板启用/停用状态",
"description": "**关联字典**\n- common_status通用状态状态切换,ACTIVE=启用/INACTIVE=停用)",
"operationId": "toggleStatusUsingPUT",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "模板ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«补充约定模板»",
"originalRef": "统一响应结果«补充约定模板»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«补充约定模板»",
"originalRef": "统一响应结果«补充约定模板»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/create": {
"post": {
"tags": [
"合同管理"
],
"summary": "创建合同(标准模式)",
"description": "标准电子签约流程:创建合同 → 平台生成合同PDF → 发送签署短信给出行人 → 出行人在线签署 → 回调更新状态。状态流转CREATED → SIGNING → SIGNED",
"operationId": "createContractUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "创建合同请求",
"required": false,
"schema": {
"$ref": "#/definitions/创建合同请求",
"originalRef": "创建合同请求"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同详情»",
"originalRef": "统一响应结果«合同详情»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同详情»",
"originalRef": "统一响应结果«合同详情»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/list": {
"get": {
"tags": [
"合同管理"
],
"summary": "合同列表",
"description": "分页查询合同记录,支持按订单号、合同状态、旅行社筛选\n\n**关联字典**\n- contract_status合同状态列表筛选+显示)",
"operationId": "listContractsUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "orderId",
"in": "query",
"description": "订单ID",
"required": false,
"type": "integer",
"format": "int64",
"x-example": 1001
},
{
"name": "page",
"in": "query",
"description": "页码",
"required": false,
"type": "integer",
"format": "int32",
"x-example": 1
},
{
"name": "pageSize",
"in": "query",
"description": "每页条数",
"required": false,
"type": "integer",
"format": "int32",
"x-example": 20
},
{
"name": "platform",
"in": "query",
"description": "签约平台",
"required": false,
"type": "string",
"x-example": "TOURAGE"
},
{
"name": "status",
"in": "query",
"description": "合同状态",
"required": false,
"type": "string",
"x-example": "SIGNED"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«分页结果«合同信息»»",
"originalRef": "统一响应结果«分页结果«合同信息»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«分页结果«合同信息»»",
"originalRef": "统一响应结果«分页结果«合同信息»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/report": {
"post": {
"tags": [
"合同管理"
],
"summary": "报备合同(同步模式)",
"description": "线下签约模式:创建合同记录 → 管理员上传已签署的PDF → 同步到12301报备平台。状态流转CREATED → UPLOADED → REPORTED",
"operationId": "reportContractUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"in": "body",
"name": "request",
"description": "报备合同请求",
"required": false,
"schema": {
"$ref": "#/definitions/报备合同请求(同步模式)",
"originalRef": "报备合同请求(同步模式)"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同详情»",
"originalRef": "统一响应结果«合同详情»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同详情»",
"originalRef": "统一响应结果«合同详情»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/templates": {
"get": {
"tags": [
"合同管理"
],
"summary": "合同模板列表",
"description": "返回合同平台可用的合同模板列表,创建合同时选择模板",
"operationId": "listTemplatesUsingGET",
"produces": [
"*/*"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«合同模板信息»»",
"originalRef": "统一响应结果«List«合同模板信息»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«List«合同模板信息»»",
"originalRef": "统一响应结果«List«合同模板信息»»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/{id}": {
"get": {
"tags": [
"合同管理"
],
"summary": "合同详情",
"description": "**关联字典**\n- contract_status合同状态显示",
"operationId": "getContractDetailUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "合同ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同详情»",
"originalRef": "统一响应结果«合同详情»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同详情»",
"originalRef": "统一响应结果«合同详情»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/{id}/invalidate": {
"post": {
"tags": [
"合同管理"
],
"summary": "作废合同",
"description": "将合同标记为作废状态(不可恢复)。作废后该合同不再有效,可重新为订单创建新合同",
"operationId": "invalidateContractUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "合同ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同信息»",
"originalRef": "统一响应结果«合同信息»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同信息»",
"originalRef": "统一响应结果«合同信息»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/{id}/resend-sms": {
"post": {
"tags": [
"合同管理"
],
"summary": "重发签署短信",
"description": "重新发送签署短信给出行人,用于签署短信过期或未收到的场景。仅SIGNING状态的合同可操作",
"operationId": "resendSmsUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "合同ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«boolean»",
"originalRef": "统一响应结果«boolean»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«boolean»",
"originalRef": "统一响应结果«boolean»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/{id}/status": {
"get": {
"tags": [
"合同管理"
],
"summary": "刷新合同状态(从平台同步)",
"description": "主动查询合同平台的最新签署状态并同步到本地,适用于回调未到达的场景",
"operationId": "refreshStatusUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "合同ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同信息»",
"originalRef": "统一响应结果«合同信息»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同信息»",
"originalRef": "统一响应结果«合同信息»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
},
"/admin/contract/{id}/upload-pdf": {
"post": {
"tags": [
"合同管理"
],
"summary": "上传已签署PDF(同步模式)",
"description": "同步模式专用上传线下签署完成的合同PDF文件,上传后合同状态变为UPLOADED,可进一步报备",
"operationId": "uploadPdfUsingPOST",
"consumes": [
"multipart/form-data"
],
"produces": [
"*/*"
],
"parameters": [
{
"name": "file",
"in": "formData",
"description": "签署PDF文件",
"required": false,
"type": "file"
},
{
"name": "id",
"in": "path",
"description": "合同ID",
"required": false,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同信息»",
"originalRef": "统一响应结果«合同信息»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"responsesObject": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/统一响应结果«合同信息»",
"originalRef": "统一响应结果«合同信息»"
}
},
"201": {
"description": "Created"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false,
"x-order": "2147483647"
}
}
},
"definitions": {
"分页结果«合同信息»": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "当前页码"
},
"pageSize": {
"type": "integer",
"format": "int32",
"example": 20,
"description": "每页条数"
},
"records": {
"type": "array",
"description": "数据列表",
"items": {
"$ref": "#/definitions/合同信息",
"originalRef": "合同信息"
}
},
"total": {
"type": "integer",
"format": "int32",
"example": 100,
"description": "总记录数"
}
},
"title": "分页结果«合同信息»"
},
"创建合同请求": {
"type": "object",
"required": [
"adultCost",
"contactName",
"contactPhone",
"departureDate",
"destination",
"returnDate",
"routeName",
"signatoryIdNumber",
"signatoryName",
"signatoryPhone",
"templateCode",
"totalAmount",
"travelers"
],
"properties": {
"adultCost": {
"type": "number",
"example": 2980.0,
"description": "成人费用"
},
"agencyCode": {
"type": "string",
"example": "L-FJ-100005",
"description": "旅行社编号(可选,默认使用配置值)"
},
"childCost": {
"type": "number",
"example": 1490.0,
"description": "儿童费用"
},
"contactName": {
"type": "string",
"example": "李四",
"description": "联系人姓名"
},
"contactPhone": {
"type": "string",
"example": 13900139000,
"description": "联系人电话"
},
"contractType": {
"type": "string",
"example": "TOUR",
"description": "合同类型: TOUR-旅游合同(默认), INSURANCE-保险单"
},
"days": {
"type": "integer",
"format": "int32",
"example": 3,
"description": "行程天数"
},
"departureCity": {
"type": "string",
"example": "成都",
"description": "出发城市"
},
"departureDate": {
"type": "string",
"format": "date",
"example": "2026-04-01",
"description": "出发日期"
},
"destination": {
"type": "string",
"example": "九寨沟",
"description": "目的地"
},
"disputeResolution": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "争议解决方式: 1-仲裁 2-诉讼"
},
"groupId": {
"type": "string",
"example": "GRP20260401001",
"description": "团号"
},
"leastCustomerNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "最低成团人数"
},
"nights": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "住宿晚数"
},
"orderId": {
"type": "integer",
"format": "int64",
"example": 1001,
"description": "订单ID"
},
"paymentMethod": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "付款方式: 1-现金 2-转账 3-在线"
},
"returnDate": {
"type": "string",
"format": "date",
"example": "2026-04-03",
"description": "返回日期"
},
"routeName": {
"type": "string",
"example": "九寨沟三日游",
"description": "线路名称"
},
"signatoryIdNumber": {
"type": "string",
"example": 110101199001011234,
"description": "签署人证件号码"
},
"signatoryIdType": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "签署人证件类型: 1-身份证"
},
"signatoryMode": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "签署模式: 1-短信 2-现场 3-线下"
},
"signatoryName": {
"type": "string",
"example": "李四",
"description": "签署人姓名"
},
"signatoryPhone": {
"type": "string",
"example": 13900139000,
"description": "签署人电话"
},
"signingPlace": {
"type": "string",
"example": "成都市武侯区",
"description": "签约地点"
},
"supplementaryClause": {
"type": "string",
"example": "夏季补充约定...",
"description": "补充约定内容"
},
"templateCode": {
"type": "string",
"example": "TOURAGE_STANDARD",
"description": "模板编码"
},
"totalAmount": {
"type": "number",
"example": 5960.0,
"description": "合同总金额"
},
"transactorName": {
"type": "string",
"example": "张三",
"description": "经办人姓名"
},
"transactorPhone": {
"type": "string",
"example": 13800138000,
"description": "经办人电话"
},
"travelers": {
"type": "array",
"description": "出行人列表",
"items": {
"$ref": "#/definitions/合同出行人请求",
"originalRef": "合同出行人请求"
}
},
"vehicleModel": {
"type": "string",
"example": "考斯特19座",
"description": "车型名称(产品快照)"
}
},
"title": "创建合同请求"
},
"合同信息": {
"type": "object",
"properties": {
"agencyCode": {
"type": "string",
"description": "旅行社编号"
},
"contactName": {
"type": "string",
"description": "联系人姓名"
},
"contactPhone": {
"type": "string",
"description": "联系人电话"
},
"contractId": {
"type": "integer",
"format": "int64",
"description": "合同ID"
},
"contractNumber": {
"type": "string",
"description": "合同编号"
},
"contractType": {
"type": "string",
"description": "合同类型: TOUR-旅游合同, INSURANCE-保险单"
},
"createTime": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"departureDate": {
"type": "string",
"format": "date",
"description": "出发日期"
},
"destination": {
"type": "string",
"description": "目的地"
},
"fileUrl": {
"type": "string",
"description": "合同文件URL"
},
"mode": {
"type": "string",
"description": "签约模式: STANDARD/SYNC"
},
"orderId": {
"type": "integer",
"format": "int64",
"description": "订单ID"
},
"platform": {
"type": "string",
"description": "签约平台"
},
"qrCodeUrl": {
"type": "string",
"description": "二维码URL"
},
"returnDate": {
"type": "string",
"format": "date",
"description": "返回日期"
},
"signUrl": {
"type": "string",
"description": "签署URL"
},
"status": {
"type": "string",
"description": "合同状态"
},
"statusLabel": {
"type": "string",
"description": "合同状态标签"
},
"templateCode": {
"type": "string",
"description": "模板编码"
},
"templateName": {
"type": "string",
"description": "模板名称"
},
"totalAmount": {
"type": "number",
"description": "合同总金额"
},
"touristCount": {
"type": "integer",
"format": "int32",
"description": "出行人数"
},
"travelAgencyName": {
"type": "string",
"description": "旅行社名称"
}
},
"title": "合同信息"
},
"合同出行人信息": {
"type": "object",
"properties": {
"idCardNo": {
"type": "string",
"description": "证件号码"
},
"idCardType": {
"type": "string",
"description": "证件类型"
},
"isSigner": {
"type": "boolean",
"description": "是否签署人"
},
"name": {
"type": "string",
"description": "姓名"
},
"phone": {
"type": "string",
"description": "手机号"
},
"travelerId": {
"type": "integer",
"format": "int64",
"description": "出行人ID"
}
},
"title": "合同出行人信息"
},
"合同出行人请求": {
"type": "object",
"required": [
"idCardNo",
"name"
],
"properties": {
"age": {
"type": "integer",
"format": "int32",
"example": 30,
"description": "年龄"
},
"gender": {
"type": "string",
"example": "male",
"description": "性别: male/female"
},
"health": {
"type": "string",
"example": "健康",
"description": "健康信息"
},
"idCardNo": {
"type": "string",
"example": 110101199001011234,
"description": "证件号码"
},
"idCardType": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "证件类型: 1-身份证 2-护照"
},
"isChild": {
"type": "boolean",
"example": false,
"description": "是否儿童"
},
"isSigner": {
"type": "boolean",
"example": false,
"description": "是否签署人"
},
"name": {
"type": "string",
"example": "王五",
"description": "姓名"
},
"phone": {
"type": "string",
"example": 13800138000,
"description": "手机号"
}
},
"title": "合同出行人请求"
},
"合同模板信息": {
"type": "object",
"properties": {
"createTime": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"description": {
"type": "string",
"description": "模板描述"
},
"mode": {
"type": "string",
"description": "签约模式: STANDARD/SYNC"
},
"platform": {
"type": "string",
"description": "签约平台"
},
"status": {
"type": "string",
"description": "模板状态"
},
"templateCode": {
"type": "string",
"description": "模板编码"
},
"templateId": {
"type": "integer",
"format": "int64",
"description": "模板ID"
},
"templateName": {
"type": "string",
"description": "模板名称"
}
},
"title": "合同模板信息"
},
"合同状态变更日志": {
"type": "object",
"properties": {
"createTime": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"logId": {
"type": "integer",
"format": "int64",
"description": "日志ID"
},
"newStatus": {
"type": "string",
"description": "新状态"
},
"oldStatus": {
"type": "string",
"description": "旧状态"
},
"source": {
"type": "string",
"description": "变更来源"
}
},
"title": "合同状态变更日志"
},
"合同详情": {
"type": "object",
"properties": {
"agencyCode": {
"type": "string",
"description": "旅行社编号"
},
"contactName": {
"type": "string",
"description": "联系人姓名"
},
"contactPhone": {
"type": "string",
"description": "联系人电话"
},
"contractId": {
"type": "integer",
"format": "int64",
"description": "合同ID"
},
"contractNumber": {
"type": "string",
"description": "合同编号"
},
"contractType": {
"type": "string",
"description": "合同类型: TOUR-旅游合同, INSURANCE-保险单"
},
"createTime": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"departureDate": {
"type": "string",
"format": "date",
"description": "出发日期"
},
"destination": {
"type": "string",
"description": "目的地"
},
"fileUrl": {
"type": "string",
"description": "合同文件URL"
},
"mode": {
"type": "string",
"description": "签约模式: STANDARD/SYNC"
},
"orderId": {
"type": "integer",
"format": "int64",
"description": "订单ID"
},
"platform": {
"type": "string",
"description": "签约平台"
},
"qrCodeUrl": {
"type": "string",
"description": "二维码URL"
},
"returnDate": {
"type": "string",
"format": "date",
"description": "返回日期"
},
"signUrl": {
"type": "string",
"description": "签署URL"
},
"status": {
"type": "string",
"description": "合同状态"
},
"statusLabel": {
"type": "string",
"description": "合同状态标签"
},
"statusLogs": {
"type": "array",
"description": "状态变更日志",
"items": {
"$ref": "#/definitions/合同状态变更日志",
"originalRef": "合同状态变更日志"
}
},
"supplementaryClause": {
"type": "string",
"description": "补充约定内容"
},
"templateCode": {
"type": "string",
"description": "模板编码"
},
"templateName": {
"type": "string",
"description": "模板名称"
},
"totalAmount": {
"type": "number",
"description": "合同总金额"
},
"touristCount": {
"type": "integer",
"format": "int32",
"description": "出行人数"
},
"travelAgencyName": {
"type": "string",
"description": "旅行社名称"
},
"travelers": {
"type": "array",
"description": "出行人列表",
"items": {
"$ref": "#/definitions/合同出行人信息",
"originalRef": "合同出行人信息"
}
}
},
"title": "合同详情"
},
"报备合同请求(同步模式)": {
"type": "object",
"required": [
"adultCost",
"contactName",
"contactPhone",
"departureDate",
"destination",
"returnDate",
"routeName",
"signatoryIdNumber",
"signatoryName",
"signatoryPhone",
"templateCode",
"totalAmount",
"travelers"
],
"properties": {
"adultCost": {
"type": "number",
"example": 2980.0,
"description": "成人费用"
},
"agencyCode": {
"type": "string",
"example": "L-FJ-100005",
"description": "旅行社编号"
},
"childCost": {
"type": "number",
"example": 1490.0,
"description": "儿童费用"
},
"contactName": {
"type": "string",
"example": "李四",
"description": "联系人姓名"
},
"contactPhone": {
"type": "string",
"example": 13900139000,
"description": "联系人电话"
},
"contractType": {
"type": "string",
"example": "TOUR",
"description": "合同类型: TOUR-旅游合同(默认), INSURANCE-保险单"
},
"days": {
"type": "integer",
"format": "int32",
"example": 3,
"description": "行程天数"
},
"departureCity": {
"type": "string",
"example": "成都",
"description": "出发城市"
},
"departureDate": {
"type": "string",
"format": "date",
"example": "2026-04-01",
"description": "出发日期"
},
"destination": {
"type": "string",
"example": "九寨沟",
"description": "目的地"
},
"disputeResolution": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "争议解决方式: 1-仲裁 2-诉讼"
},
"groupId": {
"type": "string",
"example": "GRP20260401001",
"description": "团号"
},
"leastCustomerNumber": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "最低成团人数"
},
"nights": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "住宿晚数"
},
"orderId": {
"type": "integer",
"format": "int64",
"example": 1001,
"description": "订单ID"
},
"paymentMethod": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "付款方式: 1-现金 2-转账 3-在线"
},
"returnDate": {
"type": "string",
"format": "date",
"example": "2026-04-03",
"description": "返回日期"
},
"routeName": {
"type": "string",
"example": "九寨沟三日游",
"description": "线路名称"
},
"signatoryIdNumber": {
"type": "string",
"example": 110101199001011234,
"description": "签署人证件号码"
},
"signatoryIdType": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "签署人证件类型: 1-身份证"
},
"signatoryMode": {
"type": "integer",
"format": "int32",
"example": 2,
"description": "签署模式同步模式默认2-现场)"
},
"signatoryName": {
"type": "string",
"example": "李四",
"description": "签署人姓名"
},
"signatoryPhone": {
"type": "string",
"example": 13900139000,
"description": "签署人电话"
},
"signingPlace": {
"type": "string",
"example": "成都市武侯区",
"description": "签约地点"
},
"supplementaryClause": {
"type": "string",
"example": "冬季补充约定...",
"description": "补充约定内容"
},
"templateCode": {
"type": "string",
"example": "TOURAGE_SYNC",
"description": "模板编码"
},
"totalAmount": {
"type": "number",
"example": 5960.0,
"description": "合同总金额"
},
"transactorName": {
"type": "string",
"example": "张三",
"description": "经办人姓名"
},
"transactorPhone": {
"type": "string",
"example": 13800138000,
"description": "经办人电话"
},
"travelers": {
"type": "array",
"description": "出行人列表",
"items": {
"$ref": "#/definitions/合同出行人请求",
"originalRef": "合同出行人请求"
}
}
},
"title": "报备合同请求(同步模式)"
},
"旅行社信息": {
"type": "object",
"properties": {
"agencyAddress": {
"type": "string",
"description": "旅行社地址"
},
"agencyName": {
"type": "string",
"example": "呼籁旅行社",
"description": "旅行社名称"
},
"businessLicenseNumber": {
"type": "string",
"description": "营业执照号"
},
"businessScope": {
"type": "string",
"example": "国内旅游",
"description": "经营范围"
},
"code": {
"type": "string",
"example": "hulai",
"description": "旅行社编码"
},
"licenseNumber": {
"type": "string",
"example": "L-FJ-100005",
"description": "旅行社许可证号"
},
"regionId": {
"type": "string",
"example": 350200,
"description": "地区ID"
},
"transactorName": {
"type": "string",
"example": "张三",
"description": "经办人姓名"
},
"transactorPhone": {
"type": "string",
"example": 13800138000,
"description": "经办人电话"
},
"zjParentId": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "属地管理机构ID"
}
},
"title": "旅行社信息"
},
"统一响应结果«List«合同信息»»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"type": "array",
"description": "响应数据",
"items": {
"$ref": "#/definitions/合同信息",
"originalRef": "合同信息"
}
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«List«合同信息»»"
},
"统一响应结果«List«合同模板信息»»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"type": "array",
"description": "响应数据",
"items": {
"$ref": "#/definitions/合同模板信息",
"originalRef": "合同模板信息"
}
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«List«合同模板信息»»"
},
"统一响应结果«List«旅行社信息»»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"type": "array",
"description": "响应数据",
"items": {
"$ref": "#/definitions/旅行社信息",
"originalRef": "旅行社信息"
}
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«List«旅行社信息»»"
},
"统一响应结果«List«补充约定模板»»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"type": "array",
"description": "响应数据",
"items": {
"$ref": "#/definitions/补充约定模板",
"originalRef": "补充约定模板"
}
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«List«补充约定模板»»"
},
"统一响应结果«Void»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«Void»"
},
"统一响应结果«boolean»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"type": "boolean",
"description": "响应数据"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«boolean»"
},
"统一响应结果«分页结果«合同信息»»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"description": "响应数据",
"$ref": "#/definitions/分页结果«合同信息»",
"originalRef": "分页结果«合同信息»"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«分页结果«合同信息»»"
},
"统一响应结果«合同信息»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"description": "响应数据",
"$ref": "#/definitions/合同信息",
"originalRef": "合同信息"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«合同信息»"
},
"统一响应结果«合同详情»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"description": "响应数据",
"$ref": "#/definitions/合同详情",
"originalRef": "合同详情"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«合同详情»"
},
"统一响应结果«补充约定模板»": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32",
"example": 200,
"description": "状态码"
},
"data": {
"description": "响应数据",
"$ref": "#/definitions/补充约定模板",
"originalRef": "补充约定模板"
},
"message": {
"type": "string",
"example": "成功",
"description": "响应消息"
}
},
"title": "统一响应结果«补充约定模板»"
},
"补充约定模板": {
"type": "object",
"properties": {
"content": {
"type": "string",
"description": "模板内容"
},
"createTime": {
"type": "string",
"format": "date-time",
"description": "创建时间"
},
"name": {
"type": "string",
"description": "模板名称"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"description": "排序"
},
"status": {
"type": "string",
"description": "状态: ACTIVE/INACTIVE"
},
"templateId": {
"type": "integer",
"format": "int64",
"description": "模板ID"
}
},
"title": "补充约定模板"
},
"补充约定模板请求": {
"type": "object",
"required": [
"content",
"name"
],
"properties": {
"content": {
"type": "string",
"example": "夏季补充约定...",
"description": "模板内容"
},
"name": {
"type": "string",
"example": "夏季小团",
"description": "模板名称"
},
"sortOrder": {
"type": "integer",
"format": "int32",
"example": 1,
"description": "排序(升序)"
}
},
"title": "补充约定模板请求"
}
}
}