ucapi/1.0 – Trac

Context Navigation

接口索引

1. 1. 车友会提供个人中心接口

1. 车友会提供个人中心接口

1.1 动态相关

1.1.1 个人主页动态列表

说明：获取个人动态列表
接口：/usercenter/1.0/dyna/getDynaListByUserId.do [GET]
请求参数
	*userId:用户ID


是否登录:否
缓存时间:无
是否分页:是

返回
{
	code:0成功，-1失败
        message:提示信息
        version: 接口版本号如1.0，1.0（latest)表示最新版本 

        total:总条数
        pageNo:页码
        pageSize:每页条数
        pageCount:总共几页

	userId:
	dynaList:[
	    {
	        dynaInfoId：动态id，
		postCount:回复数
		pubTime: 发布时间, 
		forumId: 板块ID, 
		forumName: 板块名称, 
		createBy: 创建者ID, 
		nickName:作者昵称,
		isHasImg: 是否有图片(0:没有，1：有）, 
		petrol: 贡献油值, 
		authorPhoto: 作者头像, 
		isVip：是否认证，（0：否，1：是）
		praiseCount：点赞数

		dynaType:动态类型(1-普通帖子（旧数据包含提问帖子），2-说说动态，3-图片动态，4-提问帖子，5-公告动态，6-活动动态，7-新会员加入动态，8-创建车友会动态）
				
		//以上是动态列表公共字段
		//下面是根据不同的动态类型，返回不同的字段或内容
		dynaType == 1，4
		         dynaTargetId:帖子ID
		         content:帖子内容 
		         topicTitle: 帖子标题,
		         isPick: 是否是精华（0：不是，1：是，2：是）, 
		         isRecommend: 是否是推荐（0：不是，1：是）
				   
		dynaType == 2
			 dynaTargetId ：说说动态ID
			 content:说说内容
				   
		dynaType == 3
			 dynaTargetId ：相册ID
		         content:上传了100张相片到《相册名字》
				   
		dynaType == 5
                         content : 发布了公告：XXXXXXXXXXXX
				   
		dynaType == 6
			 dynaTargetId ：活动ID
			 content:发起了活动：活动标题
                         signUpCount:成功报名人数
                         activityCost:每人花费	
                         activityCover : 活动封面图
                         beginDate:活动开始时间
                         endDate：活动结束时间
                         signupDate：活动截止时间
                         activityPlace：活动地址
                         activityUrl:活动终端页地址
                 
                dynaType == 7
                         content : Hello，我已经加入了 + 车友会名字 + ，现在我是一个有组织的人了，欢迎大家来围观	
                         clubName:车友会名称
                 
                dynaType == 8 
                         content : 创建了+ clubName + 车友会主页： + targetUrl + , 大家快去邀请车友加入吧	
                         clubName:车友会名称
                         clubUrl:车友会地址

                dynaType == 9	
                        dynaTargetId: 动态ID
                        content : 投票标题
                        voteCount: 投票人数	
                        voteDetail:[{
                         itemId：选项id
                         content:投票选项内容
                         count ： 选项被投票次数
                         
                        }]			   
				   
		images:[
		     {
			url:http://xxxx.jpg,
			//真实宽度
			width:960,
			//真实高度
			height:1000
		      },
                     {
			url:http://xxxx.jpg,
			//真实宽度
			width:960,
			//真实高度
			height:1000
		      }
	        ]
	   }
     ]
}

1.2.2 动态详情接口

说明：获取动态
接口：/usercenter/1.0/dyna/getDynaDetail.do [GET]
请求参数
	*dynaInfoId：动态id
	*createBy：动态创建者id

是否登录:否
缓存时间:无
是否分页:否

返回
{
	code:0成功，-1失败
        message:提示信息
        version: 接口版本号如1.0，1.0（latest)表示最新版本

	dynaDetail:[
		{
	    postCount:回复数
	    pubTime: 发布时间, 
            authorId: 作者ID, 
            forumId: 16160, 
            authorName: 作者名称, 
            nickname:作者昵称,
            contribution: 贡献油值, 
            dynaInfoId,动态ID
            authorPhoto: 作者头像, 
            isRecommend: 是否是推荐,
            content:动态内容
	    isVip：是否认证	(0:未认证,1:已认证)
	    praiseCount：点赞数,
            images:[
		{
		url:http://xxxx.jpg,
		//真实宽度
		width:960,
		//真实高度
		height:1000,
		//质量参数,默认为0，10月上线
		qua:80
		},
                {
		url:http://xxxx.jpg,
		//真实宽度
		width:960,
		//真实高度
		height:1000,
		//质量参数,默认为0，10月上线
		qua:80
		}		
	   ]
	}
    ]
}

1.1.3 点赞/取消赞

说明：点赞/取消赞 
接口：/usercenter/1.0/dyna/doPraise.do [POST]
请求参数
	praiseDynaInfoIds:动态ID,动态创建日期（Json形式）
	unPraiseDynaInfoIds:动态ID,动态创建日期（Json形式）

        Json形式例子：
        {
         praiseDynaInfoIds:[
           {"dynaInfoId":"111","createDate":"2014-11-01"},
           {"dynaInfoId":"111","createDate":"2014-11-01"},
           {"dynaInfoId":"111","createDate":"2014-11-01"}
         ],
         unPraiseDynaInfoIds:[
           {"dynaInfoId":"111","createDate":"2014-11-01"},
           {"dynaInfoId":"111","createDate":"2014-11-01"},
           {"dynaInfoId":"111","createDate":"2014-11-01"}
         ]
        }



是否登录:是
缓存时间:无
是否分页:否

返回
{
	code:0成功，-1失败
        message:提示信息
        version: 接口版本号如1.0，1.0（latest)表示最新版本

	time:系统完成操作的时间
        failPraiseDynaInfoIds:返回设置点赞失败的动态ID(类似参数列表,Json格式）
        failUnPraiseDynaInfoIds:返回取消赞失败的动态ID(类似参数列表,Json格式）

        返回的动态ID列表说明：
        failPraiseDynaInfoIds：[
           {"dynaInfoId":"111","createDate":"2014-11-01"},
           {"dynaInfoId":"111","createDate":"2014-11-01"}
        ]
        failUnPraiseDynaInfoIds：[
           {"dynaInfoId":"111","createDate":"2014-11-01"},
           {"dynaInfoId":"111","createDate":"2014-11-01"}
        ]
}

1.1.4 获取动态点赞用户列表

说明：获取动态点赞用户列表
接口：/usercenter/1.0/dyna/getPraiseUserList.do [GET]
请求参数
	*dynaInfoId：动态id
        pageNo:页码数
        pageSize:每页条数


是否登录:否
缓存时间:无
是否分页:是

返回
{
	code:0成功，-1失败
        message:提示信息
        version: 接口版本号如1.0，1.0（latest)表示最新版本

        total:总条数
        pageNo:页码
        pageSize:每页条数
        pageCount:总共几页

	userList:[
		{
		userId:用户id
		nickName:昵称
                authorPhoto: 用户头像
		},
		{
		userId:用户id
		nickName:昵称
                authorPhoto: 用户头像
		}
	]
}

1.1.5 判断是否已赞

说明：判断是否已赞
接口：/usercenter/1.0/dyna/getHadPraiseList.do [GET]
请求参数
        *userId:用户ID
	*dynaInfoIds：动态id列表，用“，”连接起来


是否登录:否
缓存时间:无
是否分页:否

返回
{
	code:0成功，-1失败
        message:提示信息
        version: 接口版本号如1.0，1.0（latest)表示最新版本

	hadPraiseList:[123,456,789,0]  返回已经赞过的动态ID数组，没有返回空数组
}

1.1.6 动态回复

说明：动态回复
接口：/usercenter/1.0/dyna/replyDyna.do [POST]
请求参数
       clubId 车友会ID（可选）
       provinceId:省id
       cityId:城市ID（无则无须传cityid)
       content 留言内容
       dynaInfoId 动态ID
       postToDynaReplyId 发表回复的回复ID
       createDate 创建时间，列表数据的pubTime，后台查表需要，格式yyyy-MM-dd

是否登录:是
缓存时间:无
是否分页:否
    
      返回结果：
      {
         code	返回结果代码,正常返回 1:操作失败 1001:权限类错误 1002:数据类错误 1003:用户无登陆  
         message	返回结果描述
         data:{
                    replyId://回复id
                    userId://用户ID
                    authorPhoto://用户头像
                    nickname://用户昵称
                    content://回复内容
                    createDate://回复时间
                    createAt://long 类型，回复时间
                    postToDynaReplyId://被回复id(为回复回复时返回)
                    postToUserId://被回复用户ID(为回复回复时返回)
                    postToNickName://被回复用户昵称(为回复回复时返回)
              }
}

1.1.7 动态回复列表

说明：动态回复列表
接口：/usercenter/1.0/dyna/getReplyList.do [GET]
请求参数
       dynaInfoId 动态ID

是否登录:是
缓存时间:无
是否分页:否
    
      返回结果：
      {
       dynaInfoId://动态ID
       replys:[
              {
                    replyId://回复id
                    userId://用户ID
                    authorPhoto://用户头像
                    userName://用户昵称
                    content://回复内容
                    replyToId://被回复id(为回复回复时返回)
                    replyToUserId://被回复用户ID(为回复回复时返回)
                    replyToUserName://被回复用户昵称(为回复回复时返回)
              }
       ]

1.1.8 未读动态点赞清零

说明：未读动态点赞清零
接口：/usercenter/1.0/dyna/clearUnreadPraise.do [POST]
请求参数
	根据用户登录的Session获取用户ID
        dynaInfoIds:动态ID列表（用“，”连接起来）

        说明：
            1.参数dynaInfoIds可选。
            2.如果dynaInfoIds有传正确动态ID列表，只会对登录用户相应的动态被赞标记为已读。
            3.如果dynaInfoIds为空值，或者不传参数，将会对登录用户所有未读被赞标记为已读。
        


是否登录:是
缓存时间:无
是否分页:否

返回
{
	code:0成功，-1失败
        message:提示信息
        version: 接口版本号如1.0，1.0（latest)表示最新版本

        successIds:返回被标为已读的动态ID
}

1.1.9 未读已赞数(包括图片赞数，动态赞数)

说明：未读动态点赞清零
接口：/usercenter/1.0/dyna/getUnReadCount.do [GET]
请求参数
	根据用户登录的Session获取用户ID

是否登录:是
缓存时间:无
是否分页:否

返回
{
	code:0成功，-1失败
        message:提示信息
        version: 接口版本号如1.0，1.0（latest)表示最新版本

	dynaPraiseNotReadCount:动态未读已赞的数量
        photoPraiseNotReadCount:图片未读已赞的数量
}

1.1.10 批量获取投票人数和活动人数

说明：获取投票人数和活动人数
接口：/usercenter/1.0/dyna/getVoteActivityCount.do [GET]
请求参数
	voteIds : 投票id (用“，”隔开)
        activityIds : 活动id(用 “，” 隔开)

是否登录:否
缓存时间:无
是否分页:否

返回
{
	code:0成功，-1失败
        message:提示信息
        version: 接口版本号如1.0，1.0（latest)表示最新版本
        voteItems[{
            voteId:投票id
            voteCount:投票人数
        },{
            voteId:投票id
            voteCount:投票人数
        }]
        activityItems[{
           activityId : 活动id
           activityCount :活动报名人数
        }，{
           activityId : 活动id
           activityCount :活动报名人数
        }]
	
        
}

1.2 投票相关

1.2.1 用户进行投票

接口/usercenter/1.0/vote/takeVote.do [POST]
说明 : 用户进行投票
请求参数：
  *voteId ：投票ID
  *voteItemId : 投票选项ID
 
  权限：车友会会员

是否登录 : 是
缓存时间 : 无
是否分页 : 否


返回结果：
{
   code : 0成功，-1失败
   message : 提示信息
   version : 接口版本号如1.0，1.0（latest)表示最新版本
}

1.2.2 删除投票

接口/usercenter/1.0/vote/deleteVote.do [POST]
说明 : 用户删除投票
请求参数：
  *voteId ：投票ID

  权限：发布者，会长，副会长

是否登录 : 是
缓存时间 : 无
是否分页 : 否


返回结果：
{
   code : 0成功，-1失败
   message : 提示信息
   version : 接口版本号如1.0，1.0（latest)表示最新版本
}

1.2.3 判断用户是否已投票

接口/usercenter/1.0/vote/hasVoted.do [GET]
说明 : 用户对动态进行投票
请求参数：
  *userId : 用户ID
  *voteId ：投票ID
 

是否登录 : 否
缓存时间 : 无
是否分页 : 否


返回结果：
{
   userId : 用户ID
   voteId : 投票ID
   hasVoted : 0,未投票；1，已投票
   voteItemId : 0,未投票; >0,已投选项

   code : 0成功，-1失败
   message : 提示信息
   version : 接口版本号如1.0，1.0（latest)表示最新版本
}

1.3 照片相关

1.3.1 未读照片点赞清零

接口：/usercenter/1.0/photo/clearUnreadPraise.do [POST]
说明：未读照片点赞清零
请求参数
    photoIds:照片ID列表（用“，”连接起来）

    说明：
        1.参数photoIds可选。
        2.如果photoIds有传正确照片ID列表，只会对登录用户相应的照片被赞标记为已读。
        3.如果photoIds为空值，或者不传参数，将会对登录用户所有未读照片被赞标记为已读。
        


是否登录:是
缓存时间:无
是否分页:否

返回
{
    successPhotoIds:返回被标为已读的照片ID

    code:0成功，-1失败
    message:提示信息
    version: 接口版本号如1.0，1.0（latest)表示最新版本

}

1.3.2 评论照片

接口/usercenter/1.0/photo/replyPhoto.do [POST]
说明 : 评论照片
请求参数：
  *photoId:照片ID
  *albumId:相册ID
  *content:评论内容
   postToPhotoReplyId:被评论的评论ID（如果为空，代表直接评论照片）
 

是否登录 : 是
缓存时间 : 无
是否分页 : 否


返回结果：
{
   code : 0成功，-1失败
   message : 提示信息
   version : 接口版本号如1.0，1.0（latest)表示最新版本
}

返回
顶部

Download in other formats:

Plain Text