GET /api/bookmarks
列出所有收藏

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

search
选填

过滤结果

Validations:

  • Must be a String

order
选填

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
选填

编页结果

Validations:

  • Must be a String

per_page
选填

每个请求中的条目数

Validations:

  • Must be a String

搜索字段

字段名 类型 可能的值
controller string
name string

GET /api/bookmarks/:id
显示收藏

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/bookmarks
创建收藏

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

bookmark
必填

Validations:

  • Must be a Hash

bookmark[name]
必填

Validations:

  • Must be a String

bookmark[controller]
必填

Validations:

  • Must be a String

bookmark[query]
必填

Validations:

  • Must be a String

bookmark[public]
选填 , 允许空值

Validations:

  • Must be one of: true, false, 1, 0.


PUT /api/bookmarks/:id
更新收藏

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

bookmark
必填

Validations:

  • Must be a Hash

bookmark[name]
选填

Validations:

  • Must be a String

bookmark[controller]
选填

Validations:

  • Must be a String

bookmark[query]
选填

Validations:

  • Must be a String

bookmark[public]
选填 , 允许空值

Validations:

  • Must be one of: true, false, 1, 0.


DELETE /api/bookmarks/:id
删除收藏

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.