UserResource Resource

GET /users

Request Parameters
name type description default constraints
count query 100 int
description_format query text  
email query    
first query 0 int
id query   long
keyword query    
name query    
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

POST /users

Request Parameters
name type description default
description_format query text
password query  
Request Body
media type data type
application/json User (JSON)
application/xml user (XML)
Response Body
media type data type
application/json User (JSON)
application/xml user (XML)

GET /users/name/{name}

Request Parameters
name type description default constraints
name path    
description_format query text  
include_attachments query true boolean
Response Body
media type data type
application/json User (JSON)
application/xml user (XML)

GET /users/{id}

Request Parameters
name type description default constraints
id path   long
description_format query text  
include_attachments query true boolean
Response Body
media type data type
application/json User (JSON)
application/xml user (XML)

PUT /users/{id}

Request Parameters
name type description default constraints
id path   long
description_format query text  
include_attachments query true boolean
Request Body
media type data type
application/json User (JSON)
application/xml user (XML)
Response Body
media type data type
application/json User (JSON)
application/xml user (XML)

POST /users/{id}/password

Request Parameters
name type description constraints
new_password form  
old_password form  
id path long
Response Body
media type data type
application/json object (JSON)
application/xml anyType (XML)

GET /users/{id}/teams

Request Parameters
name type description constraints
id path long
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

GET /users/{id}/favorites

Request Parameters
name type description constraints
id path long
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

GET /users/{id}/groups

Request Parameters
name type description constraints
id path long
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

GET /users/{id}/ancestry

Request Parameters
name type description constraints
id path long
Response Body
media type data type
application/json array of BinderBrief (JSON)
application/xml list of binderBrief (XML)

GET /users/{id}/attachments

Request Parameters
name type description constraints
id path long
Response Body
media type data type
application/json SearchResultList (JSON)
application/xml searchResultList (XML)

POST /users/{id}/attachments

Request Parameters
name type description constraints
id path long
data_name query  
file_name query  
md5 query  
mod_date query  
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /users/{id}/attachments

Request Parameters
name type description constraints
id path long
data_name query  
file_name query  
md5 query  
mod_date query  
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)

POST /users/{id}/attachments

Request Parameters
name type description
id path
Response Body
media type data type
application/json FileProperties (JSON)
application/xml fileProperties (XML)