- Home
- Resources
- ShareResource
User: david
Date: 7/25/12
Time: 2:25 PM
POST /shares
Request Parameters
name |
type |
description |
default |
constraints |
id |
form |
|
|
long |
notify |
form |
|
false |
boolean |
notify_address |
form |
|
|
|
GET /shares/{id}
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
Response Body
media type |
data type |
application/json |
Share
(JSON) |
application/xml |
share
(XML) |
POST /shares/{id}
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
notify |
query |
|
false |
boolean |
notify_address |
query |
|
|
|
Request Body
media type |
data type |
application/json |
Share
(JSON) |
application/xml |
share
(XML) |
Response Body
media type |
data type |
application/json |
Share
(JSON) |
application/xml |
share
(XML) |
DELETE /shares/{id}
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
GET /shares/by_user/{id}
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
GET /shares/by_user/{id}/binder_tree
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
hidden |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
BinderTree
(JSON) |
application/xml |
binderTree
(XML) |
GET /shares/by_user/{id}/library_children
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
hidden |
query |
|
false |
boolean |
title |
query |
|
|
|
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/by_user/{id}/entries
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
GET /shares/by_user/{id}/files
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
file_name |
query |
|
|
|
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/by_user/{id}/library_entities
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
binders |
query |
|
true |
boolean |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
files |
query |
|
true |
boolean |
first |
query |
|
0 |
int |
folder_entries |
query |
|
true |
boolean |
hidden |
query |
|
false |
boolean |
keyword |
query |
|
|
|
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
replies |
query |
|
true |
boolean |
unhidden |
query |
|
true |
boolean |
GET /shares/by_user/{id}/library_files
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
file_name |
query |
|
|
|
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/by_user/{id}/library_changes
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
500 |
int |
description_format |
query |
|
text |
|
hidden |
query |
|
false |
boolean |
recursive |
query |
|
true |
boolean |
since |
query |
|
|
|
unhidden |
query |
|
true |
boolean |
GET /shares/by_user/{id}/recent_activity
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
20 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
GET /shares/with_user/{id}
Request Parameters
name |
type |
description |
constraints |
id |
path |
|
long |
GET /shares/with_user/{id}/binder_tree
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
hidden |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
BinderTree
(JSON) |
application/xml |
binderTree
(XML) |
GET /shares/with_user/{id}/library_children
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
hidden |
query |
|
false |
boolean |
title |
query |
|
|
|
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/with_user/{id}/library_entities
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
binders |
query |
|
true |
boolean |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
files |
query |
|
true |
boolean |
first |
query |
|
0 |
int |
folder_entries |
query |
|
true |
boolean |
hidden |
query |
|
false |
boolean |
keyword |
query |
|
|
|
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
replies |
query |
|
true |
boolean |
unhidden |
query |
|
true |
boolean |
GET /shares/with_user/{id}/entries
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
GET /shares/with_user/{id}/files
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
file_name |
query |
|
|
|
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/with_user/{id}/library_files
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
file_name |
query |
|
|
|
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/with_user/{id}/library_tree
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
description_format |
query |
|
text |
|
hidden |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
BinderTree
(JSON) |
application/xml |
binderTree
(XML) |
GET /shares/with_user/{id}/library_changes
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
500 |
int |
description_format |
query |
|
text |
|
hidden |
query |
|
false |
boolean |
recursive |
query |
|
true |
boolean |
since |
query |
|
|
|
unhidden |
query |
|
true |
boolean |
GET /shares/with_user/{id}/recent_activity
Request Parameters
name |
type |
description |
default |
constraints |
id |
path |
|
|
long |
count |
query |
|
20 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
GET /shares/public/binders
Request Parameters
name |
type |
description |
default |
constraints |
hidden |
query |
|
false |
boolean |
title |
query |
|
|
|
unhidden |
query |
|
true |
boolean |
GET /shares/public/binder_tree
Request Parameters
name |
type |
description |
default |
constraints |
description_format |
query |
|
text |
|
hidden |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
BinderTree
(JSON) |
application/xml |
binderTree
(XML) |
GET /shares/public/library_tree
Request Parameters
name |
type |
description |
default |
constraints |
description_format |
query |
|
text |
|
hidden |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
BinderTree
(JSON) |
application/xml |
binderTree
(XML) |
GET /shares/public/library_children
Request Parameters
name |
type |
description |
default |
constraints |
hidden |
query |
|
false |
boolean |
title |
query |
|
|
|
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/public/library_folders
Request Parameters
name |
type |
description |
default |
constraints |
hidden |
query |
|
false |
boolean |
title |
query |
|
|
|
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/public/entries
Request Parameters
name |
type |
description |
default |
constraints |
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
GET /shares/public/files
Request Parameters
name |
type |
description |
default |
constraints |
file_name |
query |
|
|
|
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/public/library_files
Request Parameters
name |
type |
description |
default |
constraints |
file_name |
query |
|
|
|
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /shares/public/library_entities
Request Parameters
name |
type |
description |
default |
constraints |
binders |
query |
|
true |
boolean |
count |
query |
|
100 |
int |
description_format |
query |
|
text |
|
files |
query |
|
true |
boolean |
first |
query |
|
0 |
int |
folder_entries |
query |
|
true |
boolean |
hidden |
query |
|
false |
boolean |
keyword |
query |
|
|
|
parent_binder_paths |
query |
|
false |
boolean |
recursive |
query |
|
false |
boolean |
replies |
query |
|
true |
boolean |
unhidden |
query |
|
true |
boolean |
GET /shares/public/library_changes
Request Parameters
name |
type |
description |
default |
constraints |
count |
query |
|
500 |
int |
description_format |
query |
|
text |
|
hidden |
query |
|
false |
boolean |
recursive |
query |
|
true |
boolean |
since |
query |
|
|
|
unhidden |
query |
|
true |
boolean |
GET /shares/public/recent_activity
Request Parameters
name |
type |
description |
default |
constraints |
count |
query |
|
20 |
int |
description_format |
query |
|
text |
|
first |
query |
|
0 |
int |
hidden |
query |
|
false |
boolean |
parent_binder_paths |
query |
|
false |
boolean |
unhidden |
query |
|
true |
boolean |