== 汽车网车友汇项目接口 ==

=== 目录 ===
 1. [#point100 基本约定 ]

 2. [#point200 互动核心平台接口 ]

 2.1 [#point201 发送系统消息 ]

 2.2 [#point202 获取系统消息 ]

 2.3 [#point203 更新系统消息状态 ]

 3. [#point300 PASSPORT接口 ]

 3.1 [#point301 登录接口 ]

 3.2 [#point302 自动激活接口 ]

 3.3 [#point303 辨认登录状态接口 ]


 4. [#point400 BBS接口 ]

 4.1 [#point401 BBS发帖接口 ]

 5. [#point500 车友会接口 ]

 5.1 [#point501 创建活动 ]

 5.2 [#point502 获取活动（行程、成员） ]

 5.3 [#point503 创建行程 ]
 5.4 [#point504 修改行程 ]
 5.5 [#point505 活动报名 ]
 5.6 [#point506 删除活动成员 ]
 5.7 [#point507 发表活动总结（记账） ]
 5.8 [#point508 修改活动总结（记账） ]
 5.9 [#point509 删除活动记账 ]
 5.10 [#point510 上传活动图片 ]

 5.11 [#point511 创建用户 ]

 5.12 [#point512 修改用户资料 ]

 5.13 [#point513 获取用户资料 ]

 5.14 [#point514 车友会查询 ]

 5.15 [#point515 维护我关注的车友会 ]

 5.16 [#point516 获取地区列表 ]

 5.17 [#point517 获取评论列表 ]

 5.18 [#point518 发表评论 ]

 5.19 [#point519 获取推荐活动列表 ]

 5.20 [#point520 查询路书 ]

 5.21 [#point521 热门推荐 ]

 5.22 [#point522 同车友会推荐 ]

 5.23 [#point523 同地区推荐 ]

 6. [#point600 修改历史 ]

=== 1. [=#point100 基本约定] ===
{{{
1.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。

2.当接口处理异常时，HTTP STATUS CODE 返回给500，并且给出具体的错误信息。
    {
	"uri" : "/intf/albums-by-type.jsp",
	"error-code":"20502",
	"error-desc":"Need you follow uid.",
        "user-notice":"给用户的提示放在这里"
    }

    
3.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。在JSP的最顶部，实现类似下面的代码：

        String queryString = request.getQueryString();
        String requestEncoding = getParam(queryString,"req_enc");
        String responseEncoding = getParam(queryString,"resp_enc");
        if(isNotBlank(requestEncoding)){
            request.setCharacterEncoding(requestEncoding);
        }
        if(isNotBlank(responseEncoding)){
            response.setCharacterEncoding(responseEncoding);
        }

4.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。

5.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹，并且过滤掉回车换行，对字符串中包含的双引号(")进行转义；是数字类型时，不用引号。

}}}

== 2. [=#point200 互动核心平台接口 ]  ==
=== 2.1 [=#point201 发送系统消息 ] ===

=== 2.2 [=#point202 获取系统消息 ] ===

=== 2.3 [=#point203 更新系统消息状态 ] ===

== 3. [=#point300 PASSPORT接口 ]  ==
=== 3.1 [=#point301 登录接口 ] ===
=== 3.2 [=#point302 自动激活接口 ] ===
=== 3.3 [=#point303 辨认登录状态接口 ] ===


== 4. [=#point400 BBS接口 ]  ==
=== 4.1 [=#point401 BBS发帖接口 ] ===


== 5. [=#point500 车友会接口 ] ==
=== 5.1 [=#point501 创建活动 ] ===
{{{
    URL：/intf/act-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：common_session_id：登录后的session id
              name：活动名称
              start-date：开始时间
              end-date：结束时间
              pay：预计费用
              count：人数限制
              verify-str：验证密码
              detail：活动详情
              area-id：地区编号        
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"act-id":2342,
     "name":"一起去海边",
     "start-date":"2012-03-18",
     "end-date":"2012-03-20",
     "pay":800,
     "count":20,
     "verify-str":"下海去捞鱼",
     "detail":"活动详情，里面通常包括了手台信息",
     "area-id":233,
     "area-desc":"广东省/广州市"
    }
    返回参数说明：
        act-id：活动id
        name：活动名称
        start-date：开始日期（yyyy-mm-dd）
        end-date：结束日期（yyyy-mm-dd）
        pay：预计费用
        count：人数限制
        verify-str：验证密码
        detail：活动详情
        area-id：地区编号
        area-desc：地区名称
    排序方式：
        无
}}}

=== 5.2 [=#point502 获取活动（行程、成员） ] ===
{{{
    URL：/intf/act-get.jsp
    HTTP请求方式：get
    是否需要登录：否
    提交参数：act-ids：活动id，用逗号分隔（122,332,344）
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"acts":[{"act-id":122,
              "name":"一起去海边",
              "start-date":"2012-03-18",
              "end-date":"2012-03-20",
              "pay":800,
              "count":20,
              "verify-str":"下海去捞鱼",
              "detail":"活动详情，里面通常包括了手台信息",
              "area-id":233,
              "area-desc":"广东省/广州市",
              "created-by":"活动发起者",
              "creater-nickname":"大浪淘沙",
              "creater-mobile":"13932233232",
              "act-routes":[{"route-id":12,"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232"},
                           {"route-id":13,"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232"},
                           {"route-id":14,"seq":3,"route-name":"深圳","longitude":"23.2332.2332","latitude":"102.32.232"}],
              "act-member":[{"member-id":12232,"uid":232332,"type":"manager","mobile":"18933300984","license-plate":"粤A-23456"},
                            {"member-id":12233,"uid":234343,"type":"member","mobile":"18933300984","license-plate":""}]
             }
            ]
    }
    返回参数说明：
        act-id：活动编号
        name：活动名称
        start-date：开始日期
        end-date：结束日期
        pay：活动费用
        count：人数限制
        verify-str：活动密码
        detail：活动详情
        area-id：地区编号
        area-desc：地区名称
        created-by：活动创建者ID，这个ID是太平洋公共帐号ID。
        creater-nickname：创建者昵称，从个人资料中获取，冗余在结果里。
        creater-mobile：创建者手机，从个人资料中获取，冗余在结果里。
        route-id：行程编号
        seq：行程顺序号
        route-name：停留点名称
        longitude：经度
        latitude：纬度
        member-id：活动成员编号
        uid：活动成员的太平洋公共帐号
        type：活动成员身份
        mobile：活动成员手机，默认从个人资料获取，网友可以在参加活动时修改
        license-plate：活动成员车牌，默认从个人资料获取，网友可以在参加活动时修改
    排序方式：
        1、按传入的act-id顺序排序
        2、按活动创建时间逆序
}}}

=== 5.3 [=#point503 创建行程 ] ===
{{{
    URL：/intf/act-route-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：common_session_id：登录后的session id
              routes：[{"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232"},
                       {"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232"}]
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"act-rountes":[{"route-id":12,"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232"},
                    {"route-id":13,"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232"},
                    {"route-id":14,"seq":3,"route-name":"深圳","longitude":"23.2332.2332","latitude":"102.32.232"}]
    }
    返回参数说明：
        route-id：行程编号
        seq：行程顺序号
        route-name：停留点名称
        longitude：经度
        latitude：纬度        
    排序方式：
        1、按照seq顺序排列
}}}

=== 5.4 [=#point504 修改行程 ] ===
{{{
    URL：/intf/act-route-update.jsp， 采取删除/重建的方式来实现修改操作。
    HTTP请求方式：post
    是否需要登录：否
    提交参数：common_session_id：登录后的session id
              routes：[{"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232"},
                       {"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232"}]
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"act-rountes":[{"route-id":12,"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232"},
                    {"route-id":13,"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232"},
                    {"route-id":14,"seq":3,"route-name":"深圳","longitude":"23.2332.2332","latitude":"102.32.232"}]
    }
    返回参数说明：
        route-id：行程编号
        seq：行程顺序号
        route-name：停留点名称
        longitude：经度
        latitude：纬度        
    排序方式：
        1、按照seq顺序排列

}}}

=== 5.5 [=#point505 活动报名 ] ===
{{{
    URL：/intf/act-apply.jsp，报名成功后返回活动信息，方便应用处理。
    HTTP请求方式：post
    是否需要登录：是
    提交参数：common_session_id：登录后的session id
              act-id：活动ID
              verify-str：验证密码
              license-plate：车牌
              mobile：手机
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
    {"acts":[{"act-id":122,
              "name":"一起去海边",
              "start-date":"2012-03-18",
              "end-date":"2012-03-20",
              "pay":800,
              "count":20,
              "verify-str":"下海去捞鱼",
              "detail":"活动详情，里面通常包括了手台信息",
              "area-id":233,
              "area-desc":"广东省/广州市",
              "created-by":"活动发起者",
              "creater-nickname":"大浪淘沙",
              "creater-mobile":"13932233232",
              "act-routes":[{"route-id":12,"seq":1,"route-name":"广州","longitude":"23.2332.2332","latitude":"102.32.232"},
                           {"route-id":13,"seq":2,"route-name":"东莞","longitude":"23.2332.2332","latitude":"102.32.232"},
                           {"route-id":14,"seq":3,"route-name":"深圳","longitude":"23.2332.2332","latitude":"102.32.232"}],
              "act-member":[{"member-id":12232,"uid":232332,"type":"manager","mobile":"18933300984","license-plate":"粤A-23456"},
                            {"member-id":12233,"uid":234343,"type":"member","mobile":"18933300984","license-plate":""}]
             }
            ]
       }
    返回参数说明：
        act-id：活动编号
        name：活动名称
        start-date：开始日期
        end-date：结束日期
        pay：活动费用
        count：人数限制
        verify-str：活动密码
        detail：活动详情
        area-id：地区编号
        area-desc：地区名称
        created-by：活动创建者ID，这个ID是太平洋公共帐号ID。
        creater-nickname：创建者昵称，从个人资料中获取，冗余在结果里。
        creater-mobile：创建者手机，从个人资料中获取，冗余在结果里。
        route-id：行程编号
        seq：行程顺序号
        route-name：停留点名称
        longitude：经度
        latitude：纬度
        member-id：活动成员编号
        uid：活动成员的太平洋公共帐号
        type：活动成员身份
        mobile：活动成员手机，默认从个人资料获取，网友可以在参加活动时修改
        license-plate：活动成员车牌，默认从个人资料获取，网友可以在参加活动时修改
    排序方式：
        无。

}}}


=== 5.6 [=#point506 删除活动成员 ] ===
{{{
    URL：/intf/act-member-del.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：common_session_id：登录后的session id
              uids：活动成员id，可以是一个或多个id，多个id之间用逗号（','）分隔，例如（2123,23434,434,343）
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        无。
    排序方式：
        无。

}}}


=== 5.7 [=#point507 发表活动总结（记账） ] ===
{{{
    URL：/intf/act-pay-create.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：common_session_id：登录后的session id
              pay-type：记账类型
              pay：金额
              desc：描述
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {"id":233,"pay-type":"住宿","pay":4340,"desc":"住宿费用"}
    返回参数说明：
        id：费用记录ID
        pay-type：费用类型
        pay：费用
        desc：费用描述
    排序方式：
        无。

}}}

=== 5.8 [=#point508 修改活动总结（记账） ] ===
{{{
    URL：/intf/act-pay-update.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：common_session_id：登录后的session id
              id：记账id
              pay-type：记账类型
              pay：金额
              desc：描述
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        {"id":233,"pay-type":"住宿","pay":4340,"desc":"住宿费用"}
    返回参数说明：
        id：费用记录ID
        pay-type：费用类型
        pay：费用
        desc：费用描述
    排序方式：
        无。

}}}

=== 5.9 [=#point509 删除活动记账 ] ===
{{{
    URL：/intf/act-pay-del.jsp
    HTTP请求方式：post
    是否需要登录：是
    提交参数：common_session_id：登录后的session id
              ids：记账id的集合，用逗号分隔不同的id，例如（233,323,323,323）
              req-enc：请求时字符编码，缺省是UTF-8
              resp-enc：响应时字符编码，缺省是UTF-8
    返回参数：
        无。
    排序方式：
        无。

}}}

=== 5.10 [=#point510 上传活动图片 ] ===
=== 5.11 [=#point511 创建用户 ] ===
=== 5.12 [=#point512 修改用户资料 ] ===
=== 5.13 [=#point513 获取用户资料 ] ===
=== 5.14 [=#point514 车友会查询 ] ===
=== 5.15 [=#point515 维护我关注的车友会 ] ===
=== 5.16 [=#point516 获取地区列表 ] ===
=== 5.17 [=#point517 获取评论列表 ] ===
=== 5.18 [=#point518 发表评论 ] ===
=== 5.19 [=#point519 获取推荐活动列表 ] ===
=== 5.20 [=#point520 查询路书 ] ===
=== 5.21 [=#point521 热门推荐 ] ===
=== 5.22 [=#point522 同车友会推荐 ] ===
=== 5.23 [=#point523 同地区推荐 ] ===

== 5. [=#point500 车友会接口 ] ==
== 6. [=#point600 修改历史 ] ==