`paraworld.lobby.GetRoomList`

Contents

Description
Parameters
Example Return XML
Example Return JSON
Error Codes
Test Cases

Description

取得指定页的房间数据

Parameters

Required	Name	Type	Description
optional	pageIndex	string	以０开始的页码
	pageSize	int	每页的最大数据量
	worldID	int	取得与该World相关联的所有房间，若指定了worldID，将忽略worldPath
	worldPath	string	取得与该World相关联的所有房间
	orderField	int	排序字段。１：RoomID，２：CreateDate，３：ActivityDate，　默认值为２
	orderDirection	int	排序方式。１：正序；２：倒序，默认值为２
	format	int	返回的数据格式（0:XML 1:JSON），默认值为0

Example Return XML

<msg>
        <pageCount type="double">1</pageCount>
        <rooms>
                <param index="1">
                        <roomID type="double">1</roomID>
                        <worldID type="double">9</worldID>
                        <worldPath type="string" />
                        <hostUID type="string">ed06733e-986d-4236-8fc8-9f8300456c21</hostUID>
                        <joinPassword type="string">password</joinPassword>
                        <description type="string">Description</description>
                        <maxClients type="double">200</maxClients>
                        <createDate type="string">2008-6-17 16:52:15</createDate>
                        <activityDate type="string">2008-6-17 16:52:15</activityDate>
                </param>
                <param index="2">
                        <roomID type="double">2</roomID>
                        <worldID type="double">9</worldID>
                        <worldPath type="string" />
                        <hostUID type="string">ed06733e-986d-4236-8fc8-9f8300456c21</hostUID>
                        <joinPassword type="string">password</joinPassword>
                        <description type="string">This is a test room</description>
                        <maxClients type="double">300</maxClients>
                        <createDate type="string">2008-6-17 17:23:13</createDate>
                        <activityDate type="string">2008-6-17 17:23:13</activityDate>
                </param>
        </rooms>
</msg>

Example Return JSON

{"pageCount":"1","rooms":[{"roomID":"1747","worldID":"0","worldPath":"WorldPath","hostUID":"28275afd-670c-4d60-84ef-dc8f4e78ca87","joinPassword":"",
"description":"This is a test room","maxClients":"100","createDate":"2008-12-10T11:28:14.7","activityDate":"2008-12-10T11:28:14.7"}]}

Error Codes

当发生异常时，返回数据中会有一个“errorCode”节点，该节点记录了错误码。0：无异常 500：未知错误 499：提供的数据不完整 498：非法的访问 497：数据不存在或已被删除 496：未登录

查看完整的Error Code

Test Cases

case 1

Input:

{

        ["pageIndex"]=0,

        ["orderDirection"]=1,

        ["pageSize"]=5,

        ["orderField"]=1,

}

Result:

{

        ["pageCount"]=1,

        ["rooms"]={

                [1]={

                        ["hostUID"]="ed06733e-986d-4236-8fc8-9f8300456c21",

                        ["description"]="This is a test room",

                        ["maxClients"]=300,

                        ["roomID"]=1,

                        ["activityDate"]="2008-6-17 17:25:35",

                        ["createDate"]="2008-6-17 17:25:35",

                        ["worldPath"]="",

                        ["worldID"]=9,

                        ["joinPassword"]="password",

                },

        },

}

Topic revision: r4 - 2008-12-10 - CaoYF