Files
pj_service_cloud/pjcloud-integrated/pjcloud-integrated-biz/MEETING_DESK_LAYOUT_API.md
T
2025-09-13 00:45:49 +08:00

3.6 KiB
Raw Blame History

移动端摆放形式选择接口使用说明

📋 概述

本文档介绍移动端预约课程时选择摆放形式的接口使用方法。

🌐 接口信息

获取摆放形式列表接口

  • 接口地址: GET /meetingDeskLayout/app/list
  • 请求方式: GET
  • 认证方式: 无需认证(移动端公开接口)
  • 数据格式: JSON

📡 响应格式

成功响应

{
  "code": 0,
  "msg": "操作成功",
  "data": [
    {
      "id": 1,
      "layoutName": "U型摆放",
      "layoutImage": "https://example.com/images/u-layout.jpg",
      "capacityMin": 8,
      "capacityMax": 12,
      "description": "适合小组讨论的U型摆放方式"
    },
    {
      "id": 2,
      "layoutName": "课桌式摆放",
      "layoutImage": "https://example.com/images/classroom-layout.jpg",
      "capacityMin": 20,
      "capacityMax": 50,
      "description": "传统课桌式摆放,适合培训课程"
    },
    {
      "id": 3,
      "layoutName": "圆桌式摆放",
      "layoutImage": "https://example.com/images/round-table-layout.jpg",
      "capacityMin": 6,
      "capacityMax": 10,
      "description": "圆桌式摆放,促进互动交流"
    }
  ]
}

字段说明

字段名 类型 说明
id Long 摆放形式ID
layoutName String 摆放形式名称
layoutImage String 摆放形式示意图URL
capacityMin Integer 最小容纳人数
capacityMax Integer 最大容纳人数
description String 摆放形式描述

🔍 业务逻辑说明

  1. 数据过滤: 只返回状态为"可用"(isAvailable = "0")的摆放形式
  2. 排序规则: 按照sortOrder字段升序排列
  3. 数据精简: 只返回移动端需要的核心字段,减少数据传输量

📱 使用示例

JavaScript 调用示例

fetch('/meetingDeskLayout/app/list', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => {
  if (data.code === 0) {
    // 处理摆放形式数据
    const layouts = data.data;
    layouts.forEach(layout => {
      console.log(`摆放形式: ${layout.layoutName}, 容纳人数: ${layout.capacityMin}-${layout.capacityMax}人`);
    });
  }
})
.catch(error => {
  console.error('获取摆放形式失败:', error);
});

React Native 调用示例

const fetchDeskLayouts = async () => {
  try {
    const response = await fetch('/meetingDeskLayout/app/list');
    const result = await response.json();
    
    if (result.code === 0) {
      return result.data;
    } else {
      throw new Error(result.msg);
    }
  } catch (error) {
    console.error('获取摆放形式失败:', error);
    return [];
  }
};

cURL 调用示例

curl -X GET "http://your-domain/meetingDeskLayout/app/list" \
  -H "Content-Type: application/json"

🎯 应用场景

  1. 课程预约: 用户在预约课程时选择适合的摆放形式
  2. 会议室配置: 根据参会人数推荐合适的摆放形式
  3. 活动策划: 根据活动类型选择合适的桌椅摆放方式

⚠️ 注意事项

  1. 数据一致性: 接口返回的数据与后台管理系统的摆放形式数据保持一致
  2. 图片加载: layoutImage字段可能为空,前端需要处理图片加载失败的情况
  3. 容量限制: 建议根据实际参会人数选择合适的摆放形式
  4. 缓存策略: 建议前端对摆放形式数据进行适当缓存,减少重复请求

🔄 版本更新

  • v1.0.0 (2025-01-27): 初始版本,提供基本的摆放形式选择功能