文章 List Gallery REST 端点

URLs

GET api/v1/galleries.xml (or .json)

LIST galleries.

GET api/v1/groups/{groupid}/galleries.xml (or .json)

LIST galleries.

请求参数

名称

类型

描述

必需

默认值

选项

GroupId

int?

Group Id

否

IncludeSubGroups

bool?

Only used when GroupId is specified. Default is false.

否

ApplicationIds

string

Comma separated list of ApplicationIds. Used to limit to a specific set of blogs as well as sort order if SoryBy is set to ApplicationIdsOrder

否

PermissionId

string

Used to get a list of galleries for which the user set in UserId has the provided Permission ID.

否

NameQuery

string

Name Query

否

SortBy

string

Options are: DateCreate, LastPost, Name, Post, SortOrder, Thread, TotalPosts, Score:SCORE_ID. Default is SortOrder.

否

SortOrder

string

Options include Ascending, Descending. Default is Ascending.

否

UserId

int?

User ID of the user to check permissions for. This option is only used whenever the PermissionId is also supplied.

否

PageSize

int?

Specify the number of results to return per page. If not set the default is 20. The max is 100.

否

PageIndex

int?

Specify the page number of paged results to return. Zero-based index. If not specified the default is 0.

否